Anvil
Anvil.API.NwDomain Class Reference

A selectable domain type used by classes with the NwClass.HasDomains property (e.g. clerics) More...

Static Public Member Functions

static ? NwDomain FromDomainId (int domainId)
 Resolves a NwDomain from a domain id. More...
 
static ? NwDomain FromDomainType (Domain domainType)
 Resolves a NwDomain from a Domain. More...
 
static implicit operator NwDomain? (Domain domainType)
 

Properties

bool CastableFeat [get]
 Gets if the feat provides an active property, e.g. the Death domain's "Negative Plane Avatar" ability. More...
 
StrRef Description [get]
 Gets the description for this domain, as shown in the character generation and level up screens. More...
 
Domain DomainType [get]
 Gets the associated Domain type for this domain. More...
 
NwFeatGrantedFeat [get]
 Gets the feat that is granted when selecting this domain. More...
 
string? Icon [get]
 Gets the icon resref to use for this domain. More...
 
byte Id [get]
 Gets the ID of this domain. More...
 
bool IsValidDomain [get]
 Gets if this is a correctly configured domain. More...
 
StrRef Name [get]
 Gets the name of this domain. More...
 
IReadOnlyList< NwSpell?> Spells [get]
 Gets a list of spells specific to this domain. More...
 

Detailed Description

A selectable domain type used by classes with the NwClass.HasDomains property (e.g. clerics)

Member Function Documentation

◆ FromDomainId()

static ? NwDomain Anvil.API.NwDomain.FromDomainId ( int  domainId)
inlinestatic

Resolves a NwDomain from a domain id.

Parameters
domainIdThe id of the domain to resolve.
Returns
The associated NwDomain instance. Null if the domain id is invalid.

◆ FromDomainType()

static ? NwDomain Anvil.API.NwDomain.FromDomainType ( Domain  domainType)
inlinestatic

Resolves a NwDomain from a Domain.

Parameters
domainTypeThe domain type to resolve.
Returns
The associated NwDomain instance. Null if the domain type is invalid.

Property Documentation

◆ CastableFeat

bool Anvil.API.NwDomain.CastableFeat
get

Gets if the feat provides an active property, e.g. the Death domain's "Negative Plane Avatar" ability.

◆ Description

StrRef Anvil.API.NwDomain.Description
get

Gets the description for this domain, as shown in the character generation and level up screens.

◆ DomainType

Domain Anvil.API.NwDomain.DomainType
get

Gets the associated Domain type for this domain.

◆ GrantedFeat

NwFeat? Anvil.API.NwDomain.GrantedFeat
get

Gets the feat that is granted when selecting this domain.

◆ Icon

string? Anvil.API.NwDomain.Icon
get

Gets the icon resref to use for this domain.

◆ Id

byte Anvil.API.NwDomain.Id
get

Gets the ID of this domain.

◆ IsValidDomain

bool Anvil.API.NwDomain.IsValidDomain
get

Gets if this is a correctly configured domain.

◆ Name

StrRef Anvil.API.NwDomain.Name
get

Gets the name of this domain.

◆ Spells

IReadOnlyList<NwSpell?> Anvil.API.NwDomain.Spells
get

Gets a list of spells specific to this domain.

This property returns a fixed size list of 10, matching the number of spell levels (cantrips + 9 levels)
Levels that do not grant a spell for a domain return a null NwSpell in that slot.


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