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.

GetPlayerVelocity

Description

Get the velocity (speed) of a player on the X, Y and Z axes.

Name	Description
playerid	The player to get the speed from.
&Float:x	A float variable in which to store the velocity on the X axis, passed by reference.
&Float:y	A float variable in which to store the velocity on the Y axis, passed by reference.
&Float:z	A float variable in which to store the velocity on the Z axis, passed by reference.

Returns

The function itself doesn't return a specific value. The X, Y and Z velocities are stored in the specified variables.

Examples

public OnPlayerCommandText(playerid, cmdtext[])
{
    if (!strcmp(cmdtext, "/velocity", true))
    {
        new
            Float:x, Float:y, Float:z,
            string[128];

        GetPlayerVelocity(playerid, x, y, z);
        
        format(string, sizeof(string), "You are going at a velocity of X: %f, Y: %f, Z: %f", x, y, z);
        SendClientMessage(playerid, 0xFFFFFFFF, string);
        return 1;
    }
}

Related Functions

SetPlayerVelocity: Set a player's velocity.
SetVehicleVelocity: Set a vehicle's velocity.
GetVehicleVelocity: Get a vehicle's velocity.