DgsGetParent: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
(DGS OOP Syntax changing)
 
(6 intermediate revisions by 2 users not shown)
Line 2: Line 2:
__NOTOC__
__NOTOC__
This function is used to determine the parent of a DGS ''element''.
This function is used to determine the parent of a DGS ''element''.
{{Note|dgsSetParent only works with DGS elements.}}
{{Note|dgsGetParent only works with DGS elements.}}
==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
element dgsGetParent( element theElement )   
element dgsGetParent( element theElement )   
</syntaxhighlight>  
</syntaxhighlight>
{{DGS/OOP|
    Method = DGSElement:getParent|
    Variable = parent|
    Counterpart = dgsSetParent
}}


===Required Arguments===  
===Required Arguments===  
Line 15: Line 20:


==Example==
==Example==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
DGS = exports.dgs
DGS = exports.dgs
local window = DGS:dgsDxCreateWindow(500, 500, 300, 300, "test window", false) -- create a window
local window = DGS:dgsCreateWindow(500, 500, 300, 300, "test window", false) -- create a window
local child = DGS:dgsDxCreateLabel(0, 0, 300, 20, "test label", false, window) -- create a label on the window
local child = DGS:dgsCreateLabel(0, 0, 300, 20, "test label", false, window) -- create a label on the window
local parent = DGS:dgsGetParent(child) -- get the parent of the label
local parent = DGS:dgsGetParent( child ) -- get the parent of the label
outputChatBox(DGS:dgsGetType(parent)) -- output the type of the parent ( dgs-dxwindow )
outputChatBox( DGS:dgsGetType( parent ) ) -- output the type of the parent ( dgs-dxwindow )
</syntaxhighlight>
</syntaxhighlight>
</section>


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

Latest revision as of 18:59, 3 May 2021

This function is used to determine the parent of a DGS element.

[[{{{image}}}|link=|]] Note: dgsGetParent only works with DGS elements.

Syntax

element dgsGetParent( element theElement )  

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

Method: DGSElement:getParent(...)
Variable: .parent
Counterpart: dgsSetParent

Required Arguments

  • theElement: The child of the parent element you want returned.

Returns

This returns the parent as a DGS element. It returns false if theElement is invalid, or false (You can think of it as the screen or root).

Example

DGS = exports.dgs
local window = DGS:dgsCreateWindow(500, 500, 300, 300, "test window", false) -- create a window
local child = DGS:dgsCreateLabel(0, 0, 300, 20, "test label", false, window) -- create a label on the window
local parent = DGS:dgsGetParent( child ) -- get the parent of the label
outputChatBox( DGS:dgsGetType( parent ) ) -- output the type of the parent ( dgs-dxwindow )

See Also

General Functions

General Events