GUI Overlays - Revision history

Datiswous at 17:21, 4 November 2022

2022-11-04T17:21:46Z

← Older revision		Revision as of 17:21, 4 November 2022
Line 37:		Line 37:

	{{GUI}}		{{GUI}}
	~~[[Category:Scripting]]~~		{{scripting}}

Geep: Change category tag to {{GUI}}, that includes Editing

2022-11-04T16:28:29Z

Change category tag to {{GUI}}, that includes Editing

← Older revision		Revision as of 16:28, 4 November 2022
Line 36:		Line 36:
	* [[GUI Scripting Language]]		* [[GUI Scripting Language]]

	~~[[Category:Editing]]~~		{{GUI}}
	[[Category:Scripting]]		[[Category:Scripting]]

Geep: Add "See Also" link to GUI Scripting Language

2022-11-02T20:39:07Z

Add "See Also" link to GUI Scripting Language

← Older revision		Revision as of 20:39, 2 November 2022
Line 32:		Line 32:

	The player can interact with overlays created from interactive GUIs. While an interactive overlay exists, the player will be given a cursor which they can use to click on buttons and such, but their view will not be locked - it is up to the script to do that if so desired. If more than one interactive overlay exists, the player will only interact with the one that is drawn last.		The player can interact with overlays created from interactive GUIs. While an interactive overlay exists, the player will be given a cursor which they can use to click on buttons and such, but their view will not be locked - it is up to the script to do that if so desired. If more than one interactive overlay exists, the player will only interact with the one that is drawn last.

			== See Also ==
			* [[GUI Scripting Language]]

	[[Category:Editing]]		[[Category:Editing]]
	[[Category:Scripting]]		[[Category:Scripting]]

Grayman at 01:46, 8 November 2013

2013-11-08T01:46:11Z

← Older revision		Revision as of 01:46, 8 November 2013
Line 1:		Line 1:
	GUI overlays are a way to draw GUIs over the player's screen. They're used for things such as the HUD, readables and inventory display. They could also be used for things like fading out the player's vision, adding an in-game shop GUI, popping up hints, asking the player if they really want to leave the level, obscuring their vision with a clunky helmet, adding new elements to the HUD without modifying it, etc.		GUI overlays are a way to draw GUIs over the player's screen. They're used for things such as the HUD, readables and inventory display. They could also be used for things like fading out the player's vision, adding an in-game shop GUI, popping up hints, asking the player if they really want to leave the level, obscuring their vision with a clunky helmet, adding new elements to the HUD without modifying it, etc.

	'''~~darkmod_events~~.script''' contains documentation about the various script functions used to manipulate GUI overlays, but it might not be helpful unless some basic concepts about GUI overlays are understood. This page aims to explain those concepts. It assumes knowledge of GUIs.		'''tdm_events.script''' contains documentation about the various script functions used to manipulate GUI overlays, but it might not be helpful unless some basic concepts about GUI overlays are understood. This page aims to explain those concepts. It assumes knowledge of GUIs.

	== Creating and destroying your first GUI overlay ==		== Creating and destroying your first GUI overlay ==

Greebo: categorised

2007-06-21T10:08:46Z

categorised

← Older revision		Revision as of 10:08, 21 June 2007
Line 32:		Line 32:

	The player can interact with overlays created from interactive GUIs. While an interactive overlay exists, the player will be given a cursor which they can use to click on buttons and such, but their view will not be locked - it is up to the script to do that if so desired. If more than one interactive overlay exists, the player will only interact with the one that is drawn last.		The player can interact with overlays created from interactive GUIs. While an interactive overlay exists, the player will be given a cursor which they can use to click on buttons and such, but their view will not be locked - it is up to the script to do that if so desired. If more than one interactive overlay exists, the player will only interact with the one that is drawn last.

			[[Category:Editing]]
			[[Category:Scripting]]

Gildoran at 09:17, 23 January 2007

2007-01-23T09:17:58Z

