SHVDN  v3
An ASI plugin for Grand Theft Auto V, which allows running scripts written in any .NET language in-game. Developed by crosire https://github.com/crosire/scripthookvdotnet/
GTA.Pickup Class Reference
Inheritance diagram for GTA.Pickup:
GTA.PoolObject GTA.Native.INativeValue GTA.IDeletable GTA.IExistable

Public Member Functions

 Pickup (int handle)
 
bool ObjectExists ()
 Determines if the object of this Pickup exists. More...
 
override void Delete ()
 Destroys this Pickup. More...
 
override bool Exists ()
 Determines if this Pickup exists. More...
 
override bool Equals (object obj)
 Determines if an object refers to the same pickup as this Pickup. More...
 
override int GetHashCode ()
 

Static Public Member Functions

static bool operator== (Pickup left, Pickup right)
 Determines if two Pickups refer to the same pickup. More...
 
static bool operator!= (Pickup left, Pickup right)
 Determines if two Pickups don't refer to the same pickup. More...
 
static implicit operator InputArgument (Pickup value)
 Converts a Pickup to a native input argument. More...
 

Public Attributes

Vector3 Position => Function.Call<Vector3>(Hash.GET_PICKUP_COORDS, Handle)
 The position of this Pickup. More...
 
bool IsCollected => Function.Call<bool>(Hash.HAS_PICKUP_BEEN_COLLECTED, Handle)
 Gets if this Pickup has been collected. More...
 

Additional Inherited Members

- Protected Member Functions inherited from GTA.PoolObject
 PoolObject (int handle)
 
- Properties inherited from GTA.PoolObject
int Handle [get, protected set]
 The handle of the object. More...
 
ulong NativeValue [get, set]
 The handle of the object translated to a native value. More...
 
- Properties inherited from GTA.Native.INativeValue
ulong NativeValue [get, set]
 

Constructor & Destructor Documentation

◆ Pickup()

GTA.Pickup.Pickup ( int  handle)

Member Function Documentation

◆ Delete()

override void GTA.Pickup.Delete ( )
virtual

Destroys this Pickup.

Implements GTA.PoolObject.

◆ Equals()

override bool GTA.Pickup.Equals ( object  obj)

Determines if an object refers to the same pickup as this Pickup.

Parameters
objThe object to check.
Returns
true if the obj is the same pickup as this Pickup; otherwise, false.

◆ Exists()

override bool GTA.Pickup.Exists ( )
virtual

Determines if this Pickup exists.

Returns
true if this Pickup exists; otherwise, false.

Implements GTA.PoolObject.

◆ GetHashCode()

override int GTA.Pickup.GetHashCode ( )

◆ ObjectExists()

bool GTA.Pickup.ObjectExists ( )

Determines if the object of this Pickup exists.

Returns

◆ operator InputArgument()

static implicit GTA.Pickup.operator InputArgument ( Pickup  value)
static

Converts a Pickup to a native input argument.

◆ operator!=()

static bool GTA.Pickup.operator!= ( Pickup  left,
Pickup  right 
)
static

Determines if two Pickups don't refer to the same pickup.

Parameters
leftThe left Pickup.
rightThe right Pickup.
Returns
true if left is not the same pickup as right ; otherwise, false.

◆ operator==()

static bool GTA.Pickup.operator== ( Pickup  left,
Pickup  right 
)
static

Determines if two Pickups refer to the same pickup.

Parameters
leftThe left Pickup.
rightThe right Pickup.
Returns
true if left is the same pickup as right ; otherwise, false.

Member Data Documentation

◆ IsCollected

bool GTA.Pickup.IsCollected => Function.Call<bool>(Hash.HAS_PICKUP_BEEN_COLLECTED, Handle)

Gets if this Pickup has been collected.

◆ Position

Vector3 GTA.Pickup.Position => Function.Call<Vector3>(Hash.GET_PICKUP_COORDS, Handle)

The position of this Pickup.


The documentation for this class was generated from the following file: