GUI Scripting: ChoiceDef - Revision history

Geep: Add category tag

2022-11-04T17:42:49Z

Add category tag

← Older revision		Revision as of 17:42, 4 November 2022
Line 158:		Line 158:

	* Content here is primarily from Ref 1 of [[GUI Scripting: References & Resources]], heavily augmented by inspection of TDM 2.10 source code and GUI files. Ref 3 has a conflicting meaning of what choiceType denotes (as simply "Boolean versus multiple choice"), but appears sketchy and less authoritative than usual, so may be discounted as describing a real difference between Doom 3 and Quake 4.		* Content here is primarily from Ref 1 of [[GUI Scripting: References & Resources]], heavily augmented by inspection of TDM 2.10 source code and GUI files. Ref 3 has a conflicting meaning of what choiceType denotes (as simply "Boolean versus multiple choice"), but appears sketchy and less authoritative than usual, so may be discounted as describing a real difference between Doom 3 and Quake 4.

			{{GUI}}

Geep: /* Additional Properties of ChoiceDefs */

2022-10-14T16:01:43Z

Additional Properties of ChoiceDefs

← Older revision		Revision as of 16:01, 14 October 2022
Line 23:		Line 23:

	==Additional Properties of ChoiceDefs==		==Additional Properties of ChoiceDefs==
	® = A property known as a "register", that can be altered at runtime by binding it to a GUI:: parameter, or in a "set" or "transition" script command. Other properties cannot be so altered.		® = A property known as a "register", that can be altered at runtime by binding it to a GUI:: parameter, or in a "set" or "transition" script command. Other properties cannot be so altered, nor appear within event handlers.

	===Lists of Valid Choices===		===Lists of Valid Choices===

Geep: /* Features Shared with All GuiDef Types */

2022-08-07T19:00:49Z

Features Shared with All GuiDef Types

← Older revision		Revision as of 19:00, 7 August 2022
Line 20:		Line 20:
	Occasionally, a namedEvent handler is useful to provide feedback from the C++ code to the GUI.		Occasionally, a namedEvent handler is useful to provide feedback from the C++ code to the GUI.

	Tool tips (implemented by event handlers) are provided for a number of choiceDefs~~, editDefs,~~ and sliderDefs. See [[GUI Scripting:Tooltip Macro]] for more.		Tool tips (implemented by event handlers) are provided for a number of choiceDefs and sliderDefs. See [[GUI Scripting:Tooltip Macro]] for more.

	==Additional Properties of ChoiceDefs==		==Additional Properties of ChoiceDefs==

Geep: /* (Choicevar "string" ®) */

2022-08-07T18:05:52Z

(Choicevar "string" ®)

← Older revision		Revision as of 18:05, 7 August 2022
Line 108:		Line 108:

	===(Choicevar "string" ®)===		===(Choicevar "string" ®)===
	Undefined. Probably can be parsed in a GUI but not fully implemented. In the list of Registers in Windows.cpp of Doom 3 and TDM, and mentioned but not explained in Ref 1 of [[GUI Scripting: Resources ~~& References~~]].		Undefined. Probably can be parsed in a GUI but not fully implemented. In the list of Registers in Windows.cpp of Doom 3 and TDM, and mentioned but not explained in Ref 1 of [[GUI Scripting: References & Resources]].

	==Two Basic Examples==		==Two Basic Examples==

Geep: /* Features Shared with All GuiDef Types */

2022-08-07T17:06:15Z

Features Shared with All GuiDef Types

