DgsSwitchButtonSetText: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
{{Client function}}
{{Client function}}
__NOTOC__
This function sets the text of switch button.
==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool dgsSwitchButtonSetText( element switchbutton, string textOn, string textOff)
bool dgsSwitchButtonSetText( element switchbutton, string textOn, string textOff )
</syntaxhighlight>  
</syntaxhighlight>  


===Required Arguments===  
===Required Arguments===  
*'''switchButton:''' Switch you wish to change the text of
*'''switchButton:''' Switch Button you wish to change the text of.
*'''textOn:''' New text
*'''textOn:''' A string of the text of state ''on''.
*'''textOff:''' New text
*'''textOff:''' A string of the text of state ''off''.


===Returns===
===Returns===
Returns true if text has been changed successfully, false otherwise.
Returns ''true'' if text has been changed successfully, ''false'' otherwise.


==Example==  
==Example==  
Line 18: Line 21:
button = DGS:dgsCreateSwitchButton( 0.7, 0.1, 0.2, 0.1, "On", "Off", false, true )
button = DGS:dgsCreateSwitchButton( 0.7, 0.1, 0.2, 0.1, "On", "Off", false, true )
addCommandHandler("switch", function()
addCommandHandler("switch", function()
     DGS:dgsSwitchButtonSetText(button, "Turn", "Shutdown")
     DGS:dgsSwitchButtonSetText(button, "Running", "Stopped")
end)
end)
</syntaxhighlight>
</syntaxhighlight>
==See Also==
{{DGSFUNCTIONS}}

Latest revision as of 15:00, 22 April 2020

This function sets the text of switch button.

Syntax

bool dgsSwitchButtonSetText( element switchbutton, string textOn, string textOff )

Required Arguments

  • switchButton: Switch Button you wish to change the text of.
  • textOn: A string of the text of state on.
  • textOff: A string of the text of state off.

Returns

Returns true if text has been changed successfully, false otherwise.

Example

DGS = exports.dgs
button = DGS:dgsCreateSwitchButton( 0.7, 0.1, 0.2, 0.1, "On", "Off", false, true )
addCommandHandler("switch", function()
    DGS:dgsSwitchButtonSetText(button, "Running", "Stopped")
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/DgsSwitchButtonSetText?oldid=65963"