DeletePVar

From SA-MP Wiki

Jump to: navigation, search


Description:

Deletes a previously set player variable.


Parameters:
(playerid, varname[])
playeridThe ID of the player whose player variable to delete.
varnameThe name of the player variable to delete.


Return Values:

  • 1: The function executed successfully.
  • 0: The function failed to execute. Either the player specified isn't connected or there is no variable set with the given name.


Example Usage:

SetPVarInt(playerid, "SomeVarName", 69);
 
// Later on, when the variable is no longer needed...
 
DeletePVar(playerid, "SomeVarName");
Image:32px-Ambox_warning_orange.png

Note

Once a variable is deleted, attempts to retrieve the value will return 0 (for integers and floats and NULL for strings.


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.
In other languages