Dgs-dxswitchbutton: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Drawt)
 
(Blanked the page)
Tag: Blanking
Line 1: Line 1:
__NOTOC__
{{Client function}}
This function allows creation of a DGS Switch Button, which is a clickable item as part of GUI.


'''Notice: This is a function exported by DGS!'''
==Syntax==
<syntaxhighlight lang="lua">
element dgsCreateSwitchButton( float x, float y, float sx, float sy, [ string textOn, string textOff, bool state = false, bool relative = false, element parent = nil, int textColor_t = 0x5AA0E6FF, int textColor_f = 0x3C3C3CFF, float scalex = 1, float scaley = 1 ] )
</syntaxhighlight>
===Required Arguments===
*'''x:''' A float of the 2D x position of the button on a player's screen.  This is affected by the ''relative'' argument.
*'''y:''' A float of the 2D y position of the button on a player's screen. This is affected by the ''relative'' argument.
*'''sx:'''
*'''sy:'''
===Optional Arguments===
{{OptionalArg}}
*'''textOn'''
*'''textOff'''
*'''state'''
*'''relative'''
*'''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.
*'''textColor_t:'''
*'''textColor_f'''
*'''scalex:''' A float of the 2D x scale of the text of the button.
*'''scaley:''' A float of the 2D y scale of the text of the button.
===Returns===
Returns an [[element]] of the created [[Element/DGS/SwitchButton|Switch Button]] if it was successfully created, ''false'' otherwise.
==Example==
==See Also==
{{DGSFUNCTIONS}}

Revision as of 08:44, 2 April 2020