Dgs/DgsDxCreateButton: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Created page with "==Syntax== <syntaxhighlight lang="lua"> element dgsDxCreateButton ( float x, float y, float width, float height, string text, bool relative, [ element parent = nil, ] ) </sy...")
 
(Blanked the page)
 
(16 intermediate revisions by the same user not shown)
Line 1: Line 1:
==Syntax==
<syntaxhighlight lang="lua">
element dgsDxCreateButton ( float x, float y, float width, float height, string text, bool relative, [ element parent = nil,  ] )
</syntaxhighlight>
{{OOP||[[Element/GUI/Button|GuiButton]]}}


===Required Arguments===
[[Image:Button.png|thumb|GUI Test Button]]
*'''x:''' A float of the 2D x position of the GUI button on a player's screen.  This is affected by the ''relative'' argument.
*'''y:''' A float of the 2D y position of the GUI button on a player's screen. This is affected by the ''relative'' argument.
*'''width:''' A float of the width of the GUI button. This is affected by the ''relative'' argument.
*'''height:''' A float of the height of the GUI button. This is affected by the ''relative'' argument.
*'''text:''' A string of the text that will be displayed as a label on the button.
*'''relative:''' This is whether sizes and positioning are relative.  If this is ''true'', then all ''x, y, width'' and ''height'' floats must be between 0 and 1, representing sizes relative to the parent.
===Optional Arguments===
{{OptionalArg}}
*'''parent:''' This is the parent that the dgs button is attached to.  If the ''relative'' argument is true, sizes and positioning will be made relative to this parent. If the ''relative'' argument is false, positioning will be the number of offset pixels from the parent's origin. If no parent is passed, the parent will become the screen - causing positioning and sizing according to screen positioning.
===Returns===
Returns an [[element]] of the created [[Element/DGS/Button|button]] if it was successfully created, false otherwise.

Latest revision as of 02:01, 2 July 2017