GUI Scripting: Properties in Common - Revision history

Geep: Add category tag

2022-11-04T16:17:39Z

Add category tag

← Older revision		Revision as of 16:17, 4 November 2022
Line 174:		Line 174:
	==For More==		==For More==
	This property listing is largely from Ref 3 of [[GUI Scripting: References & Resources]] as supplemented by Ref 1, but re-ordered. Examples are largely from TDM 2.10 core menus.		This property listing is largely from Ref 3 of [[GUI Scripting: References & Resources]] as supplemented by Ref 1, but re-ordered. Examples are largely from TDM 2.10 core menus.

			{{GUI}}

Geep: /* text string_literal_or_variable ® */

2022-10-25T18:03:12Z

text string_literal_or_variable ®

← Older revision		Revision as of 18:03, 25 October 2022
Line 80:		Line 80:
	The text to be displayed in the guiDef. The character limit is 1024 [true?]. Default: "".		The text to be displayed in the guiDef. The character limit is 1024 [true?]. Default: "".
	text "Heading" // In property list. Widely used.		text "Heading" // In property list. Widely used.
			text "gui::gui_parm1" // Get desired sign text from spawnarg; used with sign text decals available as prefabs.
	set "leftCapital::text" "$gui::left_capital"; // script command used in core for readable books with illuminated drop caps.		set "leftCapital::text" "$gui::left_capital"; // script command used in core for readable books with illuminated drop caps.

	====textalign ''align_enum''====		====textalign ''align_enum''====
	Defines the text’s alignment within the guiDef. Values are 0 (align left), 1 (center horizontally), or 2 (align right). Default: 0 (align left).		Defines the text’s alignment within the guiDef. Values are 0 (align left), 1 (center horizontally), or 2 (align right). Default: 0 (align left).

Geep: /* Introduction */ Clarify non-register description

2022-10-14T15:54:53Z

Introduction: Clarify non-register description

← Older revision		Revision as of 15:54, 14 October 2022
Line 1:		Line 1:
	''This page is part of a series. See [[GUI Scripting Language]] for overview.''		''This page is part of a series. See [[GUI Scripting Language]] for overview.''
	==Introduction==		==Introduction==
	Here is a catalogue of Properties common to windowDefs and all other members of the "guiDef" family. (~~Other members have~~ additional task-related Properties~~; see [[GUI Scripting: Properties Def-Specific]]~~). The catalogue is arranged by:		Here is a catalogue of Properties common to windowDefs and all other members of the "guiDef" family. (Each member's additional task-related Properties are detailed individually elsewhere.) The catalogue is arranged by:

	1) Frequency of use in TDM (widely; seldom; debug; unlikely to be useful)		1) Frequency of use in TDM (widely; seldom; debug; unlikely to be useful)
Line 13:		Line 13:
	3) Alphabetically		3) Alphabetically

	A Property has a predefined name, type (Boolean, float, vec2, vec4, string) and default value. Properties appear in a <Property List> at the start of a guiDef's body, after the "{". ~~Conventionally~~, one Property is listed per line. Any property not explicitly listed still exists, with its default value.		A Property has a predefined name, type (Boolean, float, vec2, vec4, string) and default value. Properties appear in a <Property List>, by convention at the start of a guiDef's body, after the "{". Routinely, one Property is listed per line. Any property not explicitly listed still exists, with its default value.
	====About "Registers", Marked Here As ®====		====About "Registers", Marked Here As ®====
	As indicated in the listing below, properties are of two types:		As indicated in the listing below, properties are of two types:
	* those that can only be given an initial unchanging value.		* those that can only appear in a property list - not within event handlers - and can only be given an initial unchanging value. Informally, these are like tags.
	* those that ''can'' be changed, called "Registers", and indicated here by a ® symbol.		* those that ''can'' be changed, called "Registers", and indicated here by a ® symbol. These are like true variables.

	A Register can be changed by one of these two methods:		A Register can be changed by one of these two methods:

