Latest revision as of 10:55, 14 May 2024

Client-Side
Function

JavaScript

Disable a control so it cannot be used.

Syntax

mp.game.controls.disableControlAction(inputGroup, control, disable);

Required Arguments

inputGroup: Int (Input Groups)
control: Int (Game Controls)
disable: Boolean

Return value

Boolean

Example

Client-Side

// This will disable using the character wheel
mp.events.add('render', () => {
    mp.game.controls.disableControlAction(2, 19, true);
});

// Disable vehicle weapon on RMB. 
mp.events.add('render', () => {
    mp.game.controls.disableControlAction(32, 68, true); // Use inputGroup 32 in case you are not sure, it seems to have the whole collection of control actions. 
    mp.game.controls.disableControlAction(32, 70, true);
});

@@ Line 1: / Line 1: @@
-control values and meaning: github.com/crosire/scripthookvdotnet/blob/dev/source/scripting/Controls.hpp<br><br>0, 1 and 2 used in the scripts. 0 is by far the most common of them.<br><br>Control values from the decompiled scripts: 0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,<br>28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,53,5<br>4,55,56,57,58,59,60,61,62,63,64,65,66,67,68,69,70,71,72,73,74,75,76,77,78,<br>79,80,81,82,85,86,87,88,89,90,91,92,93,95,96,97,98,99,100,101,102,103,105,<br>107,108,109,110,111,112,113,114,115,116,117,118,119,123,126,129,130,131,132,<br>133,134,136,137,138,139,140,141,142,143,144,145,146,147,148,149,150,151,152,<br>153,154,155,156,157,158,159,160,161,162,163,164,165,166,167,168,169,171,172<br>,177,187,188,189,190,195,196,199,200,201,202,203,205,207,208,209,211,212,213, 217,219,220,221,225,226,230,234,235,236,237,238,239,240,241,242,243,244,257,<br>261,262,263,264,265,270,271,272,273,274,278,279,280,281,282,283,284,285,286,<br>287,288,289,337.<br><br>Example: CONTROLS::DISABLE_CONTROL_ACTION(2, 19, true) disables the switching UI from appearing both when using a keyboard and Xbox 360 controller. Needs to be looped. <br> <br>Control group 1 and 0 gives the same results as 2. Same results for all players.
+{{ClientsideJsFunction}}
-==Syntax==
+Disable a control so it cannot be used.
-<syntaxhighlight lang="javascript">controls.disableControlAction(inputGroup, control, disable);</syntaxhighlight>
+== Syntax ==
+<pre>
+mp.game.controls.disableControlAction(inputGroup, control, disable);
+</pre>
 === Required Arguments ===
-*'''inputGroup:''' int
+*'''inputGroup:''' {{RageType|Int}} ([[InputGroup|Input Groups]])
-*'''control:''' int
+*'''control:''' {{RageType|Int}} ([[Controls|Game Controls]])
-*'''disable:''' Boolean
+*'''disable:''' {{RageType|Boolean}}
 ===Return value===
-*'''Undefined'''
+*'''Boolean'''
 ==Example==
-<syntaxhighlight lang="javascript">
-todo
+{{ClientsideCode|
-</syntaxhighlight>
+<pre>
+// This will disable using the character wheel
+mp.events.add('render', () => {
+    mp.game.controls.disableControlAction(2, 19, true);
+});
+// Disable vehicle weapon on RMB.
+mp.events.add('render', () => {
+    mp.game.controls.disableControlAction(32, 68, true); // Use inputGroup 32 in case you are not sure, it seems to have the whole collection of control actions.
+    mp.game.controls.disableControlAction(32, 70, true);
+});
+</pre>
+}}
 ==See also==
-{{Controls_function_c}}
+{{Controls_functions_c}}
 [[Category:Clientside API]]
-[[Category:TODO: Example]]

Latest revision as of 10:55, 14 May 2024

Client-Side Function

Syntax

Required Arguments

Return value

Example

See also

Client-Side
Function