/ HALion Developer Resource / HALion Script / Reference /

Bypass Masks

(Since HALion 6.4.0)

Description

Enumerator to determine the values that determine if a bus or effect follows the global inserts and Aux bypass buttons of the plug-in. The values must be applied to the bypassMask field of the desired Bus or Effect object. See the example below for details.

Available in: Controller.

Bypass Masks

The values are determined with these names:

Example

bus = this.parent:getBus()
  
bypassSettings = {
    {name = "No Bypass",            value = BypassMask.noBypass },
    {name = "Follow Inserts",       value = BypassMask.bypassInserts },
    {name = "Follow Aux",           value = BypassMask.bypassAux },
    {name = "Follow Inserts & Aux", value = BypassMask.bypassInserts + BypassMask.bypassAux },
}
  
bypassSettingsNames = {}
  
for i = 1, #bypassSettings do
    bypassSettingsNames[i] = bypassSettings[i].name
end
  
function onBypassSettingChanged()
    bus.bypassMask = bypassSettings[GlobalBypass].value
    print(bus.name, bus.bypassMask)
end
  
defineParameter("GlobalBypass", nil, 1, bypassSettingsNames, onBypassSettingChanged)

See also: Bus, Effect