GetResourceGUIElement - Revision history

Myonlake at 21:12, 7 August 2018

2018-08-07T21:12:49Z

← Older revision		Revision as of 21:12, 7 August 2018
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Client function}}		{{Client function}}
	This function retrieves a resource's GUI element. The resource's GUI element is the element in the element tree which is the default parent of all GUI elements that belong to a particular resource. ~~This~~ has ~~the tag~~ '~~guiroot~~', and each resource has one of these. You can attach event handlers to this element to easily capture events that originate from your resource (and global events that originate from the root element).		This function retrieves a resource's GUI element. The resource's GUI element is the element in the element tree which is the default parent of all GUI elements that belong to a particular resource. It has a predefined variable called '''guiRoot''', and each resource has one of these. You can attach event handlers to this element to easily capture events that originate from your resource (and global events that originate from the root element).

	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">element getResourceGUIElement ( [resource theResource=getThisResource()] )</syntaxhighlight>		<syntaxhighlight lang="lua">element getResourceGUIElement ( [ resource theResource = getThisResource( ) ] )</syntaxhighlight>

	===Optional Arguments===		===Optional Arguments===

John at 20:50, 30 April 2012

2012-04-30T20:50:39Z

← Older revision		Revision as of 20:50, 30 April 2012
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Client function}}		{{Client function}}
	This function retrieves a resource's GUI element. The resource's GUI element is the element in the element tree which is the default parent of all GUI elements that belong to a particular resource. This has the tag 'guiroot', and each resource has one of these.~~<!--~~ You can attach event handlers to this element to easily capture events that originate from your resource (and global events that originate from the root element). ~~---- Confirm please? ---- -->~~		This function retrieves a resource's GUI element. The resource's GUI element is the element in the element tree which is the default parent of all GUI elements that belong to a particular resource. This has the tag 'guiroot', and each resource has one of these. You can attach event handlers to this element to easily capture events that originate from your resource (and global events that originate from the root element).

	==Syntax==		==Syntax==
Line 8:		Line 8:
	===Optional Arguments===		===Optional Arguments===
	{{OptionalArg}}		{{OptionalArg}}
	*'''theResource:''' the resource whose GUI element we are getting. If not specified, assumes the current resource. ~~(the resource returned from [[getThisResource]])~~		*'''theResource:''' the resource whose GUI element we are getting. If not specified, assumes the current resource.

	===Returns===		===Returns===

John: Added a proper example

2012-04-30T20:49:18Z

Added a proper example

← Older revision		Revision as of 20:49, 30 April 2012
Line 14:		Line 14:

	==Example==		==Example==
	This example ~~creates~~ a ~~window and~~ a ~~button with the cursor showing~~. ~~If the player clicks on myButton then the window would be destroyed and the cursor would not show. (Not sure if this function works)~~		This example provides a function for destroying all the GUI elements of a resource.
	<syntaxhighlight lang="lua">~~myWindow = guiCreateWindow~~ ( ~~0, 0, 0.7, 0.5, "Information", true~~ )		<syntaxhighlight lang="lua">function destroyAllGUIs()
	~~myButton = guiCreateButton ( 0.7, 0.1~~, ~~0.2, 0.1, "Output!", true, myWindow )~~		-- Destroy all of the gui-root's children
	~~showCursor~~(~~true)~~		for _, guiElement in ipairs(getElementChildren(getResourceGUIElement())) do
			if isElement(guiElement) then -- This checks that the element still exists (in case we already destroyed it's parent).
	~~addEventHandler~~(~~"onClientGUIClick",~~getResourceGUIElement()~~,function(~~)		destroyElement(guiElement)
	if(~~source == myButton~~)then		end
	destroyElement(~~myWindow~~)
	~~showCursor(false)~~
	end		end
	end~~,false)~~		end
	</syntaxhighlight>		</syntaxhighlight>

	==See Also==		==See Also==
	{{Client_resource_functions}}		{{Client_resource_functions}}

Jaysds at 18:53, 28 April 2012

2012-04-28T18:53:41Z

← Older revision		Revision as of 18:53, 28 April 2012
Line 29:		Line 29:
	==See Also==		==See Also==
	{{Client_resource_functions}}		{{Client_resource_functions}}
	~~[[Category:Needs Example]]~~

Jaysds at 18:53, 28 April 2012

2012-04-28T18:53:26Z

← Older revision		Revision as of 18:53, 28 April 2012
Line 14:		Line 14:

	==Example==		==Example==
	<~~section name~~="~~Client~~" ~~class~~="~~client~~" ~~show~~="true">		This example creates a window and a button with the cursor showing. If the player clicks on myButton then the window would be destroyed and the cursor would not show. (Not sure if this function works)
	~~<syntaxhighlight lang~~=~~"lua">~~		<syntaxhighlight lang="lua">myWindow = guiCreateWindow ( 0, 0, 0.7, 0.5, "Information", true )
	~~-- Add example~~		myButton = guiCreateButton ( 0.7, 0.1, 0.2, 0.1, "Output!", true, myWindow )
			showCursor(true)

			addEventHandler("onClientGUIClick",getResourceGUIElement(),function()
			if(source == myButton)then
			destroyElement(myWindow)
			showCursor(false)
			end
			end,false)
	</syntaxhighlight>		</syntaxhighlight>
	~~</section>~~

	==See Also==		==See Also==
	{{Client_resource_functions}}		{{Client_resource_functions}}
	[[Category:Needs Example]]		[[Category:Needs Example]]

EAi at 15:19, 9 August 2009

2009-08-09T15:19:02Z

← Older revision		Revision as of 15:19, 9 August 2009
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Client function}}		{{Client function}}
	This function retrieves a resource's GUI element. The resource's GUI element is the element in the element tree which is the parent of all GUI elements that belong to a particular resource. This has the tag 'guiroot', and each resource has one of these.<!-- You can attach event handlers to this element to easily capture events that originate from your resource (and global events that originate from the root element). ---- Confirm please? ---- -->		This function retrieves a resource's GUI element. The resource's GUI element is the element in the element tree which is the default parent of all GUI elements that belong to a particular resource. This has the tag 'guiroot', and each resource has one of these.<!-- You can attach event handlers to this element to easily capture events that originate from your resource (and global events that originate from the root element). ---- Confirm please? ---- -->

	==Syntax==		==Syntax==

