DgsLabelSetColor - Revision history

Thisdp at 19:15, 16 January 2021

2021-01-16T19:15:21Z

← Older revision		Revision as of 19:15, 16 January 2021
Line 18:		Line 18:
	===Returns===		===Returns===
	Returns ''true'' if the the color of the dgs label was successfully changed, ''false'' otherwise.		Returns ''true'' if the the color of the dgs label was successfully changed, ''false'' otherwise.

			==Example==
			This example creates a label with text "Hello World!" and sets it to a random color.
			<syntaxhighlight lang="lua">
			DGS = exports.dgs
			local myLabel = DGS:dgsCreateLabel ( 0.45, 0.48, 0.2, 0.5, "Hello world", true )
			DGS:dgsLabelSetColor ( myLabel, math.random(0, 255), math.random(0, 255), math.random(0, 255), 255 )</syntaxhighlight>

	==Syntax==		==Syntax==
Line 32:		Line 39:
	Returns ''true'' if the the color of the dgs label was successfully changed, ''false'' otherwise.		Returns ''true'' if the the color of the dgs label was successfully changed, ''false'' otherwise.

	==Example ~~1==~~		==Example==
	~~This example creates a label with text "Hello World!" and sets it to a random color.~~
	~~<syntaxhighlight lang="lua">~~
	~~DGS = exports.dgs~~
	~~local myLabel = DGS:dgsCreateLabel ( 0.45, 0.48, 0.2, 0.5, "Hello world", true )~~
	~~DGS:dgsLabelSetColor ( myLabel, math.random(0, 255), math.random(0, 255), math.random(0, 255), 255 )</syntaxhighlight>~~

	~~==Example 2~~==
	This example creates a label with text "Hello World!" and sets it to a random color.		This example creates a label with text "Hello World!" and sets it to a random color.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">

Thisdp at 19:14, 16 January 2021

2021-01-16T19:14:44Z

← Older revision		Revision as of 19:14, 16 January 2021
Line 4:		Line 4:
	This function allows you to set the color of a DGS label.		This function allows you to set the color of a DGS label.

	==Syntax 1==		==Syntax==
	<!-- NOTE: don't use 'special' names for variable names, e.g. you shouldn't be writing things like 'player player, vehicle vehicle', instead write something like 'player thePlayer, vehicle vehicleToGetInto'. This is less confusing and prevents the syntax highlighting being odd -->
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	bool dgsLabelSetColor ( element theElement, int red, int green, int blue, int alpha )		bool dgsLabelSetColor ( element theElement, int red, int green, int blue, int alpha )
Line 11:		Line 10:

	===Required Arguments===		===Required Arguments===
	~~<!-- List each argument one per line. This should be the argument's name as in the argument list above, NOT the argument's data type -->~~
	*'''theElement:''' The label to be changed.		*'''theElement:''' The label to be changed.
	*'''red:''' An integer specifying the amount of red (0 to 255).		*'''red:''' An integer specifying the amount of red (0 to 255).
Line 19:		Line 17:

	===Returns===		===Returns===
	~~<!-- Make this descriptive. Explain what cases will return false. If you're unsure, add a tag to it so we can check -->~~
	Returns ''true'' if the the color of the dgs label was successfully changed, ''false'' otherwise.		Returns ''true'' if the the color of the dgs label was successfully changed, ''false'' otherwise.

	==Syntax 2==		==Syntax==
	<!-- NOTE: don't use 'special' names for variable names, e.g. you shouldn't be writing things like 'player player, vehicle vehicle', instead write something like 'player thePlayer, vehicle vehicleToGetInto'. This is less confusing and prevents the syntax highlighting being odd -->
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	bool dgsLabelSetColor ( element theElement, int color, bool notSplitColor )		bool dgsLabelSetColor ( element theElement, int color, bool notSplitColor )
Line 29:		Line 25:

	===Required Arguments===		===Required Arguments===
	~~<!-- List each argument one per line. This should be the argument's name as in the argument list above, NOT the argument's data type -->~~
	*'''theElement:''' The label to be changed.		*'''theElement:''' The label to be changed.
	*'''color:''' An integer of the color of the text of the label.		*'''color:''' An integer of the color of the text of the label.
