DgsCreateSelector: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Created page with "{{Client function}} __NOTOC__ This function allows creation of a DGS Selector. ==Syntax== <syntaxhighlight lang="lua"> element dgsCreateSelector( float x, float y,float sx,...")
 
No edit summary
Line 5: Line 5:
==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
element dgsCreateSelector( float x, float y,float sx, float sy, bool relative, element parent,int textColor, float scalex, float scaley, float shadowoffsetx, float shadowoffsety, int shadowcolor)
element dgsCreateSelector( float x, float y, float width, float height, bool relative [, element parent = nil, int textColor = 0xFFFFFFFF, float scaleX = 1, float scaleY = 1, float shadowOffsetX = nil, float shadowOffsetY = nil, int shadowColor = nil ] )
</syntaxhighlight>
</syntaxhighlight>


Line 11: Line 11:
*'''x:''' A float of the 2D x position of the DGS selector on a player's screen.  This is affected by the ''relative'' argument.
*'''x:''' A float of the 2D x position of the DGS selector on a player's screen.  This is affected by the ''relative'' argument.
*'''y:''' A float of the 2D y position of the DGS selector on a player's screen. This is affected by the ''relative'' argument.
*'''y:''' A float of the 2D y position of the DGS selector on a player's screen. This is affected by the ''relative'' argument.
*'''sx:''' A float of the width of the DGS selector. This is affected by the ''relative'' argument.
*'''width:''' A float of the width of the DGS selector. This is affected by the ''relative'' argument.
*'''sy:''' A float of the height of the DGS selector. This is affected by the ''relative'' argument.
*'''height:''' A float of the height of the DGS selector. This is affected by the ''relative'' argument.


===Optional Arguments===
===Optional Arguments===
Line 18: Line 18:
*'''parent:''' This is the parent that the DGS selector is attached to. If the relative argument is true, sizes and positioning will be made relative to this parent. If the relative argument is false, positioning will be the number of offset pixels from the parent's origin. If no parent is passed, the parent will become the screen - causing positioning and sizing according to screen positioning.
*'''parent:''' This is the parent that the DGS selector is attached to. If the relative argument is true, sizes and positioning will be made relative to this parent. If the relative argument is false, positioning will be the number of offset pixels from the parent's origin. If no parent is passed, the parent will become the screen - causing positioning and sizing according to screen positioning.
*'''textColor:''' An int of the text color of the text.
*'''textColor:''' An int of the text color of the text.
*'''scalex:''' A float of the 2D x scale of the text of the selector.
*'''scaleX:''' A float of the 2D x scale of the text of the selector.
*'''scaley:''' A float of the 2D y scale of the text of the selector.
*'''scaleY:''' A float of the 2D y scale of the text of the selector.
*'''shadowoffsetx:''' A float of the shadow 2D x offset.
*'''shadowOffsetX:''' A float of the shadow 2D x offset.
*'''shadowoffsety:''' A float of the shadow 2D y offset.
*'''shadowOffsetY:''' A float of the shadow 2D y offset.
*'''shadowcolor:''' An int of the shadow color of the text.
*'''shadowColor:''' An int of the shadow color of the text.


==Example==
==Example==

Revision as of 12:34, 9 February 2021

This function allows creation of a DGS Selector.

Syntax

element dgsCreateSelector( float x, float y, float width, float height, bool relative [, element parent = nil, int textColor = 0xFFFFFFFF, float scaleX = 1, float scaleY = 1, float shadowOffsetX = nil, float shadowOffsetY = nil, int shadowColor = nil ] )

Required Arguments

  • x: A float of the 2D x position of the DGS selector on a player's screen. This is affected by the relative argument.
  • y: A float of the 2D y position of the DGS selector on a player's screen. This is affected by the relative argument.
  • width: A float of the width of the DGS selector. This is affected by the relative argument.
  • height: A float of the height of the DGS selector. This is affected by the relative argument.

Optional Arguments

  • realtive: This is whether sizes and positioning are relative. If this is true, then all x, y, width and height floats must be between 0 and 1, representing sizes relative to the parent.
  • parent: This is the parent that the DGS selector is attached to. If the relative argument is true, sizes and positioning will be made relative to this parent. If the relative argument is false, positioning will be the number of offset pixels from the parent's origin. If no parent is passed, the parent will become the screen - causing positioning and sizing according to screen positioning.
  • textColor: An int of the text color of the text.
  • scaleX: A float of the 2D x scale of the text of the selector.
  • scaleY: A float of the 2D y scale of the text of the selector.
  • shadowOffsetX: A float of the shadow 2D x offset.
  • shadowOffsetY: A float of the shadow 2D y offset.
  • shadowColor: An int of the shadow color of the text.

Example

This example creates a selector on the screen. 

DGS = exports.dgs 
addEventHandler("onClientResourceStart", resourceRoot, function()
    local selector = DGS:dgsCreateSelector(0, 100, 300, 100)
    DGS:dgsCenterElement(selector)
    showCursor(true) 
end)

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/DgsCreateSelector?oldid=68860"