SetPVarFloat

From SA-MP Wiki

Jump to: navigation, search


Description:

Set a float player variable's value.


Image:32px-Ambox_warning_orange.png

Note

Variables aren't reset until after OnPlayerDisconnect is called, so the values are still accessible in OnPlayerDisconnect.


Parameters:
(playerid, varname[], Float:float_value)
playeridThe ID of the player whose player variable will be set.
varnameThe name of the player variable.
float_valueThe float you want to save in the player variable.


Return Values:

  • 1: The function executed successfully.
  • 0: The function failed to execute. Either the player specified is not connected, or the variable name is null or over 40 characters.


Example Usage:

forward SavePos(playerid);
public SavePos(playerid)
{
    new Float:x,Float:y,Float:z;
    GetPlayerPos(playerid,x,y,z); // Get the players position
    SetPVarFloat(playerid,"xpos",x); // Save the float into a player variable
    SetPVarFloat(playerid,"ypos",y); // Save the float into a player variable
    SetPVarFloat(playerid,"zpos",z); // Save the float into a player variable
    return 1;
}

Related Functions

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

  • SetPVarInt: Set an integer for a player variable.
  • GetPVarInt: Get the previously set integer from a player variable.
  • GetPVarString: Get the previously set string from a player variable.
  • GetPVarFloat: Get the previously set float from a player variable.
Personal tools
Navigation
Toolbox
In other languages