DgsSetParent: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
m (DGS (OOP Syntax)/(Template Organization) Mission)
 
(13 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Server client function}}
{{Client function}}
__NOTOC__  
__NOTOC__  
This function is used for setting a DGS element as the parent of another DGS element.
This function is used for setting a DGS element as the parent of another DGS element.
{{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.}}
{{Note|DGS elements are always destroyed when the resource that created them is stopped.}}
{{Note|dgsSetParent only works to DGS elements.}}
{{Note|dgsSetParent only works with DGS elements.}}
==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool dgsSetParent( element theElement, element parent )   
bool dgsSetParent( element theElement, element parent )   
</syntaxhighlight>  
</syntaxhighlight>
{{DGS/OOP||DGSElement:setParent||parent|dgsGetParent||}}


===Required Arguments===  
===Required Arguments===  
*'''theElement:''' The element that you wish to set the parent of.
*'''theElement:''' The dgs element that you wish to set the parent of.
*'''parent:''' The element you wish to be the parent of ''theElement''.
*'''parent:''' The dgs element you wish to be the parent of ''theElement''.


===Returns===
===Returns===
Line 17: Line 18:


==Example==  
==Example==  
<section name="Server" class="server" show="true">
This example sets the parent of each spawnpoint to a dummy element:
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
dummyElem = createElement ( "spawngroup", "Group of spawn points" ) -- create a dummy element
DGS = exports.dgs
local spawnpoints = getElementsByType ( "spawnpoint" ) -- get a table of spawn point elements
parent = DGS:dgsCreateWindow( 500, 500, 300, 300, "test window", false ) -- create a window
for k,v in ipairs (spawnpoints) do -- loop through the table of spawn points
label = DGS:dgsCreateLabel( 0, 0, 300, 20, "test label", false ) -- create a label that its parent is the screen
  setElementParent ( v, dummyElem ) -- set the dummy element as the parent of the spawn point
DGS:dgsSetParent(label, parent) -- set the window as the parent of the label
end
-- all of the spawn points are now children of 'dummyElem'
</syntaxhighlight>
</syntaxhighlight>


This is the equivalent of:
==See Also==
<syntaxhighlight lang="xml">
 
<spawngroup id="Group of spawn points">
===<span style="color:#eb3f00;text-shadow:0.05em 0.05em 0.2em #00000099;">General Functions</span>===
  <spawnpoint id="spawnpoint_0" posX="2507.8715820313" posY="2772.6071777344" posZ="10.8203125" rot="270" skin="285"/>
{{DGS General Functions}}
  <spawnpoint id="spawnpoint_1" posX="2508.060546875" posY="2780.3647460938" posZ="10.8203125" rot="270" skin="285"/>
  <spawnpoint id="spawnpoint_2" posX="2508.0053710938" posY="2776.2897949219" posZ="10.8203125" rot="270" skin="285"/>
  <spawnpoint id="spawnpoint_3" posX="2510.6899414063" posY="2778.3745117188" posZ="10.8203125" rot="270" skin="285"/>
</spawngroup></syntaxhighlight>
</section>


==See Also==
===<span style="color:#eb3f00;text-shadow:0.05em 0.05em 0.2em #00000099;">General Events</span>===
{{element functions}}
{{DGS Events/General}}

Latest revision as of 18:39, 16 April 2021

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

[[{{{image}}}|link=|]] Note: DGS elements are always destroyed when the resource that created them is stopped.
[[{{{image}}}|link=|]] Note: dgsSetParent only works with DGS elements.

Syntax

bool dgsSetParent( element theElement, element parent )

DGS OOP Syntax Help! I don't understand this!

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

DGS = exports.dgs
parent = DGS:dgsCreateWindow( 500, 500, 300, 300, "test window", false ) -- create a window
label = DGS:dgsCreateLabel( 0, 0, 300, 20, "test label", false ) -- create a label that its parent is the screen
DGS:dgsSetParent(label, parent) -- set the window as the parent of the label

See Also

General Functions

General Events

Retrieved from "https://wiki.multitheftauto.com/wiki/DgsSetParent?oldid=70706"