← Older revision		Revision as of 17:06, 7 August 2022
Line 14:		Line 14:

	==Features Shared with All GuiDef Types==		==Features Shared with All GuiDef Types==
	A choiceDef will make use of [GUI Scripting: Properties in Common \| Properties in common] to sculpt the presentation of its text. [GUI Scripting: User Variables \| User variables] were not seen in practice, possibly because the designated Cvar/GUI:: Parameter can fulfill the role.		A choiceDef will make use of [[GUI Scripting: Properties in Common \| Properties in common]] to sculpt the presentation of its text. [[GUI Scripting: User Variables \| User variables]] were not seen in practice, possibly because the designated Cvar/GUI:: Parameter can fulfill the role.

	ChoiceDefs routinely have an onAction event handler, whose event block invokes the internal C++ task necessitated by a change in choice. onAction is called when LMB is first clicked and during subsequently value changes. It actually fires after the Cvar and/or GUI:: Parameter are updated, during the key (or mouse button) release.		ChoiceDefs routinely have an onAction event handler, whose event block invokes the internal C++ task necessitated by a change in choice. onAction is called when LMB is first clicked and during subsequently value changes. It actually fires after the Cvar and/or GUI:: Parameter are updated, during the key (or mouse button) release.

Geep: Remove tooltip from Other Properties section

2022-08-07T17:04:47Z

Remove tooltip from Other Properties section

