GSC reference › Built-in
ReturnPlayerControl()
Built-in (engine)
Server
Vehicle Called on: vehicle
After controlling a vehicle from script using something like setvehgoalpos(), if the vehicle is being driven by a player, you call this function to return control of the vehicle to the player.
Signature
<vehicle> ReturnPlayerControl()
Called on an entity: vehicle ReturnPlayerControl(...)
Example (from Treyarch's docs)
cobra returnplayercontrol()
Real uses in BO3's scripts
Called 3 times in the decompiled scripts. A few, zombies first:
- scripts/cp/cp_mi_cairo_aquifer_utility.gsc, line 2612
self.pvtol returnplayercontrol(); - scripts/cp/cp_mi_cairo_aquifer_utility.gsc, line 3747
self.pvtol returnplayercontrol(); - scripts/cp/cp_mi_cairo_aquifer_utility.gsc, line 4327
self.pvtol returnplayercontrol();
Related built-ins
- TakePlayerControl()You call this function to take control away from a player.
- isremotecontrol()Query whether this vehicle is usable by players
- IsVehicleManualControl()Check if vehicle hkai behavior is enabled.
- SetVehicleManualControl()Turns on and off vehicle hkai behavior.
- IsPlayer()Checks whether this entity is the player
- GetPlayers()Returns an array of the currently connected players.
- GetLocalPlayer()Get the local player predicted centity.
- PlaySoundToPlayer()Play the sound alias as if coming from the entity, so that only one player can hear it
- GetPlayerAngles()Get the player view angles
- FreezeControls()Blocks or unblocks control input from this player
- GetLocalPlayers()Get an array of all the local players
- SetInvisibleToPlayer()Make the entity invisible to the player
New to GSC?
Start with the basics, or paste a compile error to get the fix.
Built-in descriptions, parameters and examples come from Treyarch's BO3 mod tools docs. Usage links point at shiversoftdev/t7-source (decompiled BO3 scripts).