types.number_property_builder

Builds and registers a number setting.

Functions

default_value(value : number): types.number_property_builder

Sets the default value of the setting.

• value (number) The default value
• returns (types.number_property_builder) This builder

range(min : number, max : number): types.number_property_builder

Sets numeric bounds for number and number_range settings.

• min (number) The minimum allowed value
• max (number) The maximum allowed value
• returns (types.number_property_builder) This builder

step(step : number): types.number_property_builder

Sets the numeric step for number and number_range settings. Defaults to 0.01.

• step (number) A positive increment
• returns (types.number_property_builder) This builder

observer(callback : function): types.number_property_builder

Sets a callback notified when the setting value changes.

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

visibility(callback : function): types.number_property_builder

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

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

category(category : types.property_category): types.number_property_builder

Groups the setting under an existing property category.

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

description(description : string): types.number_property_builder

Sets the setting's description.

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

build(): types.number_property

Registers the setting and returns its property.

• returns (types.number_property) The registered property