the Cold Dark: Help: Commands: @def-setting

Core Help Root: Commands: @def-setting

PROGRAMMER COMMAND

Syntax: @def-set?ting|@define-set?ting <definer>:<setting>[=default] [options]

This command creates, and sets up new settings that can be modified with @set.

Options can be:

+get Sets the method that is called when you try to get the contents of the setting.

+get-a?rgs Data to return when the setting is gotten. If this option is empty, when the setting is gotten it returns the contents of the setting.

+set Sets the method that is called in order to set this setting.

+set-a?rgs Additional data used by the method in +set option.

+parse Sets the method that is called when you @set the setting, this method then parses it before saving it to the setting.

+parse-a?rgs Additional data used by the method in +parse option.

+c?lear Sets the method for clearing the setting.

+f?ormat Sets the method that is called when other methods want the setting formatted for display.

+a?ccess Sets that determines who or what has access to this setting.

+t?ype Types can be any ColdC type, 'boolean, or 'item-list.

`+get`	Sets the method that is called when you try to get the contents of the setting.
`+get-a?rgs`	Data to return when the setting is gotten. If this option is empty, when the setting is gotten it returns the contents of the setting.
`+set`	Sets the method that is called in order to set this setting.
`+set-a?rgs`	Additional data used by the method in +set option.
`+parse`	Sets the method that is called when you @set the setting, this method then parses it before saving it to the setting.
`+parse-a?rgs`	Additional data used by the method in +parse option.
`+c?lear`	Sets the method for clearing the setting.
`+f?ormat`	Sets the method that is called when other methods want the setting formatted for display.
`+a?ccess`	Sets that determines who or what has access to this setting.
`+t?ype`	Types can be any ColdC type, 'boolean, or 'item-list.