/ HALion Developer Resource / HALion Script / Reference /

removeZone

removeZone(zoneOrPosition)

Description

Function to remove a zone from the specified layer. For example, this.parent specifies the parent layer of the script module as the layer that contains the zone. The zone to be removed is determined by its Zone object or its position. You can use getZone or findZones to determine the Zone object. The position is the number that indexes the zones in the specified layer.

Available in: Controller.

Arguments

ArgumentDescriptionValue Type
zoneOrPositionThe Zone object or position of the zone to be removed.Zone or number

Example

-- Remove all zones from the program.

zones = this.program:findZones(true)

for i, zone in ipairs(zones) do
    zone.parent:removeZone(zone)
end

See also: removeBus, removeEffect, removeLayer, removeMidiModule, Zone