DgsSetParent: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
Line 17: Line 17:


==Example==  
==Example==  
<section name="Server" class="server" show="true">
<section name="Client" class="client" show="true">
This example sets the parent of each spawnpoint to a dummy element:
This example sets the parent of each spawnpoint to a dummy element:
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">

Revision as of 09:18, 27 June 2017

This function is used for setting a DGS element as the parent of another DGS element.

[[{{{image}}}|link=|]] Note: This function does not change when an element will be destroyed - DGS elements are always destroyed when the resource that created them is stopped.
[[{{{image}}}|link=|]] Note: dgsSetParent only works to DGS elements.

Syntax

bool dgsSetParent( element theElement, element parent )  

Required Arguments

  • theElement: The dgs element that you wish to set the parent of.
  • parent: The dgs element you wish to be the parent of theElement.

Returns

Returns true if both elements are valid, false otherwise.

Example

Click to collapse [-]
Client

This example sets the parent of each spawnpoint to a dummy element:

dummyElem = createElement ( "spawngroup", "Group of spawn points" ) -- create a dummy element
local spawnpoints = getElementsByType ( "spawnpoint" ) -- get a table of spawn point elements
for k,v in ipairs (spawnpoints) do -- loop through the table of spawn points
   setElementParent ( v, dummyElem ) -- set the dummy element as the parent of the spawn point
end
-- all of the spawn points are now children of 'dummyElem'

See Also