DgsCreateSwitchButton - Revision history

XLive: update arguments names

2021-02-16T10:45:14Z

update arguments names

← Older revision		Revision as of 10:45, 16 February 2021
Line 5:		Line 5:
	==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 23:		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===

Thisdp at 09:27, 17 January 2021

2021-01-17T09:27:15Z

← Older revision		Revision as of 09:27, 17 January 2021
Line 5:		Line 5:
	==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 textScaleX = 1, float textScaleY = 1 ] )
	</syntaxhighlight>		</syntaxhighlight>

Temois: /* Example */

2020-04-22T08:15:08Z

Example

← Older revision		Revision as of 08:15, 22 April 2020
Line 32:		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}}

Thisdp at 08:53, 2 April 2020

2020-04-02T08:53:05Z

← Older revision		Revision as of 08:53, 2 April 2020
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==

Thisdp: /* Returns */

2020-04-02T08:52:39Z

Returns

← Older revision		Revision as of 08:52, 2 April 2020
Line 29:		Line 29:

	===Returns===		===Returns===
	Returns an [[element]] of the created [[~~Element/DGS/SwitchButton~~\|Switch Button]] if it was successfully created, ''false'' otherwise.		Returns an [[element]] of the created [[dgs-dxswitchbutton\|Switch Button]] if it was successfully created, ''false'' otherwise.

	==Example==		==Example==

Thisdp at 08:52, 2 April 2020

2020-04-02T08:52:08Z

← Older revision		Revision as of 08:52, 2 April 2020
Line 7:		Line 7:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<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 ] )		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 ] )
	</syntaxhighlight>		</syntaxhighlight>

Line 13:		Line 13:
	*'''x:''' A float of the 2D x position of the button on a player's screen. This is affected by the ''relative'' argument.		*'''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.		*'''y:''' A float of the 2D y position of the button on a player's screen. This is affected by the ''relative'' argument.
	*'''sx:'''		*'''width:''' A float of the width of the button. This is affected by the ''relative'' argument.
	*'''sy:'''		*'''height:''' A float of the height of the button. This is affected by the ''relative'' argument.

	===Optional Arguments===		===Optional Arguments===
	{{OptionalArg}}		{{OptionalArg}}
	*'''textOn'''		*'''textOn:''' A string of the text of switch button when it is turned on.
	*'''textOff'''		*'''textOff:''' A string of the text of switch button when it is turned off.
	*'''state'''		*'''state:''' A bool indicates whether the switch is turned on or off.
	*'''relative'''		*'''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 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.		*'''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.
	*'''~~textColor_t~~:'''		*'''textColorOn:''' An int of the color of the text when the switch button turns on.
	*'''~~textColor_f~~'''		*'''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.		*'''textScaleX:''' 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.		*'''textScaleY:''' A float of the 2D y scale of the text of the button.

	===Returns===		===Returns===
Line 32:		Line 32:

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

Dmi7ry: Created page with "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!'..."

2020-04-02T08:42:56Z

Created page with "__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!'..."

New page

__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}}