DgsLabelSetColor: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
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}}

Revision as of 11:18, 20 January 2018

This function allows you to set the color of a DGS label.

Syntax 1

bool dgsLabelSetColor ( element theElement, int red, int green, int blue, int alpha )

Required Arguments

  • theElement: The label to be changed.
  • red: An integer specifying the amount of red (0 to 255).
  • green: An integer specifying the amount of green (0 to 255). ( If you pass "true" into this argument, see Syntax 2. )
  • blue: An integer specifying the amount of blue (0 to 255).
  • alpha: An integer specifying the amount of alpha (0 to 255).

Returns

Returns true if the the color of the dgs label was successfully changed, false otherwise.

Syntax 2

bool dgsLabelSetColor ( element theElement, int color, bool notSplitColor )

Required Arguments

  • theElement: The label to be changed.
  • color: An integer of the color of the text of the label.
  • notSplitColor: A bool of whether the color argument is split or not. ( This argument must be true if you use this syntax! )

Returns

Returns true if the the color of the dgs label was successfully changed, false otherwise.

Example 1

This example creates a label with text "Hello World!" and sets it to a random color.

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 )

Example 2

This example creates a label with text "Hello World!" and sets it to a random color.

DGS = exports.dgs
local myLabel = DGS:dgsCreateLabel ( 0.45, 0.48, 0.2, 0.5, "Hello world", true )
DGS:dgsLabelSetColor ( myLabel, tocolor(math.random(0, 255), math.random(0, 255), math.random(0, 255), 255 ) ,true )

See Also

Custom Cursor Functions

Multi Language Supports

Animation

3D Element

3D Interface

3D Line

3D Image

3D Text

Browser

Button

Check Box

Combo Box

Custom Renderer

Edit

Detect Area

Drag'N Drop

Grid List

Image

Memo

Menu

Label

Layout

Line

Progress Bar

Radio Button

Scale Pane

Scroll Bar

Scroll Pane

Selector

Style

Switch Button

Tab Panel

Window

Basic Shape Plugins

Circle

Quadrilateral

Rounded Rectangle

Other Plugins

Blur Box

Canvas

Chart

Color Picker

Effect 3D

Gradient

Mask

Media Browser

Nine Slice

Object Preview Supports

Paste Handler

QRCode

Remote Image

Screen Source

SVG

Tooltips