getResourceGUIElement | Multi Theft Auto: Wiki Skip to content
Multi Theft Auto: Wiki

getResourceGUIElement

Client-side
Server-side
Shared

Manual Review Required

Please finish this page using the corresponding Old Wiki article. Go to Contribution guidelines for more information.

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.

  • resource theResource (default: getThisResource(): MISSING_PARAM_DESC

Returns

  • element: value

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

Code Examples

shared

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

Resource Functions
Resource Events
Resource Elements
Reference