DgsCreateLabel - Revision history

XLive: update arguments names

2021-02-16T12:09:01Z

update arguments names

← Older revision		Revision as of 12:09, 16 February 2021
Line 5:		Line 5:
	If you would like to have a bigger text you can either change its size with property "textsize":		If you would like to have a bigger text you can either change its size with property "textsize":
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	dgsSetProperty(label,"textSize",{~~scale_x~~,~~scale_y~~})		dgsSetProperty(label,"textSize",{scaleX,scaleY})
	</syntaxhighlight>		</syntaxhighlight>
	or change its font.		or change its font.
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	element dgsCreateLabel ( float x, float y, float width, float height, string text, bool relative [, element parent = nil, int ~~textcolor~~ = 0xFFFFFFFF, float ~~scale_x~~ = 1, float ~~scale_y~~ = 1, float ~~shadowOffset_x~~ = nil, float ~~shadowOffset_y~~ = nil, int shadowColor = nil, string horizontalAlign = "left", string verticalAlign = "top"] )		element dgsCreateLabel ( float x, float y, float width, float height, string text, bool relative [, element parent = nil, int textColor = 0xFFFFFFFF, float scaleX = 1, float scaleY = 1, float shadowOffsetX = nil, float shadowOffsetY = nil, int shadowColor = nil, string horizontalAlign = "left", string verticalAlign = "top"] )
	</syntaxhighlight>		</syntaxhighlight>

Line 25:		Line 25:
	{{OptionalArg}}		{{OptionalArg}}
	*'''parent:''' This is the parent that the gui label 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 gui label 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 color of the text color.		*'''textColor:''' An int of the color of the text color.
	*'''~~scale_x~~:''' A float of the width of the text scale.		*'''scaleX:''' A float of the width of the text scale.
	*'''~~scale_y~~:''' A float of the height of the text scale.		*'''scaleY:''' A float of the height of the text scale.
	*'''~~shadowOffset_x~~:''' A float of the 2D x position offset of the shadow text.		*'''shadowOffsetX:''' A float of the 2D x position offset of the shadow text.
	*'''~~shadowOffset_y~~:''' A float of the 2D y position offset of the shadow text.		*'''shadowOffsetY:''' A float of the 2D y position offset of the shadow text.
	*'''shadowColor:''' An int of the color of the shadow text.		*'''shadowColor:''' An int of the color of the shadow text.
	*'''horizontalAlign:''' A string of the horizontal alignment of the label.		*'''horizontalAlign:''' A string of the horizontal alignment of the label.

Thisdp at 09:26, 17 January 2021

2021-01-17T09:26:17Z

← Older revision		Revision as of 09:26, 17 January 2021
Line 10:		Line 10:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	element dgsCreateLabel ( float x, float y, float width, float height, string text, bool relative, [element parent = nil, int textcolor = 0xFFFFFFFF, float scale_x = 1, float scale_y = 1, float shadowOffset_x = nil, float shadowOffset_y = nil, int shadowColor = nil, string horizontalAlign = "left", string verticalAlign = "top"] )		element dgsCreateLabel ( float x, float y, float width, float height, string text, bool relative [, element parent = nil, int textcolor = 0xFFFFFFFF, float scale_x = 1, float scale_y = 1, float shadowOffset_x = nil, float shadowOffset_y = nil, int shadowColor = nil, string horizontalAlign = "left", string verticalAlign = "top"] )
	</syntaxhighlight>		</syntaxhighlight>

Thisdp at 08:53, 17 January 2021

2021-01-17T08:53:51Z

← Older revision		Revision as of 08:53, 17 January 2021
Line 1:		Line 1:
	~~__NOTOC__~~
	{{Client function}}		{{Client function}}
			__NOTOC__
	This function is for creating a new DGS label. A label is simply a piece of text that cannot be edited by the user.		This function is for creating a new DGS label. A label is simply a piece of text that cannot be edited by the user.

Temois at 15:09, 26 May 2020

2020-05-26T15:09:02Z

← Older revision		Revision as of 15:09, 26 May 2020
Line 5:		Line 5:
	If you would like to have a bigger text you can either change its size with property "textsize":		If you would like to have a bigger text you can either change its size with property "textsize":
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	dgsSetProperty(label,"~~textsize~~",{scale_x,scale_y})		dgsSetProperty(label,"textSize",{scale_x,scale_y})
	</syntaxhighlight>		</syntaxhighlight>
	or change its font.		or change its font.

Thisdp at 13:52, 19 May 2018

2018-05-19T13:52:22Z

