DgsCreateCmd: Difference between revisions

Latest revision as of 11:23, 20 January 2018

This function is for creating a DGS Command which likes the one in windows. Players can execute functions or events in cmd.

Syntax

element dgsCreateCmd ( float x, float y, float w, float h, bool relative [, element parent = nil, float scalex = 1, float scaley = 1, float lineSpace = 20, element bgimg = nil, int bgcolor = 0x96000000 ] )

Example DGS Cmd.

Required Arguments

x: A float of the 2D x position of the DGS cmd on a player's screen. This is affected by the relative argument.
y: A float of the 2D y position of the DGS cmd on a player's screen. This is affected by the relative argument.
width: A float of the width of the DGS cmd. This is affected by the relative argument.
height: A float of the height of the DGS cmd. This is affected by the relative argument.
text: A string of the text that will be displayed by the label.
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

NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use. For more information on optional arguments, see optional arguments.

parent: This is the parent that the gui label 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.
scalex: A float of the width ratio of the text of the cmd.
scaley: A float of the height ratio of the text of the cmd.
lineSpace: A float of the pixels between two lines of the cmd.
bgimg: An image element of the background of the cmd.
bgcolor: An integer of the color of the background of the cmd.

Returns

Returns an element of the created cmd if it was successfully created, false otherwise.

Example

DGS = exports.dgs

myWindow = DGS:dgsCreateWindow(0.25,0.25,0.5,0.5,"CMD",true)
myCmd = DGS:dgsCreateCmd(0,0,1,1,true,myWindow )

Custom Cursor Functions

Multi Language Supports

Animation

3D Element

3D Interface

3D Line

3D Image

3D Text

Browser

dgsCreateBrowser

Button

Check Box

Combo Box

Custom Renderer

Edit

Detect Area

Drag'N Drop

Grid List

Image

Memo

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

dgsCreateCanvas

Chart

Color Picker

Effect 3D

Gradient

Mask

Media Browser

Nine Slice

Object Preview Supports

Paste Handler

QRCode

Remote Image

Screen Source

SVG

Tooltips

@@ Line 1: / Line 1: @@
 __NOTOC__
 {{Client function}}
-[[Image:gui-label.png|frame|Example GUI label.]]
 This function is for creating a DGS Command which likes the one in windows. Players can execute functions or events in cmd.
 ==Syntax==
 <syntaxhighlight lang="lua">
-element dgsDxCreateCmd ( float x, float y, float w, float h, bool relative [, element parent = nil, float scalex = 1, float scaley = 1, float lineSpace = 20, element bgimg = nil, int bgcolor = 0x96000000 ] )
+element dgsCreateCmd ( float x, float y, float w, float h, bool relative [, element parent = nil, float scalex = 1, float scaley = 1, float lineSpace = 20, element bgimg = nil, int bgcolor = 0x96000000 ] )
 </syntaxhighlight>
+[[Image:Dx_7.PNG|frame|Example DGS Cmd.]]
 ===Required Arguments===
@@ Line 30: / Line 29: @@
 Returns an element of the created cmd if it was successfully created, false otherwise.
 ==Example==
-'''Example 1:''' This example creates a information window and adds two tabs to a "tabPanel" tabpanel, and adds some gui labels to each tab.
 <syntaxhighlight lang="lua">
 DGS = exports.dgs
-myWindow = DGS:dgsDxCreateWindow(0.25,0.25,0.5,0.5,"CMD",true)
+myWindow = DGS:dgsCreateWindow(0.25,0.25,0.5,0.5,"CMD",true)
-myCmd = dgsDxCreateCmd(0,0,1,1,true,myWindow )
+myCmd = DGS:dgsCreateCmd(0,0,1,1,true,myWindow )
 </syntaxhighlight>
 ==See Also==
 {{DGSFUNCTIONS}}