GetVehicleVelocity

From SA-MP Wiki

Jump to: navigation, search


GetVehicleVelocity was added in SA-MP 0.3a This function was added in SA-MP 0.3a and will not work in earlier versions!


Description:

Get the velocity of a vehicle on the X, Y and Z axes.


Parameters:
(vehicleid, &Float:x, &Float:y, &Float:z)
vehicleidThe ID of the vehicle to get the velocity of.
&Float:xA float variable in to which to store the vehicle's X velocity, passed by reference.
&Float:yA float variable in to which to store the vehicle's Y velocity, passed by reference.
&Float:zA float variable in to which to store the vehicle's Z velocity, passed by reference.


Return Values:

  • 1: The function executed successfully.
  • 0: The function failed to execute. This means the vehicle specified does not exist.
  • The vehicle's velocity is stored in the specified variables.


Example Usage:

public OnPlayerCommandText(playerid, cmdtext[])
{
    if (!strcmp("/GetMyCarVelocity", cmdtext) && IsPlayerInAnyVehicle(playerid))
    {
        new Float:Velocity[3], output[80];
	GetVehicleVelocity(GetPlayerVehicleID(playerid), Velocity[0], Velocity[1], Velocity[2]);
        format(output, sizeof(output), "You are going at a velocity of X%f, Y%f, Z%f", Velocity[0], Velocity[1], Velocity[2]);
        SendClientMessage(playerid, 0xFFFFFFFF, output);
	return 1;
    }
    return 0;
}
Tip

Image:Light_bulb_icon.png

This function can be used to retrieve a vehicle's speed (km/h, m/s or mph). For more info look here.


Related Functions

The following functions may be useful, as they are related to this function in one way or another.

Personal tools
In other languages