← Older revision		Revision as of 13:52, 19 May 2018
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Client function}}		{{Client function}}
	~~<table><tr><td valign=top height=100>~~
	This function is for creating a new DGS label. A label is simply a piece of text that cannot be edited by the user.		This function is for creating a new DGS label. A label is simply a piece of text that cannot be edited by the user.

Line 9:		Line 8:
	</syntaxhighlight>		</syntaxhighlight>
	or change its font.		or change its font.
	~~</td></tr></table>~~
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">

Thisdp at 13:52, 19 May 2018

2018-05-19T13:52:00Z

← Older revision		Revision as of 13:52, 19 May 2018
Line 19:		Line 19:
	*'''x:''' A float of the 2D x position of the DGS label on a player's screen. This is affected by the ''relative'' argument.		*'''x:''' A float of the 2D x position of the DGS label on a player's screen. This is affected by the ''relative'' argument.
	*'''y:''' A float of the 2D y position of the DGS label on a player's screen. This is affected by the ''relative'' argument.		*'''y:''' A float of the 2D y position of the DGS label on a player's screen. This is affected by the ''relative'' argument.
	*'''width:''' A float of the width of the ~~GUI~~ label. This is affected by the ''relative'' argument.		*'''width:''' A float of the width of the DGS label. This is affected by the ''relative'' argument.
	*'''height:''' A float of the height of the ~~GUI~~ label. This is affected by the ''relative'' argument.		*'''height:''' A float of the height of the DGS label. This is affected by the ''relative'' argument.
	*'''text:''' A string of the text that will be displayed by the label.		*'''text:''' A string of the text that will be displayed by the label.
	*'''relative:''' This is whether sizes and positioning are relative. If this is ''true'', then all x,y,width,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,height floats must be between 0 and 1, representing sizes relative to the parent.

Thisdp at 13:40, 19 May 2018

2018-05-19T13:40:27Z

← Older revision		Revision as of 13:40, 19 May 2018
Line 2:		Line 2:
	{{Client function}}		{{Client function}}
	<table><tr><td valign=top height=100>		<table><tr><td valign=top height=100>
	This function is for creating a new DGS label. A label is simply a piece of text that cannot be edited by the user. If you would like to have a bigger text you can either change its size with property "textsize"( dgsSetProperty(label,"textsize",{scale_x,scale_y}) ) or change its font.		This function is for creating a new DGS label. A label is simply a piece of text that cannot be edited by the user.

			If you would like to have a bigger text you can either change its size with property "textsize":
			<syntaxhighlight lang="lua">
			dgsSetProperty(label,"textsize",{scale_x,scale_y})
			</syntaxhighlight>
			or change its font.
	</td></tr></table>		</td></tr></table>
	==Syntax==		==Syntax==

Thisdp: Thisdp moved page DgsDxCreateLabel to DgsCreateLabel

2018-01-20T11:19:31Z

Thisdp moved page DgsDxCreateLabel to DgsCreateLabel

← Older revision

Revision as of 11:19, 20 January 2018

Thisdp at 11:18, 20 January 2018

2018-01-20T11:18:37Z

← Older revision		Revision as of 11:18, 20 January 2018
Line 2:		Line 2:
	{{Client function}}		{{Client function}}
	<table><tr><td valign=top height=100>		<table><tr><td valign=top height=100>
	This function is for creating a new DGS label. A label is simply a piece of text that cannot be edited by the user. If you would like to have a bigger text you can either change its size with property "textsize"( ~~dgsDxGUISetProperty~~(label,"textsize",{scale_x,scale_y}) ) or change its font.		This function is for creating a new DGS label. A label is simply a piece of text that cannot be edited by the user. If you would like to have a bigger text you can either change its size with property "textsize"( dgsSetProperty(label,"textsize",{scale_x,scale_y}) ) or change its font.
	</td></tr></table>		</td></tr></table>
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	element ~~dgsDxCreateLabel~~ ( float x, float y, float width, float height, string text, bool relative, [element parent = nil, int textcolor = 0xFFFFFFFF, float scale_x = 1, float scale_y = 1, float shadowOffset_x = nil, float shadowOffset_y = nil, int shadowColor = nil, string horizontalAlign = "left", string verticalAlign = "top"] )		element dgsCreateLabel ( float x, float y, float width, float height, string text, bool relative, [element parent = nil, int textcolor = 0xFFFFFFFF, float scale_x = 1, float scale_y = 1, float shadowOffset_x = nil, float shadowOffset_y = nil, int shadowColor = nil, string horizontalAlign = "left", string verticalAlign = "top"] )
	</syntaxhighlight>		</syntaxhighlight>

Line 42:		Line 42:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	DGS = exports.dgs		DGS = exports.dgs
	local myWindow = DGS:~~dgsDxCreateWindow~~ ( 0, 0, 0.5, 0.4, "Information", true )--create a window which has "Information" in the title bar.		local myWindow = DGS:dgsCreateWindow ( 0, 0, 0.5, 0.4, "Information", true )--create a window which has "Information" in the title bar.
	local tabPanel = DGS:~~dgsDxCreateTabPanel~~ ( 0, 0.1, 1, 1, true, myWindow ) --create a tab panel which fills the whole window		local tabPanel = DGS:dgsCreateTabPanel ( 0, 0.1, 1, 1, true, myWindow ) --create a tab panel which fills the whole window
	local tabMap = DGS:~~dgsDxCreateTab~~( "Map Information", tabPanel ) -- create a tab named "Map Information" on 'tabPanel'		local tabMap = DGS:dgsCreateTab( "Map Information", tabPanel ) -- create a tab named "Map Information" on 'tabPanel'
	local tabHelp = DGS:~~dgsDxCreateTab~~( "Help", tabPanel ) -- create another tab named "Help" on 'tabPanel'		local tabHelp = DGS:dgsCreateTab( "Help", tabPanel ) -- create another tab named "Help" on 'tabPanel'

	-- adds a label (text) to each tab		-- adds a label (text) to each tab
	DGS:~~dgsDxCreateLabel~~(0.02,0.04,0.94,0.2,"This is information about the current map",true,tabMap)		DGS:dgsCreateLabel(0.02,0.04,0.94,0.2,"This is information about the current map",true,tabMap)
	DGS:~~dgsDxCreateLabel~~(0.02,0.04,0.94,0.92,"This is help text.",true,tabHelp)		DGS:dgsCreateLabel(0.02,0.04,0.94,0.92,"This is help text.",true,tabHelp)
	</syntaxhighlight>		</syntaxhighlight>

Line 55:		Line 55:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	DGS = exports.dgs		DGS = exports.dgs
	local myLabel = DGS:~~dgsDxCreateLabel~~ ( 0, 0, 1, 1, "", true )		local myLabel = DGS:dgsCreateLabel ( 0, 0, 1, 1, "", true )

	function addLabelOnClick ( button, state, absoluteX, absoluteY, worldX, worldY, worldZ, clickedElement )		function addLabelOnClick ( button, state, absoluteX, absoluteY, worldX, worldY, worldZ, clickedElement )
Line 63:		Line 63:
	local elementType = getElementType ( clickedElement )		local elementType = getElementType ( clickedElement )
	--change the label text to that element type		--change the label text to that element type
	DGS:~~dgsDxGUISetText~~ ( myLabel, elementType )		DGS:dgsSetText ( myLabel, elementType )
	--and place it in the position of where the element is		--and place it in the position of where the element is
	DGS:dgsSetPosition ( myLabel, absoluteX, absoluteY, false )		DGS:dgsSetPosition ( myLabel, absoluteX, absoluteY, false )
	--hide the text by passing an empty string 5 seconds later		--hide the text by passing an empty string 5 seconds later
	setTimer ( DGS:~~dgsDxGUISetText~~, 5000, 1, myLabel, "" )		setTimer ( DGS:dgsSetText, 5000, 1, myLabel, "" )
	end		end
	end		end

Ahmed Ly at 01:39, 18 November 2017

2017-11-18T01:39:16Z

← Older revision		Revision as of 01:39, 18 November 2017
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Client function}}		{{Client function}}
	~~[[Image:gui-label.png\|frame\|Example GUI label.]]~~
	<table><tr><td valign=top height=100>		<table><tr><td valign=top height=100>
	This function is for creating a new DGS label. A label is simply a piece of text that cannot be edited by the user. If you would like to have a bigger text you can either change its size with property "textsize"( dgsDxGUISetProperty(label,"textsize",{scale_x,scale_y}) ) or change its font.		This function is for creating a new DGS label. A label is simply a piece of text that cannot be edited by the user. If you would like to have a bigger text you can either change its size with property "textsize"( dgsDxGUISetProperty(label,"textsize",{scale_x,scale_y}) ) or change its font.
Line 11:		Line 10:

	===Required Arguments===		===Required Arguments===
			[[Image:Tab.PNG \|400px\|thumb\|right\|Example tab panel and label .]]
	*'''x:''' A float of the 2D x position of the DGS label on a player's screen. This is affected by the ''relative'' argument.		*'''x:''' A float of the 2D x position of the DGS label on a player's screen. This is affected by the ''relative'' argument.
	*'''y:''' A float of the 2D y position of the DGS label on a player's screen. This is affected by the ''relative'' argument.		*'''y:''' A float of the 2D y position of the DGS label on a player's screen. This is affected by the ''relative'' argument.