DgsAttachElements: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
(DGS (OOP Syntax)/(Template Organization) Mission)
 
(5 intermediate revisions by one other user not shown)
Line 5: Line 5:
==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool dgsAttachElements( element dgsElement, element attachTo, int/float offsetX, int/float offsetY, int/float offsetW, int/float offsetH [, bool relativePos = false, bool relativeSize = false )
bool dgsAttachElements( element dgsElement, element attachTo, int/float offsetX, int/float offsetY, int/float offsetW, int/float offsetH [, bool relativePos = false, bool relativeSize = false ] )
</syntaxhighlight>  
</syntaxhighlight>
{{DGS/OOP|
    Method = DGSElement:attach|
    Counterpart = dgsDetachElements
}}


===Required Arguments===  
===Required Arguments===  
Line 15: Line 19:
*'''offsetW:''' A float of the width of the element. This is affected by the relative argument.
*'''offsetW:''' A float of the width of the element. This is affected by the relative argument.
*'''offsetH:''' A float of the height of the window. This is affected by the relative argument.
*'''offsetH:''' A float of the height of the window. This is affected by the relative argument.
===Optional Arguments===
*'''relativePos:''' This is whether sizes and positioning are relative. If this is true, then all x,y floats must be between 0 and 1, representing sizes/positions as a fraction of the screen size. If false, then the size and co-ordinates are based on client's resolution.
*'''relativePos:''' This is whether sizes and positioning are relative. If this is true, then all x,y floats must be between 0 and 1, representing sizes/positions as a fraction of the screen size. If false, then the size and co-ordinates are based on client's resolution.
*'''relativeSize:''' This is whether sizes and positioning are relative. If this is true, then all width,height floats must be between 0 and 1, representing sizes/positions as a fraction of the screen size. If false, then the size and co-ordinates are based on client's resolution.
*'''relativeSize:''' This is whether sizes and positioning are relative. If this is true, then all width,height floats must be between 0 and 1, representing sizes/positions as a fraction of the screen size. If false, then the size and co-ordinates are based on client's resolution.
Line 28: Line 34:
window = DGS:dgsCreateWindow(50,50,100,100,"dgs", false) -- create a window
window = DGS:dgsCreateWindow(50,50,100,100,"dgs", false) -- create a window
label = DGS:dgsCreateLabel(0,200,100,100,"label", false) -- create a label
label = DGS:dgsCreateLabel(0,200,100,100,"label", false) -- create a label
DGS:dgsAttachElements(label,window,10,20,false,50,50,false) -- attach label to window
DGS:dgsAttachElements(label,window,10,20,_,_,false) -- attach label to window
</syntaxhighlight>
</syntaxhighlight>
{{DGSFUNCTIONS}}
 
=See Also=
 
==<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 23:10, 3 May 2021

This function allows you to attach a specific dgs element to another dgs element. This will make something like dgsSetParent, but there will be no "parent-child" relationship.

Syntax

bool dgsAttachElements( element dgsElement, element attachTo, int/float offsetX, int/float offsetY, int/float offsetW, int/float offsetH [, bool relativePos = false, bool relativeSize = false ] )

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

Method: DGSElement:attach(...)
Counterpart: dgsDetachElements

Required Arguments

  • dgsElement: An element you want to get attached
  • attachTo: A dgs element you want to attach to
  • offsetX: A float of the 2D x position of the element on a player's screen. This is affected by the relative argument.
  • offsetY: A float of the 2D x position of the element on a player's screen. This is affected by the relative argument.
  • offsetW: A float of the width of the element. This is affected by the relative argument.
  • offsetH: A float of the height of the window. This is affected by the relative argument.

Optional Arguments

  • relativePos: This is whether sizes and positioning are relative. If this is true, then all x,y floats must be between 0 and 1, representing sizes/positions as a fraction of the screen size. If false, then the size and co-ordinates are based on client's resolution.
  • relativeSize: This is whether sizes and positioning are relative. If this is true, then all width,height floats must be between 0 and 1, representing sizes/positions as a fraction of the screen size. If false, then the size and co-ordinates are based on client's resolution.

Returns

Returns true if successful, false otherwise.

Example

This example attach label to window 

DGS = exports.dgs

window = DGS:dgsCreateWindow(50,50,100,100,"dgs", false) -- create a window
label = DGS:dgsCreateLabel(0,200,100,100,"label", false) -- create a label
DGS:dgsAttachElements(label,window,10,20,_,_,false) -- attach label to window

See Also

General Functions

General Events

Retrieved from "https://wiki.multitheftauto.com/wiki/DgsAttachElements?oldid=71033"