GUI Scripting: Commands - Revision history

Geep: /* Examples */

2023-11-02T21:56:19Z

Examples

← Older revision		Revision as of 21:56, 2 November 2023
Line 60:		Line 60:
	transition "MMIGCreditsText::forecolor" SNORMAL_COLOR SGLOW_WHITE_COLOR "50" ;		transition "MMIGCreditsText::forecolor" SNORMAL_COLOR SGLOW_WHITE_COLOR "50" ;

	Another example, with a ''time_duration'' value #defined in tdm_gui01.pk4\guis\readables\readable.guicode, and frequently used in other .gui for page-flipping visuals in readables. Observe that in this case, the developer chose not to include double quotes around ''time_duration'', ''accel'', and ''decel'' values:		Another example, with a ''time_duration'' value #defined in tdm_gui01.pk4\guis\readables\readable.guicode:
	#define READABLE_FADE_TIME 200		#define READABLE_FADE_TIME 200
			This constant is then frequently used in other .gui for page-flipping visuals in readables. For instance, in tdm_gui01.pk4\guis\readables\sheets\sheet_paper_print_stone.gui (line 124):
	transition "leftPageCurl::matcolor" "1 1 1 0" "1 1 1 1" READABLE_FADE_TIME 0.5 0;		transition "leftPageCurl::matcolor" "1 1 1 0" "1 1 1 1" READABLE_FADE_TIME 0.5 0;
			Observe that in this case, the developer chose not to include double quotes around ''time_duration'', ''accel'', and ''decel'' values.

	==Sparingly Used==		==Sparingly Used==

Geep: /* Example */

2023-10-09T22:05:44Z

Example

