DgsSetProperties: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (DGS OOP Syntax changing)
 
(16 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Client function}}
{{Client function}}
__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 values of specific properties 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 ... ] )
bool dgsSetProperties ( element/table dgsElement, table properties )
</syntaxhighlight>
</syntaxhighlight>
{{DGS/OOP|
    Method = DGSElements:setProperties|
    Counterpart = dgsGetProperties
}}


===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.
*'''properties:''' a table stores the properties name and value that you want to set (index = property name; value = property value).
*'''value:''' the value you want to set.
*'''arg1:''' extra argument passed into the function.
*'''arg2:''' extra argument passed into the function.


===Returns===
===Returns===
If the function succeeds, it returns true, false otherwise.
returns true if succeeds, false otherwise.


==Example==
==Example==
This example creates a label whose text can be changed by itself.
This example shows how to set multi properties at a time.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
DGS = exports.dgs
DGS = exports.dgs
button = DGS:dgsDxCreateLabel(20, 200, 150, 30, "Test", false)
button = DGS:dgsCreateLabel(20, 200, 150, 30, "Test", false)
code = "return getTickCount()"
properties = {}
DGS:dgsDxGUISetProperty(button, "functions", code)
properties.text = "Done"
properties.shadow = {1,1,tocolor(0,0,0,255)}
DGS:dgsSetProperties(button, properties)
</syntaxhighlight>
</syntaxhighlight>


==See Also==
=See Also=
{{DGSFUNCTIONS}}
 
==<span style="color:#eb3f00;text-shadow:0.05em 0.05em 0.2em #00000099;">DGS Properties</span>==
{{DGSPROPERTIES}}
 
==<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:01, 3 May 2021

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

[[{{{image}}}|link=|]] Note: If you push a value improperly, errors or warnings will occur, which may cause lag and debug info spamming.

Syntax

bool dgsSetProperties ( element/table dgsElement, table properties )

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

Method: DGSElements:setProperties(...)
Counterpart: dgsGetProperties

Required Arguments

  • dgsElement: the DGS element or a list of DGS elements you wish to set a property to.
  • properties: a table stores the properties name and value that you want to set (index = property name; value = property value).

Returns

returns true if succeeds, false otherwise.

Example

This example shows how to set multi properties at a time. 

DGS = exports.dgs
button = DGS:dgsCreateLabel(20, 200, 150, 30, "Test", false)
properties = {}
properties.text = "Done"
properties.shadow = {1,1,tocolor(0,0,0,255)}
DGS:dgsSetProperties(button, properties)

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/DgsSetProperties?oldid=70991"