Geep: /* Unused in Doom 3 & TDM */ mention dpadgui

2022-09-17T19:08:07Z

Unused in Doom 3 & TDM: mention dpadgui

← Older revision		Revision as of 19:08, 17 September 2022
Line 165:		Line 165:

	runscript® Not available as property, only as script command in Doom 3 (though unused in that form in TDM.)		runscript® Not available as property, only as script command in Doom 3 (though unused in that form in TDM.)

			Listed in Ref 3 (Quake 4), but not in Ref 1:

			dpadgui

	==For More==		==For More==
	This property listing is largely from Ref 3 of [[GUI Scripting: References & Resources]] as supplemented by Ref 1, but re-ordered. Examples are largely from TDM 2.10 core menus.		This property listing is largely from Ref 3 of [[GUI Scripting: References & Resources]] as supplemented by Ref 1, but re-ordered. Examples are largely from TDM 2.10 core menus.

Geep: /* rect vector_with_4_values ® */ relative positioning

2022-08-21T03:16:24Z

rect vector_with_4_values ®: relative positioning

← Older revision		Revision as of 03:16, 21 August 2022
Line 58:		Line 58:
	noclip 1 // Widely set to 1 in core, e.g., for readables.		noclip 1 // Widely set to 1 in core, e.g., for readables.
	====rect ''vector_with_4_values'' ®====		====rect ''vector_with_4_values'' ®====
	Defines the location, width and height of the guiDef rectangle as x-origin, y-origin, width, height. 0, 0, 640, 480 would be a guiDef of 640 by 480 logical pixels whose top left corner is at coordinate 0,0. The first two values always represent the guiDef’s upper left corner.		Defines the location, width and height of the guiDef rectangle as x-origin, y-origin, width, height. 0, 0, 640, 480 would be a guiDef of 640 by 480 logical pixels whose top left corner is at coordinate 0,0. The first two values always represent the guiDef’s upper left corner. The rect of a child guiDef is relative to its parent's rect but within its inner border as given by bordersize. That is, if the parent x/y origin coordinates are 0,0, and the parent's bordersize is 3, then if the child x/y origin coordinates are 0,0, that's actually at the parent's 3,3 location.
	rect 0, 0, 640, 480 // By convention, a top-level windowDef is explicitly set to these values, to define the logical coordinate system for child guiDefs.		rect 0, 0, 640, 480 // By convention, a top-level windowDef is explicitly set to these values, to define the logical coordinate system for child guiDefs.
	set "body::rect" "20, 10, 250, 380"; // In guis\readables\parchment_everett_hand_2.gui		set "body::rect" "20, 10, 250, 380"; // In guis\readables\parchment_everett_hand_2.gui
	transition "message::rect" "0, 0, 185, 1000" "10, 59, 185, 1000" "1" // a script event in tdm_message_no_art.gui that appropriately sizes a popup message box, in this case for 2 lines of text.		transition "message::rect" "0, 0, 185, 1000" "10, 59, 185, 1000" "1" // a script event in tdm_message_no_art.gui that appropriately sizes a popup message box, in this case for 2 lines of text.

	====visible ''bool'' ®====		====visible ''bool'' ®====
	Should this guiDef be visible? Default: 1 (true).		Should this guiDef be visible? Default: 1 (true).

Geep: /* wantenter bool */

2022-07-22T18:28:02Z

wantenter bool

← Older revision		Revision as of 18:28, 22 July 2022
Line 139:		Line 139:
	===Timer and Events===		===Timer and Events===
	====wantenter ''bool''====		====wantenter ''bool''====
	When the user presses enter, should the guiDef’s onAction ~~script~~ run? Default: 0 (false)		When the user presses enter, and there's no child guiDef that has the focus, should the guiDef’s onAction (and/or onActionRelease) event handler run? Default: 0 (false)
	wantenter 1		wantenter 1

