gta.createPickup: Difference between revisions

Revision as of 20:36, 19 November 2022

Function Server and Client Online and Offline

Available since Server 1.0.0, Client 1.0.0

Pickup gta.createPickup(int model, [ Vec3 position = Vec3(0.0,0.0,0.0) ], [ int pickupType = 2 ])

The gta.createPickup function is used to add a pickup, use the addToWorld function afterwards to add the pickup to the players games.

1)	int	model	The pickup model ID.
2)	Vec3	position	Optional, defaults to Vec3(0.0,0.0,0.0). The position for the pickup.
3)	int	pickupType	Optional, defaults to 2. The pickup type.

Pickup	The pickup handle.

There aren't any examples for this function.

There isn't any compatibility information for this function.

@@ Line 1: / Line 1: @@
-{{ScriptItem
+{{ScriptItem2
-|endpoint = shared
+|name = gta.createPickup
+|side = shared
 |type = function
-|name = gta.createPickup
+|games = iii vc sa iv
-|parameters = int model, [ Vec3 position = Vec3(0.0,0.0,0.0), int pickupType = 2 ]
+|desc = add a pickup, use the [[addToWorld|addToWorld]] function afterwards to add the pickup to the players games
-|parameter1 = int model The pickup model ID.
+|arg1 = int model The pickup model ID.
-|parameter2 = Vec3 position optional Vec3(0.0,0.0,0.0) The position for the pickup.
+|arg2 = [Vec3 position = Vec3(0.0,0.0,0.0)] The position for the pickup.
-|parameter3 = int pickupType optional 2 The pickup type.
+|arg3 = [int pickupType = 2] The pickup type.
-|return1 = Pickup The pickup handle.
+|return = Pickup The pickup handle.
-|returnFail1 = null n/a
+|freturn = null n/a
-|usage = add a pickup, use the [[addToWorld|addToWorld]] function afterwards to add the pickup to the players games
+|note = Please note that pickup type 0 is invalid.
-|returnInfo = a handle to the pickup
-|notes = Please note that pickup type 0 is invalid.
 }}