Options.tbl - Revision history

MjnMixael: Replaced content with "{{SCPUI moved|https://github.com/MjnMixael/SCPUI/wiki/options.tbl}} Category:SCPUI Category:Tables"

2026-10-28T18:29:38Z

Replaced content with "{{SCPUI moved|https://github.com/MjnMixael/SCPUI/wiki/options.tbl}} Category:SCPUI Category:Tables"

Show changes

MjnMixael at 22:05, 18 September 2024

2024-09-18T22:05:50Z

← Older revision		Revision as of 22:05, 18 September 2024
Line 1:		Line 1:
	{{~~SCP_table~~}}		{{SCPUI_table}}
	{{Tables}}		{{Tables}}
	Options.tbl is used by the [[SCPUI]] script system to define special user or script preferences in the built-in SCPUI Options Interface.		Options.tbl is used by the [[SCPUI]] script system to define special user or script preferences in the built-in SCPUI Options Interface.

The Force at 20:17, 11 December 2023

2023-12-11T20:17:14Z

← Older revision		Revision as of 20:17, 11 December 2023
Line 183:		Line 183:

	[[Category:Tables]]		[[Category:Tables]]
			[[Category:SCPUI]]

The Force: Adjust Formatting to match other tables.

2023-12-11T19:59:43Z

Adjust Formatting to match other tables.

← Older revision		Revision as of 19:59, 11 December 2023
Line 1:		Line 1:
			{{SCP_table}}
			{{Tables}}
	Options.tbl is used by the [[SCPUI]] script system to define special user or script preferences in the built-in SCPUI Options Interface.		Options.tbl is used by the [[SCPUI]] script system to define special user or script preferences in the built-in SCPUI Options Interface.

Line 179:		Line 181:
	#End		#End
	</pre>		</pre>

			[[Category:Tables]]

MjnMixael: /* +Display Names: */

2023-10-09T14:19:10Z

+Display Names:

← Older revision		Revision as of 14:19, 9 October 2023
Line 45:		Line 45:
	*Syntax: '''''string'''''		*Syntax: '''''string'''''

	===+Display Names:===		===+Display Names===
	*Starts a section of value display names		*Starts a section of value display names
	*Display names should match the order of Valid Values.		*Display names should match the order of Valid Values.

MjnMixael: /* +Valid Values: */

2023-10-09T14:19:03Z

+Valid Values:

