DgsCreateButton: Difference between revisions

Latest revision as of 14:01, 16 February 2021

This function allows creation of a DGS Button, which is a clickable item as part of GUI.

Notice: This is a function exported by DGS!

Syntax

element dgsCreateButton ( float x, float y, float width, float height, string text, bool relative [, element parent = nil, int textColor = 0xFFFFFFFF, float scaleX = 1, float scaleY = 1, element normalImage = nil, element hoveringImage = nil, element clickedImage = nil, int normalColor = 0xC80078C8, int hoveringColor = 0xC8005AFF, int clickedColor = 0xC8325A] )

Required Arguments

DGS Button

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

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 DGS button 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 button.
scaleX: A float of the 2D x scale of the text of the button.
scaleY: A float of the 2D y scale of the text of the button.
normalImage: A texture element of the background of the button ( no mouse enter and no mouse click ).
hoveringImage: A texture element of the background of the button which is selected.
clickedImage: A texture element of the background of the button which is clicked.
normalColor: An int of the color of the background of the button ( no mouse enter and no mouse click ).
hoveringColor: An int of the color of the background of the button which is selected.
clickedColor: An int of the color of the background of the button which is clicked.

Returns

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

Example

This example creates an edit box alongside an "Output!" button. When the button is clicked, it will output the message in the edit box into the Chat Box.

DGS = exports.dgs
--create our button
button = DGS:dgsCreateButton( 0.7, 0.1, 0.2, 0.1, "Output!", true )
--Create an edit box and define it as "editBox".
editBox = DGS:dgsCreateEdit( 0.3, 0.1, 0.4, 0.1, "Type your message here!", true )
-- and attach our button to the outputEditBox function
addEventHandler ( "onDgsMouseClick", editBox, outputEditBox )

--setup our function to output the message to the chatbox
function outputEditBox ()
        local text = DGS :dgsGetText ( editBox )--get the text from the edit box
        outputChatBox ( text ) --output that text
end
addEventHandler ( "onDgsMouseClick", button, outputEditBox )

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: @@
-#REDIRECT [[Dgs/DgsDxCreateButton]]
+__NOTOC__
+{{Client function}}
+This function allows creation of a DGS Button, which is a clickable item as part of GUI.
+'''Notice: This is a function exported by DGS!'''
+==Syntax==
+<syntaxhighlight lang="lua">
+element dgsCreateButton ( float x, float y, float width, float height, string text, bool relative [, element parent = nil, int textColor = 0xFFFFFFFF, float scaleX = 1, float scaleY = 1, element normalImage = nil, element hoveringImage = nil, element clickedImage = nil, int normalColor = 0xC80078C8, int hoveringColor = 0xC8005AFF, int clickedColor = 0xC8325A] )
+</syntaxhighlight>
+===Required Arguments===
+[[Image:DGS_Button.png|thumb|DGS Button]]
+*'''x:''' A float of the 2D x position of the button on a player's screen.  This is affected by the ''relative'' argument.
+*'''y:''' A float of the 2D y position of the button on a player's screen. This is affected by the ''relative'' argument.
+*'''width:''' A float of the width of the button. This is affected by the ''relative'' argument.
+*'''height:''' A float of the height of the button. This is affected by the ''relative'' argument.
+*'''text:''' A string of the text that will be displayed as a label on the button.
+*'''relative:''' 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.
+===Optional Arguments===
+{{OptionalArg}}
+*'''parent:''' This is the parent that the DGS button 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 button.
+*'''scaleX:''' A float of the 2D x scale of the text of the button.
+*'''scaleY:''' A float of the 2D y scale of the text of the button.
+*'''normalImage:''' A texture element of the background of the button ( no mouse enter and no mouse click ).
+*'''hoveringImage:''' A texture element of the background of the button which is selected.
+*'''clickedImage:''' A texture element of the background of the button which is clicked.
+*'''normalColor:''' An int of the color of the background of the button ( no mouse enter and no mouse click ).
+*'''hoveringColor:''' An int of the color of the background of the button which is selected.
+*'''clickedColor:''' An int of the color of the background of the button which is clicked.
+===Returns===
+Returns an [[element]] of the created [[Element/DGS/Button|button]] if it was successfully created, false otherwise.
+==Example==
+This example creates an edit box alongside an "Output!" button.  When the button is clicked, it will output the message in the edit box into the Chat Box.
+<syntaxhighlight lang="lua">
+DGS = exports.dgs
+--create our button
+button = DGS:dgsCreateButton( 0.7, 0.1, 0.2, 0.1, "Output!", true )
+--Create an edit box and define it as "editBox".
+editBox = DGS:dgsCreateEdit( 0.3, 0.1, 0.4, 0.1, "Type your message here!", true )
+-- and attach our button to the outputEditBox function
+addEventHandler ( "onDgsMouseClick", editBox, outputEditBox )
+--setup our function to output the message to the chatbox
+function outputEditBox ()
+        local text = DGS :dgsGetText ( editBox )--get the text from the edit box
+        outputChatBox ( text ) --output that text
+end
+addEventHandler ( "onDgsMouseClick", button, outputEditBox )
+</syntaxhighlight>
+==See Also==
+{{DGSFUNCTIONS}}
+[[ZH-CN:dgsCreateButton]]