Line 35:		Line 30:

	===Returns===		===Returns===
	~~<!-- Make this descriptive. Explain what cases will return false. If you're unsure, add a tag to it so we can check -->~~
	Returns ''true'' if the the color of the dgs label was successfully changed, ''false'' otherwise.		Returns ''true'' if the the color of the dgs label was successfully changed, ''false'' otherwise.

Thisdp: Thisdp moved page DgsDxLabelSetColor to DgsLabelSetColor

2018-01-20T11:19:35Z

Thisdp moved page DgsDxLabelSetColor to DgsLabelSetColor

← Older revision

Revision as of 11:19, 20 January 2018

Thisdp at 11:18, 20 January 2018

2018-01-20T11:18:28Z

← Older revision		Revision as of 11:18, 20 January 2018
Line 7:		Line 7:
	<!-- NOTE: don't use 'special' names for variable names, e.g. you shouldn't be writing things like 'player player, vehicle vehicle', instead write something like 'player thePlayer, vehicle vehicleToGetInto'. This is less confusing and prevents the syntax highlighting being odd -->		<!-- NOTE: don't use 'special' names for variable names, e.g. you shouldn't be writing things like 'player player, vehicle vehicle', instead write something like 'player thePlayer, vehicle vehicleToGetInto'. This is less confusing and prevents the syntax highlighting being odd -->
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	bool ~~dgsDxLabelSetColor~~ ( element theElement, int red, int green, int blue, int alpha )		bool dgsLabelSetColor ( element theElement, int red, int green, int blue, int alpha )
	</syntaxhighlight>		</syntaxhighlight>

Line 25:		Line 25:
	<!-- NOTE: don't use 'special' names for variable names, e.g. you shouldn't be writing things like 'player player, vehicle vehicle', instead write something like 'player thePlayer, vehicle vehicleToGetInto'. This is less confusing and prevents the syntax highlighting being odd -->		<!-- NOTE: don't use 'special' names for variable names, e.g. you shouldn't be writing things like 'player player, vehicle vehicle', instead write something like 'player thePlayer, vehicle vehicleToGetInto'. This is less confusing and prevents the syntax highlighting being odd -->
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	bool ~~dgsDxLabelSetColor~~ ( element theElement, int color, bool notSplitColor )		bool dgsLabelSetColor ( element theElement, int color, bool notSplitColor )
	</syntaxhighlight>		</syntaxhighlight>

Line 42:		Line 42:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	DGS = exports.dgs		DGS = exports.dgs
	local myLabel = DGS:~~dgsDxCreateLabel~~ ( 0.45, 0.48, 0.2, 0.5, "Hello world", true )		local myLabel = DGS:dgsCreateLabel ( 0.45, 0.48, 0.2, 0.5, "Hello world", true )
	DGS:~~dgsDxLabelSetColor~~ ( myLabel, math.random(0, 255), math.random(0, 255), math.random(0, 255), 255 )</syntaxhighlight>		DGS:dgsLabelSetColor ( myLabel, math.random(0, 255), math.random(0, 255), math.random(0, 255), 255 )</syntaxhighlight>

	==Example 2==		==Example 2==
Line 49:		Line 49:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	DGS = exports.dgs		DGS = exports.dgs
	local myLabel = DGS:~~dgsDxCreateLabel~~ ( 0.45, 0.48, 0.2, 0.5, "Hello world", true )		local myLabel = DGS:dgsCreateLabel ( 0.45, 0.48, 0.2, 0.5, "Hello world", true )
	DGS:~~dgsDxLabelSetColor~~ ( myLabel, tocolor(math.random(0, 255), math.random(0, 255), math.random(0, 255), 255 ) ,true )</syntaxhighlight>		DGS:dgsLabelSetColor ( myLabel, tocolor(math.random(0, 255), math.random(0, 255), math.random(0, 255), 255 ) ,true )</syntaxhighlight>

	==See Also==		==See Also==
	{{DGSFUNCTIONS}}		{{DGSFUNCTIONS}}

