DgsGetRenderSetting: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Created page with "{{Client function}} __NOTOC__ This function allows developers to get DGS render settings. ==Syntax== <syntaxhighlight lang="lua"> mixed dgsGetRenderSetting( string settingNa...")
 
(DGS (OOP Syntax)/(Template Organization) Mission)
 
(4 intermediate revisions by 2 users not shown)
Line 7: Line 7:
mixed dgsGetRenderSetting( string settingName )
mixed dgsGetRenderSetting( string settingName )
</syntaxhighlight>
</syntaxhighlight>
{{DGS/OOP|
    Method = '''dgsRootInstance''':getRenderSetting|
    Counterpart = dgsSetRenderSetting
}}


===Required Arguments===  
===Required Arguments===  
Line 26: Line 30:
DGS = exports.dgs
DGS = exports.dgs


local setting = DGS:dgsGetRenderSetting("postGUI",true)
local setting = DGS:dgsGetRenderSetting("postGUI")
outputChatBox(tostring(settings)) --default postGUI is nil for "auto"
outputChatBox(tostring(settings)) --default postGUI is nil for being "automatic"
</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:47, 3 May 2021

This function allows developers to get DGS render settings.

Syntax

mixed dgsGetRenderSetting( string settingName )

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

Method: dgsRootInstance:getRenderSetting(...)
Counterpart: dgsSetRenderSetting

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"

Returns

Returns the value of the setting.

Example

DGS = exports.dgs

local setting = DGS:dgsGetRenderSetting("postGUI")
outputChatBox(tostring(settings)) --default postGUI is nil for being "automatic"

See Also

General Functions

General Events

Retrieved from "https://wiki.multitheftauto.com/wiki/DgsGetRenderSetting?oldid=71026"