Search Results for

    Show / Hide Table of Contents

    Class Flashlight

    A wrapped class for .

    Inheritance
    System.Object
    TypeCastObject<Item>
    Item
    Flashlight
    Implements
    IWrapper<InventorySystem.Items.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.IsLightEmitter
    Item.IsDisarmer
    Item.Owner
    Item.Get(ItemBase)
    Item.Get(UInt16)
    Item.Create(ItemType, Player)
    Item.Give(Player)
    Item.Destroy()
    Item.CreatePickup(Vector3, Quaternion, Boolean)
    Item.ChangeItemOwner(Player, Player)
    TypeCastObject<Item>.Cast<TObject>()
    TypeCastObject<Item>.Cast<TObject>(TObject)
    TypeCastObject<Item>.As<TObject>()
    TypeCastObject<Item>.Is<TObject>(TObject)
    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 Flashlight : Item, IWrapper<ItemBase>, IWrapper<ToggleableLightItemBase>

    Constructors

    | Improve this Doc View Source

    Flashlight(ToggleableLightItemBase)

    Initializes a new instance of the Flashlight class.

    Declaration
    public Flashlight(ToggleableLightItemBase itemBase)
    Parameters
    Type Name Description
    ToggleableLightItemBase itemBase

    The base class.

    Properties

    | Improve this Doc View Source

    Active

    Declaration
    [Obsolete("Use IsEmittingLight instead.")]
    public bool Active { get; set; }
    Property Value
    Type Description
    System.Boolean
    | Improve this Doc View Source

    Base

    Gets the that this class is encapsulating.

    Declaration
    public ToggleableLightItemBase Base { get; }
    Property Value
    Type Description
    ToggleableLightItemBase
    Remarks

    Can be or .

    | Improve this Doc View Source

    IsEmittingLight

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

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

    NextAllowedTime

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

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

    Methods

    | Improve this Doc View Source

    Clone()

    Declaration
    public override Item Clone()
    Returns
    Type Description
    Item
    Overrides
    Item.Clone()
    | Improve this Doc View Source

    ToString()

    Returns the item in a human readable format.

    Declaration
    public override string ToString()
    Returns
    Type Description
    System.String

    A string containing item-related data.

    Overrides
    Item.ToString()

    Implements

    IWrapper<T>
    IWrapper<T>

    Extension Methods

    ReflectionExtensions.CopyProperties(Object, Object)
    • Improve this Doc
    • View Source
    In This Article
    Back to top Generated by DocFX