← Older revision		Revision as of 09:17, 23 January 2007
Line 28:		Line 28:

	$book.setGuiFloat( GUI_ENTITY2, "page", 1 );		$book.setGuiFloat( GUI_ENTITY2, "page", 1 );

			== Interactive Overlays ==

			The player can interact with overlays created from interactive GUIs. While an interactive overlay exists, the player will be given a cursor which they can use to click on buttons and such, but their view will not be locked - it is up to the script to do that if so desired. If more than one interactive overlay exists, the player will only interact with the one that is drawn last.

Gildoran at 09:12, 23 January 2007

2007-01-23T09:12:29Z

← Older revision		Revision as of 09:12, 23 January 2007
Line 1:		Line 1:
	GUI overlays are a way to draw GUIs over the player's screen. They're used for things such as the HUD, readables and inventory display. They could also be used for things like fading out the player's vision, adding an in-game shop GUI, popping up hints, asking the player if they really want to leave the level, etc.		GUI overlays are a way to draw GUIs over the player's screen. They're used for things such as the HUD, readables and inventory display. They could also be used for things like fading out the player's vision, adding an in-game shop GUI, popping up hints, asking the player if they really want to leave the level, obscuring their vision with a clunky helmet, adding new elements to the HUD without modifying it, etc.

	'''darkmod_events.script''' contains documentation about the various script functions used to manipulate GUI overlays, but it might not be helpful unless some basic concepts about GUI overlays are understood. This page aims to explain those concepts.		'''darkmod_events.script''' contains documentation about the various script functions used to manipulate GUI overlays, but it might not be helpful unless some basic concepts about GUI overlays are understood. This page aims to explain those concepts. It assumes knowledge of GUIs.

	== Creating and destroying your first GUI overlay ==		== Creating and destroying your first GUI overlay ==
Line 18:		Line 18:

	If for some reason '''createOverlay()''' fails, it'll return '''GUI_INVALID'''.		If for some reason '''createOverlay()''' fails, it'll return '''GUI_INVALID'''.

			== Working with the HUD and entity GUIs ==

			To access the HUD, use the '''GUI_HUD''' handle. For example, to call the "''foobar''" event in the HUD, you would do:

			$player1.callGui( GUI_HUD, "foobar" );

			Similarly, you can interact with entity GUIs via '''GUI_ENTITY1''', '''GUI_ENTITY2''' and '''GUI_ENTITY3'''. To set a GUI parameter for the second GUI on a book, you might do:

			$book.setGuiFloat( GUI_ENTITY2, "page", 1 );

Gildoran at 09:04, 23 January 2007

2007-01-23T09:04:15Z

New page

GUI overlays are a way to draw GUIs over the player's screen. They're used for things such as the HUD, readables and inventory display. They could also be used for things like fading out the player's vision, adding an in-game shop GUI, popping up hints, asking the player if they really want to leave the level, etc.

'''darkmod_events.script''' contains documentation about the various script functions used to manipulate GUI overlays, but it might not be helpful unless some basic concepts about GUI overlays are understood. This page aims to explain those concepts.

== Creating and destroying your first GUI overlay ==

Let's say you want to draw "''guis/mygui.gui''" over the player's screen. To do that, you call '''createOverlay()''' on the player. For example:

$player1.createOverlay( "guis/mygui.gui", 100 );

The second argument (100) is the layer of the overlay. Overlays are drawn in ascending order by layer; overlays in higher layers are drawn on top of overlays in lower layers. The order in which overlays in the same layer are drawn is undefined. The HUD is in layer 0, so in order to ensure that the GUI is drawn over the HUD, we've put it in layer 100.

So how do you delete the overlay you just created? You need to make use of [http://en.wikipedia.org/wiki/Smart_pointer#Handles handles]. The '''createOverlay()''' function returns a handle that can be used to access the overlay. This handle can then be passed to the '''destroyOverlay()''' function. For example, this will flash the GUI on screen for 5 seconds:

float overlayHandle = $player1.createOverlay( "guis/mygui.gui", 100 );
sys.wait(5);
$player1.destroyOverlay( overlayHandle );

If for some reason '''createOverlay()''' fails, it'll return '''GUI_INVALID'''.