Class Flashlight

Namespace

Exiled.API.Features.Items

Assembly

Exiled.API.dll

A wrapped class for InventorySystem.Items.ToggleableLights.ToggleableLightItemBase.

public class Flashlight : Item, IWrapper<ItemBase>, IWrapper<ToggleableLightItemBase>

Inheritance

object

TypeCastObject<Item>

Item

Flashlight

Implements

IWrapper<ItemBase>

IWrapper<ToggleableLightItemBase>

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

Flashlight(ToggleableLightItemBase)

Initializes a new instance of the Flashlight class.

public Flashlight(ToggleableLightItemBase itemBase)

Parameters

itemBase ToggleableLightItemBase

The base InventorySystem.Items.ToggleableLights.ToggleableLightItemBase class.

Properties

Base

Gets the InventorySystem.Items.ToggleableLights.ToggleableLightItemBase that this class is encapsulating.

public ToggleableLightItemBase Base { get; }

Property Value

ToggleableLightItemBase

Remarks

Can be InventorySystem.Items.ToggleableLights.Flashlight.FlashlightItem or InventorySystem.Items.ToggleableLights.Lantern.LanternItem.

IsEmittingLight

Gets or sets a value indicating whether the item is emitting light.

public bool IsEmittingLight { get; set; }

Property Value

bool

NextAllowedTime

Gets or sets time since level loaded when player will be able to change IsEmittingLight again.

public float NextAllowedTime { get; set; }

Property Value

float

Methods

Clone()

Clones the current item with a different serial.

public override Item Clone()

Returns

Item

Cloned item object.

ToString()

Returns the item in a human readable format.

public override string ToString()

Returns

string

A string containing item-related data.