Difference between revisions of "DgsSetRenderSetting"

From Multi Theft Auto: Wiki
(Optional Arguments)
 
(6 intermediate revisions by the same 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>
  
===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:''' Learn more [[addEventHandler]]. Possible values are:
 
**'''renderPriority:''' Learn more [[addEventHandler]]. Possible values are:
 
***"high"
 
***"high"
Line 23: Line 21:
  
 
===Returns===
 
===Returns===
Returns true if succeed, false otherwise.
+
Returns ''true'' if succeed, false otherwise.
  
 
==Example==  
 
==Example==  

Latest revision as of 04:43, 11 June 2018

This function allows developers to change DGS render settings.

Syntax

bool dgsSetRenderSetting( string settingName, mixed value )

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

Multi Language Supports

Animation

3D Interface

3D Text

Browser

Button

Check Box

Combo Box

Custom Renderer

Edit

Ellipse Detect Area [Deprecated]

Detect Area

Grid List

Image

Memo

Label

Progress Bar

Radio Button

Scroll Bar

Scroll Pane

Switch Button

Tab Panel

Window

Plugin

Blur Box

Color Picker

Canvas

Effect 3D

Media Browser

Mask

Nine Slice

Object Preview

QRCode

Rounded Rectangle