Anvil
Classes | Properties | List of all members
Anvil.API.Events.OnHealKitUse Class Reference

Called when a heal kit is used by a creature. More...

+ Inheritance diagram for Anvil.API.Events.OnHealKitUse:
+ Collaboration diagram for Anvil.API.Events.OnHealKitUse:

Classes

class  Factory
 

Properties

int ItemPropertyIndex [get]
 Gets the item property index on the heal item that was used. More...
 
NwItem ItemUsed = null! [get]
 Gets the heal item that was used. More...
 
bool MoveToTarget [get]
 Gets if the creature had to move to the target to use the heal item. More...
 
bool PreventUse [get, set]
 Gets or sets whether the heal kit should be prevented from being used. More...
 
Lazy< ActionState > Result = null! [get]
 Gets if the creature successfully used this healing kit. More...
 
NwGameObject Target = null! [get]
 Gets the object that was targetted with this healing item. More...
 
NwCreature UsedBy = null! [get]
 Gets the creature that used the heal item. More...
 
- Properties inherited from Anvil.API.Events.IEvent
NwObject? Context [get]
 

Detailed Description

Called when a heal kit is used by a creature.

Property Documentation

◆ ItemPropertyIndex

int Anvil.API.Events.OnHealKitUse.ItemPropertyIndex
get

Gets the item property index on the heal item that was used.

◆ ItemUsed

NwItem Anvil.API.Events.OnHealKitUse.ItemUsed = null!
get

Gets the heal item that was used.

◆ MoveToTarget

bool Anvil.API.Events.OnHealKitUse.MoveToTarget
get

Gets if the creature had to move to the target to use the heal item.

◆ PreventUse

bool Anvil.API.Events.OnHealKitUse.PreventUse
getset

Gets or sets whether the heal kit should be prevented from being used.

◆ Result

Lazy<ActionState> Anvil.API.Events.OnHealKitUse.Result = null!
get

Gets if the creature successfully used this healing kit.

◆ Target

NwGameObject Anvil.API.Events.OnHealKitUse.Target = null!
get

Gets the object that was targetted with this healing item.

◆ UsedBy

NwCreature Anvil.API.Events.OnHealKitUse.UsedBy = null!
get

Gets the creature that used the heal item.

The documentation for this class was generated from the following file: