DgsSetRenderSetting: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(DGS OOP Syntax changing)
 
(8 intermediate revisions by one other user not shown)
Line 1: Line 1:
{{Client function}}
{{Client function}}
__NOTOC__
__NOTOC__
This function allows developers to change DGS' render settings.
This function allows developers to change DGS render settings.


==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
string dgsSetRenderSetting( string settingName, mixed value)
bool dgsSetRenderSetting( string settingName, mixed value )
</syntaxhighlight>
</syntaxhighlight>
{{DGS/OOP|
    Method = '''dgsRootInstance''':setRenderSetting|
    Counterpart = dgsGetRenderSetting
}}


===Required Arguments===
===Required Arguments===
None
===Optional Arguments===
*'''settingName:''' The specific setting name you want to operate.
*'''settingName:''' The specific setting name you want to operate.
**'''postGUI:''' Global post gui setting.
**'''postGUI:''' Global post gui setting ( when a dgs element creates, its "postgui" property will be set according to this render setting ).
***"true" ''force to be post gui''.
***"true" ''force to be post gui''.
***"false" ''force to be under gui''.
***"false" ''force to be under gui''.
***"nil" ''whether to be post gui depends on dgs elements' property "postgui".
***"nil" ''whether to be post gui depends on dgs elements' property "postGUI".
**'''renderPriority:'''A string representing the trigger order priority relative to other event handlers of the same name. Possible values are:
**'''renderPriority:''' Learn more [[addEventHandler]]. Possible values are:
***"high"
***"high"
***"normal"
***"normal"
Line 23: Line 25:


===Returns===
===Returns===
Returns true if succeed, false otherwise.
Returns ''true'' if succeed, false otherwise.


==Example==  
==Example==  
Line 32: Line 34:
</syntaxhighlight>
</syntaxhighlight>


==See Also==
=See Also=
{{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 22:46, 3 May 2021

This function allows developers to change DGS render settings.

Syntax

bool dgsSetRenderSetting( string settingName, mixed value )

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

Method: dgsRootInstance:setRenderSetting(...)
Counterpart: dgsGetRenderSetting

Required Arguments

  • settingName: The specific setting name you want to operate.
    • postGUI: Global post gui setting ( when a dgs element creates, its "postgui" property will be set according to this render setting ).
      • "true" force to be post gui.
      • "false" force to be under gui.
      • "nil" whether to be post gui depends on dgs elements' property "postGUI".
    • renderPriority: Learn more addEventHandler. Possible values are:
      • "high"
      • "normal"
      • "low"
  • value: Target value.

Returns

Returns true if succeed, false otherwise.

Example

DGS = exports.dgs

DGS:dgsSetRenderSetting("postGUI",true)

See Also

General Functions

General Events

Retrieved from "https://wiki.multitheftauto.com/wiki/DgsSetRenderSetting?oldid=71025"