DgsGetText: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Created page with "{{Client function}} __NOTOC__ <!-- Describe in plain english what this function does. Don't go into details, just give an overview --> This function is used to get the text of...")
 
m (DGS OOP Syntax changing)
 
(3 intermediate revisions by 2 users not shown)
Line 7: Line 7:
<!-- NOTE: don't use 'special' names for variable names, e.g. you shouldn't be writing things like 'player player, vehicle vehicle', instead write something like 'player thePlayer, vehicle vehicleToGetInto'. This is less confusing and prevents the syntax highlighting being odd -->
<!-- NOTE: don't use 'special' names for variable names, e.g. you shouldn't be writing things like 'player player, vehicle vehicle', instead write something like 'player thePlayer, vehicle vehicleToGetInto'. This is less confusing and prevents the syntax highlighting being odd -->
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
string dgsDxGUIGetText ( element guiElement )
string dgsGetText ( element guiElement )
</syntaxhighlight>
</syntaxhighlight>
{{DGS/OOP|
    Method = DGSElement:getText|
    Variable = text|
    Counterpart = dgsSetText
}}


===Required Arguments===  
===Required Arguments===  
Line 25: Line 30:
DGS = exports.dgs
DGS = exports.dgs
-- We create a dummy dgs label to get text of
-- We create a dummy dgs label to get text of
local dummyGUIElement = DGS:dgsDxCreateLabel ( 0.45, 0.48, 0.10, 0.04, "Hello world", true )
local dummyGUIElement = DGS:dgsCreateLabel ( 0.45, 0.48, 0.10, 0.04, "Hello world", true )
-- Output the text of the label to chat box
-- Output the text of the label to chat box
outputChatBox ( "Text in the DGS label: " .. DGS:dgsDxGUIGetText ( dummyGUIElement ) )
outputChatBox ( "Text in the DGS label: " .. DGS:dgsGetText ( dummyGUIElement ) )
</syntaxhighlight>
</syntaxhighlight>


==See Also==
=See Also=
<!-- Change FunctionArea to the area that this function is in on the main function list page, e.g. Server, Player, Vehicle etc -->
<!-- Change FunctionArea to the area that this function is in on the main function list page, e.g. Server, Player, Vehicle etc -->
{{DGSFUNCTIONS}}
==<span style="color:#eb3f00;text-shadow:0.05em 0.05em 0.2em #00000099;">General Functions</span>==
{{DGS General Functions}}
 
==<span style="color:#eb3f00;text-shadow:0.05em 0.05em 0.2em #00000099;">General Events</span>==
{{DGS Events/General}}

Latest revision as of 21:25, 3 May 2021

This function is used to get the text of DGS elements like edit boxes, labels, buttons etc.

Syntax

string dgsGetText ( element guiElement )

DGS OOP Syntax Help! I don't understand this!

Method: DGSElement:getText(...)
Variable: .text
Counterpart: dgsSetText

Required Arguments

  • guiElement: element you wish to get text of.

Returns

Returns a string containing the requested element's text, or false if the dgs element passed to the function is invalid.

Example

This example gets the text of a pre-made dgs element and outputs it to chat box. 

DGS = exports.dgs
-- We create a dummy dgs label to get text of
local dummyGUIElement = DGS:dgsCreateLabel ( 0.45, 0.48, 0.10, 0.04, "Hello world", true )
-- Output the text of the label to chat box
outputChatBox ( "Text in the DGS label: " .. DGS:dgsGetText ( dummyGUIElement ) )

See Also

General Functions

General Events

Retrieved from "https://wiki.multitheftauto.com/wiki/DgsGetText?oldid=71003"