Dgs/DgsDxCreateButton - Revision history

Thisdp: Blanked the page

2017-07-02T02:01:59Z

Blanked the page

← Older revision		Revision as of 02:01, 2 July 2017
Line 1:		Line 1:
	~~__NOTOC__~~
	~~{{Client function}}~~
	~~This function allows creation of a DGS Button, which is a clickable item as part of GUI.~~

	~~'''Notice: This is a function exported by DGS!'''~~

	~~==Syntax==~~
	~~<syntaxhighlight lang="lua">~~
	element dgsDxCreateButton ( float x, float y, float width, float height, string text, bool relative, [ element parent = nil, int textcolor = 0xFFFFFFFF, float scalex = 1, float scaley = 1, element defimg = nil, element selimg = nil, element cliimg = nil, int defcolor = 0xC80078C8, int selcolor = 0xC8005AFF, int clicolor = 0xC8325A] )
	~~</syntaxhighlight>~~

	~~===Required Arguments===~~
	~~[[Image:DGS_Button.png\|thumb\|DGS Button]]~~
	*'''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.
	*'''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.
	*'''textcolor:''' An int of the text color of the button.
	*'''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.
	*'''defimg:''' A texture element of the background of the button ( no mouse enter and no mouse click ).
	*'''selimg:''' A texture element of the background of the button which is selected.
	*'''cliimg:''' A texture element of the background of the button which is clicked.
	*'''defcolor:''' An int of the color of the background of the button ( no mouse enter and no mouse click ).
	*'''selcolor:''' An int of the color of the background of the button which is selected.
	*'''clicolor:''' An int of the color of the background of the button which is clicked.

	~~===Returns===~~
	~~Returns an [[element]] of the created [[Element/DGS/Button\|button]] if it was successfully created, false otherwise.~~

	~~==Example==~~
	~~This example creates an edit box alongside an "Output!" button. When the button is clicked, it will output the message in the edit box into the Chat Box.~~
	~~<syntaxhighlight lang="lua">~~
	~~--create our button~~
	~~button = dgsDxCreateButton( 0.7, 0.1, 0.2, 0.1, "Output!", true )~~
	~~--Create an edit box and define it as "editBox".~~
	~~editBox = dgsDxCreateEdit( 0.3, 0.1, 0.4, 0.1, "Type your message here!", true )~~
	~~-- and attach our button to the outputEditBox function~~
	~~addEventHandler ( "onClientDgsMouseClick", editBox, outputEditBox )~~

	~~--setup our function to output the message to the chatbox~~
	~~function outputEditBox ()~~
	~~local text = dgsDxGUIGetText ( editBox )--get the text from the edit box~~
	~~outputChatBox ( text ) --output that text~~
	~~end~~
	~~addEventHandler ( "onClientDgsMouseClick", button, outputEditBox )~~
	~~</syntaxhighlight>~~

	~~==See Also==~~
	~~{{DGSFUNCTIONS}}~~
	~~[[ZH-CN:dgsDxCreateButton]]~~

Thisdp: /* Syntax */

2017-06-08T05:57:25Z

Syntax

← Older revision		Revision as of 05:57, 8 June 2017
Line 7:		Line 7:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	element dgsDxCreateButton ( float x, float y, float width, float height, string text, bool relative, [ element parent = nil, int textcolor = 0xFFFFFFFF, float scalex = 1, float scaley = 1, element defimg = nil, element selimg = nil, element cliimg = nil, int defcolor = ~~0x0078C8C8~~, int selcolor = ~~0x005AFFC8~~, int clicolor = ~~0x325AC8~~] )		element dgsDxCreateButton ( float x, float y, float width, float height, string text, bool relative, [ element parent = nil, int textcolor = 0xFFFFFFFF, float scalex = 1, float scaley = 1, element defimg = nil, element selimg = nil, element cliimg = nil, int defcolor = 0xC80078C8, int selcolor = 0xC8005AFF, int clicolor = 0xC8325A] )
	</syntaxhighlight>		</syntaxhighlight>

Thisdp: /* Syntax */

2017-06-03T04:27:23Z

Syntax

← Older revision		Revision as of 04:27, 3 June 2017
Line 7:		Line 7:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	element dgsDxCreateButton ( float x, float y, float width, float height, string text, bool relative, [ element parent = nil, int textcolor = 0xFFFFFFFF, float scalex = 1, float scaley = 1, ~~texture~~ defimg = nil, ~~texture~~ selimg = nil, ~~texture~~ cliimg = nil, int defcolor = 0x0078C8C8, int selcolor = 0x005AFFC8, int clicolor = 0x325AC8] )		element dgsDxCreateButton ( float x, float y, float width, float height, string text, bool relative, [ element parent = nil, int textcolor = 0xFFFFFFFF, float scalex = 1, float scaley = 1, element defimg = nil, element selimg = nil, element cliimg = nil, int defcolor = 0x0078C8C8, int selcolor = 0x005AFFC8, int clicolor = 0x325AC8] )
	</syntaxhighlight>		</syntaxhighlight>

Line 25:		Line 25:
	*'''scalex:''' 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.
	*'''scaley:''' 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.
	*'''defimg:''' A texture of the background of the button ( no mouse enter and no mouse click ).		*'''defimg:''' A texture element of the background of the button ( no mouse enter and no mouse click ).
	*'''selimg:''' A texture of the background of the button which is selected.		*'''selimg:''' A texture element of the background of the button which is selected.
	*'''cliimg:''' A texture of the background of the button which is clicked.		*'''cliimg:''' A texture element of the background of the button which is clicked.
	*'''defcolor:''' ~~A integer~~ of the color of the background of the button ( no mouse enter and no mouse click ).		*'''defcolor:''' An int of the color of the background of the button ( no mouse enter and no mouse click ).
	*'''selcolor:''' ~~A integer~~ of the color of the background of the button which is selected.		*'''selcolor:''' An int of the color of the background of the button which is selected.
	*'''clicolor:''' ~~A integer~~ of the color of the background of the button which is clicked.		*'''clicolor:''' An int of the color of the background of the button which is clicked.

	===Returns===		===Returns===

Thisdp: /* Syntax */

2017-06-03T04:26:41Z

Syntax

← Older revision		Revision as of 04:26, 3 June 2017
Line 7:		Line 7:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	element dgsDxCreateButton ( float x, float y, float width, float height, string text, bool relative, [ element parent = nil, int textcolor, float scalex, float scaley, texture defimg = nil, texture selimg = nil, texture cliimg = nil, int defcolor, int selcolor, int clicolor] )		element dgsDxCreateButton ( float x, float y, float width, float height, string text, bool relative, [ element parent = nil, int textcolor = 0xFFFFFFFF, float scalex = 1, float scaley = 1, texture defimg = nil, texture selimg = nil, texture cliimg = nil, int defcolor = 0x0078C8C8, int selcolor = 0x005AFFC8, int clicolor = 0x325AC8] )
	</syntaxhighlight>		</syntaxhighlight>

Thisdp at 14:28, 1 June 2017

2017-06-01T14:28:30Z

← Older revision		Revision as of 14:28, 1 June 2017
Line 2:		Line 2:
	{{Client function}}		{{Client function}}
	This function allows creation of a DGS Button, which is a clickable item as part of GUI.		This function allows creation of a DGS Button, which is a clickable item as part of GUI.

	'''Notice: This is a function exported by DGS!'''		'''Notice: This is a function exported by DGS!'''

Thisdp at 14:28, 1 June 2017

2017-06-01T14:28:15Z

← Older revision		Revision as of 14:28, 1 June 2017
Line 2:		Line 2:
	{{Client function}}		{{Client function}}
	This function allows creation of a DGS Button, which is a clickable item as part of GUI.		This function allows creation of a DGS Button, which is a clickable item as part of GUI.
	Notice: This is a function exported by DGS!		'''Notice: This is a function exported by DGS!'''

	==Syntax==		==Syntax==

Thisdp at 14:28, 1 June 2017

2017-06-01T14:28:01Z

← Older revision		Revision as of 14:28, 1 June 2017
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Client function}}		{{Client function}}
	This function allows creation of a ~~GUI~~ Button, which is a clickable item as part of GUI.		This function allows creation of a DGS Button, which is a clickable item as part of GUI.
			Notice: This is a function exported by DGS!

	==Syntax==		==Syntax==

Thisdp at 14:26, 1 June 2017

2017-06-01T14:26:53Z

← Older revision		Revision as of 14:26, 1 June 2017
Line 9:		Line 9:

	===Required Arguments===		===Required Arguments===
	[[Image:~~Button~~.png\|thumb\|~~GUI Test~~ Button]]		[[Image:DGS_Button.png\|thumb\|DGS Button]]
	*'''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.

