PlayerTextDrawSetString

From SA-MP Wiki

Jump to: navigation, search


PlayerTextDrawSetString was added in SA-MP 0.3e This feature (player-textdraws) was added in SA-MP 0.3e and will not work in earlier versions!


Description:

Change the text of a player-textdraw.


Parameters:
(playerid, PlayerText:text, string[])
playeridThe ID of the player who's textdraw string to set
textThe ID of the textdraw to change
string[]The new string for the TextDraw


Return Values:

This function does not return any specific values.


Image:32px-Circle-style-warning.png

Important
Note

There are limits to the length of textdraw strings! See Limits for more info.


Example Usage:

new pVehicleHealthTimer[MAX_PLAYERS];
new PlayerText:pVehicleHealthTD[MAX_PLAYERS];
 
public OnPlayerStateChange(playerid, newstate, oldstate)
{
    if(newstate == 2) // Entered a vehicle as driver
    {
        pVehicleHealthTD[playerid] = CreatePlayerTextDraw(playerid, x, y, " ");
        PlayerTextDrawShow(playerid, pVehicleHealthTD[playerid]);
 
        // Set a timer to update the textdraw every second
        pVehicleHealthTimer[playerid] = SetTimerEx("vhealth_td_update", 1000, true, "i", playerid);
    }
    if(oldstate == 2)
    {
        KillTimer(pVehicleHealthTD[playerid]);
        PlayerTextDrawDestroy(playerid, pVehicleHealthTD[playerid]);
    }
}
 
public vhealth_td_update(playerid)
{
    new tdstring[32], Float:vHealth;
    GetVehicleHealth(GetPlayerVehicleID(playerid), vHealth);
 
    format(tdstring, sizeof(tdstring), "Vehicle Health: %0f", vHealth);
 
    PlayerTextDrawSetString(playerid, pVehicleHealthTD[playerid], tdstring); // <<< Update the text to show the vehicle health
    return 1;
}
 
/*
NOTE: This example is purely for demonstration purposes, it is not guaranteed to work in-game. It is merely to show the usage of the PlayerTextDrawSetString function.
*/

Related Functions

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


Personal tools