Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Excerpt
Panel
findZones(recursive, nameOrFilterFunction)

Description

Function to find zones in a containerthe specified layer. For example, this.parent defines the parent layer of the script module as containerthe layer to be searched in. If recursive is set to true, subcontainers sublayers will also be searched. The function returns an array with the element the Zone objects of the found zones. Particular zones can be searched by name or through a filter function. If searching by name, findZones accepts only the element the Zone objects that match the specified name. The filter function uses the element the Zone object of each zone as argument. Only those element those Zone objects that return true for the search criteria defined in the filter function will be accepted by findZones. Without a name or filter function the element the Zone objects of all zones in the searched containers layers will be returned.

Available in: Controller, Processor.

Arguments

recursiveIf set to false, only the current container layer will be searched. If set to true, subcontainers sublayers will also be searched. The default is false.boolean
nameOrFilterFunctionThe name of the zones searched for or a filter function. Only the element Zone objects that match the name or return true for the search criteria of the filter function will be accepted. Set this to nil to deactivate any name filter or search criteria.string or function, optional

Return Values

Returns an array with the element the Zone objects of the found zones. Returns an empty table if no zones are found.

Example

Code Block
-- find all zones and print their names
zones = this.program:findZones(true)

if zones[1] then
    for i, zone in ipairs(zones) do
        print(zone.name)
    end
else
    print("Could not find any zones!")
end

Panel

See Also: findBussesfindChildrenfindInsertsfindEffectsfindLayers, findMidiModules, findSlots, Zone