GUI Scripting: Event Handlers - Revision history

Geep: Add category tag

2022-11-04T16:20:19Z

Add category tag

← Older revision		Revision as of 16:20, 4 November 2022
Line 44:		Line 44:
	These “leftover” commands are parsed in “Windows.cpp”, but used in neither core GUIs or those of a sample of FMs. So functionality or applicability is suspect.		These “leftover” commands are parsed in “Windows.cpp”, but used in neither core GUIs or those of a sample of FMs. So functionality or applicability is suspect.
	* onDeactivate, onTrigger, onEnterRelease		* onDeactivate, onTrigger, onEnterRelease

			{{GUI}}

Geep: /* onNamedEvent event */

2022-07-20T02:32:46Z

onNamedEvent event

← Older revision		Revision as of 02:32, 20 July 2022
Line 13:		Line 13:
	Fires when ''time'' in milliseconds is reached, for the specific guiDef’s timer.		Fires when ''time'' in milliseconds is reached, for the specific guiDef’s timer.
	===onNamedEvent ''event''===		===onNamedEvent ''event''===
	Catches a custom event, generated by your entity’s script function (e.g., in a script object). Or catches an engine-generated event. Example: The 'overwrite save game' windowDef is implemented with a named event. For more, see [[GUI Scripting: Named Events]].		Catches a custom event, generated by your entity’s script function (e.g., in a script object). Or catches an engine-generated event. Example: The 'overwrite save game' windowDef is implemented with a named event. For more, see [[GUI Scripting: Named Events]]. This should appear only in a top-level guiDef.

	===onAction===		===onAction===

Geep: /* onActivate */

2022-07-20T02:25:56Z

onActivate

← Older revision		Revision as of 02:25, 20 July 2022
Line 26:		Line 26:
	Responds to an Escape keypress. In mainmenu_utils.gui, this does general escape key handling during briefing (text or video), debriefing, main menus, and in-game menus.		Responds to an Escape keypress. In mainmenu_utils.gui, this does general escape key handling during briefing (text or video), debriefing, main menus, and in-game menus.
	===onActivate===		===onActivate===
	Runs once when gui first activated. ~~Deployed~~ in ~~restart~~.gui~~, which is shown~~ when the ~~player dies or~~ the ~~mission fails~~, ~~to fade the “fail skull”~~.		Runs once when gui first activated. This is a global command, meaning it should be put exclusively inside the main desktop window, says HMart in Ref 10 of [[GUI Scripting: References & Resources]].

			In TDM, it appears only once, in windowDef MainMenuStartUp of mainmenu_utils.gui. This windowDef gets executed exactly once when the main menu is displayed for the first time. onActivate is used to reliably trigger initialization instead of onTime 0. This avoids a problem, indicates stgatilov: onTime 0 events can trigger before activation on engine restart, with all GUI cmds suppressed.

	===onEvent===		===onEvent===
	Runs every frame. In mainmenu_settings_guisize.gui, associated with a sliderDef to change objectives text size, In tdm_hud.gui, used to catch player crouching and adjust light gem height.		Runs every frame. In mainmenu_settings_guisize.gui, associated with a sliderDef to change objectives text size, In tdm_hud.gui, used to catch player crouching and adjust light gem height.

Geep: /* General Purpose & Syntax */

2022-07-18T20:15:29Z

General Purpose & Syntax

← Older revision		Revision as of 20:15, 18 July 2022
Line 7:		Line 7:
	}		}

	For the body contents, see [[GUI Scripting: Commands]] and [[GUI Scripting: If~~-Clauses~~]].		For the body contents, see [[GUI Scripting: Commands]] and [[GUI Scripting: If Statements]].

	==Used Widely in TDM==		==Used Widely in TDM==

Geep: /* onNamedEvent event */

2022-07-16T21:11:09Z

onNamedEvent event

← Older revision		Revision as of 21:11, 16 July 2022
Line 13:		Line 13:
	Fires when ''time'' in milliseconds is reached, for the specific guiDef’s timer.		Fires when ''time'' in milliseconds is reached, for the specific guiDef’s timer.
	===onNamedEvent ''event''===		===onNamedEvent ''event''===
	Catches a custom event, generated by your entity’s script function (e.g., in a script object). Or catches an engine-generated event. Example: The 'overwrite save game' windowDef is implemented with a named event.		Catches a custom event, generated by your entity’s script function (e.g., in a script object). Or catches an engine-generated event. Example: The 'overwrite save game' windowDef is implemented with a named event. For more, see [[GUI Scripting: Named Events]].

	===onAction===		===onAction===
	Generally responses to a click of the mouse "Action" button (LMB by default). Also fires upon editDef text changes, or choiceDef pick changes.		Generally responses to a click of the mouse "Action" button (LMB by default). Also fires upon editDef text changes, or choiceDef pick changes.

Geep: Geep moved page GUi Scripting: Event Handlers to GUI Scripting: Event Handlers: capitalization error

2022-07-14T20:26:42Z

Geep moved page GUi Scripting: Event Handlers to GUI Scripting: Event Handlers: capitalization error

← Older revision	Revision as of 20:26, 14 July 2022
(No difference)

Geep: create this article

2022-07-14T20:23:17Z

create this article

New page

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

==General Purpose & Syntax==
Event Handlers are located within a windowDef (or any guiDef), at the end, after properties, user variables, and embedded child guiDefs. Each one fires when its condition is met, then processes its body (that is, contained commands and if-clauses) in the usual function-body order. Syntax (where [ ] = optional ):
''eventHandler'' [''eventHandlerParam''] {
...
}

For the body contents, see [[GUI Scripting: Commands]] and [[GUI Scripting: If-Clauses]].

==Used Widely in TDM==
===onTime ''time''===
Fires when ''time'' in milliseconds is reached, for the specific guiDef’s timer.
===onNamedEvent ''event''===
Catches a custom event, generated by your entity’s script function (e.g., in a script object). Or catches an engine-generated event. Example: The 'overwrite save game' windowDef is implemented with a named event.
===onAction===
Generally responses to a click of the mouse "Action" button (LMB by default). Also fires upon editDef text changes, or choiceDef pick changes.
===onMouseEnter & onMouseExit===
Fires respectively, upon mouse cursor entry to & exit from the guiDef’s rectangle. (May be sluggish.)

==Used Sparingly==
===onActionRelease===
Runs when the action is finished, e.g., 'left mouse button up'. Used in mainmen_loadsave.gui as part of process of loading a mission.
===onEsc===
Responds to an Escape keypress. In mainmenu_utils.gui, this does general escape key handling during briefing (text or video), debriefing, main menus, and in-game menus.
===onActivate===
Runs once when gui first activated. Deployed in restart.gui, which is shown when the player dies or the mission fails, to fade the “fail skull”.
===onEvent===
Runs every frame. In mainmenu_settings_guisize.gui, associated with a sliderDef to change objectives text size, In tdm_hud.gui, used to catch player crouching and adjust light gem height.
===onEnter===
Fires if the user:
* presses Enter/Return key (e.g., in an editDef)
* double-clicks in a listDef

For example, in loadsave.gui, onEnter responds to:
* the Return key, after entering the name of the save file.
* double-clicking on the name of a previously-saved game file to load.

==Evidently Unused==
These “leftover” commands are parsed in “Windows.cpp”, but used in neither core GUIs or those of a sample of FMs. So functionality or applicability is suspect.
* onDeactivate, onTrigger, onEnterRelease