Anvil.API.Events.OnDispelMagicApply Class Reference

Called when a API.Effect.DispelMagicAll or API.Effect.DispelMagicBest effect is applied to an object. More...

Inheritance diagram for Anvil.API.Events.OnDispelMagicApply:

Collaboration diagram for Anvil.API.Events.OnDispelMagicApply:

Classes
class	Factory

Properties
Effect	Effect = null! [get]
	Gets the dispel effect. More...
int	NumEffectsDispelled [get]
	Gets the number of effects dispelled. Only available in the after event. More...
NwGameObject	Object = null! [get]
	Gets the object who is having spell effects dispelled. More...
bool	Skip [get, set]
	Gets or sets if dispelling should be skipped. More...
DispelMagicType	Type [get]
	Gets the type of dispel effect. More...
Properties inherited from Anvil.API.Events.IEvent
NwObject?	Context [get]

Detailed Description

Called when a API.Effect.DispelMagicAll or API.Effect.DispelMagicBest effect is applied to an object.

Property Documentation

Effect

Effect Anvil.API.Events.OnDispelMagicApply.Effect = null!

get

Gets the dispel effect.

NumEffectsDispelled

int Anvil.API.Events.OnDispelMagicApply.NumEffectsDispelled

get

Gets the number of effects dispelled. Only available in the after event.

Object

NwGameObject Anvil.API.Events.OnDispelMagicApply.Object = null!

get

Gets the object who is having spell effects dispelled.

Skip

bool Anvil.API.Events.OnDispelMagicApply.Skip

getset

Gets or sets if dispelling should be skipped.

Type

DispelMagicType Anvil.API.Events.OnDispelMagicApply.Type

get

Gets the type of dispel effect.

---

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

• NWN.Anvil/src/main/API/Events/Native/SpellEvents/OnDispelMagicApply.cs