Anvil.API.NwSpell Class Reference

A spell definition. More...

Public Member Functions
string?	GetConjureSound (Gender gender)
	Gets the chant/voice that is played when this spell is conjured.
byte	GetSpellLevelForClass (NwClass nwClass)
	Gets the spell class level for the specified class.

Static Public Member Functions
static ? NwSpell	FromSpellId (int? spellId)
	Resolves a NwSpell from a spell id.
static ? NwSpell	FromSpellId (uint? spellId)
	Resolves a NwSpell from a spell id.
static ? NwSpell	FromSpellType (Spell spellType)
	Resolves a NwSpell from a Anvil.API.Spell.
static implicit	operator NwSpell? (Spell spellType)

Properties
MetaMagic	AllowedMetaMagic [get]
	Gets the type of MetaMagic that may be used with this spell.
StrRef	AltMessage [get]
	Gets the unformatted message shown in the combat log when something casts this spell.
SpellCastAnimType	CastAnim [get]
	Gets the animation type used to cast this spell.
string?	CastGroundVisual [get]
	Gets the ResRef of the visual effect model shown at the ground of the creature when casting this spell.
string?	CastHandVisual [get]
	Gets the ResRef of the visual effect model shown at the creature's hands when casting this spell.
string?	CastHeadVisual [get]
	Gets the ResRef of the visual effect model shown above the creature's head when casting this spell.
string?	CastSound [get]
	Gets the ResRef of the sound that plays when a creature casts this spell.
TimeSpan	CastTime [get]
	Gets the amount of time to cast the spell, once it has been successfully conjured.
SpellConjureAnimType	ConjureAnim [get]
	Gets the animation type used to conjure the spell.
string?	ConjureGroundVisual [get]
	Gets the ResRef of the visual effect model shown at the ground of the creature when conjuring this spell.
string?	ConjureHandVisual [get]
	Gets the ResRef of the visual effect model shown at the creature's hands when conjuring this spell.
string?	ConjureHeadVisual [get]
	Gets the ResRef of the visual effect model shown above the creature's head when conjuring this spell.
string?	ConjureSound [get]
	Gets the ResRef of the sound that plays when a creature conjures this spell.
TimeSpan	ConjureTime [get]
	Gets the amount of time needed to conjure the spell. This is the animation that plays before the spell is cast.
IReadOnlyList< NwSpell >	CounterSpells [get]
	Gets a list of spells that may directly counter this spell.
StrRef	Description [get]
	Gets the description of this spell.
NwFeat?	FeatReference [get]
	Gets the associated feat if this spell is linked to a feat.
bool	HasProjectile [get]
	Gets if this spell fires a projectile once successfully cast.
string?	IconResRef [get]
	Gets the spell's icon ResRef.
int	Id [get]
	Gets the ID of this spell.
string?	ImpactScript [get]
	Gets the name of the script invoked when the spell impacts a target. This script is only invoked when the spell was successfully cast.
byte	InnateSpellLevel [get]
	Gets the innate level of this spell. See GetSpellLevelForClass to get the spell level for a specific class.
bool	IsHostileSpell [get]
	Gets if this spell is considered hostile when cast on other creatures.
NwSpell?	MasterSpell [get]
	Gets the parent spell if this spell is a subradial spell. The reverse of RadialSpells.
StrRef	Name [get]
	Gets the name of this spell.
string?	ProjectileModel [get]
	Gets the ResRef of the projectile model.
SpellProjectileOrientation	ProjectileOrientation [get]
	Gets the orientation of this spell's projectile.
ProjectilePathType	ProjectilePathType [get]
	Gets the type of path that this spell's projectile follows by default.
string?	ProjectileSound [get]
	Gets the sound of this spell's projectile.
SpellProjectileSpawnPoint	ProjectileSpawnPoint [get]
	Gets the spawn point of this spell's projectile.
IReadOnlyList< NwSpell >	RadialSpells [get]
	Gets the sub-list of spells that appear in the spell's radial menu.
SpellRange	Range [get]
	Gets the range of this spell.
SpellComponents	SpellComponents [get]
	Gets the spell components needed to cast this spell.
SpellSchool	SpellSchool [get]
	Gets the spell school for this spell.
Spell	SpellType [get]
	Gets the associated Spell type for this spell.
bool	SpontaneouslyCast [get]
	Gets if this spell can be spontaneously cast (e.g. cleric heal spells).
TalentCategory	TalentCategory [get]
	Gets the talent category that this spell is assigned to.
SpellTargetTypes	TargetTypes [get]
	Gets the types of targets that this spell is valid for.
bool	UseConcentration [get]
	Gets if this spell should trigger concentration checks.
SpellUserType	UserType [get]
	Gets the UserType for this spell.

Detailed Description

A spell definition.

Member Function Documentation

FromSpellId() [1/2]

static ? NwSpell Anvil.API.NwSpell.FromSpellId ( int? spellId )

inlinestatic

Resolves a NwSpell from a spell id.

Parameters

spellId

The id of the spell to resolve.

Returns

The associated NwSpell instance. Null if the spell id is invalid.

FromSpellId() [2/2]

static ? NwSpell Anvil.API.NwSpell.FromSpellId ( uint? spellId )

inlinestatic

Resolves a NwSpell from a spell id.

Parameters

spellId

The id of the spell to resolve.

Returns

The associated NwSpell instance. Null if the spell id is invalid.

FromSpellType()

static ? NwSpell Anvil.API.NwSpell.FromSpellType ( Spell spellType )

inlinestatic

Resolves a NwSpell from a Anvil.API.Spell.

Parameters

spellType

The spell type to resolve.

Returns

The associated NwSpell instance. Null if the spell type is invalid.

GetConjureSound()

string? Anvil.API.NwSpell.GetConjureSound ( Gender gender )

inline

Gets the chant/voice that is played when this spell is conjured.

Parameters

gender

The gender of the caster.

Returns

The ResRef of the sound to play for the specified gender.

GetSpellLevelForClass()

byte Anvil.API.NwSpell.GetSpellLevelForClass ( NwClass nwClass )

inline

Gets the spell class level for the specified class.

Parameters

nwClass

The class to query.

Returns

The spell level for the specified class.

---

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

• NWN.Anvil/src/main/API/Ruleset/NwSpell.cs