Thisdp: /* See Also */

2017-06-01T14:17:40Z

Thisdp: /* Syntax */

2017-06-01T14:16:22Z

Syntax

← Older revision		Revision as of 14:16, 1 June 2017
Line 5:		Line 5:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	element dgsDxCreateButton ( float x, float y, float width, float height, string text, bool relative, [ element parent = nil ] )		element dgsDxCreateButton ( float x, float y, float width, float height, string text, bool relative, [ element parent = nil, int textcolor, float scalex, float scaley, texture defimg = nil, texture selimg = nil, texture cliimg = nil, int defcolor, int selcolor, int clicolor] )
	</syntaxhighlight>		</syntaxhighlight>

	===Required Arguments===		===Required Arguments===
	[[Image:Button.png\|thumb\|GUI Test Button]]		[[Image:Button.png\|thumb\|GUI Test Button]]
	*'''x:''' A float of the 2D x position of the ~~DGS~~ 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 ~~DGS~~ 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 ~~DGS~~ button. 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 ~~DGS~~ button. This is affected by the ''relative'' argument.		*'''height:''' A float of the height of the button. This is affected by the ''relative'' argument.
	*'''text:''' A string of the text that will be displayed as a label on the button.		*'''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.		*'''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.
Line 19:		Line 19:
	===Optional Arguments===		===Optional Arguments===
	{{OptionalArg}}		{{OptionalArg}}
	*'''parent:''' This is the parent that the ~~gui~~ 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 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:''' An int of the text color of the button.
			*'''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.
			*'''defimg:''' A texture of the background of the button ( no mouse enter and no mouse click ).
			*'''selimg:''' A texture of the background of the button which is selected.
			*'''cliimg:''' A texture of the background of the button which is clicked.
			*'''defcolor:''' A integer of the color of the background of the button ( no mouse enter and no mouse click ).
			*'''selcolor:''' A integer of the color of the background of the button which is selected.
			*'''clicolor:''' A integer of the color of the background of the button which is clicked.

	===Returns===		===Returns===

← Older revision		Revision as of 14:17, 1 June 2017
Line 52:		Line 52:

	==See Also==		==See Also==
	{{~~DGS_FUNCTIONS~~}}		{{DGSFUNCTIONS}}
	[[ZH-CN:dgsDxCreateButton]]		[[ZH-CN:dgsDxCreateButton]]