Awwu at 13:57, 9 August 2009

2009-08-09T13:57:33Z

← Older revision		Revision as of 13:57, 9 August 2009
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Client function}}		{{Client function}}
			This function retrieves a resource's GUI element. The resource's GUI element is the element in the element tree which is the parent of all GUI elements that belong to a particular resource. This has the tag 'guiroot', and each resource has one of these.<!-- You can attach event handlers to this element to easily capture events that originate from your resource (and global events that originate from the root element). ---- Confirm please? ---- -->

	~~This function gets the~~ resource ~~GUI element.~~		==Syntax==
			<syntaxhighlight lang="lua">element getResourceGUIElement ( [resource theResource=getThisResource()] )</syntaxhighlight>

	==~~Syntax~~==		===Optional Arguments===
	~~<syntaxhighlight lang="lua">~~element ~~getResourceGUIElement~~()~~</syntaxhighlight>~~		{{OptionalArg}}
			*'''theResource:''' the resource whose GUI element we are getting. If not specified, assumes the current resource. (the resource returned from [[getThisResource]])

	===Returns===		===Returns===
	Returns the root GUI element that contains all the other GUI elements~~. This has the tag 'guiroot', and each resource has one of these~~.		Returns the root GUI element that contains all the other GUI elements.

	==Example==		==Example==

Sebassje at 12:31, 13 June 2009

2009-06-13T12:31:12Z

@@ Line 1: / Line 1: @@
-Returns the root GUI element that contains all the other GUI elements. This has the tag 'guiroot', and each resource has one of these.
+__NOTOC__
 ==Syntax==
 <syntaxhighlight lang="lua">element getResourceGUIElement()</syntaxhighlight>
-[[Category:Incomplete]] [[Category:Needs Example]]
+===Returns===

EAi at 02:21, 6 April 2008

2008-04-06T02:21:48Z

← Older revision		Revision as of 02:21, 6 April 2008
Line 3:		Line 3:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">element getResourceGUIElement()</syntaxhighlight>		<syntaxhighlight lang="lua">element getResourceGUIElement()</syntaxhighlight>

			[[Category:Incomplete]] [[Category:Needs Example]]

EAi at 02:21, 6 April 2008

2008-04-06T02:21:25Z

← Older revision		Revision as of 02:21, 6 April 2008
Line 1:		Line 1:
	This ~~function doesn~~'~~t exist~~, ~~but will do at some point in the future :~~)		Returns the root GUI element that contains all the other GUI elements. This has the tag 'guiroot', and each resource has one of these.

			==Syntax==
			<syntaxhighlight lang="lua">element getResourceGUIElement()</syntaxhighlight>