DgsSetInputMode: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Created page with "{{Client function}} This function is attached to guiSetInputEnabled. In order to satisfy the needs of developers, the function exists here. Because DGS elements will also...")
 
(DGS OOP Syntax changing)
 
(5 intermediate revisions by one other user not shown)
Line 1: Line 1:
{{Client function}}
{{Client function}}
This function is attached to [[guiSetInputEnabled]]. In order to satisfy the needs of developers, the function exists here. Because DGS elements will also be affected by guiSetInputEnabled.
__NOTOC__
This function is a replica of [[guiSetInputMode]]. In order to satisfy the needs of developers, the function exists here. DGS elements will also be affected by guiSetInputMode.


==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool dgsSetInputEnabled ( bool enabled )
bool dgsSetInputMode ( string mode )
</syntaxhighlight>
</syntaxhighlight>
{{DGS/OOP|
    Method = '''dgsRootInstance''':setInputMode|
    Counterpart = dgsGetInputMode
}}


===Required Arguments===
===Required Arguments===
Line 16: Line 21:
Returns ''true'' if input mode could be changed, ''false'' if invalid parameters are passed.
Returns ''true'' if input mode could be changed, ''false'' if invalid parameters are passed.


=See Also=


==See Also==
==<span style="color:#eb3f00;text-shadow:0.05em 0.05em 0.2em #00000099;">General Functions</span>==
{{DGSFUNCTIONS}}
{{DGS General Functions}}
{{DGSEVENTS}}
 
==<span style="color:#eb3f00;text-shadow:0.05em 0.05em 0.2em #00000099;">General Events</span>==
{{DGS Events/General}}

Latest revision as of 22:32, 3 May 2021

This function is a replica of guiSetInputMode. In order to satisfy the needs of developers, the function exists here. DGS elements will also be affected by guiSetInputMode.

Syntax

bool dgsSetInputMode ( string mode )

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

Method: dgsRootInstance:setInputMode(...)
Counterpart: dgsGetInputMode

Required Arguments

  • mode: a string representing the desired input mode. Accepted values are:
    • "allow_binds": binds are enabled, hence using a key such as t in an editbox will still activate the chatbox (default)
    • "no_binds": binds are disabled, hence using a key such as t in an editbox will not activate the chatbox
    • "no_binds_when_editing": binds are always enabled except when an editable editbox or memo has input focus

Returns

Returns true if input mode could be changed, false if invalid parameters are passed.

See Also

General Functions

General Events

Retrieved from "https://wiki.multitheftauto.com/wiki/DgsSetInputMode?oldid=71018"