DgsColorPickerGetColor: Difference between revisions

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


Line 14: Line 14:
*'''colorType:''' The color type. Available values are as follows:
*'''colorType:''' The color type. Available values are as follows:
**'''RGB''':
**'''RGB''':
***'''color1:''' A number ranges from 0 to 255, indicates the R (red) value of the color.
***''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.
***''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.
***''color3:'' A number ranges from 0 to 255, indicates the B (blue) value of the color.
**'''HSL''':
**'''HSL''':
***'''color1:''' A number ranges from 0 to 360, indicates the H (hue) value of the color.
***''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.
***''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.
***''color3:'' A number ranges from 0 to 100, indicates the L (lightness) value of the color.
**'''HSV''':
**'''HSV''':
***'''color1:''' A number ranges from 0 to 360, indicates the H (hue) value of the color.
***''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.
***''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.
***''color3:'' A number ranges from 0 to 100, indicates the V (value) value of the color.


===Returns===
===Returns===
Returns 3 ''integer'' depends on color type if successful, false otherwise.
Returns four ''integer''s depends on color type if successful, false otherwise.


==Example==  
==Example==  
Line 34: Line 34:


local cp = DGS:dgsCreateColorPicker("HSVRing",50,50,300,300,false)
local cp = DGS:dgsCreateColorPicker("HSVRing",50,50,300,300,false)
local H,S,L = DGS:dgsColorPickerGetColor(cp,"HSL")
--Alpha remains in any color type
outputChatBox("H:"..H..";S:"..S..";V:"..V)
local H,S,L,A = DGS:dgsColorPickerGetColor(cp,"HSL")
local R,G,B = DGS:dgsColorPickerGetColor(cp,"RGB")
outputChatBox("H:"..H..";S:"..S..";V:"..V..";A:"..A)
outputChatBox("R:"..R..";G:"..G..";B:"..B)
local R,G,B,A = DGS:dgsColorPickerGetColor(cp,"RGB")
outputChatBox("R:"..R..";G:"..G..";B:"..B..";A:"..A)
</syntaxhighlight>
</syntaxhighlight>


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

Latest revision as of 09:37, 26 July 2019

This function gets the color from the color picker.

Syntax

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

Required Arguments

  • colorPicker: The color picker you want to set.

Optional Arguments

  • 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 four integers depends on color type if successful, false otherwise.

Example

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

local cp = DGS:dgsCreateColorPicker("HSVRing",50,50,300,300,false)
--Alpha remains in any color type
local H,S,L,A = DGS:dgsColorPickerGetColor(cp,"HSL")
outputChatBox("H:"..H..";S:"..S..";V:"..V..";A:"..A)
local R,G,B,A = DGS:dgsColorPickerGetColor(cp,"RGB")
outputChatBox("R:"..R..";G:"..G..";B:"..B..";A:"..A)

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/DgsColorPickerGetColor?oldid=63453"