Class Jailbird

Namespace

Exiled.API.Features.Items

Assembly

Exiled.API.dll

A wrapped class for InventorySystem.Items.Jailbird.JailbirdItem.

public class Jailbird : Item, IWrapper<ItemBase>, IWrapper<JailbirdItem>

Inheritance

object

TypeCastObject<Item>

Item

Jailbird

Implements

IWrapper<ItemBase>

IWrapper<JailbirdItem>

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.Identifier

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

Jailbird(JailbirdItem)

Initializes a new instance of the Jailbird class.

public Jailbird(JailbirdItem itemBase)

Parameters

itemBase JailbirdItem

The base InventorySystem.Items.Jailbird.JailbirdItem class.

Properties

Base

Gets the InventorySystem.Items.Jailbird.JailbirdItem that this class is encapsulating.

public JailbirdItem Base { get; }

Property Value

JailbirdItem

ChargeDamage

Gets or sets the amount of damage dealt with a Jailbird charge hit.

public float ChargeDamage { get; set; }

Property Value

float

ConcussionDuration

Gets or sets the amount of time in seconds that the CustomPlayerEffects.Concussed effect will be applied on being hit.

public float ConcussionDuration { get; set; }

Property Value

float

FlashDuration

Gets or sets the amount of time in seconds that the CustomPlayerEffects.Flashed effect will be applied on being hit.

public float FlashDuration { get; set; }

Property Value

float

MeleeDamage

Gets or sets the amount of damage dealt with a Jailbird melee hit.

public float MeleeDamage { get; set; }

Property Value

float

Radius

Gets or sets the radius of the Jailbird's hit register.

public float Radius { get; set; }

Property Value

float

TotalCharges

Gets or sets the number of times the item has been charged and used.

public int TotalCharges { get; set; }

Property Value

int

TotalDamageDealt

Gets or sets the total amount of damage dealt with the Jailbird.

public float TotalDamageDealt { get; set; }

Property Value

float

WearState

Gets or sets the InventorySystem.Items.Jailbird.JailbirdWearState for this item.

public JailbirdWearState WearState { get; set; }

Property Value

JailbirdWearState

Methods

Break()

Breaks the Jailbird.

public void Break()

Clone()

Clones current Jailbird object.

public override Item Clone()

Returns

Item

New Jailbird object.

GetCharge(JailbirdWearState)

Gets the charge needed to reach a specific InventorySystem.Items.Jailbird.JailbirdWearState.

public int GetCharge(JailbirdWearState wearState)

Parameters

wearState JailbirdWearState

The desired wear state to calculate the charge for.

Returns

int

The charge value required to achieve the specified wear state.

GetDamage(JailbirdWearState)

Calculates the damage corresponding to a given InventorySystem.Items.Jailbird.JailbirdWearState.

public float GetDamage(JailbirdWearState wearState)

Parameters

wearState JailbirdWearState

The wear state to calculate damage for.

Returns

float

The amount of damage associated with the specified wear state.

ToString()

Returns the JailBird in a human readable format.

public override string ToString()

Returns

string

A string containing JailBird-related data.