Class OnItemUse

Namespace: Anvil.API.Events

Assembly: NWN.Anvil.dll

Triggered when a creature attempts to use an item.

public sealed class OnItemUse : IEvent

Inheritance: object

OnItemUse

Implements: IEvent

Inherited Members: object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods: CollectionExtensions.SafeYield<T>(T?)

CollectionExtensions.Yield<T>(T)

Properties

Item: Gets the item being used.

ItemPropertyIndex: Gets the active item property index.

ItemSubPropertyIndex: Gets the active item sub-property index.

PreventUseItem: Set to true to prevent the item from being used.

SuppressCannotUseFeedback: Set to true to suppress the "Cannot Use" feedback when use fails.

TargetArea: Gets the targeted area, if applicable.

TargetObject: Gets the targeted object, if applicable.

TargetPosition: Gets the targeted position, if applicable.

UseCharges: Gets or sets whether using the item should consume charges.

UsedBy: Gets the creature using the item.

Edit this page