Class MicroHid

Namespace

Exiled.API.Features.Items

Assembly

Exiled.API.dll

A wrapper class for InventorySystem.Items.MicroHID.MicroHIDItem.

public class MicroHid : Item, IWrapper<ItemBase>, IWrapper<MicroHIDItem>

Inheritance

object

TypeCastObject<Item>

Item

MicroHid

Implements

IWrapper<ItemBase>

IWrapper<MicroHIDItem>

Inherited Members

Item.List

Item.Serial

Item.IsInInventory

Item.Scale

Item.Type

Item.Category

Item.TierFlags

Item.Weight

Item.IsAmmo

Item.IsArmor

Item.IsKeycard

Item.IsConsumable

Item.IsThrowable

Item.IsUsable

Item.IsWeapon

Item.IsFirearm

Item.IsLightEmitter

Item.IsDisarmer

Item.Owner

Item.AddReason

Item.Get(ItemBase)

Item.Get<T>(ItemBase)

Item.Get(ushort)

Item.Get<T>(ushort)

Item.Create(ItemType, Player)

Item.Create<T>(ItemType, Player)

Item.Give(Player)

Item.Destroy()

Item.CreatePickup(Vector3, Quaternion?, bool)

Item.ChangeItemOwner(Player, Player)

TypeCastObject<Item>.Cast<TObject>()

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

TypeCastObject<Item>.As<TObject>()

TypeCastObject<Item>.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)

Constructors

MicroHid(MicroHIDItem)

Initializes a new instance of the MicroHid class.

public MicroHid(MicroHIDItem itemBase)

Parameters

itemBase MicroHIDItem

The base InventorySystem.Items.MicroHID.MicroHIDItem class.

Properties

Base

Gets the InventorySystem.Items.MicroHID.MicroHIDItem base of the item.

public MicroHIDItem Base { get; }

Property Value

MicroHIDItem

BrokeTime

Gets a time when this MicroHid was broken.

public float BrokeTime { get; }

Property Value

float

A time when this MicroHid was broken, or 0 if it is not broken.

BrokenModule

Gets the InventorySystem.Items.MicroHID.Modules.BrokenSyncModule of the MicroHID.

public BrokenSyncModule BrokenModule { get; }

Property Value

BrokenSyncModule

CycleController

Gets the CycleController of the MicroHID.

public CycleController CycleController { get; }

Property Value

CycleController

Energy

Gets or sets the remaining energy in the MicroHID.

public float Energy { get; set; }

Property Value

float

Maximum energy is 1. Minimum energy is 0.

EnergyManager

Gets the InventorySystem.Items.MicroHID.Modules.EnergyManagerModule of the MicroHID.

public EnergyManagerModule EnergyManager { get; }

Property Value

EnergyManagerModule

InputModule

Gets the InventorySystem.Items.MicroHID.Modules.InputSyncModule of the MicroHID.

public InputSyncModule InputModule { get; }

Property Value

InputSyncModule

IsBroken

Gets or sets a value indicating whether the MicroHID is broken.

public bool IsBroken { get; set; }

Property Value

bool

IsPrimary

Gets a value indicating whether the LastReceived is InventorySystem.Items.MicroHID.Modules.InputSyncModule.SyncData.Primary.

public bool IsPrimary { get; }

Property Value

bool

LastFiringMode

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

public MicroHidFiringMode LastFiringMode { get; set; }

Property Value

MicroHidFiringMode

LastReceived

Gets or sets the last received InventorySystem.Items.MicroHID.Modules.InputSyncModule.SyncData.

public InputSyncModule.SyncData LastReceived { get; set; }

Property Value

InputSyncModule.SyncData

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

Clone()

Clones current MicroHid object.

public override Item Clone()

Returns

Item

New MicroHid object.

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.

Recharge()

Recharges the MicroHID.

public void Recharge()

ToString()

Returns the MicroHid in a human readable format.

public override string ToString()

Returns

string

A string containing MicroHid-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.