Class Equippable

Namespace

S1API.Items

Assembly

S1API.dll

Represents an equippable component that can be attached to items. Provides a wrapper around the game's native equippable system.

public class Equippable

Inheritance

object

Equippable

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods

ReflectionUtils.GetValueTupleItems(object)

ReflectionUtils.IsValueTuple(object)

Properties

CanInteractWhenEquipped

Gets or sets whether the player can interact with objects when this item is equipped.

public bool CanInteractWhenEquipped { get; set; }

Property Value

bool

CanPickUpWhenEquipped

Gets or sets whether the player can pick up items when this item is equipped.

public bool CanPickUpWhenEquipped { get; set; }

Property Value

bool

Methods

Equip(ItemInstance)

Called when this item is equipped by the player. Override this in derived classes to implement custom equip behavior.

public virtual void Equip(ItemInstance item)

Parameters

item ItemInstance

The item instance being equipped.

Unequip()

Called when this item is unequipped by the player. Override this in derived classes to implement custom unequip behavior.

public virtual void Unequip()