DgsCreateSwitchButton: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(update arguments names)
 
(3 intermediate revisions by 2 users not shown)
Line 2: Line 2:
{{Client function}}
{{Client function}}
This function allows creation of a DGS Switch Button, which is a clickable item as part of GUI.
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==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
element dgsCreateSwitchButton( float x, float y, float width, float height, [ string textOn = "", string textOff = "", bool state = false, bool relative = false, element parent = nil, int textColorOn = 0x5AA0E6FF, int textColorOff = 0x3C3C3CFF, float textScaleX = 1, float textScaleY = 1 ] )
element dgsCreateSwitchButton( float x, float y, float width, float height [, string textOn = "", string textOff = "", bool state = false, bool relative = false, element parent = nil, int textColorOn = 0x5AA0E6FF, int textColorOff = 0x3C3C3CFF, float scaleX = 1, float scaleY = 1 ] )
</syntaxhighlight>  
</syntaxhighlight>  


Line 25: Line 23:
*'''textColorOn:''' An int of the color of the text when the switch button turns on.
*'''textColorOn:''' An int of the color of the text when the switch button turns on.
*'''textColorOff:''' An int of the color of the text when the switch button turns off.
*'''textColorOff:''' An int of the color of the text when the switch button turns off.
*'''textScaleX:''' A float of the 2D x scale of the text of the button.
*'''scaleX:''' A float of the 2D x scale of the text of the button.
*'''textScaleY:''' A float of the 2D y scale of the text of the button.
*'''scaleY:''' A float of the 2D y scale of the text of the button.


===Returns===
===Returns===
Line 34: Line 32:
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
DGS = exports.dgs
DGS = exports.dgs
button = DGS:dgsCreateSwitchButton( 0.7, 0.1, 0.2, 0.1, "On", "Off", true )
button = DGS:dgsCreateSwitchButton( 0.7, 0.1, 0.2, 0.1, "On", "Off", true, true )
addEventHandler ( "onDgsMouseClickDown", button, function()
addEventHandler ( "onDgsMouseClickDown", button, function()
         outputChatBox ( "The switch turns "..(DGS:dgsSwitchButtonGetState(source) and "on" or "off"))
         outputChatBox ( "The switch turns "..(DGS:dgsSwitchButtonGetState(source) and "on" or "off"))
end
end)
</syntaxhighlight>
</syntaxhighlight>
==See Also==
==See Also==
{{DGSFUNCTIONS}}
{{DGSFUNCTIONS}}

Latest revision as of 10:45, 16 February 2021

This function allows creation of a DGS Switch Button, which is a clickable item as part of GUI.

Syntax

element dgsCreateSwitchButton( float x, float y, float width, float height [, string textOn = "", string textOff = "", bool state = false, bool relative = false, element parent = nil, int textColorOn = 0x5AA0E6FF, int textColorOff = 0x3C3C3CFF, float scaleX = 1, float scaleY = 1 ] )

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.
  • width: A float of the width of the button. This is affected by the relative argument.
  • height: A float of the height of the button. This is affected by the relative argument.

Optional Arguments

NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use. For more information on optional arguments, see optional arguments.

  • textOn: A string of the text of switch button when it is turned on.
  • textOff: A string of the text of switch button when it is turned off.
  • state: A bool indicates whether the switch is turned on or off.
  • 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.
  • parent: This is the parent that the DGS switch 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.
  • textColorOn: An int of the color of the text when the switch button turns on.
  • textColorOff: An int of the color of the text when the switch button turns off.
  • 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 Switch Button if it was successfully created, false otherwise.

Example

DGS = exports.dgs
button = DGS:dgsCreateSwitchButton( 0.7, 0.1, 0.2, 0.1, "On", "Off", true, true )
addEventHandler ( "onDgsMouseClickDown", button, function()
        outputChatBox ( "The switch turns "..(DGS:dgsSwitchButtonGetState(source) and "on" or "off"))
end)

See Also

Custom Cursor Functions

Multi Language Supports

Animation

3D Element

3D Interface

3D Line

3D Image

3D Text

Browser

Button

Check Box

Combo Box

Custom Renderer

Edit

Detect Area

Drag'N Drop

Grid List

Image

Memo

Menu

Label

Layout

Line

Progress Bar

Radio Button

Scale Pane

Scroll Bar

Scroll Pane

Selector

Style

Switch Button

Tab Panel

Window

Basic Shape Plugins

Circle

Quadrilateral

Rounded Rectangle

Other Plugins

Blur Box

Canvas

Chart

Color Picker

Effect 3D

Gradient

Mask

Media Browser

Nine Slice

Object Preview Supports

Paste Handler

QRCode

Remote Image

Screen Source

SVG

Tooltips

Retrieved from "https://wiki.multitheftauto.com/wiki/DgsCreateSwitchButton?oldid=69007"