Thisdp: Thisdp moved page Dgs/DgsDxLabelSetColor to DgsDxLabelSetColor

2017-07-02T02:02:39Z

Thisdp moved page Dgs/DgsDxLabelSetColor to DgsDxLabelSetColor

← Older revision

Revision as of 02:02, 2 July 2017

Thisdp: /* Returns */

2017-06-12T15:59:29Z

Returns

← Older revision		Revision as of 15:59, 12 June 2017
Line 20:		Line 20:
	===Returns===		===Returns===
	<!-- Make this descriptive. Explain what cases will return false. If you're unsure, add a tag to it so we can check -->		<!-- Make this descriptive. Explain what cases will return false. If you're unsure, add a tag to it so we can check -->
	Returns ''true'' if the the color of the ~~gui~~ label was successfully changed, ''false'' otherwise.		Returns ''true'' if the the color of the dgs label was successfully changed, ''false'' otherwise.

	==Syntax 2==		==Syntax 2==

Thisdp: /* Returns */

2017-06-12T15:59:11Z

Returns

← Older revision		Revision as of 15:59, 12 June 2017
Line 36:		Line 36:
	===Returns===		===Returns===
	<!-- Make this descriptive. Explain what cases will return false. If you're unsure, add a tag to it so we can check -->		<!-- Make this descriptive. Explain what cases will return false. If you're unsure, add a tag to it so we can check -->
	Returns ''true'' if the the color of the ~~gui~~ label was successfully changed, ''false'' otherwise.		Returns ''true'' if the the color of the dgs label was successfully changed, ''false'' otherwise.

	==Example 1==		==Example 1==

Thisdp: /* Required Arguments */

2017-06-12T15:58:58Z

Required Arguments

← Older revision		Revision as of 15:58, 12 June 2017
Line 32:		Line 32:
	*'''theElement:''' The label to be changed.		*'''theElement:''' The label to be changed.
	*'''color:''' An integer of the color of the text of the label.		*'''color:''' An integer of the color of the text of the label.
	*'''notSplitColor:''' A bool of whether the color argument is ~~splited~~ or not. '''( This argument must be true if you use this syntax! )'''		*'''notSplitColor:''' A bool of whether the color argument is split or not. '''( This argument must be true if you use this syntax! )'''

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

Thisdp at 15:30, 12 June 2017

2017-06-12T15:30:55Z

← Older revision		Revision as of 15:30, 12 June 2017
Line 2:		Line 2:
	__NOTOC__		__NOTOC__
	<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->		<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->
	This function allows you to set the color of a ~~GUI~~ label.		This function allows you to set the color of a DGS label.

	==Syntax 1==		==Syntax 1==

Thisdp: /* Syntax 1 */

2017-06-12T15:30:27Z

Syntax 1

← Older revision		Revision as of 15:30, 12 June 2017
Line 7:		Line 7:
	<!-- NOTE: don't use 'special' names for variable names, e.g. you shouldn't be writing things like 'player player, vehicle vehicle', instead write something like 'player thePlayer, vehicle vehicleToGetInto'. This is less confusing and prevents the syntax highlighting being odd -->		<!-- NOTE: don't use 'special' names for variable names, e.g. you shouldn't be writing things like 'player player, vehicle vehicle', instead write something like 'player thePlayer, vehicle vehicleToGetInto'. This is less confusing and prevents the syntax highlighting being odd -->
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	bool ~~dgsLabelSetColor~~ ( element theElement, int red, int green, int blue, int alpha )		bool dgsDxLabelSetColor ( element theElement, int red, int green, int blue, int alpha )
	</syntaxhighlight>		</syntaxhighlight>