Geep: /* For More */ Add links

2022-07-22T18:14:59Z

For More: Add links

← Older revision		Revision as of 18:14, 22 July 2022
Line 165:		Line 165:
	runscript® Not available as property, only as script command in Doom 3 (though unused in that form in TDM.)		runscript® Not available as property, only as script command in Doom 3 (though unused in that form in TDM.)
	==For More==		==For More==
	This property listing is largely from [Ref 3] as supplemented by [Ref 1], but re-ordered. Examples are largely from TDM 2.10 core menus.		This property listing is largely from Ref 3 of [[GUI Scripting: References & Resources]] as supplemented by Ref 1, but re-ordered. Examples are largely from TDM 2.10 core menus.

Geep: /* About "Registers", Marked Here As ® */

2022-07-17T21:31:35Z

About "Registers", Marked Here As ®

← Older revision		Revision as of 21:31, 17 July 2022
Line 19:		Line 19:
	* those that ''can'' be changed, called "Registers", and indicated here by a ® symbol.		* those that ''can'' be changed, called "Registers", and indicated here by a ® symbol.

	A Register can be changed by one of these two ~~(mutually exclusive)~~ methods:		A Register can be changed by one of these two methods:
	# By a "set" or "transition" event handler command, which updates the initial value. If the command is in a different guiDef (while still part of the same GUI), use the "guiDef_name::" prefix before the variable.		# By a "set" or "transition" event handler command, which updates the initial value. If the command is in a different guiDef (while still part of the same GUI), use the "guiDef_name::" prefix before the variable.
	# By "binding" a gui:: parameter to it, as its value. This value will then be checked every frame. The value of the gui:: parameter is updated either from an associated .script file, or from a "set" or "transition" command in some guiDef of the GUI. For more, see [[GUI Scripting: GUI:: Parameters]].		# By "binding" a gui:: parameter to it, as its value. This value will then be checked every frame. The value of the gui:: parameter is updated either from an associated .script file, or from a "set" or "transition" command in some guiDef of the GUI. For more, see [[GUI Scripting: GUI:: Parameters]].

Geep: /* About "Registers", Marked Here As ® */ revise

2022-07-17T21:29:14Z

About "Registers", Marked Here As ®: revise

← Older revision		Revision as of 21:29, 17 July 2022
Line 15:		Line 15:
	A Property has a predefined name, type (Boolean, float, vec2, vec4, string) and default value. Properties appear in a <Property List> at the start of a guiDef's body, after the "{". Conventionally, one Property is listed per line. Any property not explicitly listed still exists, with its default value.		A Property has a predefined name, type (Boolean, float, vec2, vec4, string) and default value. Properties appear in a <Property List> at the start of a guiDef's body, after the "{". Conventionally, one Property is listed per line. Any property not explicitly listed still exists, with its default value.
	====About "Registers", Marked Here As ®====		====About "Registers", Marked Here As ®====
	~~Properties~~ of ~~guiDefs~~ that can be '''changed by event handler ~~commands''' are called~~ "~~registers~~".		As indicated in the listing below, properties are of two types:
			* those that can only be given an initial unchanging value.
			* those that ''can'' be changed, called "Registers", and indicated here by a ® symbol.

			A Register can be changed by one of these two (mutually exclusive) methods:
			# By a "set" or "transition" event handler command, which updates the initial value. If the command is in a different guiDef (while still part of the same GUI), use the "guiDef_name::" prefix before the variable.
			# By "binding" a gui:: parameter to it, as its value. This value will then be checked every frame. The value of the gui:: parameter is updated either from an associated .script file, or from a "set" or "transition" command in some guiDef of the GUI. For more, see [[GUI Scripting: GUI:: Parameters]].

			While changing a non-register value is not possible, you can probably get the desired effect by cloning the guiDef and selective hiding.

	====About Syntax & Usage Examples====		====About Syntax & Usage Examples====
	Syntax examples shown here start with how they can appear in a property list. For properties that are registers, there may be additional examples with event handler commands "set", "transition", or "if (condition)". Property list and event handler commands have different syntax; don’t confuse them.		Syntax examples shown here start with how they can appear in a property list. For properties that are registers, there may be additional examples with event handler commands "set", "transition", or "if (condition)". Property list and event handler commands have different syntax; don’t confuse them.

