OptionWML - Revision history

Jarom: choice as primary tag name

2024-09-04T19:29:24Z

choice as primary tag name

← Older revision		Revision as of 19:29, 4 September 2024
Line 11:		Line 11:
	** '''name''': a string to be displayed next to the widget.		** '''name''': a string to be displayed next to the widget.
	** '''description''': the tooltip text to be displayed when the user hovers the mouse over the widget.		** '''description''': the tooltip text to be displayed when the user hovers the mouse over the widget.
	* {{anchor\|choice\|'''[~~combo~~]'''}}: registers a combo box. ~~{{DevFeature1.13\|6}}~~ This ~~was renamed~~ to '''[~~choice~~]'''.		* {{anchor\|choice\|'''[choice]'''}}: registers a combo box. This tag used to be named '''[combo]''' before 1.13.6.
	** '''id''': the id for this option. Must be unique.		** '''id''': the id for this option. Must be unique.
	** '''default''': the default value of the widget.		** '''default''': the default value of the widget.

Soliton: /* The [options] tag */ Remove outdated note

2024-08-13T11:53:04Z

The [options] tag: Remove outdated note

← Older revision		Revision as of 11:53, 13 August 2024
Line 2:		Line 2:
	== The [options] tag ==		== The [options] tag ==

	This tag might be a child of an [era], [multiplayer] or [modification] tag. {{DevFeature1.13\|1}} [options] are now also recognised in a [campaign] tag. Its subtags describe a set of configuration options which are displayed to the user as widgets on the game creation screen, and the entered values are translated into WML variables in the game~~. Please note that the option variables are initialized in a prestart event, therefore they can't be used before the first prestart event~~. The created variables' name is identical to the option's id they're attached to, so option ~~ids~~ must be unique across all kinds of options.		This tag might be a child of an [[EraWML\|[era]]], [[ScenarioWML#The_.5Bmultiplayer.5D_tag\|[multiplayer]]] or [[ModificationWML\|[modification]]] tag. {{DevFeature1.13\|1}} [options] are now also recognised in a [[CampaignWML\|[campaign]]] tag. Its subtags describe a set of configuration options which are displayed to the user as widgets on the game creation screen, and the entered values are translated into WML variables in the game. The created variables' name is identical to the option's id they're attached to, so option IDs must be valid variable names and unique across all kinds of options. A good idea might be to prefix the addon ID.

	The following subtags are recognized for '''[options]''':		The following subtags are recognized for '''[options]''':

Celtic Minstrel: /* The [options] tag */ Add anchors that can be linked to

2024-02-25T01:38:30Z

The [options] tag: Add anchors that can be linked to

Vasya: /* The [options] tag */

2017-11-29T15:45:46Z

The [options] tag

← Older revision		Revision as of 15:45, 29 November 2017
Line 11:		Line 11:
	** '''name''': a string to be displayed next to the widget.		** '''name''': a string to be displayed next to the widget.
	** '''description''': the tooltip text to be displayed when the user hovers the mouse over the widget.		** '''description''': the tooltip text to be displayed when the user hovers the mouse over the widget.
	* '''[combo]''': registers a combo box. {{DevFeature1.13\|6}} This was renamed.		* '''[combo]''': registers a combo box. {{DevFeature1.13\|6}} This was renamed to '''[choice]'''.
	** '''id''': the id for this option. Must be unique.		** '''id''': the id for this option. Must be unique.
	** '''default''': the default value of the widget.		** '''default''': the default value of the widget.

Gfgtdf at 11:18, 11 July 2017

2017-07-11T11:18:29Z

← Older revision		Revision as of 11:18, 11 July 2017
Line 2:		Line 2:
	== The [options] tag ==		== The [options] tag ==

	This tag might be a child of an [era], [multiplayer], [modification] or [campaign] tag. Its subtags describe a set of configuration options which are displayed to the user as widgets on the game creation screen, and the entered values are translated into WML variables in the game. Please note that the option variables are initialized in a prestart event, therefore they can't be used before the first prestart event. The created variables' name is identical to the option's id they're attached to, so option ids must be unique across all kinds of options.		This tag might be a child of an [era], [multiplayer] or [modification] tag. {{DevFeature1.13\|1}} [options] are now also recognised in a [campaign] tag. Its subtags describe a set of configuration options which are displayed to the user as widgets on the game creation screen, and the entered values are translated into WML variables in the game. Please note that the option variables are initialized in a prestart event, therefore they can't be used before the first prestart event. The created variables' name is identical to the option's id they're attached to, so option ids must be unique across all kinds of options.

	The following subtags are recognized for '''[options]''':		The following subtags are recognized for '''[options]''':
Line 36:		Line 36:
	{{DevFeature1.13\|0}} These variables are now inserted directly in the scenario without events, this means you can also use those variables in scenariolevel [lua] tags and prestart events.		{{DevFeature1.13\|0}} These variables are now inserted directly in the scenario without events, this means you can also use those variables in scenariolevel [lua] tags and prestart events.

	For [campaign] use in 1.12, options need to be inserted in the first [scenario]. ~~{{DevFeature1.13\|x}}~~ Options for campaigns no longer work inside the first [scenario] and must now be placed directly inside [campaign].		For [campaign] use in 1.12, options need to be inserted in the first [scenario]. Options for campaigns no longer work inside the first [scenario] and must now be placed directly inside [campaign].

SigurdFireDragon: /* The [options] tag */ Add 1.12/1.13 campaign usage

2017-07-09T14:19:27Z

The [options] tag: Add 1.12/1.13 campaign usage

← Older revision		Revision as of 14:19, 9 July 2017
Line 35:		Line 35:
	in 1.12 those variables are inserted as preload event that set these variables.		in 1.12 those variables are inserted as preload event that set these variables.
	{{DevFeature1.13\|0}} These variables are now inserted directly in the scenario without events, this means you can also use those variables in scenariolevel [lua] tags and prestart events.		{{DevFeature1.13\|0}} These variables are now inserted directly in the scenario without events, this means you can also use those variables in scenariolevel [lua] tags and prestart events.

			For [campaign] use in 1.12, options need to be inserted in the first [scenario]. {{DevFeature1.13\|x}} Options for campaigns no longer work inside the first [scenario] and must now be placed directly inside [campaign].

Gfgtdf: /* The [options] tag */

2017-05-30T19:20:30Z

The [options] tag

← Older revision		Revision as of 19:20, 30 May 2017
Line 11:		Line 11:
	** '''name''': a string to be displayed next to the widget.		** '''name''': a string to be displayed next to the widget.
	** '''description''': the tooltip text to be displayed when the user hovers the mouse over the widget.		** '''description''': the tooltip text to be displayed when the user hovers the mouse over the widget.
	* '''[combo]''': registers a combo box.		* '''[combo]''': registers a combo box. {{DevFeature1.13\|6}} This was renamed.
	** '''id''': the id for this option. Must be unique.		** '''id''': the id for this option. Must be unique.
	** '''default''': the default value of the widget.		** '''default''': the default value of the widget.
Line 32:		Line 32:
	** '''name''': a string to be displayed next to the widget.		** '''name''': a string to be displayed next to the widget.
	** '''description''': the tooltip text to be displayed when the user hovers the mouse over the widget.		** '''description''': the tooltip text to be displayed when the user hovers the mouse over the widget.

			in 1.12 those variables are inserted as preload event that set these variables.
			{{DevFeature1.13\|0}} These variables are now inserted directly in the scenario without events, this means you can also use those variables in scenariolevel [lua] tags and prestart events.

SigurdFireDragon: /* The [options] tag */

2016-05-27T02:42:26Z

The [options] tag

← Older revision		Revision as of 02:42, 27 May 2016
Line 2:		Line 2:
	== The [options] tag ==		== The [options] tag ==

	This tag might be a child of an [era], [multiplayer] or [~~modification~~] tag. Its subtags describe a set of configuration options which are displayed to the user as widgets on the game creation screen, and the entered values are translated into WML variables in the game. Please note that the option variables are initialized in a prestart event, therefore they can't be used before the first prestart event. The created variables' name is identical to the option's id they're attached to, so option ids must be unique across all kinds of options.		This tag might be a child of an [era], [multiplayer], [modification] or [campaign] tag. Its subtags describe a set of configuration options which are displayed to the user as widgets on the game creation screen, and the entered values are translated into WML variables in the game. Please note that the option variables are initialized in a prestart event, therefore they can't be used before the first prestart event. The created variables' name is identical to the option's id they're attached to, so option ids must be unique across all kinds of options.

	The following subtags are recognized for '''[options]''':		The following subtags are recognized for '''[options]''':

Vultraz: Remove DevFeature1.11

2015-04-17T07:03:42Z

Remove DevFeature1.11

← Older revision		Revision as of 07:03, 17 April 2015
Line 2:		Line 2:
	== The [options] tag ==		== The [options] tag ==

	~~{{DevFeature1.11}}~~ This tag might be a child of an [era], [multiplayer] or [modification] tag. Its subtags describe a set of configuration options which are displayed to the user as widgets on the game creation screen, and the entered values are translated into WML variables in the game. Please note that the option variables are initialized in a prestart event, therefore they can't be used before the first prestart event. The created variables' name is identical to the option's id they're attached to, so option ids must be unique across all kinds of options.		This tag might be a child of an [era], [multiplayer] or [modification] tag. Its subtags describe a set of configuration options which are displayed to the user as widgets on the game creation screen, and the entered values are translated into WML variables in the game. Please note that the option variables are initialized in a prestart event, therefore they can't be used before the first prestart event. The created variables' name is identical to the option's id they're attached to, so option ids must be unique across all kinds of options.

	The following subtags are recognized for '''[options]''':		The following subtags are recognized for '''[options]''':

Lipk: Added [combo] and sorted alphabetically.

2013-12-28T10:07:56Z

Added [combo] and sorted alphabetically.

← Older revision		Revision as of 10:07, 28 December 2013
Line 6:		Line 6:
	The following subtags are recognized for '''[options]''':		The following subtags are recognized for '''[options]''':

	* '''[~~entry~~]''': registers a text ~~entry~~.		* '''[checkbox]''': registers a checkbox.
			** '''id''': the id for this option. Must be unique.
			** '''default''': boolean value, determines if the box should be checked initially. Default no.
			** '''name''': a string to be displayed next to the widget.
			** '''description''': the tooltip text to be displayed when the user hovers the mouse over the widget.
			* '''[combo]''': registers a combo box.
	** '''id''': the id for this option. Must be unique.		** '''id''': the id for this option. Must be unique.
	** '''default''': the ~~string initially displayed by~~ the widget.		** '''default''': the default value of the widget.
	** '''name''': a string to be displayed next to the widget.		** '''name''': a string to be displayed next to the widget.
	** '''description''': the tooltip text to be displayed when the user hovers the mouse over the widget.		** '''description''': the tooltip text to be displayed when the user hovers the mouse over the widget.
	* '''[~~checkbox~~]''': registers a ~~checkbox~~.		** '''[item]''': adds an item to the combo box.
			*** '''name''': the displayed name of this item.
			*** '''value''': the value the widget will take when this item is selected.
			* '''[entry]''': registers a text entry.
	** '''id''': the id for this option. Must be unique.		** '''id''': the id for this option. Must be unique.
	** '''default''': ~~boolean value, determines if~~ the ~~box should be checked~~ initially~~. Default no~~.		** '''default''': the string initially displayed by the widget.
	** '''name''': a string to be displayed next to the widget.		** '''name''': a string to be displayed next to the widget.
	** '''description''': the tooltip text to be displayed when the user hovers the mouse over the widget.		** '''description''': the tooltip text to be displayed when the user hovers the mouse over the widget.

← Older revision		Revision as of 01:38, 25 February 2024
Line 6:		Line 6:
	The following subtags are recognized for '''[options]''':		The following subtags are recognized for '''[options]''':

	* '''[checkbox]''': registers a checkbox.		* {{anchor\|checkbox\|'''[checkbox]'''}}: registers a checkbox.
	** '''id''': the id for this option. Must be unique.		** '''id''': the id for this option. Must be unique.
	** '''default''': boolean value, determines if the box should be checked initially. Default no.		** '''default''': boolean value, determines if the box should be checked initially. Default no.
	** '''name''': a string to be displayed next to the widget.		** '''name''': a string to be displayed next to the widget.
	** '''description''': the tooltip text to be displayed when the user hovers the mouse over the widget.		** '''description''': the tooltip text to be displayed when the user hovers the mouse over the widget.
	* '''[combo]''': registers a combo box. {{DevFeature1.13\|6}} This was renamed to '''[choice]'''.		* {{anchor\|choice\|'''[combo]'''}}: registers a combo box. {{DevFeature1.13\|6}} This was renamed to '''[choice]'''.
	** '''id''': the id for this option. Must be unique.		** '''id''': the id for this option. Must be unique.
	** '''default''': the default value of the widget.		** '''default''': the default value of the widget.
Line 19:		Line 19:
	*** '''name''': the displayed name of this item.		*** '''name''': the displayed name of this item.
	*** '''value''': the value the widget will take when this item is selected.		*** '''value''': the value the widget will take when this item is selected.
	* '''[entry]''': registers a text entry.		* {{anchor\|entry\|'''[entry]'''}}: registers a text entry.
	** '''id''': the id for this option. Must be unique.		** '''id''': the id for this option. Must be unique.
	** '''default''': the string initially displayed by the widget.		** '''default''': the string initially displayed by the widget.
	** '''name''': a string to be displayed next to the widget.		** '''name''': a string to be displayed next to the widget.
	** '''description''': the tooltip text to be displayed when the user hovers the mouse over the widget.		** '''description''': the tooltip text to be displayed when the user hovers the mouse over the widget.
	* '''[slider]''': registers an integer slider.		* {{anchor\|slider\|'''[slider]'''}}: registers an integer slider.
	** '''id''': the id for this option. Must be unique.		** '''id''': the id for this option. Must be unique.
	** '''default''': an integer value. The slider will be positioned at this value by default.		** '''default''': an integer value. The slider will be positioned at this value by default.