DgsSetLayer: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Created page with "__NOTOC__ {{Client function}} This function allow us to set a dgs element always at bottom. ==Syntax== <syntaxhighlight lang="lua"> bool dgsSetLayer( element dgsElement, st...")
 
m (DGS OOP Syntax changing)
 
(6 intermediate revisions by 2 users not shown)
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
{{Client function}}
{{Client function}}
This function allow us to set a dgs element always at bottom.
This function allow us to set the render layer of a dgs element.
 
This function only have effect on a non-parent dgs element unless the '''forceDetatch''' is enabled.


==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool dgsSetLayer( element dgsElement, string layer )
bool dgsSetLayer( element dgsElement, string layer [, bool forceDetatch = false ] )
</syntaxhighlight>
</syntaxhighlight>
{{DGS/OOP|
    Method = DGSElement:setLayer|
    Variable = alwaysOn|
    Counterpart = dgsGetLayer
}}


[[Image:DGSRenderLayer.png|300px|thumb|DGSRenderLayer]]
[[Image:DGSRenderLayer.png|300px|thumb|DGSRenderLayer]]
Line 13: Line 20:
*'''layer:''' The layer that the DGS element will be.
*'''layer:''' The layer that the DGS element will be.
**'''top'''
**'''top'''
**'''center'''
**'''bottom'''
===Optional Arguments===
*'''forceDetatch:''' If the target DGS element is a child element of other DGS element, you can set forceDetatch to '''true''' to detatch the target DGS element from its parent, or this function will return '''false'''.


===Returns===
===Returns===
Line 23: Line 35:
window1 = DGS:dgsCreateWindow(400,100,200,200,"DGS Window 1",false) --Create window1
window1 = DGS:dgsCreateWindow(400,100,200,200,"DGS Window 1",false) --Create window1
window2 = DGS:dgsCreateWindow(400,100,200,200,"DGS Window 2",false) --Create window2
window2 = DGS:dgsCreateWindow(400,100,200,200,"DGS Window 2",false) --Create window2
dgsSetBottom (window1) --Now it is always at bottom
DGS:dgsSetLayer (window1,"top") --Now it is always on top
</syntaxhighlight>
</syntaxhighlight>


==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 19:05, 3 May 2021

This function allow us to set the render layer of a dgs element.

This function only have effect on a non-parent dgs element unless the forceDetatch is enabled.

Syntax

bool dgsSetLayer( element dgsElement, string layer [, bool forceDetatch = false ] )

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

Method: DGSElement:setLayer(...)
Variable: .alwaysOn
Counterpart: dgsGetLayer
DGSRenderLayer

Required Arguments

  • dgsElement: The DGS element to set.
  • layer: The layer that the DGS element will be.
    • top
    • center
    • bottom

Optional Arguments

  • forceDetatch: If the target DGS element is a child element of other DGS element, you can set forceDetatch to true to detatch the target DGS element from its parent, or this function will return false.

Returns

Returns true if succeed, false otherwise.

Example

DGS = exports.dgs

window1 = DGS:dgsCreateWindow(400,100,200,200,"DGS Window 1",false)	--Create window1
window2 = DGS:dgsCreateWindow(400,100,200,200,"DGS Window 2",false)	--Create window2
DGS:dgsSetLayer (window1,"top") --Now it is always on top

See Also

General Functions

General Events

Retrieved from "https://wiki.multitheftauto.com/wiki/DgsSetLayer?oldid=70984"