Class Jailbird

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

Inheritance
System.Object
TypeCastObject<Item>
Item
Jailbird
Implements
IWrapper<InventorySystem.Items.ItemBase>
IWrapper<InventorySystem.Items.Jailbird.JailbirdItem>
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 Jailbird : Item, IWrapper<ItemBase>, IWrapper<JailbirdItem>

Constructors

| Improve this Doc View Source

Jailbird(JailbirdItem)

Initializes a new instance of the Jailbird class.

Declaration
public Jailbird(JailbirdItem itemBase)
Parameters
Type Name Description
InventorySystem.Items.Jailbird.JailbirdItem itemBase

The base InventorySystem.Items.Jailbird.JailbirdItem class.

Properties

| Improve this Doc View Source

Base

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

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

ChargeDamage

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

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

FlashDuration

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

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

MeleeDamage

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

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

Radius

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

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

TotalCharges

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

Declaration
public int TotalCharges { get; set; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

TotalDamageDealt

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

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

WearState

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

Declaration
public JailbirdWearState WearState { get; set; }
Property Value
Type Description
InventorySystem.Items.Jailbird.JailbirdWearState

Methods

| Improve this Doc View Source

Break()

Breaks the Jailbird.

Declaration
public void Break()
| Improve this Doc View Source

Clone()

Clones current Jailbird object.

Declaration
public override Item Clone()
Returns
Type Description
Item

New Jailbird object.

Overrides
| Improve this Doc View Source

ToString()

Returns the JailBird in a human readable format.

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

A string containing JailBird-related data.
Overrides

Implements

Extension Methods