DgsCreateLabel

2017-09-14T07:30:57Z

Anchor: /* Syntax */

__NOTOC__
{{Client function}}
[[Image:gui-label.png|frame|Example GUI label.]]
<table><tr><td valign=top height=100>
This function is for creating a new DGS label. A label is simply a piece of text that cannot be edited by the user. If you would like to have a bigger text you can either change its size with property "textsize"( dgsDxGUISetProperty(label,"textsize",{scale_x,scale_y}) ) or change its font.
</td></tr></table>
==Syntax==
<syntaxhighlight lang="lua">
element dgsDxCreateLabel ( float x, float y, float width, float height, string text, bool relative, [element parent = nil, int textcolor = 0xFFFFFFFF, float scale_x = 1, float scale_y = 1, float shadowOffset_x = nil, float shadowOffset_y = nil, int shadowColor = nil, string horizontalAlign = "left", string verticalAlign = "top"] )
</syntaxhighlight>

===Required Arguments===
*'''x:''' A float of the 2D x position of the DGS label on a player's screen. This is affected by the ''relative'' argument.
*'''y:''' A float of the 2D y position of the DGS label on a player's screen. This is affected by the ''relative'' argument.
*'''width:''' A float of the width of the GUI label. This is affected by the ''relative'' argument.
*'''height:''' A float of the height of the GUI label. 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===
{{OptionalArg}}
*'''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.
*'''textcolor:''' An int of the color of the text color.
*'''scale_x:''' A float of the width of the text scale.
*'''scale_y:''' A float of the height of the text scale.
*'''shadowOffset_x:''' A float of the 2D x position offset of the shadow text.
*'''shadowOffset_y:''' A float of the 2D y position offset of the shadow text.
*'''shadowColor:''' An int of the color of the shadow text.
*'''horizontalAlign:''' A string of the horizontal alignment of the label.
**"left"
**"center"
**"right"
*'''verticalAlign:''' A string of the vertical alignment of the label.
**"top"
**"center"
**"bottom"
===Returns===
Returns an [[DGS_widgets|element]] of the created label 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 dgs labels to each tab.
<syntaxhighlight lang="lua">
DGS = exports.dgs
local myWindow = DGS:dgsDxCreateWindow ( 0, 0, 0.5, 0.4, "Information", true )--create a window which has "Information" in the title bar.
local tabPanel = DGS:dgsDxCreateTabPanel ( 0, 0.1, 1, 1, true, myWindow ) --create a tab panel which fills the whole window
local tabMap = DGS:dgsDxCreateTab( "Map Information", tabPanel ) -- create a tab named "Map Information" on 'tabPanel'
local tabHelp = DGS:dgsDxCreateTab( "Help", tabPanel ) -- create another tab named "Help" on 'tabPanel'

-- adds a label (text) to each tab
DGS:dgsDxCreateLabel(0.02,0.04,0.94,0.2,"This is information about the current map",true,tabMap)
DGS:dgsDxCreateLabel(0.02,0.04,0.94,0.92,"This is help text.",true,tabHelp)
</syntaxhighlight>

'''Example 2:''' This example creates a label. When an element is clicked, the label displays in the position of the element telling you what kind of element you have clicked. It hides after 5 seconds.
<syntaxhighlight lang="lua">
DGS = exports.dgs
local myLabel = DGS:dgsDxCreateLabel ( 0, 0, 1, 1, "", true )

function addLabelOnClick ( button, state, absoluteX, absoluteY, worldX, worldY, worldZ, clickedElement )
--if an element was clicked on screen
if ( clickedElement ) then
--retreive the element type
local elementType = getElementType ( clickedElement )
--change the label text to that element type
DGS:dgsDxGUISetText ( myLabel, elementType )
--and place it in the position of where the element is
DGS:dgsSetPosition ( myLabel, absoluteX, absoluteY, false )
--hide the text by passing an empty string 5 seconds later
setTimer ( DGS:dgsDxGUISetText, 5000, 1, myLabel, "" )
end
end
addEventHandler ( "onClientClick", getRootElement(), addLabelOnClick )
</syntaxhighlight>

==See Also==
{{DGSFUNCTIONS}}

DgsEditSetMaxLength

2017-09-14T07:19:09Z

Anchor: /* Syntax */

__NOTOC__
{{Client function}}
This function sets the maximum text length that can be typed into an edit box.

==Syntax==
<syntaxhighlight lang="lua">
bool dgsDxEditSetMaxLength ( element Edit, int length )
</syntaxhighlight>

===Required Arguments===

*'''theElement:''' The dgs-dxedit to be changed.
*'''length:''' An integer indicating the maximum number of characters that can be typed into the box.

===Returns===
Returns ''true'' if the max length was set successfully, ''false'' otherwise.

==Example==
DGS = exports.dgs
This example creates an edit box with a limit on text length, 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">
-- create our button
button = DGS:dgsDxCreateButton( 0.7, 0.1, 0.2, 0.1, "Output!", true )
-- create an edit box and define it as "editBox".
editBox = DGS:dgsDxCreateEdit( 0.3, 0.1, 0.4, 0.1, "Type your message here!", true )
-- set a maximum text length of 128 characters
DGS:dgsDxEditSetMaxLength ( editBox, 128 )

</syntaxhighlight>

==See Also==
{{DGSFUNCTIONS}}

Multi Theft Auto: Wiki - User contributions [en]

DgsCreateLabel

DgsEditSetMaxLength