GetResourceGUIElement: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(New page: This function doesn't exist, but will do at some point in the future :))
 
mNo edit summary
 
(9 intermediate revisions by 5 users not shown)
Line 1: Line 1:
This function doesn't exist, but will do at some point in the future :)
__NOTOC__
{{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. 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==
<syntaxhighlight lang="lua">element getResourceGUIElement ( [ resource theResource = getThisResource( ) ] )</syntaxhighlight>
 
===Optional Arguments===
{{OptionalArg}}
*'''theResource:''' the resource whose GUI element we are getting. If not specified, assumes the current resource.
 
===Returns===
Returns the root GUI element that contains all the other GUI elements.
 
==Example==
This example provides a function for destroying all the GUI elements of a resource.
<syntaxhighlight lang="lua">function destroyAllGUIs()
-- Destroy all of the gui-root's children
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).
destroyElement(guiElement)
end
end
end
</syntaxhighlight>
 
==See Also==
{{Client_resource_functions}}

Latest revision as of 21:12, 7 August 2018

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

element getResourceGUIElement ( [ resource theResource = getThisResource( ) ] )

Optional Arguments

NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use. For more information on optional arguments, see optional arguments.

  • theResource: the resource whose GUI element we are getting. If not specified, assumes the current resource.

Returns

Returns the root GUI element that contains all the other GUI elements.

Example

This example provides a function for destroying all the GUI elements of a resource. 

function destroyAllGUIs()
	-- Destroy all of the gui-root's children
	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).
			destroyElement(guiElement)
		end
	end
end

See Also



Retrieved from "https://wiki.multitheftauto.com/wiki/GetResourceGUIElement?oldid=57559"