Class MicroHIDPickup

Namespace

Exiled.API.Features.Pickups

Assembly

Exiled.API.dll

A wrapper class for a MicroHID pickup.

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

Inheritance

object

TypeCastObject<Pickup>

Pickup

MicroHIDPickup

Implements

IWrapper<ItemPickupBase>

IWorldSpace

IPosition

IRotation

IWrapper<MicroHIDPickup>

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()

Pickup.InitializeProperties(ItemBase)

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

Base

Gets the InventorySystem.Items.MicroHID.MicroHIDPickup that this class is encapsulating.

public MicroHIDPickup Base { get; }

Property Value

MicroHIDPickup

CycleController

Gets the InventorySystem.Items.MicroHID.Modules.CycleController of this MicroHIDPickup.

public CycleController CycleController { get; }

Property Value

CycleController

Energy

Gets or sets the MicroHID Energy Level.

public float Energy { get; set; }

Property Value

float

LastFiringMode

Gets or sets the last received InventorySystem.Items.MicroHID.Modules.MicroHidFiringMode.

public MicroHidFiringMode LastFiringMode { get; set; }

Property Value

MicroHidFiringMode

State

Gets or sets the InventorySystem.Items.MicroHID.Modules.MicroHidPhase.

public MicroHidPhase State { get; set; }

Property Value

MicroHidPhase

WindUpProgress

Gets or sets progress of winging up.

public float WindUpProgress { get; set; }

Property Value

float

A value between 0 and 1.

Methods

Explode()

Explodes the MicroHID.

public void Explode()

Fire(MicroHidFiringMode)

Starts firing the MicroHID.

public void Fire(MicroHidFiringMode firingMode = MicroHidFiringMode.PrimaryFire)

Parameters

firingMode MicroHidFiringMode

Fire mode.

ToString()

Returns the MicroHIDPickup in a human readable format.

public override string ToString()

Returns

string

A string containing MicroHIDPickup related data.

TryGetFireController<T>(MicroHidFiringMode, out T)

Tries to get a InventorySystem.Items.MicroHID.Modules.FiringModeControllerModule assosiated with the specified InventorySystem.Items.MicroHID.Modules.MicroHidFiringMode.

public bool TryGetFireController<T>(MicroHidFiringMode firingMode, out T module) where T : FiringModeControllerModule

Parameters

firingMode MicroHidFiringMode

Target firing mode.

module T

Found module or null.

Returns

bool

true if module was found, false otherwise.

Type Parameters

T

Type of module.

TryGetLastFireController(out FiringModeControllerModule)

Tries to get a InventorySystem.Items.MicroHID.Modules.FiringModeControllerModule assosiated with the last InventorySystem.Items.MicroHID.Modules.MicroHidFiringMode.

public bool TryGetLastFireController(out FiringModeControllerModule module)

Parameters

module FiringModeControllerModule

Found module or null.

Returns

bool

true if module was found, false otherwise.