← Older revision		Revision as of 17:04, 7 August 2022
Line 97:		Line 97:
	This is always initialized to 1 (true) in TDM's classes for choiceDef, editDef, and sliderDef, and is never seen to be changed explicitly thereafter in any GUIs. Speculatively, if you wanted to design menus that used that had "Done" and "Cancel" buttons, you might use:		This is always initialized to 1 (true) in TDM's classes for choiceDef, editDef, and sliderDef, and is never seen to be changed explicitly thereafter in any GUIs. Speculatively, if you wanted to design menus that used that had "Done" and "Cancel" buttons, you might use:
	liveupdate 0		liveupdate 0

	~~===ToolTip "''string''"===~~
	This is a new option with TDM, not in Doom 3, and just for the main menu system. It is supported for choiceDefs, editDefs, and sliderDefs. It offers a simple way to provide an internationalized tooltip (i.e., #str_...), invoked by mouse-over, that appears in a fixed screen location, namely offset to the left of the current menu.

	==Unused in TDM?==		==Unused in TDM?==

Geep: /* Features Shared with All GuiDef Types */ Move tooltips mention here

2022-08-07T17:02:57Z

Features Shared with All GuiDef Types: Move tooltips mention here

← Older revision		Revision as of 17:02, 7 August 2022
Line 19:		Line 19:

	Occasionally, a namedEvent handler is useful to provide feedback from the C++ code to the GUI.		Occasionally, a namedEvent handler is useful to provide feedback from the C++ code to the GUI.

			Tool tips (implemented by event handlers) are provided for a number of choiceDefs, editDefs, and sliderDefs. See [[GUI Scripting:Tooltip Macro]] for more.

	==Additional Properties of ChoiceDefs==		==Additional Properties of ChoiceDefs==

Geep: change choicetype headings

2022-08-06T14:52:00Z

change choicetype headings

← Older revision		Revision as of 14:52, 6 August 2022
Line 73:		Line 73:
	Related to the foregoing, currentchoice is the currently selected choice, as a zero-based integer index. No TDM core GUI currently uses this Property, though the parsing and corresponding C++ variable is implemented. Possibly intended to be a read-only variable, for event handler if-conditions.		Related to the foregoing, currentchoice is the currently selected choice, as a zero-based integer index. No TDM core GUI currently uses this Property, though the parsing and corresponding C++ variable is implemented. Possibly intended to be a read-only variable, for event handler if-conditions.

	===Establishing the Source of Cvar Values===		===Establishing the Source and Nature of Cvar Values===
	====Choicetype ''type_number''====		====Choicetype ''type_number''====
	Takes a value of 0 or 1, that determines the source of the value that gets passed to the specified cvar. Default is 0 (but TDM menus #defines a CHOICE_DEF that specifies 1 unless further overwritten).		Takes a value of 0 or 1, that determines the source of the value that gets passed to the specified cvar. Default is 0 (but TDM menus #defines a CHOICE_DEF that specifies 1 unless further overwritten).

	~~====~~With ChoiceType 0~~====~~		'''With ChoiceType 0'''

	The bound cvar's value always represents a zero-based index into the choices list. The value is the same as that of currentchoice and (if present) the bound gui.		The bound cvar's value always represents a zero-based index into the choices list. The value is the same as that of currentchoice and (if present) the bound gui.

	Any "values" list is treated as just a comment for documentation.		Any "values" list is treated as just a comment for documentation.

	~~====~~With ChoiceType 1~~====~~		'''With ChoiceType 1'''

	The bound cvar's value comes from the appropriate value within a list, where the list is either:		The bound cvar's value comes from the appropriate value within a list, where the list is either:
	* "values" if defined (in which case the value is a float, most often an int); otherwise		* "values" if defined (in which case the value is a float, most often an int); otherwise
Line 89:		Line 91:
	==Other Choice Def Properties==		==Other Choice Def Properties==
	===Liveupdate ''bool''===		===Liveupdate ''bool''===
	This Property also available for editDefs and sliderDefs. If set to 1, the cvar (and gui parameter) is changed as the text is changed, and the text changes as the cvar changes. Otherwise only changes when "cvar read ''group_name''" or "cvar write ''group_name''" is sent.		This Property is also available for editDefs and sliderDefs. If set to 1, the cvar (and gui parameter) is changed as the text is changed, and the text changes as the cvar changes. Otherwise only changes when "cvar read ''group_name''" or "cvar write ''group_name''" is sent.

	This is always initialized to 1 (true) in TDM's classes for choiceDef, editDef, and sliderDef, and is never seen to be changed explicitly thereafter in any GUIs. Speculatively, if you wanted to design menus that used that had "Done" and "Cancel" buttons, you might use:		This is always initialized to 1 (true) in TDM's classes for choiceDef, editDef, and sliderDef, and is never seen to be changed explicitly thereafter in any GUIs. Speculatively, if you wanted to design menus that used that had "Done" and "Cancel" buttons, you might use:

Geep: /* Gui "gui_parameter_name" */

2022-08-06T14:45:22Z

Gui "gui_parameter_name"

← Older revision		Revision as of 14:45, 6 August 2022
Line 62:		Line 62:
	====Gui "''gui_parameter_name''"====		====Gui "''gui_parameter_name''"====
	Defines the choiceDef's GUI:: Parameter. Gui_parameter_name here skips the "gui::" prefix. The value will contain a numeric 0-based index into the list(s) of choices. This value is equal to that of the currentchoice property. It provides a way to pass a choice to the engine, without necessarily using an exposed individualized Cvar. (Arguably, you could accomplish the same thing with something like:		Defines the choiceDef's GUI:: Parameter. Gui_parameter_name here skips the "gui::" prefix. The value will contain a numeric 0-based index into the list(s) of choices. This value is equal to that of the currentchoice property. It provides a way to pass a choice to the engine, without necessarily using an exposed individualized Cvar. (Arguably, you could accomplish the same thing with something like:
	~~Set~~ "gui::myparam" "currentchoice"; // Then do a set "cmd"... call that will read myparam		set "gui::myparam" "currentchoice"; // Then do a set "cmd"... call that will read myparam
	)		)

Geep: /* Choices "choice_string" ® */

2022-08-06T14:42:11Z

Choices "choice_string" ®

← Older revision		Revision as of 14:42, 6 August 2022
Line 33:		Line 33:
	choices "#str_07314" // Enhanced;Default		choices "#str_07314" // Enhanced;Default

	Less general ~~choices~~:		Less general choice lists:
	choices "#str_07241" // Off;Low;Medium;High		choices "#str_07241" // Off;Low;Medium;High
	choices "#str_02948" // 32 bits;64 bits		choices "#str_02948" // 32 bits;64 bits
Line 43:		Line 43:
	A singleton, set in another control's event handler as part of disabling an inappropriate control:		A singleton, set in another control's event handler as part of disabling an inappropriate control:
	set "MeleeAutoParry::choices" "#str_07306"; // Disabled		set "MeleeAutoParry::choices" "#str_07306"; // Disabled

			See tdm_base01.pk4/strings/all.lang for additional possibilities.

	====Values "''values_string''"====		====Values "''values_string''"====