Class Usable

A wrapper class for InventorySystem.Items.Usables.UsableItem.

Inheritance
System.Object
TypeCastObject<Item>
Item
Usable
Consumable
Scp1576
Scp244
Scp330
Implements
IWrapper<InventorySystem.Items.ItemBase>
IWrapper<InventorySystem.Items.Usables.UsableItem>
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Exiled.API.Features.Items
Assembly: Exiled.API.dll
Syntax
public class Usable : Item, IWrapper<ItemBase>, IWrapper<UsableItem>

Constructors

| Improve this Doc View Source

Usable(UsableItem)

Initializes a new instance of the Usable class.

Declaration
public Usable(UsableItem itemBase)
Parameters
Type Name Description
InventorySystem.Items.Usables.UsableItem itemBase

The base InventorySystem.Items.Usables.UsableItem class.

Properties

| Improve this Doc View Source

Base

Gets the InventorySystem.Items.Usables.UsableItem that this class is encapsulating.

Declaration
public UsableItem Base { get; }
Property Value
Type Description
InventorySystem.Items.Usables.UsableItem
| Improve this Doc View Source

Equippable

Gets a value indicating whether this item is equippable.

Declaration
public bool Equippable { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

Holsterable

Gets a value indicating whether this item is holsterable.

Declaration
public bool Holsterable { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

IsUsing

Gets a value indicating whether the item is currently being used.

Declaration
public bool IsUsing { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

MaxCancellableTime

Gets or sets how long after using starts a player has to cancel using the item.

Declaration
public float MaxCancellableTime { get; set; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

PlayerGetCooldown

Gets all the cooldown between uses of this item.

Declaration
public float PlayerGetCooldown { get; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

RemainingCooldown

Gets or sets the cooldown between repeated uses of this item.

Declaration
public float RemainingCooldown { get; set; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

UseTime

Gets or sets how long it takes to use the item.

Declaration
public float UseTime { get; set; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

Weight

Gets or sets the weight of the item.

Declaration
public float Weight { get; set; }
Property Value
Type Description
System.Single

Methods

| Improve this Doc View Source

CreatePickup(Vector3, Quaternion, Boolean)

Creates the Pickup that based on this Item.

Declaration
public override Pickup CreatePickup(Vector3 position, Quaternion rotation = default(Quaternion), bool spawn = true)
Parameters
Type Name Description
UnityEngine.Vector3 position

The location to spawn the item.
UnityEngine.Quaternion rotation

The rotation of the item.
System.Boolean spawn

Whether the Pickup should be initially spawned.
Returns
Type Description
Pickup

The created Pickup.
Overrides
| Improve this Doc View Source

Use()

Uses the item.

Declaration
public virtual void Use()
Exceptions
Type Condition
System.InvalidOperationException

The Owner of the item cannot be null.

Implements

Extension Methods