User prop add boolean

From Sim Innovations Wiki
Jump to navigation Jump to search


user_prop_id = user_prop_add_boolean(name, default_value, description)

user_prop_add_float will add an additional user customizable setting to your instrument of the type boolean (true or false).

Return value

Argument Type Description
user_prop_id ID This value can be used for further reference. Functions such as user_prop_get can use this user_prop_id. Its good practice to store this persist_id in your logic code.


# Argument Type Description
1 name String The name of the user property. This name must be unique (there may only be one user property of a certain name in an instrument)
2 default_value Boolean The default value of the property. The is the value the property gets when the user adds the instrument to a panel.
3 description String A description of the property, explaining to the user what function this user property has.


-- Let's give our instrument two properties
screws_prop = user_prop_add_boolean("Show screws", true, "Show the screws")
bezel_prop  = user_prop_add_boolean("Show bezel", true, "Show the bezel")

-- We can check here what the user has configured
print("Show the screw graphics: " .. tostring(user_prop_get(screws_prop) ) )
print("Show the bezel graphics: " .. tostring(user_prop_get(bezel_prop) ) )
Settings visible to user within instrument configuration