types.boolean_property_builder

Builds and registers a boolean setting.

Functions

default_value(value : boolean): types.boolean_property_builder

Sets the default value of the setting.

• value (boolean) The default value
• returns (types.boolean_property_builder) This builder

observer(callback : function): types.boolean_property_builder

Sets a callback notified when the setting value changes.

• callback (fun(old_value:boolean,new_value:boolean)) Receives the previous and new values
• returns (types.boolean_property_builder) This builder

visibility(callback : function): types.boolean_property_builder

Sets a callback controlling GUI visibility. Defaults to always visible.

• callback (function) Returns whether the setting is visible
• returns (types.boolean_property_builder) This builder

category(category : types.property_category): types.boolean_property_builder

Groups the setting under an existing property category.

• category (types.property_category) A category created by feature.register_category
• returns (types.boolean_property_builder) This builder

description(description : string): types.boolean_property_builder

Sets the setting's description.

• description (string) The GUI description
• returns (types.boolean_property_builder) This builder

build(): types.boolean_property

Registers the setting and returns its property.

• returns (types.boolean_property) The registered property