SetPlayerArmedWeapon

SetPlayerArmedWeapon

Description:

Function SetPlayerArmedWeapon sets which weapon (that a player already has) the player is holding.

Function SetPlayerArmedWeapon was added in 0.3a and will not work in earlier versions!

This function arms a player with a weapon they already have; it does not give them a new weapon. See GivePlayerWeapon.

Parameters:

(playerid, weaponid)

int

playerid

The ID of the player to arm with a weapon.

int

weaponid

The ID of the weapon that the player should be armed with.

Return Values:

• 1: The function was executed successfully. Success is returned even when the function fails to execute (the player doesn't have the weapon specified, or it is an invalid weapon).
• 0: The function failed to execute. The player is not connected.

Examples:

Example 1

public OnPlayerUpdate(playerid)
{
    SetPlayerArmedWeapon(playerid,0); // disables weapons
    return 1;
}

// SMG driveby by [03]Garsino (for SA:MP 0.3c)
public OnPlayerStateChange(playerid, newstate, oldstate)
{
    if(newstate == PLAYER_STATE_DRIVER || newstate == PLAYER_STATE_PASSENGER)
    {
        new weapon, ammo;
        GetPlayerWeaponData(playerid, 4, weapon, ammo); // Get the players SMG weapon in slot 4
        SetPlayerArmedWeapon(playerid, weapon); // Set the player to driveby with SMG
    }
    return 1;
}

Related Functions

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

• GivePlayerWeapon: Give a player a weapon.
• GetPlayerWeapon: Check what weapon a player is currently holding.