Override#
An Override
object is returned from get_fixture_override and get_group_override.
Member functions#
The following are member functions of Override
objects.
set_irgb#
set_irgb(intensity, red, green, blue, [fade, [path]])
Overrides the intensity, red, green and blue levels for the fixture or group according to the parameters:
Parameter |
Value Type |
Description |
Value Example |
---|---|---|---|
|
integer (0-255) |
Intensity level to set as an override. |
|
|
integer (0-255) |
Red level to set as an override. |
|
|
integer (0-255) |
Green level to set as an override. |
|
|
integer (0-255) |
Blue level to set as an override. |
|
|
float |
Optional. Fade time to apply the override change, in seconds. |
|
|
string |
Optional. Crossfade path to use when applying the override: |
|
For example:
-- Get override for fixture 22
override = get_fixture_override(22)
-- Set the override colour to red (and full intensity)
override:set_irgb(255, 255, 0, 0)
set_intensity#
set_intensity(intensity, [fade, [path]])
Overrides the intensity level for the fixture or group according to the parameters:
Parameter |
Value Type |
Description |
Value Example |
---|---|---|---|
|
integer (0-255) |
Intensity level to set as an override. |
|
|
float |
Optional. Fade time to apply the override change, in seconds. |
|
|
string |
Optional. Crossfade path to use when applying the override: |
|
For example:
-- Get override for group 3
override = get_group_override(3)
-- Set the intensity to 50% in 2 seconds
override:set_intensity(128, 2.0)
set_red#
set_red(red, [fade, [path]])
Overrides the red level for the fixture or group according to the parameters:
Parameter |
Value Type |
Description |
Value Example |
---|---|---|---|
|
integer (0-255) |
Red level to set as an override. |
|
|
float |
Optional. Fade time to apply the override change, in seconds. |
|
|
string |
Optional. Crossfade path to use when applying the override: |
|
set_green#
set_green(green, [fade, [path]])
Overrides the green level for the fixture or group according to the parameters:
Parameter |
Value Type |
Description |
Value Example |
---|---|---|---|
|
integer (0-255) |
Green level to set as an override. |
|
|
float |
Optional. Fade time to apply the override change, in seconds. |
|
|
string |
Optional. Crossfade path to use when applying the override: |
|
set_blue#
set_blue(blue, [fade, [path]])
Overrides the blue level for the fixture or group according to the parameters:
Parameter |
Value Type |
Description |
Value Example |
---|---|---|---|
|
integer (0-255) |
Blue level to set as an override. |
|
|
float |
Optional. Fade time to apply the override change, in seconds. |
|
|
string |
Optional. Crossfade path to use when applying the override: |
|
set_temperature#
set_temperature(temperature, [fade, [path]])
Overrides the temperature level for the fixture or group according to the parameters:
Parameter |
Value Type |
Description |
Value Example |
---|---|---|---|
|
integer (0-255) |
Temperature level to set as an override. |
|
|
float |
Optional. Fade time to apply the override change, in seconds. |
|
|
string |
Optional. Crossfade path to use when applying the override: |
|
clear#
clear([fade])
Removes any override on the fixture or group. Optionally specify a fade
time in seconds as a float, e.g. 2.0
.
For example:
-- Clear the override on fixture 1
get_fixture_override(1):clear()
See also: clear_all_overrides.