SetControlState: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (This function is shared)
 
(8 intermediate revisions by 7 users not shown)
Line 1: Line 1:
{{Server client function}}  
{{Shared function}}  
__NOTOC__  
__NOTOC__  
Sets a state of a specified player's control, as if they pressed or released it.
Sets a state of a specified player's control, as if they pressed or released it.


==Syntax==  
==Syntax==  
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">bool setControlState ( player thePlayer, string control, bool state ) </syntaxhighlight>  
<syntaxhighlight lang="lua">bool setControlState ( player thePlayer, string control, bool state ) </syntaxhighlight>  
</section>
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">bool setControlState ( string control, bool state ) </syntaxhighlight>
</section>
===Required Arguments===  
===Required Arguments===  
*'''thePlayer:''' The player you wish to set the control state of.
*'''thePlayer:''' The player you wish to set the control state of.
Line 16: Line 11:


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


<section name="Server" class="server" show="false">
==Example==   
==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.  
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">
<syntaxhighlight lang="lua">
function onPlayerEnterVehicle ( theVehicle, seat, jacked )
function onPlayerEnterVehicle ( theVehicle, seat, jacked )
  toggleControl ( source, "accelerate", false ) -- disable the accelerate key
    toggleControl ( source, "accelerate", false ) -- disable the accelerate key
  toggleControl ( source, "brake_reverse", false ) -- disable the brake_reverse key
    toggleControl ( source, "brake_reverse", false ) -- disable the brake_reverse key
  toggleControl ( source, "handbrake", false ) -- disable the handbrake key
    toggleControl ( source, "handbrake", false ) -- disable the handbrake key
  setControlState ( source, "accelerate", true ) -- force the accelerate key on
    setControlState ( source, "accelerate", true ) -- force the accelerate key on
end
end
addEventHandler ( "onPlayerEnterVehicle", getRootElement(), onPlayerEnterVehicle )
addEventHandler ( "onPlayerVehicleEnter", root, onPlayerEnterVehicle )
</syntaxhighlight>
</syntaxhighlight>
</section>


<section name="Client" class="client" show="false">
==Changelog==
==Example== 
{{ChangelogHeader}}
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.  
{{ChangelogItem|1.5.5-3.11427|Deprecated client-side. Use [[setPedControlState]] and [[getPedControlState]] client-side.}}
<syntaxhighlight lang="lua">
 
function onClientPlayerEnterVehicle ( theVehicle, seat, jacked )
  toggleControl ( "accelerate", false ) -- disable the accelerate key
  toggleControl ( "brake_reverse", false ) -- disable the brake_reverse key
  toggleControl ( "handbrake", false ) -- disable the handbrake key
  setControlState ( "accelerate", true ) -- force the accelerate key on
end
addEventHandler ( "onClientPlayerVehicleEnter", getRootElement(), onClientPlayerEnterVehicle )
</syntaxhighlight>
</section>


==See Also==
==See Also==
{{Input functions}}
{{Input functions}}

Latest revision as of 00:00, 30 April 2024

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", root, onPlayerEnterVehicle )

Changelog

Version Description
1.5.5-3.11427 Deprecated client-side. Use setPedControlState and getPedControlState client-side.

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/SetControlState?oldid=79209"