DgsSetProperty: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
m (DGS OOP Syntax changing)
 
(9 intermediate revisions by 2 users not shown)
Line 2: Line 2:
__NOTOC__
__NOTOC__
This function sets the value of a specific property of a DGS element. For a list of properties and their meaning, see the [[template:DGSPROPERTIES | DGS properties page]].
This function sets the value of a specific property of a DGS element. For a list of properties and their meaning, see the [[template:DGSPROPERTIES | DGS properties page]].
'Note:' If you push a value improperly, errors or warnings will occur, which may cause lag and debug info spamming.
 
'''Note: If you push a value improperly, errors or warnings will occur, which may cause lag and debug info spamming.'''


==Syntax==
==Syntax==
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
string dgsDxGUISetProperty ( element dgsElement, string property, mixed value [, mixed arg1, mixed arg2 ... ] )
string dgsSetProperty ( element/table dgsElement, string property, mixed value [, mixed arg1, mixed arg2 ... ] )
</syntaxhighlight>
</syntaxhighlight>
{{DGS/OOP|
    Method = DGSElement:setProperty|
    Counterpart = dgsGetProperty
}}


===Required Arguments===
===Required Arguments===
*'''dgsElement:''' the DGS element you wish to set a property to.
*'''dgsElement:''' the DGS element or a list of DGS elements you wish to set a property to.
*'''property:''' the name of of property you want the value to.
*'''property:''' the name of of property you want the value to.
*'''value:''' the value you want to set.
*'''value:''' the value you want to set.
Line 17: Line 22:


===Returns===
===Returns===
If the function succeeds, it returns a value of the property. An error will occur if failed.
If the function succeeds, it returns true, false otherwise.


==Example==
==Example==
This example creates a button when the resource starts and defines a console command that toggles it between enabled (clickable) and disabled (not clickable).
This example creates a label whose text can be changed by itself.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
DGS = exports.dgs
DGS = exports.dgs
button = DGS:dgsDxCreateButton(20, 200, 150, 30, "Test", false)
button = DGS:dgsCreateLabel(20, 200, 150, 30, "Test", false)
code = "return getTickCount()"
DGS:dgsSetProperty(button, "functions", code)
</syntaxhighlight>


addCommandHandler("togglebtn",function()
=See Also=
local currentState = DGS:dgsDxGUIGetProperty(button, "enabled")
 
DGS:dgsDxGUISetProperty(button, "enabled", not currentState)
==<span style="color:#eb3f00;text-shadow:0.05em 0.05em 0.2em #00000099;">DGS Properties</span>==
end)
{{DGSPROPERTIES}}
</syntaxhighlight>
 
==<span style="color:#eb3f00;text-shadow:0.05em 0.05em 0.2em #00000099;">General Functions</span>==
{{DGS General Functions}}


==See Also==
==<span style="color:#eb3f00;text-shadow:0.05em 0.05em 0.2em #00000099;">General Events</span>==
{{DGSFUNCTIONS}}
{{DGS Events/General}}

Latest revision as of 20:57, 3 May 2021

This function sets the value of a specific property of a DGS element. For a list of properties and their meaning, see the DGS properties page.

Note: If you push a value improperly, errors or warnings will occur, which may cause lag and debug info spamming.

Syntax

string dgsSetProperty ( element/table dgsElement, string property, mixed value [, mixed arg1, mixed arg2 ... ] )

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

Method: DGSElement:setProperty(...)
Counterpart: dgsGetProperty

Required Arguments

  • dgsElement: the DGS element or a list of DGS elements you wish to set a property to.
  • property: the name of of property you want the value to.
  • value: the value you want to set.

Optional Arguments

  • arg...: extra value of some properties.

Returns

If the function succeeds, it returns true, false otherwise.

Example

This example creates a label whose text can be changed by itself. 

DGS = exports.dgs
button = DGS:dgsCreateLabel(20, 200, 150, 30, "Test", false)
code = "return getTickCount()"
DGS:dgsSetProperty(button, "functions", code)

See Also

DGS Properties

General Properties

Unique Properties For DGS Core Elements

Extra Properties For DGS Plugins

General Functions

General Events

Retrieved from "https://wiki.multitheftauto.com/wiki/DgsSetProperty?oldid=70989"