GUI Scripting: BindDef - Revision history

Geep: Add category tag

2022-11-04T17:45:55Z

Add category tag

← Older revision		Revision as of 17:45, 4 November 2022
Line 75:		Line 75:
	==For More==		==For More==
	* [[Bindings and User Settings]]		* [[Bindings and User Settings]]

			{{GUI}}

Geep: /* BindDef's Unique Property: "Bind" */

2022-10-14T16:05:57Z

BindDef's Unique Property: "Bind"

← Older revision		Revision as of 16:05, 14 October 2022
Line 13:		Line 13:
	The example below shows how bindDef works with certain [[GUI Scripting: Properties in Common \| Properties in common to all guiDefs]]. A bindDef’s overall functionality derives from C++ code and has little need for [[GUI Scripting: User Variables \| User Variables]] or [[GUI Scripting: Event Handlers \| Event Handlers]].		The example below shows how bindDef works with certain [[GUI Scripting: Properties in Common \| Properties in common to all guiDefs]]. A bindDef’s overall functionality derives from C++ code and has little need for [[GUI Scripting: User Variables \| User Variables]] or [[GUI Scripting: Event Handlers \| Event Handlers]].
	==BindDef's Unique Property: "Bind"==		==BindDef's Unique Property: "Bind"==
	® = 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. NOTE: TDM core never alters "bind" in this way.		® = 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. NOTE: TDM core never alters "bind" in this way.

	'''bind "''function''"''' ®		'''bind "''function''"''' ®

Geep at 13:20, 6 August 2022

2022-08-06T13:20:15Z

← Older revision		Revision as of 13:20, 6 August 2022
Line 1:		Line 1:
	''This page is part of a series. See [[GUI ~~Script~~ Language]] for overview.''		''This page is part of a series. See [[GUI Scripting Language]] for overview.''

	==Introduction==		==Introduction==

Geep: /* The GUI Code: Movement Page BindDefs */

2022-08-02T17:40:54Z

The GUI Code: Movement Page BindDefs

← Older revision		Revision as of 17:40, 2 August 2022
Line 71:		Line 71:
	}		}
	...		...
	To sum up, the underlying C++ code takes care of keystroke/mouse-button reception, mapping to a ~~functions~~ and display of key names in a human-friendly, language-specific way.		To sum up, the underlying C++ code takes care of keystroke/mouse-button reception, mapping to a function and display of key names in a human-friendly, language-specific way.

	==For More==		==For More==
	* [[Bindings and User Settings]]		* [[Bindings and User Settings]]

Geep: /* Settings/Controls/Movement */ Change title, add figure

2022-08-02T16:23:15Z

Settings/Controls/Movement: Change title, add figure

← Older revision		Revision as of 16:23, 2 August 2022
Line 22:		Line 22:

	==TDM’s Use of BindDef – A Representative Example==		==TDM’s Use of BindDef – A Representative Example==
	===Settings/Controls/~~Movements~~===		===Settings/Controls/Movement===
	''The English-language version is portrayed here, but menus are rendered in other TDM-supported languages.''		''The English-language version is portrayed here, but menus are rendered in other TDM-supported languages.''

	The figure shows a representative page (~~Movements~~) from TDM’s Settings/Controls main menu. On the right-hand side, a column of bindDefs (here individually annotated with a red border) is paired with a left-hand column of corresponding informative function titles in windowDefs.		The figure shows a representative page (Movement) from TDM’s Settings/Controls main menu. On the right-hand side, a column of bindDefs (here individually annotated with a red border) is paired with a left-hand column of corresponding informative function titles in windowDefs.

	[~~figure~~]		[[File:Settings controls movement red cropped.png\|500px]]

	To add a binding, the user hits LMB on a right-hand cell, which then reads "Press any key...". Hitting a key (or mouse button) adds that key to the list of those for that function. In the process, keyscan-code mapping is applied that takes into account the country-specific keyboard and the OS in use. The rectangle of the bindDef subsequently shows the logical (and language-specific) key names with " or " between them. Except pressing the Escape key will remove the bindings, showing "<empty>". Also, any older key binding elsewhere in the menu system that conflicts with a new one is automatically unbound.		To add a binding, the user hits LMB on a right-hand cell, which then reads "Press any key...". Hitting a key (or mouse button) adds that key to the list of those for that function. In the process, keyscan-code mapping is applied that takes into account the country-specific keyboard and the OS in use. The rectangle of the bindDef subsequently shows the logical (and language-specific) key names with " or " between them. Except pressing the Escape key will remove the bindings, showing "<empty>". Also, any older key binding elsewhere in the menu system that conflicts with a new one is automatically unbound.

