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.

GetPVarString

Description

Gets a player variable as a string.

Name	Description
playerid	The ID of the player whose player variable to get.
const pvar[]	The name of the player variable, set by SetPVarString.
output[]	The array in which to store the string value in, passed by reference.
len = sizeof (output)	The maximum length of the returned string.

Returns

The length of the string.

Examples

public OnPlayerConnect(playerid,reason)
{
    new playerName[MAX_PLAYER_NAME];
    GetPlayerName(playerid, playerName, MAX_PLAYER_NAME);
    SetPVarString(playerid, "PlayerName", playerName);
    return 1;
}

public OnPlayerDeath(playerid, killerid, WEAPON:reason)
{
    new playerName[MAX_PLAYER_NAME];
    GetPVarString(playerid, "PlayerName", playerName, sizeof(playerName));

    printf("%s died.", playerName);
}

Notes

tip

If length of string is zero (value not set), output text will not be updated or set to anything and will remain with old data, neccesying that you clear the variable to blank value if GetPVarString returns 0 if that behavior is undesired.

Related Functions

SetPVarString: Set a string for a player variable.
SetPVarInt: Set an integer for a player variable.
GetPVarInt: Get the previously set integer from a player variable.
SetPVarFloat: Set a float for a player variable.
GetPVarFloat: Get the previously set float from a player variable.
DeletePVar: Delete a player variable.