note Help Needed
This wiki is the result of an ongoing community effort — thank you all for helping!
If you want to provide changes to this page then please click here.
CreatePickup
Description
This function does exactly the same as AddStaticPickup, except it returns a pickup ID which can be used to destroy it afterwards and be tracked using OnPlayerPickUpPickup.
| Name | Description |
|---|---|
| model | The model of the pickup. |
| type | The pickup type. Determines how the pickup responds when picked up. |
| Float:x | The X coordinate to create the pickup at. |
| Float:y | The Y coordinate to create the pickup at. |
| Float:z | The Z coordinate to create the pickup at. |
| virtualWorld | The virtual world ID of the pickup. Use -1 to make the pickup show in all worlds. |
Returns
The ID of the created pickup, -1 on failure (pickup max limit).
Examples
new pickup_Armour; // Create a variable to store the pickup ID in
public OnGameModeInit()
{
pickup_Armour = CreatePickup(1242, 2, 1503.3359, 1432.3585, 10.1191, -1);
// Create an armour pickup and store the ID in 'pickup'
return 1;
}
// Later..
DestroyPickup(pickup_Armour); // Example of using the pickup ID
pickup_Armour = 0; // pickup variable needs to be reset to avoid future conflicts
Notes
tip
- The only type of pickup that can be picked up from inside a vehicle is 14 (except for special pickups such as bribes).
- Pickups are shown to, and can be picked up by all players.
- It is possible that if DestroyPickup() is used when a pickup is picked up, more than one player can pick up the pickup, due to lag. This can be circumvented through the use of variables.
- Certain pickup types come with 'automatic responses', for example using an M4 model in the pickup will automatically give the player the weapon and some ammo.
- For fully scripted pickups, type 1 should be used.
warning
Known Bug(s):
- Pickups that have a X or Y lower than -4096.0 or bigger than 4096.0 won't show up and won't trigger OnPlayerPickUpPickup either.
Related Functions
- AddStaticPickup: Add a static pickup.
- DestroyPickup: Destroy a pickup.
- IsValidPickup: Checks if a pickup is valid.
- IsPickupStreamedIn: Checks if a pickup is streamed in for a specific player.
- IsPickupHiddenForPlayer: Checks if a pickup is hidden for a specific player.
- SetPickupPos: Sets the position of a pickup.
- GetPickupPos: Gets the coordinates of a pickup.
- SetPickupModel: Sets the model of a pickup.
- GetPickupModel: Gets the model ID of a pickup.
- SetPickupType: Sets the type of a pickup.
- GetPickupType: Gets the type of a pickup.
- SetPickupVirtualWorld: Sets the virtual world ID of a pickup.
- GetPickupVirtualWorld: Gets the virtual world ID of a pickup.
- ShowPickupForPlayer: Shows a pickup for a specific player.
- HidePickupForPlayer: Hides a pickup for a specific player.
- SetPickupForPlayer: Adjusts the pickup model, type, and position for a specific player.
- CreatePlayerPickup: Creates a pickup which will be visible to only one player.
- DestroyPlayerPickup: Destroy a player-pickup.
Related Callbacks
The following callbacks might be useful, as they're related to this function.
- OnPlayerPickUpPickup: Called when a player picks up a pickup.
- OnPickupStreamIn: Called when a pickup enters the visual range of a player.
- OnPickupStreamOut: Called when a pickup leaves the visual range of a player.