DgsColorPickerSetColor: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Created page with "__NOTOC__ {{Client function}} This function sets the color of the color picker. ==Syntax== <syntaxhighlight lang="lua"> element dgsColorPickerSetColor( element colorPicker...")
 
 
(6 intermediate revisions by the same user not shown)
Line 6: Line 6:
==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
element dgsColorPickerSetColor( element colorPicker [, float color1, float color2, float color3, float alpha, string colorType = "RGB" ] )
bool dgsColorPickerSetColor( element colorPicker [, int color1, int color2, int color3, int alpha, string colorType = "RGB" ] )
</syntaxhighlight>  
</syntaxhighlight>  


Line 18: Line 18:
*'''colorType:''' The color type. Available values are as follows:
*'''colorType:''' The color type. Available values are as follows:
**'''RGB''':
**'''RGB''':
***'''color1:'''
***''color1:'' A number ranges from 0 to 255, indicates the R (red) value of the color.
**'''HSL'''
***''color2:'' A number ranges from 0 to 255, indicates the G (green) value of the color.
**'''HSV'''
***''color3:'' A number ranges from 0 to 255, indicates the B (blue) value of the color.
**'''HSL''':
***''color1:'' A number ranges from 0 to 360, indicates the H (hue) value of the color.
***''color2:'' A number ranges from 0 to 100, indicates the S (saturation) value of the color.
***''color3:'' A number ranges from 0 to 100, indicates the L (lightness) value of the color.
**'''HSV''':
***''color1:'' A number ranges from 0 to 360, indicates the H (hue) value of the color.
***''color2:'' A number ranges from 0 to 100, indicates the S (saturation) value of the color.
***''color3:'' A number ranges from 0 to 100, indicates the V (value) value of the color.


===Returns===
===Returns===
Returns a dgs-dximage (Plugin Type: dgs-dxcolorpicker) if successful, false otherwise.
Returns ''true'' if successful, false otherwise.


==Example==  
==Example==  
Line 29: Line 37:
DGS = exports.dgs --get exported functions from dgs
DGS = exports.dgs --get exported functions from dgs


local cp1 = dgsCreateColorPicker("HSVRing",50,50,300,300,false)
local cp = DGS:dgsCreateColorPicker("HSVRing",50,50,300,300,false)
local cp2 = dgsCreateColorPicker("HSLSquare",400,50,300,300,false)
DGS:dgsColorPickerSetColor(cp,20,50,50,255,"HSV")
</syntaxhighlight>
</syntaxhighlight>


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

Latest revision as of 07:26, 4 October 2019

This function sets the color of the color picker.

Syntax

bool dgsColorPickerSetColor( element colorPicker [, int color1, int color2, int color3, int alpha, string colorType = "RGB" ] )

Required Arguments

  • colorPicker: The color picker you want to set.

Optional Arguments

  • color1: This is the first color argument, depends on "colorType"
  • color2: This is the second color argument, depends on "colorType"
  • color3: This is the third color argument, depends on "colorType"
  • alpha: This is the alpha color argument, doesn't depend on "colorType"
  • colorType: The color type. Available values are as follows:
    • RGB:
      • color1: A number ranges from 0 to 255, indicates the R (red) value of the color.
      • color2: A number ranges from 0 to 255, indicates the G (green) value of the color.
      • color3: A number ranges from 0 to 255, indicates the B (blue) value of the color.
    • HSL:
      • color1: A number ranges from 0 to 360, indicates the H (hue) value of the color.
      • color2: A number ranges from 0 to 100, indicates the S (saturation) value of the color.
      • color3: A number ranges from 0 to 100, indicates the L (lightness) value of the color.
    • HSV:
      • color1: A number ranges from 0 to 360, indicates the H (hue) value of the color.
      • color2: A number ranges from 0 to 100, indicates the S (saturation) value of the color.
      • color3: A number ranges from 0 to 100, indicates the V (value) value of the color.

Returns

Returns true if successful, false otherwise.

Example

DGS = exports.dgs --get exported functions from dgs

local cp = DGS:dgsCreateColorPicker("HSVRing",50,50,300,300,false)
DGS:dgsColorPickerSetColor(cp,20,50,50,255,"HSV")

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

Retrieved from "https://wiki.multitheftauto.com/wiki/DgsColorPickerSetColor?oldid=64477"