warning Not Translated

This page has not been translated into the language that your browser requested yet. The English content is being shown as a fallback.

If you want to contribute a translation for this page then please click here.

RemovePlayerFromVehicle

Description

Removes/ejects a player from their vehicle.

Name	Description
playerid	The ID of the player to remove from their vehicle.
bool:force	Force remove from vehicle instantly. (default: `false`)

Returns

true - The function was executed successfully.

false - The function failed to execute. This means the player is not connected.

Examples

// Example - Players can only drive vehicles if they have 10 score.
public OnPlayerStateChange(playerid, PLAYER_STATE:newstate, PLAYER_STATE:oldstate)
{
    if (newstate == PLAYER_STATE_DRIVER && GetPlayerScore(playerid) < 10) // PlAYER_STATE_DRIVER = 2
    {
        RemovePlayerFromVehicle(playerid);
    }
    return 1;
}

Notes

tip

The exiting animation is not synced for other players.
This function will not work when used in OnPlayerEnterVehicle, because the player isn't in the vehicle when the callback is called. Use OnPlayerStateChange instead (see the example above).
If the player is in an RC vehicle, they will not be removed. (Use .force = true parameter or ClearAnimations function)

Related Functions

PutPlayerInVehicle: Put a player in a vehicle.