Class Extensions

Namespace

Exiled.CustomItems.API

Assembly

Exiled.CustomItems.dll

A collection of API methods.

public static class Extensions

Inheritance

object

Extensions

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Methods

Register(CustomItem)

Registers a CustomItem.

public static void Register(this CustomItem item)

Parameters

item CustomItem

The CustomItem to be registered.

Register(IEnumerable<CustomItem>)

Registers an IEnumerable<T> of CustomItems.

public static void Register(this IEnumerable<CustomItem> customItems)

Parameters

customItems IEnumerable<CustomItem>

CustomItems to be registered.

ResetInventory(Player, IEnumerable<string>, bool)

Resets the player's inventory to the provided list of items and/or customitems names, clearing any items it already possess.

public static void ResetInventory(this Player player, IEnumerable<string> newItems, bool displayMessage = false)

Parameters

player Player

The player to which items will be given.

newItems IEnumerable<string>

The new items that have to be added to the inventory.

displayMessage bool

Indicates a value whether ShowPickedUpMessage(Player) will be called when the player receives the CustomItem or not.

Unregister(CustomItem)

Unregisters a CustomItem.

public static void Unregister(this CustomItem item)

Parameters

item CustomItem

The CustomItem to be unregistered.

Unregister(IEnumerable<CustomItem>)

Unregisters an IEnumerable<T> of CustomItems.

public static void Unregister(this IEnumerable<CustomItem> customItems)

Parameters

customItems IEnumerable<CustomItem>

CustomItems to be unregistered.