Class FirearmPickup

Namespace

Exiled.API.Features.Pickups

Assembly

Exiled.API.dll

A wrapper class for a Firearm pickup.

public class FirearmPickup : Pickup, IWrapper<ItemPickupBase>, IWorldSpace, IPosition, IRotation, IWrapper<FirearmPickup>

Inheritance

object

TypeCastObject<Pickup>

Pickup

FirearmPickup

Implements

IWrapper<ItemPickupBase>

IWorldSpace

IPosition

IRotation

IWrapper<FirearmPickup>

Inherited Members

Pickup.List

Pickup.GameObject

Pickup.Transform

Pickup.Rigidbody

Pickup.Room

Pickup.PhysicsModule

Pickup.Serial

Pickup.Scale

Pickup.Weight

Pickup.PickupTime

Pickup.Type

Pickup.Category

Pickup.IsLocked

Pickup.Info

Pickup.PreviousOwner

Pickup.InUse

Pickup.Position

Pickup.RelativePosition

Pickup.Rotation

Pickup.IsSpawned

Pickup.Get(ItemPickupBase)

Pickup.Get<T>(ItemPickupBase)

Pickup.Get(ushort)

Pickup.Get(GameObject)

Pickup.Get(IEnumerable<ItemPickupBase>)

Pickup.Get(ItemType)

Pickup.Get(IEnumerable<GameObject>)

Pickup.Get<T>(IEnumerable<ItemPickupBase>)

Pickup.Get<T>(ItemType)

Pickup.Get<T>(IEnumerable<GameObject>)

Pickup.Create(ItemType)

Pickup.Create<T>(ItemType)

Pickup.CreateAndSpawn(ItemType, Vector3, Quaternion?, Player)

Pickup.CreateAndSpawn<T>(ItemType, Vector3, Quaternion?, Player)

Pickup.PickupTimeForPlayer(Player)

Pickup.Spawn()

Pickup.Spawn(Vector3, Quaternion?, Player)

Pickup.UnSpawn()

Pickup.Destroy()

Pickup.Clone()

TypeCastObject<Pickup>.Cast<TObject>()

TypeCastObject<Pickup>.Cast<TObject>(out TObject)

TypeCastObject<Pickup>.As<TObject>()

TypeCastObject<Pickup>.Is<TObject>(out TObject)

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Extension Methods

ReflectionExtensions.CopyProperties(object, object)

Properties

Ammo

Gets or sets a value indicating how much ammo have this FirearmPickup.

public int Ammo { get; set; }

Property Value

int

AmmoDrain

Gets or sets the ammo drain per shoot.

public int AmmoDrain { get; set; }

Property Value

int

Remarks

Always 1 by default. Applied on a high layer nether basegame ammo controllers.

Attachments

Gets or sets a value indicating whether the attachment code have this FirearmPickup.

public uint Attachments { get; set; }

Property Value

uint

Base

Gets the InventorySystem.Items.Firearms.FirearmPickup that this class is encapsulating.

public FirearmPickup Base { get; }

Property Value

FirearmPickup

IsDistributed

Gets a value indicating whether the pickup is already distributed.

[Obsolete("Feature deprecated")]
public bool IsDistributed { get; }

Property Value

bool

MaxAmmo

Gets or sets a value indicating how much ammo can contain this FirearmPickup.

public int MaxAmmo { get; set; }

Property Value

int

Methods

Distribute()

Initializes the item as if it was spawned naturally by map generation.

public void Distribute()

InitializeProperties(ItemBase)

initialize item properties.

protected override void InitializeProperties(ItemBase itemBase)

Parameters

itemBase ItemBase

target item.

ToString()

Returns the FirearmPickup in a human-readable format.

public override string ToString()

Returns

string

A string containing FirearmPickup related data.