DgsSetRenderSetting: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
(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==  

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

Custom Cursor Functions

Multi Language Supports

Animation

3D Element

3D Interface

3D Line

3D Image

3D Text

Browser

Button

Check Box

Combo Box

Custom Renderer

Edit

Detect Area

Drag'N Drop

Grid List

Image

Memo

Menu

Label

Layout

Line

Progress Bar

Radio Button

Scale Pane

Scroll Bar

Scroll Pane

Selector

Style

Switch Button

Tab Panel

Window

Basic Shape Plugins

Circle

Quadrilateral

Rounded Rectangle

Other Plugins

Blur Box

Canvas

Chart

Color Picker

Effect 3D

Gradient

Mask

Media Browser

Nine Slice

Object Preview Supports

Paste Handler

QRCode

Remote Image

Screen Source

SVG

Tooltips