CreatePlayerObject
From SA-MP Wiki
(Difference between revisions)
| Revision as of 19:05, 5 April 2019 RoboN1X (Talk | contribs) (id) ← Previous diff |
Current revision RoboN1X (Talk | contribs) |
||
| Line 14: | Line 14: | ||
| {{Param|Float:DrawDistance|The distance from which objects will appear to players. 0.0 will cause an object to render at its default distance. Leaving this parameter out will cause objects to be rendered at their default distance. The maximum usable distance is 300 in versions prior to 0.3x, in which drawdistance can be unlimited.}} | {{Param|Float:DrawDistance|The distance from which objects will appear to players. 0.0 will cause an object to render at its default distance. Leaving this parameter out will cause objects to be rendered at their default distance. The maximum usable distance is 300 in versions prior to 0.3x, in which drawdistance can be unlimited.}} | ||
| - | {{Returns|The ID of the object that was created (starts from 1 to MAX_OBJECTS), or INVALID_OBJECT_ID if the object limit (MAX_OBJECTS) was reached.}} | + | {{Returns|The ID of the object that was created (1 to MAX_OBJECTS-1), or INVALID_OBJECT_ID if the object limit (MAX_OBJECTS) was reached.}} |
| {{Note2|The 'DrawDistance' parameter was added in '''0.3b'''. It must be left out in scripts for older versions of SA:MP.}} | {{Note2|The 'DrawDistance' parameter was added in '''0.3b'''. It must be left out in scripts for older versions of SA:MP.}} | ||
Current revision
Description:
Creates an object which will be visible to only one player.
(playerid, modelid, Float:X, Float:Y, Float:Z, Float:rX, Float:rY, Float:rZ, Float:DrawDistance = 0.0)
| playerid | The ID of the player to create the object for. |
| modelid | The model to create. |
| Float:X | The X coordinate to create the object at. |
| Float:Y | The Y coordinate to create the object at. |
| Float:Z | The Z coordinate to create the object at. |
| Float:rX | The X rotation of the object. |
| Float:rY | The Y rotation of the object. |
| Float:rZ | The Z rotation of the object. |
| Float:DrawDistance | The distance from which objects will appear to players. 0.0 will cause an object to render at its default distance. Leaving this parameter out will cause objects to be rendered at their default distance. The maximum usable distance is 300 in versions prior to 0.3x, in which drawdistance can be unlimited. |
Return Values:
The ID of the object that was created (1 to MAX_OBJECTS-1), or INVALID_OBJECT_ID if the object limit (MAX_OBJECTS) was reached.
 Important | The 'DrawDistance' parameter was added in 0.3b. It must be left out in scripts for older versions of SA:MP. |
Example Usage:
new pObject[MAX_PLAYERS]; public OnPlayerConnect(playerid) { pObject[playerid] = CreatePlayerObject(playerid, 2587, 2001.195679, 1547.113892, 14.283400, 0, 0, 96); // Or alternatively, using the DrawDistance parameter to show it from as far away as possible: pObject[playerid] = CreatePlayerObject(playerid, 2587, 2001.195679, 1547.113892, 14.283400, 0, 0, 96, 300.0); return 1; } public OnPlayerDisconnect(playerid, reason) { DestroyPlayerObject(playerid, pObject[playerid]); return 1; }
[edit]
Related Functions
The following functions may be useful, as they are related to this function in one way or another.
- DestroyPlayerObject: Destroy a player object.
- IsValidPlayerObject: Checks if a certain player object is vaild.
- MovePlayerObject: Move a player object.
- StopPlayerObject: Stop a player object from moving.
- SetPlayerObjectPos: Set the position of a player object.
- SetPlayerObjectRot: Set the rotation of a player object.
- GetPlayerObjectPos: Locate a player object.
- GetPlayerObjectRot: Check the rotation of a player object.
- AttachPlayerObjectToPlayer: Attach a player object to a player.
- CreateObject: Create an object.
- DestroyObject: Destroy an object.
- IsValidObject: Checks if a certain object is vaild.
- MoveObject: Move an object.
- StopObject: Stop an object from moving.
- SetObjectPos: Set the position of an object.
- SetObjectRot: Set the rotation of an object.
- GetObjectPos: Locate an object.
- GetObjectRot: Check the rotation of an object.
- AttachObjectToPlayer: Attach an object to a player.
