Skip to content

model.getCustomFunction

model.getCustomFunction(function)

Get Custom Function parameters

Parameters

Name Req Type Description
function yes integer custom function number (use 0 for CF1)

Returns

NameTypeDescription
-nilrequested custom function does not exist
-tablecustom function data:
FieldTypeDescription
switchnumberswitch index
funcnumberfunction index
namestringName of track to play (only returned only returned if action is play track, sound or script)
valuenumbervalue (only returned only returned if action is not play track, sound or script)
modenumbermode (only returned only returned if action is not play track, sound or script)
paramnumberparameter (only returned only returned if action is not play track, sound or script)
activenumber0 = disabled, 1 = enabled
repetitionnumber-1 to 60, range and meaning depend on function

Availability

  • Since: 2.0.0
  • Radio support: all

Source

radio/src/lua/api_model.cpp