SetControlState: Difference between revisions

Revision as of 21:08, 8 July 2018

Sets a state of a specified player's control, as if they pressed or released it.

Syntax

bool setControlState ( player thePlayer, string control, bool state )

Required Arguments

thePlayer: The player you wish to set the control state of.
control: The control that you want to set the state of. See control names for a list of possible controls.
state: A boolean value representing whether or not the key will be set to pressed or not.

Returns

Returns true if the control state was successfully set, false otherwise.

Example

This example will disable the use of the accelerate, brake/reverse and handbrake keys, then force the accelerate on for any player who enters a vehicle.

function onPlayerEnterVehicle ( theVehicle, seat, jacked )
    toggleControl ( source, "accelerate", false ) -- disable the accelerate key
    toggleControl ( source, "brake_reverse", false ) -- disable the brake_reverse key
    toggleControl ( source, "handbrake", false ) -- disable the handbrake key
    setControlState ( source, "accelerate", true ) -- force the accelerate key on
end
addEventHandler ( "onPlayerVehicleEnter", getRootElement(), onPlayerEnterVehicle )

Changelog

Version	Description

1.5.5-3.11427

Deprecated client-side. Use setPedControlState and getPedControlState client-side.

@@ Line 1: / Line 1: @@
-{{Server client function}}
+{{Server function}}
 __NOTOC__
 Sets a state of a specified player's control, as if they pressed or released it.
 ==Syntax==
-<section name="Server" class="server" show="true">
 <syntaxhighlight lang="lua">bool setControlState ( player thePlayer, string control, bool state ) </syntaxhighlight>
 ===Required Arguments===
@@ Line 10: / Line 9: @@
 *'''control:''' The control that you want to set the state of. See [[control names]] for a list of possible controls.
 *'''state:''' A boolean value representing whether or not the key will be set to pressed or not.
-</section>
-<section name="Client" class="client" show="true">
-<syntaxhighlight lang="lua">bool setControlState ( string control, bool state ) </syntaxhighlight>
-===Required Arguments===
-*'''control:''' The control that you want to set the state of. See [[control names]] for a list of possible controls.
-*'''state:''' A boolean value representing whether or not the key will be set to pressed or not.
-</section>
 ===Returns===
@@ Line 22: / Line 14: @@
 ==Example==
-<section name="Server" class="server" show="true">
 This example will disable the use of the accelerate, brake/reverse and handbrake keys, then force the accelerate on for any player who enters a vehicle.
 <syntaxhighlight lang="lua">
@@ Line 33: / Line 24: @@
 addEventHandler ( "onPlayerVehicleEnter", getRootElement(), onPlayerEnterVehicle )
 </syntaxhighlight>
-</section>
-<section name="Client" class="client" show="true">
-This example will disable the use of the accelerate, brake/reverse and handbrake keys, then force the accelerate on for any player who enters a vehicle.
-<syntaxhighlight lang="lua">
-function onClientPlayerEnterVehicle ( theVehicle, seat, jacked )
+==Changelog==
-    toggleControl ( "accelerate", false ) -- disable the accelerate key
+{{ChangelogHeader}}
-    toggleControl ( "brake_reverse", false ) -- disable the brake_reverse key
+{{ChangelogItem|1.5.5-3.11427|Deprecated client-side. Use [[setPedControlState]] and [[getPedControlState]] client-side.}}
-    toggleControl ( "handbrake", false ) -- disable the handbrake key
-    setControlState ( "accelerate", true ) -- force the accelerate key on
-end
-addEventHandler ( "onClientPlayerVehicleEnter", getRootElement(), onClientPlayerEnterVehicle )
-</syntaxhighlight>
-</section>
 ==See Also==
 {{Input functions}}