Geep: REPLACE FIRST DRAFT ENTIRELY

2022-08-02T16:09:15Z

REPLACE FIRST DRAFT ENTIRELY

@@ 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 Script Language]] for overview.''
-A bindDef permits binding particular keys to particular functions. In TDM, it is used just In the Controls submenu of the main menu system.
+==Introduction==
 ==Features Shared with All GuiDef Types==
-* [[GUI Scripting: Properties in Common]]
+The example below shows how bindDef works with certain [[GUI Scripting: Properties in Common | Properties in common to all guiDefs]]. A bindDef’s overall functionality derives from C++ code and has little need for [[GUI Scripting: User Variables | User Variables]] or [[GUI Scripting: Event Handlers | Event Handlers]].
-* [[GUI Scripting: User Variables]]
+==BindDef's Unique Property: "Bind"==
-* [[GUI Scripting: Event Handlers]], excluding those specific to top-level windowDefs.
+® = 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. NOTE: TDM core never alters "bind" in this way.
-==Additional Properties of BindDefs==
+Finally, to prepare the figure, the red borders were created by temporarily appending this to #define SETTINGS_TEXT:
-® = 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.
+ ... bordercolor  1,0,0,1  bordersize 1
-====bind® "''key [ 'name_of_bound_item' ]'' "====
+===The GUI Code: Movement Page BindDefs===
-Sets the bind that will be changed when the player edits their key bindings. Default "" (i.e., unbound).
+All the Settings/Control pages are implemented with a single GUI file, mainmenu_settings_controls.gui. The GUI and engine code conspire to make only a single page visible at a time. For our Movement example, here are code snippets for the cursor’d row of the above figure:
- bind "_impulse10" // Heavily used in mainmenu_settings_controls.gui
+ ... ''Not shown: Enclosing desktop windowDef that provides the lined-parchment background.''
- bind "inventory_hotkey '#str_02397'" // "Compass”
+ windowDef SCMovementParent

Geep at 21:53, 22 July 2022

2022-07-22T21:53:29Z

← Older revision		Revision as of 21:53, 22 July 2022
Line 1:		Line 1:
	''This page is part of a series. See [[GUI ~~Script~~ Language]] for overview.''		''This page is part of a series. See [[GUI Scripting Language]] for overview.''

	A bindDef permits binding particular keys to particular functions. In TDM, it is used just In the Controls submenu of the main menu system.		A bindDef permits binding particular keys to particular functions. In TDM, it is used just In the Controls submenu of the main menu system.

Geep: create this article

2022-07-22T21:51:59Z

create this article

New page

''This page is part of a series. See [[GUI Script Language]] for overview.''

A bindDef permits binding particular keys to particular functions. In TDM, it is used just In the Controls submenu of the main menu system.

==Features Shared with All GuiDef Types==
* [[GUI Scripting: Properties in Common]]
* [[GUI Scripting: User Variables]]
* [[GUI Scripting: Event Handlers]], excluding those specific to top-level windowDefs.

==Additional Properties of BindDefs==
® = 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.

====bind® "''key [ 'name_of_bound_item' ]'' "====
Sets the bind that will be changed when the player edits their key bindings. Default "" (i.e., unbound).
bind "_impulse10" // Heavily used in mainmenu_settings_controls.gui
bind "inventory_hotkey '#str_02397'" // "Compass”