← Older revision		Revision as of 14:19, 9 October 2023
Line 35:		Line 35:
	*Syntax: '''''integer'''''		*Syntax: '''''integer'''''

	===+Valid Values:===		===+Valid Values===
	*Starts a section of value definitions		*Starts a section of value definitions
	*Must be followed by exactly 2 +Val: values for [[Options.tbl#Binary\|Binary]] options		*Must be followed by exactly 2 +Val: values for [[Options.tbl#Binary\|Binary]] options

MjnMixael: /* +Description: */

2023-10-05T16:08:52Z

+Description:

← Older revision		Revision as of 16:08, 5 October 2023
Line 15:		Line 15:
	*A description for the option		*A description for the option
	*Can be XSTR		*Can be XSTR
	*~~Not currently displayed anywhere, but that is a planned feature~~		*Displayed on mouseover of an option.
	*Syntax: '''''string'''''		*Syntax: '''''string'''''

MjnMixael at 15:54, 22 April 2023

2023-04-22T15:54:49Z

← Older revision		Revision as of 15:54, 22 April 2023
Line 25:		Line 25:
	===+Type:===		===+Type:===
	*The type of option		*The type of option
	*Valid values are [[~~options~~.tbl#Header\|Header]], [[~~options~~.tbl#Binary\|Binary]], [[~~options~~.tbl#Multi\|Multi]], [[~~options~~.tbl#Range\|Range]], [[~~options~~.tbl#FivePoint\|FivePoint]], [[~~options~~.tbl#TenPoint\|TenPoint]]		*Valid values are [[Options.tbl#Header\|Header]], [[Options.tbl#Binary\|Binary]], [[Options.tbl#Multi\|Multi]], [[Options.tbl#Range\|Range]], [[Options.tbl#FivePoint\|FivePoint]], [[Options.tbl#TenPoint\|TenPoint]]
	*Required		*Required
	*Syntax: '''''string'''''		*Syntax: '''''string'''''
Line 37:		Line 37:
	===+Valid Values:===		===+Valid Values:===
	*Starts a section of value definitions		*Starts a section of value definitions
	*Must be followed by exactly 2 +Val: values for [[~~options~~.tbl#Binary\|Binary]] options		*Must be followed by exactly 2 +Val: values for [[Options.tbl#Binary\|Binary]] options
	*Must be followed by at least 2 +Val: values for [[~~options~~.tbl#Multi\|Multi]] options		*Must be followed by at least 2 +Val: values for [[Options.tbl#Multi\|Multi]] options
	*Required only for [[~~options~~.tbl#Binary\|Binary]] and [[~~options~~.tbl#Multi\|Multi]] types		*Required only for [[Options.tbl#Binary\|Binary]] and [[Options.tbl#Multi\|Multi]] types

	====+Val:====		====+Val:====
Line 48:		Line 48:
	*Starts a section of value display names		*Starts a section of value display names
	*Display names should match the order of Valid Values.		*Display names should match the order of Valid Values.
	*Must be followed by exactly 2 +Val: values for [[~~options~~.tbl#Binary\|Binary]] options		*Must be followed by exactly 2 +Val: values for [[Options.tbl#Binary\|Binary]] options
	*Must be followed by exactly 5 +Val: values for [[~~options~~.tbl#FivePoint\|FivePoint]] options		*Must be followed by exactly 5 +Val: values for [[Options.tbl#FivePoint\|FivePoint]] options
	*Must be followed by at least 2 +Val: values for [[~~options~~.tbl#Multi\|Multi]] options and must match the number of values defined		*Must be followed by at least 2 +Val: values for [[Options.tbl#Multi\|Multi]] options and must match the number of values defined
	*Required only for [[~~options~~.tbl#Binary\|Binary]], [[~~options~~.tbl#Multi\|Multi]], and [[~~options~~.tbl#FivePoint\|FivePoint]] types		*Required only for [[Options.tbl#Binary\|Binary]], [[Options.tbl#Multi\|Multi]], and [[Options.tbl#FivePoint\|FivePoint]] types

	====+Val:====		====+Val:====
Line 59:		Line 59:

	===+Min:===		===+Min:===
	*Defines the low number for a [[~~options~~.tbl#Range\|Range]] option		*Defines the low number for a [[Options.tbl#Range\|Range]] option
	*Required only for [[~~options~~.tbl#Range\|Range]] types		*Required only for [[Options.tbl#Range\|Range]] types
	*Cannot be less than zero		*Cannot be less than zero
	*Syntax: '''''float'''''		*Syntax: '''''float'''''

	===+Max:===		===+Max:===
	*Defines the high number for a [[~~options~~.tbl#Range\|Range]] option		*Defines the high number for a [[Options.tbl#Range\|Range]] option
	*Required only for [[~~options~~.tbl#Range\|Range]] types		*Required only for [[Options.tbl#Range\|Range]] types
	*Cannot be less than or equal to the Min value		*Cannot be less than or equal to the Min value
	*Syntax: '''''float'''''		*Syntax: '''''float'''''
Line 72:		Line 72:
	===+Default Value:===		===+Default Value:===
	*Defines the default value the option will be set at		*Defines the default value the option will be set at
	*Required if option is not of type [[~~options~~.tbl#Header\|Header]]		*Required if option is not of type [[Options.tbl#Header\|Header]]
	*Different option types require a different syntax		*Different option types require a different syntax
	*Syntax: '''''[[~~options~~.tbl#FivePoint\|FivePoint]] or [[~~options~~.tbl#TenPoint\|TenPoint]] integer, [[~~options~~.tbl#Range\|Range]] float, [[~~options~~.tbl#Binary\|Binary]] or [[~~options~~.tbl#Multi\|Multi]] string'''''		*Syntax: '''''[[Options.tbl#FivePoint\|FivePoint]] or [[Options.tbl#TenPoint\|TenPoint]] integer, [[Options.tbl#Range\|Range]] float, [[Options.tbl#Binary\|Binary]] or [[Options.tbl#Multi\|Multi]] string'''''

	===+Force Selector:===		===+Force Selector:===
	*A binary option defaults to a two button style. This flag will force a binary option to use the same style as a [[~~options~~.tbl#Multi\|Multi]] type option		*A binary option defaults to a two button style. This flag will force a binary option to use the same style as a [[Options.tbl#Multi\|Multi]] type option
	*Defaults to false		*Defaults to false
	*Syntax: '''''boolean'''''		*Syntax: '''''boolean'''''

MjnMixael: Created page with "Options.tbl is used by the SCPUI script system to define special user or script preferences in the built-in SCPUI Options Interface. Options.tbl can be extended with xxx-..."

2023-04-22T15:53:20Z

Created page with "Options.tbl is used by the SCPUI script system to define special user or script preferences in the built-in SCPUI Options Interface. Options.tbl can be extended with xxx-..."

New page

Options.tbl is used by the [[SCPUI]] script system to define special user or script preferences in the built-in SCPUI Options Interface.

Options.tbl can be extended with xxx-optn.tbm.

==Options.tbl==
*Begins with #Custom Options and ends with #End

===$Name:===
*The user-facing name of the option
*Can be XSTR
*Required
*Syntax: '''''string'''''

===+Description:===
*A description for the option
*Can be XSTR
*Not currently displayed anywhere, but that is a planned feature
*Syntax: '''''string'''''

===+Key:===
*This is a unique key identifier that can be used to access the option's data
*Required
*Syntax: '''''string'''''

===+Type:===
*The type of option
*Valid values are [[options.tbl#Header|Header]], [[options.tbl#Binary|Binary]], [[options.tbl#Multi|Multi]], [[options.tbl#Range|Range]], [[options.tbl#FivePoint|FivePoint]], [[options.tbl#TenPoint|TenPoint]]
*Required
*Syntax: '''''string'''''

===+Column:===
*The column to put the option in within the interface
*Valid values are 1-4
*Required
*Syntax: '''''integer'''''

===+Valid Values:===
*Starts a section of value definitions
*Must be followed by exactly 2 +Val: values for [[options.tbl#Binary|Binary]] options
*Must be followed by at least 2 +Val: values for [[options.tbl#Multi|Multi]] options
*Required only for [[options.tbl#Binary|Binary]] and [[options.tbl#Multi|Multi]] types

====+Val:====
*Defines the internal values this option can have
*Syntax: '''''string'''''

===+Display Names:===
*Starts a section of value display names
*Display names should match the order of Valid Values.
*Must be followed by exactly 2 +Val: values for [[options.tbl#Binary|Binary]] options
*Must be followed by exactly 5 +Val: values for [[options.tbl#FivePoint|FivePoint]] options
*Must be followed by at least 2 +Val: values for [[options.tbl#Multi|Multi]] options and must match the number of values defined
*Required only for [[options.tbl#Binary|Binary]], [[options.tbl#Multi|Multi]], and [[options.tbl#FivePoint|FivePoint]] types

====+Val:====
*Defines the user-facing value name for value
*Can be XSTR
*Syntax: '''''string'''''

===+Min:===
*Defines the low number for a [[options.tbl#Range|Range]] option
*Required only for [[options.tbl#Range|Range]] types
*Cannot be less than zero
*Syntax: '''''float'''''

===+Max:===
*Defines the high number for a [[options.tbl#Range|Range]] option
*Required only for [[options.tbl#Range|Range]] types
*Cannot be less than or equal to the Min value
*Syntax: '''''float'''''

===+Default Value:===
*Defines the default value the option will be set at
*Required if option is not of type [[options.tbl#Header|Header]]
*Different option types require a different syntax
*Syntax: '''''[[options.tbl#FivePoint|FivePoint]] or [[options.tbl#TenPoint|TenPoint]] integer, [[options.tbl#Range|Range]] float, [[options.tbl#Binary|Binary]] or [[options.tbl#Multi|Multi]] string'''''

===+Force Selector:===
*A binary option defaults to a two button style. This flag will force a binary option to use the same style as a [[options.tbl#Multi|Multi]] type option
*Defaults to false
*Syntax: '''''boolean'''''

===+No Default:===
*Designates the behavior of this option for the Mod Default button within the SCPUI Option Interface
*If true then the option will be ignored
*If false then the option will be reset to the default setting if the player clicks on the Mod Default button
*Defaults to false
*Syntax: '''''boolean'''''

==Types==
Below is a list of valid option types that can be defined.

===Header===
This is not an actual option, but can be used for categorizing options under related headings. Will display as larger underlined text.

===Binary===
This is an option with only two valid values. It can be displayed as a two-button style or like a multi selector. Returned values are always strings.

===Multi===
This is an option with any number of valid values and is displayed as a dropdown box selector. Returned values are always strings.

===Range===
This is an option that has a horizontal slider between min/max float values. Returned value will be a float.

===FivePoint===
This is an option with five settings that have a relationship from low to high. It will be displayed as five unique clickable points on a bar line and each point has a display string. It's the same kind of option that Difficulty uses. Returned value will be 1-5.

===TenPoint===
This is an option with ten settings that have a relationship from low to high. It will be displayed as ten unique clickable points on a bar line. Unlike FivePoint, it does not have a display string. Returned values will be 1-10.

==Example==
<pre>
#Custom Options

$Name: XSTR("Example Header", -1)
+Description: XSTR("Category header", -1)
+Key: Header_Example
+Type: Header
+Column: 2

$Name: XSTR("Example Binary Option", -1)
+Description: XSTR("This is a binary option. You can force it to be a selector with ForceSelector True.", -1)
+Key: Example_Binary
+Type: Binary
+Column: 2
+Valid Values
+Val: Off
+Val: On
+Display Names
+Val: XSTR("Off", -1)
+Val: XSTR("On", -1)
+Default Value: On
+Force Selector: false

$Name: XSTR("Example Selector Option", -1)
+Description: XSTR("This is a selector option.", -1)
+Key: Example_Selector
+Type: Multi
+Column: 2
+Valid Values
+Val: String1
+Val: String2
+Val: String3
+Display Names
+Val: XSTR("String1", -1)
+Val: XSTR("String2", -1)
+Val: XSTR("String3", -1)
+Default Value: String1

$Name: XSTR("Example Range Option", -1)
+Description: XSTR("This is a range option. It needs more testing. Min cannot be negative!", -1)
+Key: Example_Range
+Type: Range
+Column: 2
+Min: 0
+Max: 2
+Default Value: 1

$Name: XSTR("Example Ten Point", -1)
+Description: XSTR("This is a ten point dot selector. It functions as a range where saved values will be 1-10.", -1)
+Key: Example_Ten_Point
+Type: TenPoint
+Column: 2
+Default Value: 1

$Name: XSTR("Example Five Point", -1)
+Description: XSTR("This is a five point dot selector. It functions as a range where saved values will be 1-5.", -1)
+Key: Example_Five_Point
+Type: FivePoint
+Column: 2
+Display Names
+Val: XSTR("String1", -1)
+Val: XSTR("String2", -1)
+Val: XSTR("String3", -1)
+Val: XSTR("String4", -1)
+Val: XSTR("String5", -1)
+Default Value: 1

#End
</pre>