DgsCreateLabel: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(update arguments names)
 
(9 intermediate revisions by 3 users not shown)
Line 1: Line 1:
__NOTOC__
{{Client function}}
{{Client function}}
[[Image:gui-label.png|frame|Example GUI label.]]
__NOTOC__
<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.
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>
If you would like to have a bigger text you can either change its size with property "textsize":
<syntaxhighlight lang="lua">
dgsSetProperty(label,"textSize",{scaleX,scaleY})
</syntaxhighlight>
or change its font.
==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<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"] )
element dgsCreateLabel ( float x, float y, float width, float height, string text, bool relative [, element parent = nil, int textColor = 0xFFFFFFFF, float scaleX = 1, float scaleY = 1, float shadowOffsetX = nil, float shadowOffsetY = nil, int shadowColor = nil, string horizontalAlign = "left", string verticalAlign = "top"] )
</syntaxhighlight>  
</syntaxhighlight>  


===Required Arguments===  
===Required Arguments===  
[[Image:Tab.PNG |400px|thumb|right|Example tab panel and label .]]
*'''x:''' A float of the 2D x position of the DGS label on a player's screen.  This is affected by the ''relative'' argument.
*'''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.
*'''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.
*'''width:''' A float of the width of the DGS 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.
*'''height:''' A float of the height of the DGS label. This is affected by the ''relative'' argument.
*'''text:''' A string of the text that will be displayed by the label.
*'''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.
*'''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.
Line 21: Line 25:
{{OptionalArg}}  
{{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.
*'''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.
*'''textColor:''' An int of the color of the text color.
*'''scale_x:''' A float of the width of the text scale.
*'''scaleX:''' A float of the width of the text scale.
*'''scale_y:''' A float of the height of the text scale.
*'''scaleY:''' A float of the height of the text scale.
*'''shadowOffset_x:''' A float of the 2D x position offset of the shadow text.  
*'''shadowOffsetX:''' 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.
*'''shadowOffsetY:''' A float of the 2D y position offset of the shadow text.
*'''shadowColor:''' An int of the color of the shadow text.
*'''shadowColor:''' An int of the color of the shadow text.
*'''horizontalAlign:''' A string of the horizontal alignment of the label.
*'''horizontalAlign:''' A string of the horizontal alignment of the label.
Line 42: Line 46:
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
DGS = exports.dgs
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 myWindow = DGS:dgsCreateWindow ( 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 tabPanel = DGS:dgsCreateTabPanel ( 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 tabMap = DGS:dgsCreateTab( "Map Information", tabPanel ) -- create a tab named "Map Information" on 'tabPanel'
local tabHelp = DGS:dgsDxCreateTab( "Help", tabPanel ) -- create another tab named "Help" on 'tabPanel'
local tabHelp = DGS:dgsCreateTab( "Help", tabPanel ) -- create another tab named "Help" on 'tabPanel'


-- adds a label (text) to each tab
-- 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:dgsCreateLabel(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)
DGS:dgsCreateLabel(0.02,0.04,0.94,0.92,"This is help text.",true,tabHelp)
</syntaxhighlight>
</syntaxhighlight>


Line 55: Line 59:
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
DGS = exports.dgs
DGS = exports.dgs
local myLabel = DGS:dgsDxCreateLabel ( 0, 0, 1, 1, "", true )
local myLabel = DGS:dgsCreateLabel ( 0, 0, 1, 1, "", true )


function addLabelOnClick ( button, state, absoluteX, absoluteY, worldX, worldY, worldZ, clickedElement )
function addLabelOnClick ( button, state, absoluteX, absoluteY, worldX, worldY, worldZ, clickedElement )
Line 63: Line 67:
                 local elementType = getElementType ( clickedElement )
                 local elementType = getElementType ( clickedElement )
                 --change the label text to that element type
                 --change the label text to that element type
                 DGS:dgsDxGUISetText ( myLabel, elementType )
                 DGS:dgsSetText ( myLabel, elementType )
                 --and place it in the position of where the element is
                 --and place it in the position of where the element is
                 DGS:dgsSetPosition ( myLabel, absoluteX, absoluteY, false )
                 DGS:dgsSetPosition ( myLabel, absoluteX, absoluteY, false )
                 --hide the text by passing an empty string 5 seconds later
                 --hide the text by passing an empty string 5 seconds later
                 setTimer ( DGS:dgsDxGUISetText, 5000, 1, myLabel, "" )
                 setTimer ( DGS:dgsSetText, 5000, 1, myLabel, "" )
         end
         end
end
end

Latest revision as of 12:09, 16 February 2021

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": 

dgsSetProperty(label,"textSize",{scaleX,scaleY})

or change its font.

Syntax

element dgsCreateLabel ( float x, float y, float width, float height, string text, bool relative [, element parent = nil, int textColor = 0xFFFFFFFF, float scaleX = 1, float scaleY = 1, float shadowOffsetX = nil, float shadowOffsetY = nil, int shadowColor = nil, string horizontalAlign = "left", string verticalAlign = "top"] )

Required Arguments

Example tab panel and label .
  • 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 DGS label. This is affected by the relative argument.
  • height: A float of the height of the DGS 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

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.
  • textColor: An int of the color of the text color.
  • scaleX: A float of the width of the text scale.
  • scaleY: A float of the height of the text scale.
  • shadowOffsetX: A float of the 2D x position offset of the shadow text.
  • shadowOffsetY: 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 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. 

DGS = exports.dgs
local myWindow = DGS:dgsCreateWindow ( 0, 0, 0.5, 0.4, "Information", true )--create a window which has "Information" in the title bar.
local tabPanel = DGS:dgsCreateTabPanel ( 0, 0.1, 1, 1, true, myWindow ) --create a tab panel which fills the whole window
local tabMap = DGS:dgsCreateTab( "Map Information", tabPanel ) -- create a tab named "Map Information" on 'tabPanel'
local tabHelp = DGS:dgsCreateTab( "Help", tabPanel ) -- create another tab named "Help" on 'tabPanel'

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

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. 

DGS = exports.dgs
local myLabel = DGS:dgsCreateLabel  ( 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:dgsSetText ( 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:dgsSetText, 5000, 1, myLabel, "" )
        end
end
addEventHandler ( "onClientClick", getRootElement(), addLabelOnClick )

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/DgsCreateLabel?oldid=69013"