Geep at 18:45, 16 July 2022

2022-07-16T18:45:26Z

← Older revision		Revision as of 18:45, 16 July 2022
Line 1:		Line 1:
	''This page is part of a series. See [[GUI Scripting Language]] for overview.''		''This page is part of a series. See [[GUI Scripting Language]] for overview.''

	~~[WORK IN PROGRESS]~~

	==Introduction==		==Introduction==
	Here is a catalogue of Properties common to windowDefs and all other members of the "guiDef" family. (Other members have additional task-related Properties; see [[GUI Scripting: Properties Def-Specific]]). The catalogue is arranged by:		Here is a catalogue of Properties common to windowDefs and all other members of the "guiDef" family. (Other members have additional task-related Properties; see [[GUI Scripting: Properties Def-Specific]]). The catalogue is arranged by:
Line 25:		Line 22:
	===Rectangle Size, Location, and Appearance===		===Rectangle Size, Location, and Appearance===
	====backcolor ''color_vector'' ®====		====backcolor ''color_vector'' ®====
	Defines the guiDef’s background color. Colors are normalized RGB and alpha values. . Default: all 0s (black but transparent).		Defines the guiDef’s background color. Colors are normalized RGB and alpha values. . Default: all 0 values (black but transparent).
	backcolor 1,1,0,1 // Yellow with no transparency.		backcolor 1,1,0,1 // Yellow with no transparency.
	====background ''path'' ®====		====background ''path'' ®====
Line 32:		Line 29:
	set "background" "guis/video/credits/city_sequence01"; // Logical path shown, defined in materials/tdm_gui.mtr, is to a roq video.		set "background" "guis/video/credits/city_sequence01"; // Logical path shown, defined in materials/tdm_gui.mtr, is to a roq video.
	====bordercolor ''color_vector'' ® ====		====bordercolor ''color_vector'' ® ====
	Defines the color of the guiDef’s border. Colors are normalized RGB and alpha values. The bordersize property must be non-zero for a bordercolor to show. Default: all 1s (opaque white).		Defines the color of the guiDef’s border. Colors are normalized RGB and alpha values. The bordersize property must be non-zero for a bordercolor to show. Default: all 1 values (opaque white).
	bordercolor 1,1,0,1 // Yellow with no transparency.		bordercolor 1,1,0,1 // Yellow with no transparency.
	bordercolor 0, 0, 0, 0.7 // Used in mainmenu_loadsave.gui. Semi-transparent black border.		bordercolor 0, 0, 0, 0.7 // Used in mainmenu_loadsave.gui. Semi-transparent black border.
Line 66:		Line 63:
	font "fonts/stone" // Property is widely used in core.		font "fonts/stone" // Property is widely used in core.
	====forecolor ''color_vector'' ®====		====forecolor ''color_vector'' ®====
	Defines the color of the guiDef’s text. Colors are normalized RGB and alpha values. Default: all 1s (opaque white).		Defines the color of the guiDef’s text. Colors are normalized RGB and alpha values. Default: all 1 values (opaque white).
	forecolor 1,1,1,1 // This example is opaque white, widely used.		forecolor 1,1,1,1 // This example is opaque white, widely used.
	forecolor 0, 0, 0, 0.66 // Black text, semi-transparent, as used for various sign texts.		forecolor 0, 0, 0, 0.66 // Black text, semi-transparent, as used for various sign texts.