← Older revision		Revision as of 22:05, 9 October 2023
Line 73:		Line 73:
	runScript "gui::gui_parm''n''";		runScript "gui::gui_parm''n''";
	====Example====		====Example====
	''Adapted from stgatilov in [https://bugs.thedarkmod.com/view.php?id=6164 New features in GUI ~~Engine~~ (bugtracker 6164)]. See there for more.''		''Adapted from stgatilov in [https://bugs.thedarkmod.com/view.php?id=6164 New features in GUI engine (bugtracker 6164)]. See there for more.''

	Suppose you want some special action to occur when you click Attack when reading a readable.		Suppose you want some special action to occur when you click Attack when reading a readable.

Geep: /* Example */

2023-10-09T22:04:26Z

Example

← Older revision		Revision as of 22:04, 9 October 2023
Line 73:		Line 73:
	runScript "gui::gui_parm''n''";		runScript "gui::gui_parm''n''";
	====Example====		====Example====
	''Adapted from stgatilov in bugtracker 6164''		''Adapted from stgatilov in [https://bugs.thedarkmod.com/view.php?id=6164 New features in GUI Engine (bugtracker 6164)]. See there for more.''

	Suppose you want some special action to occur when you click Attack when reading a readable.		Suppose you want some special action to occur when you click Attack when reading a readable.

Geep: /* Commands Unavailable in TDM */ drop runScript from this section

2023-10-09T21:57:16Z

Commands Unavailable in TDM: drop runScript from this section

← Older revision		Revision as of 21:57, 9 October 2023
Line 128:		Line 128:
	==Commands Unavailable in TDM==		==Commands Unavailable in TDM==
	The following are applicable to other related games using this GUI language, but not TDM. While in some cases, there is remnant code to parse and ignore these without complaint, it is best to avoid:		The following are applicable to other related games using this GUI language, but not TDM. While in some cases, there is remnant code to parse and ignore these without complaint, it is best to avoid:
	evalRegs, localSound, endGame~~, runScript~~		evalRegs, localSound, endGame
	~~However, resurrecting "runScript" is a possibility for TDM 2.12; See [https://bugs.thedarkmod.com/view.php?id=6164 New features in GUI engine].~~

	For more about these 4 commands, see [[GUI Scripting: TDM vs Doom 3, Quake 4]].		For more about these 3 commands, see [[GUI Scripting: TDM vs Doom 3, Quake 4]].

	{{GUI}}		{{GUI}}

Geep: /* Sparingly Used */ Add runScript

2023-10-09T21:55:25Z

Sparingly Used: Add runScript

@@ Line 66: / Line 66: @@
 ==Sparingly Used==
 ===SetFocus Command===
 Sets the input/selection focus to a particular editDef or listDef. Syntax:
@@ Line 94: / Line 125: @@
 Example usages of this may be seen throughout mainmenu_credits.gui, mainmenu_briefing_video.gui, mainmenu_debriefing_video.gui.
 ==Commands Unavailable in TDM==
 The following are applicable to other related games using this GUI language, but not TDM. While in some cases, there is remnant code to parse and ignore these without complaint, it is best to avoid:

Geep: /* Widely Used */ Expand "set" command to include expression mode & vector components

2022-12-27T22:20:45Z

Widely Used: Expand "set" command to include expression mode & vector components

← Older revision		Revision as of 22:20, 27 December 2022
Line 33:		Line 33:
	If you are trying to set one variable (''variable_sink'') equal to another (''variable_source'') you must reference the source using the ‘$’ prefix. This lets the parser know that you are referencing another variable, not just a literal string. Syntax:		If you are trying to set one variable (''variable_sink'') equal to another (''variable_source'') you must reference the source using the ‘$’ prefix. This lets the parser know that you are referencing another variable, not just a literal string. Syntax:
	set "''variable_sink''" "$''variable_source''";		set "''variable_sink''" "$''variable_source''";

			====Expression Mode and Vector Components====
			Starting in TDM 2.11, you can specify an arithmetic expression on the "right-hand side" (i.e., as a source parameter). You do this by using enclosing parentheses to enter the set command's "expression mode". Within expression mode, you can also specify vector components. As an example of both:

			set backcolor (backcolor[0], backcolor[1], backcolor[2], 1 - backcolor[3]);
			CAUTION: expression mode calculations that involve changeable variables ONLY use the values that are present when the handler starts. (This surprising "early evaluation" behavior traditionally has been seen in expression calculations in if-conditions. For more, see [[GUI Scripting: Evaluating Expressions & Variables]].)

	====Using Set "Cmd" to Execute a Game/Engine Command====		====Using Set "Cmd" to Execute a Game/Engine Command====

Geep: Update links to other guidef types

2022-12-27T21:18:33Z

Update links to other guidef types

← Older revision		Revision as of 21:18, 27 December 2022
Line 17:		Line 17:

	===Set Command===		===Set Command===
	Set a property, user variable, or GUI::parameter to a given value, in order to change the appearance or behavior of guiDefs during runtime. Not all properties can be changed by script command. Those that can be are called "registers" and so listed in [[GUI Scripting: Properties in Common]] and [[~~GUI Scripting: Properties Def-Specific~~]]. Syntax:		Set a property, user variable, or GUI::parameter to a given value, in order to change the appearance or behavior of guiDefs during runtime. Not all properties can be changed by script command. Those that can be are called "registers" and so listed in [[GUI Scripting: Properties in Common]] and the property lists of [[GUI_Scripting_Language#Other_%22GuiDef%22_Types \| Other "GuiDef" Types]]. Syntax:
	set "[''guiDef_name''::]''variable''" "''new_value''";		set "[''guiDef_name''::]''variable''" "''new_value''";

Line 38:		Line 38:

	===Transition Command===		===Transition Command===
	Linearly interpolates a variable from one value to another over ''time_duration'', in milliseconds. Often used for color changes. Not all properties can be changed by script command. Those that can be are called "registers" and so listed in [[GUI Scripting: Properties in Common]] and [[~~GUI Scripting: Properties Def-Specific~~]]. Syntax:		Linearly interpolates a variable from one value to another over ''time_duration'', in milliseconds. Often used for color changes. Not all properties can be changed by script command. Those that can be are called "registers" and so listed in [[GUI Scripting: Properties in Common]] and and the property lists of [[GUI_Scripting_Language#Other_%22GuiDef%22_Types \| Other "GuiDef" Types]]. Syntax:
	transition "[''guiDef_name''::]''variable''" "''from_value''" "''to_value''" ''time_duration'' [''accel decel''];		transition "[''guiDef_name''::]''variable''" "''from_value''" "''to_value''" ''time_duration'' [''accel decel''];
	where		where

Geep: /* Commands Unavailable in TDM */ Link to bugtracker RE runScript

2022-11-15T19:54:49Z

Commands Unavailable in TDM: Link to bugtracker RE runScript

← Older revision		Revision as of 19:54, 15 November 2022
Line 91:		Line 91:
	The following are applicable to other related games using this GUI language, but not TDM. While in some cases, there is remnant code to parse and ignore these without complaint, it is best to avoid:		The following are applicable to other related games using this GUI language, but not TDM. While in some cases, there is remnant code to parse and ignore these without complaint, it is best to avoid:
	evalRegs, localSound, endGame, runScript		evalRegs, localSound, endGame, runScript
	For more about these, see [[GUI Scripting: TDM vs Doom 3, Quake 4]].		However, resurrecting "runScript" is a possibility for TDM 2.12; See [https://bugs.thedarkmod.com/view.php?id=6164 New features in GUI engine].

			For more about these 4 commands, see [[GUI Scripting: TDM vs Doom 3, Quake 4]].

	{{GUI}}		{{GUI}}

Geep: Add category tag

2022-11-04T16:23:10Z

Add category tag

← Older revision		Revision as of 16:23, 4 November 2022
Line 92:		Line 92:
	evalRegs, localSound, endGame, runScript		evalRegs, localSound, endGame, runScript
	For more about these, see [[GUI Scripting: TDM vs Doom 3, Quake 4]].		For more about these, see [[GUI Scripting: TDM vs Doom 3, Quake 4]].

			{{GUI}}

Geep: /* Commands Unavailable in TDM */

2022-07-13T20:47:40Z

Commands Unavailable in TDM

← Older revision		Revision as of 20:47, 13 July 2022
Line 91:		Line 91:
	The following are applicable to other related games using this GUI language, but not TDM. While in some cases, there is remnant code to parse and ignore these without complaint, it is best to avoid:		The following are applicable to other related games using this GUI language, but not TDM. While in some cases, there is remnant code to parse and ignore these without complaint, it is best to avoid:
	evalRegs, localSound, endGame, runScript		evalRegs, localSound, endGame, runScript
	For more about these, see [[GUI ~~Scriping~~: TDM vs Doom 3, Quake 4]].		For more about these, see [[GUI Scripting: TDM vs Doom 3, Quake 4]].