DgsCreateButton - Revision history

XLive: update arguments names

2021-02-16T14:01:36Z

update arguments names

← Older revision		Revision as of 14:01, 16 February 2021
Line 7:		Line 7:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	element dgsCreateButton ( 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] )		element dgsCreateButton ( 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 normalImage = nil, element hoveringImage = nil, element clickedImage = nil, int normalColor = 0xC80078C8, int hoveringColor = 0xC8005AFF, int clickedColor = 0xC8325A] )
	</syntaxhighlight>		</syntaxhighlight>

Line 22:		Line 22:
	{{OptionalArg}}		{{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.		*'''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.		*'''textColor:''' An int of the text color of the button.
	*'''~~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 element of the background of the button ( no mouse enter and no mouse click ).		*'''normalImage:''' 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.		*'''hoveringImage:''' 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.		*'''clickedImage:''' 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 ).		*'''normalColor:''' 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.		*'''hoveringColor:''' 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.		*'''clickedColor:''' An int of the color of the background of the button which is clicked.

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

Thisdp at 09:16, 17 January 2021

2021-01-17T09:16:56Z

← Older revision		Revision as of 09:16, 17 January 2021
Line 7:		Line 7:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	element dgsCreateButton ( 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] )		element dgsCreateButton ( 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: /* Example */

2020-04-02T08:51:41Z

Example

← Older revision		Revision as of 08:51, 2 April 2020
Line 40:		Line 40:
	DGS = exports.dgs		DGS = exports.dgs
	--create our button		--create our button
	button = DGS :dgsCreateButton( 0.7, 0.1, 0.2, 0.1, "Output!", true )		button = DGS:dgsCreateButton( 0.7, 0.1, 0.2, 0.1, "Output!", true )
	--Create an edit box and define it as "editBox".		--Create an edit box and define it as "editBox".
	editBox = DGS :dgsCreateEdit( 0.3, 0.1, 0.4, 0.1, "Type your message here!", true )		editBox = DGS:dgsCreateEdit( 0.3, 0.1, 0.4, 0.1, "Type your message here!", true )
	-- and attach our button to the outputEditBox function		-- and attach our button to the outputEditBox function
	addEventHandler ( "onDgsMouseClick", editBox, outputEditBox )		addEventHandler ( "onDgsMouseClick", editBox, outputEditBox )

Thisdp at 08:51, 2 April 2020

2020-04-02T08:51:29Z

← Older revision		Revision as of 08:51, 2 April 2020
Line 38:		Line 38:
	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.		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">		<syntaxhighlight lang="lua">
			DGS = exports.dgs
	--create our button		--create our button
	button = dgsCreateButton( 0.7, 0.1, 0.2, 0.1, "Output!", true )		button = DGS :dgsCreateButton( 0.7, 0.1, 0.2, 0.1, "Output!", true )
	--Create an edit box and define it as "editBox".		--Create an edit box and define it as "editBox".
	editBox = dgsCreateEdit( 0.3, 0.1, 0.4, 0.1, "Type your message here!", true )		editBox = DGS :dgsCreateEdit( 0.3, 0.1, 0.4, 0.1, "Type your message here!", true )
	-- and attach our button to the outputEditBox function		-- and attach our button to the outputEditBox function
	addEventHandler ( "onDgsMouseClick", editBox, outputEditBox )		addEventHandler ( "onDgsMouseClick", editBox, outputEditBox )
Line 47:		Line 48:
	--setup our function to output the message to the chatbox		--setup our function to output the message to the chatbox
	function outputEditBox ()		function outputEditBox ()
	local text = dgsGetText ( editBox )--get the text from the edit box		local text = DGS :dgsGetText ( editBox )--get the text from the edit box
	outputChatBox ( text ) --output that text		outputChatBox ( text ) --output that text
	end		end

Thisdp at 13:40, 18 January 2018

2018-01-18T13:40:46Z

← Older revision		Revision as of 13:40, 18 January 2018
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 = 0xC80078C8, int selcolor = 0xC8005AFF, int clicolor = 0xC8325A] )		element dgsCreateButton ( 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>

Line 39:		Line 39:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	--create our button		--create our button
	button = ~~dgsDxCreateButton~~( 0.7, 0.1, 0.2, 0.1, "Output!", true )		button = dgsCreateButton( 0.7, 0.1, 0.2, 0.1, "Output!", true )
	--Create an edit box and define it as "editBox".		--Create an edit box and define it as "editBox".
	editBox = ~~dgsDxCreateEdit~~( 0.3, 0.1, 0.4, 0.1, "Type your message here!", true )		editBox = dgsCreateEdit( 0.3, 0.1, 0.4, 0.1, "Type your message here!", true )
	-- and attach our button to the outputEditBox function		-- and attach our button to the outputEditBox function
	addEventHandler ( "~~onClientDgsDxMouseClick~~", editBox, outputEditBox )		addEventHandler ( "onDgsMouseClick", editBox, outputEditBox )

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

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

Thisdp: Thisdp moved page DgsDxCreateButton to DgsCreateButton

2018-01-18T13:39:55Z

Thisdp moved page DgsDxCreateButton to DgsCreateButton

← Older revision

Revision as of 13:39, 18 January 2018

Thisdp: /* Example */

2017-08-11T01:57:16Z

Example

← Older revision		Revision as of 01:57, 11 August 2017
Line 43:		Line 43:
	editBox = dgsDxCreateEdit( 0.3, 0.1, 0.4, 0.1, "Type your message here!", true )		editBox = dgsDxCreateEdit( 0.3, 0.1, 0.4, 0.1, "Type your message here!", true )
	-- and attach our button to the outputEditBox function		-- and attach our button to the outputEditBox function
	addEventHandler ( "~~onClientDgsMouseClick~~", editBox, outputEditBox )		addEventHandler ( "onClientDgsDxMouseClick", editBox, outputEditBox )

	--setup our function to output the message to the chatbox		--setup our function to output the message to the chatbox
Line 50:		Line 50:
	outputChatBox ( text ) --output that text		outputChatBox ( text ) --output that text
	end		end
	addEventHandler ( "~~onClientDgsMouseClick~~", button, outputEditBox )		addEventHandler ( "onClientDgsDxMouseClick", button, outputEditBox )
	</syntaxhighlight>		</syntaxhighlight>

Thisdp at 02:01, 2 July 2017

2017-07-02T02:01:46Z

← 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: Blanked the page

2017-06-01T11:17:13Z

Blanked the page

← Older revision		Revision as of 11:17, 1 June 2017
Line 1:		Line 1:
	~~#REDIRECT [[Dgs/DgsDxCreateButton]]~~

Thisdp: Thisdp moved page DgsDxCreateButton to Dgs/DgsDxCreateButton

2017-06-01T10:46:08Z

Thisdp moved page DgsDxCreateButton to Dgs/DgsDxCreateButton

New page

#REDIRECT [[Dgs/DgsDxCreateButton]]