SetPlayerAttachedObject

From SA-MP Wiki

Jump to: navigation, search

SetPlayerAttachedObject was added in SA-MP 0.3c This function was added in SA-MP 0.3c and will not work in earlier versions!


Description:

Attach an object to a specific bone on a player.


Parameters:
(playerid, index, modelid, bone, Float:fOffsetX = 0.0, Float:fOffsetY = 0.0, Float:fOffsetZ = 0.0, Float:fRotX = 0.0, Float:fRotY = 0.0, Float:fRotZ = 0.0, Float:fScaleX = 1.0, Float:fScaleY = 1.0, Float:fScaleZ = 1.0, materialcolor1 = 0, materialcolor2 = 0)
playeridThe ID of the player to attach the object to.
indexThe index (slot) to assign the object to (0-9 since 0.3d, 0-4 in previous versions).
modelidThe model to attach.
boneThe bone to attach the object to.
fOffsetX(optional) X axis offset for the object position.
fOffsetY(optional) Y axis offset for the object position.
fOffsetZ(optional) Z axis offset for the object position.
fRotX(optional) X axis rotation of the object.
fRotY(optional) Y axis rotation of the object.
fRotZ(optional) Z axis rotation of the object.
fScaleX(optional) X axis scale of the object.
fScaleY(optional) Y axis scale of the object.
fScaleZ(optional) Z axis scale of the object.
materialcolor1(optional) The first object color to set, as an integer or hex in ARGB color format.
materialcolor2(optional) The second object color to set, as an integer or hex in ARGB color format


Return Values:

1 on success, 0 on failure.


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

Important
Note

In version 0.3d and onwards, 10 objects can be attached to a single player (index 0-9). In earlier versions, the limit is 5 (index 0-4).


Image:32px-Ambox_warning_orange.png

Note

This function is separate from the CreateObject / CreatePlayerObject pools.


public OnPlayerSpawn(playerid)
{
    SetPlayerAttachedObject(playerid, 3, 1609, 2); //Attach a turtle to the playerid's head, in slot 3
 
    // example of using colors on an object being attached to the player:
    SetPlayerAttachedObject(playerid, 3, 19487, 2, 0.101, -0.0, 0.0, 5.50, 84.60, 83.7, 1, 1, 1, 0xFF00FF00);
    // Attach a white hat to the head of the player and paint it green
    return 1;
}


Useful defines for updating to 0.3c

#define SetPlayerHoldingObject(%1,%2,%3,%4,%5,%6,%7,%8,%9) SetPlayerAttachedObject(%1,MAX_PLAYER_ATTACHED_OBJECTS-1,%2,%3,%4,%5,%6,%7,%8,%9)
#define StopPlayerHoldingObject(%1) RemovePlayerAttachedObject(%1,MAX_PLAYER_ATTACHED_OBJECTS-1)
#define IsPlayerHoldingObject(%1) IsPlayerAttachedObjectSlotUsed(%1,MAX_PLAYER_ATTACHED_OBJECTS-1)

Related Functions

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

Personal tools
In other languages