DgsColorPickerCreateComponentSelector: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Created page with "__NOTOC__ {{Client function}} <span style="color:#FF0000;text-shadow:black 0.1em 0.1em 0.2em;">>>>Warning: This feature requires pixel shader model 2_a<<<</span> This functi...")
 
 
(2 intermediate revisions by the same user not shown)
Line 10: Line 10:
</syntaxhighlight>  
</syntaxhighlight>  


[[Image:DGS_ComponentSelector.png|200px|thumb|Component Selector in different color type and color attribute]]
[[Image:DGS_ComponentSelector.png|400px|thumb|Component Selector in different color type and color attribute]]
===Required Arguments===
===Required Arguments===
*'''style:''' A string indicates the style of the color picker. Available styles are as follows:
*'''x:''' A float of the 2D x position of the DGS Component Selector on a player's screen.  This is affected by the ''relative'' argument.
**'''HSVRing''' : In order to get a best effect, please make width and height remain the same absolute pixels.
*'''y:''' A float of the 2D y position of the DGS Component Selector on a player's screen. This is affected by the ''relative'' argument.
**'''HSLSquare'''
*'''width:''' A float of the width of the DGS Component Selector. This is affected by the ''relative'' argument.
*'''x:''' A float of the 2D x position of the DGS Color Picker on a player's screen.  This is affected by the ''relative'' argument.
*'''height:''' A float of the height of the DGS Component Selector. This is affected by the ''relative'' argument. Note: height must be enough to fit the drop down menu, else the drop down won't appear.
*'''y:''' A float of the 2D y position of the DGS Color Picker on a player's screen. This is affected by the ''relative'' argument.
*'''isHorizontal:''' A bool of whether the DGS Component Selector is horizontal or vertical.
*'''width:''' A float of the width of the DGS Color Picker. This is affected by the ''relative'' argument.
*'''height:''' A float of the height of the DGS Color Picker. This is affected by the ''relative'' argument. Note: height must be enough to fit the drop down menu, else the drop down won't appear.
*'''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.
===Optional Arguments===
===Optional Arguments===
*'''parent:''' This is the parent that the DGS Color Picker is attached to.
*'''parent:''' This is the parent that the DGS Component Selector is attached to.


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


==Example==  
==Example==  
Line 30: Line 28:
DGS = exports.dgs --get exported functions from dgs
DGS = exports.dgs --get exported functions from dgs


local cp1 = DGS:dgsCreateColorPicker("HSVRing",50,50,300,300,false)
local cp = DGS:dgsCreateColorPicker("HSLSquare",50,50,300,300,false)
local cp2 = DGS:dgsCreateColorPicker("HSLSquare",400,50,300,300,false)
local Aedit = DGS:dgsColorPickerCreateComponentSelector(400,170,100,30,true,false)
DGS:dgsBindToColorPicker(Aedit,cp,"RGB","A") --Alpha doesn't request a specific color type. So it remains in any color type.
 
--Dynamic Background Component Selector
local Hedit1 = DGS:dgsColorPickerCreateComponentSelector(400,50,100,30,true,false)
local Sedit1 = DGS:dgsColorPickerCreateComponentSelector(400,90,100,30,true,false)
local Ledit1 = DGS:dgsColorPickerCreateComponentSelector(400,130,100,30,true,false)
DGS:dgsBindToColorPicker(Hedit1,cp,"HSL","H")
DGS:dgsBindToColorPicker(Sedit1,cp,"HSL","S")
DGS:dgsBindToColorPicker(Ledit1,cp,"HSL","L")
</syntaxhighlight>
</syntaxhighlight>


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

Latest revision as of 07:41, 4 October 2019

>>>Warning: This feature requires pixel shader model 2_a<<<

This function creates a dgs color picker component selector.

Syntax

element dgsColorPickerCreateComponentSelector( float x, float y, float w, float h, bool isHorizontal, bool relative [, element parent ] )
Component Selector in different color type and color attribute

Required Arguments

  • x: A float of the 2D x position of the DGS Component Selector on a player's screen. This is affected by the relative argument.
  • y: A float of the 2D y position of the DGS Component Selector on a player's screen. This is affected by the relative argument.
  • width: A float of the width of the DGS Component Selector. This is affected by the relative argument.
  • height: A float of the height of the DGS Component Selector. This is affected by the relative argument. Note: height must be enough to fit the drop down menu, else the drop down won't appear.
  • isHorizontal: A bool of whether the DGS Component Selector is horizontal or vertical.
  • 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.

Optional Arguments

  • parent: This is the parent that the DGS Component Selector is attached to.

Returns

Returns a dgs-dximage (Plugin Type: dgs-dxcomponentselector) if successful, false otherwise.

Example

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

local cp = DGS:dgsCreateColorPicker("HSLSquare",50,50,300,300,false)
local Aedit = DGS:dgsColorPickerCreateComponentSelector(400,170,100,30,true,false)
DGS:dgsBindToColorPicker(Aedit,cp,"RGB","A") --Alpha doesn't request a specific color type. So it remains in any color type.

--Dynamic Background Component Selector
local Hedit1 = DGS:dgsColorPickerCreateComponentSelector(400,50,100,30,true,false)
local Sedit1 = DGS:dgsColorPickerCreateComponentSelector(400,90,100,30,true,false)
local Ledit1 = DGS:dgsColorPickerCreateComponentSelector(400,130,100,30,true,false)
DGS:dgsBindToColorPicker(Hedit1,cp,"HSL","H")
DGS:dgsBindToColorPicker(Sedit1,cp,"HSL","S")
DGS:dgsBindToColorPicker(Ledit1,cp,"HSL","L")

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