Anvil
Anvil.API.NwFeat Class Reference

A creature/character feat(ure) definition. More...

Public Member Functions

byte GetRequiredAbilityScore (Ability ability)
 Gets the minimum ability score a character must have to select this feat. More...
 

Static Public Member Functions

static ? NwFeat FromFeatId (int featId)
 Resolves a NwFeat from a feat id. More...
 
static ? NwFeat FromFeatType (Feat featType)
 Resolves a NwFeat from a Anvil.API.Feat. More...
 
static implicit operator NwFeat? (Feat featType)
 

Properties

bool AllClassesCanUse [get]
 Gets whether all classes can use this feat or not. More...
 
StrRef Description [get]
 Gets the description of this feat, as shown in the in-game skill window. More...
 
Feat FeatType [get]
 Gets the associated Feat type for this feat. More...
 
string? IconResRef [get]
 Gets the ResRef for the icon representing this skill. More...
 
ushort Id [get]
 Gets the id of this feat. More...
 
bool IsHostileFeat [get]
 Gets whether the use of this feat is considered as a hostile act. More...
 
byte MasterFeat [get]
 This number references masterfeats.2da. The master feat is used when a feat falls into a subcategory, such as the way "improved critical (longsword)" is a subcategory of improved critical. More...
 
byte MaxLevel [get]
 Gets the maximum character level allowed a character to be able to select this feat. More...
 
byte MinAttackBonus [get]
 Gets the minimum attack bonus a character must have to select this feat. More...
 
byte MinFortSave [get]
 Gets the minimum fortitude saving throw bonus a character must have to be able to select this feat. More...
 
byte MinLevel [get]
 Gets the minimum level a character must have to be able to take this feat. More...
 
NwClassMinLevelClass [get]
 Gets the corresponding class the character must have MinLevel levels in. More...
 
byte MinSpellLevel [get]
 The minimum spell level a spellcasting character must be able to cast in order to select this feat.
To determine eligibility, a check is made in classes.2da, examining the "SpellGainTable" and either the "SpellKnownTable" (for bards and sorcerers) or the "PrimaryAbil" (for other classes). More...
 
StrRef Name [get]
 Gets the name of this feat, as shown in the in-game skill window. More...
 
IEnumerable< NwFeatRequiredFeatsAll [get]
 Gets all feats that need to be selected before this one may be chosen. More...
 
IReadOnlyList< NwFeatRequiredFeatsSome [get]
 Gets feats that need to be selected before this one may be chosen.
Unlike RequiredFeatsAll, the creature only needs one of these feats to be able to take this feat. More...
 
NwSkillRequiredSkill1 [get]
 Gets the first required skill the character must have to be able to select this feat. More...
 
ushort RequiredSkill1MinRanks [get]
 Gets the number of skill ranks needed for RequiredSkill1. More...
 
NwSkillRequiredSkill2 [get]
 Gets the second required skill the character must have to be able to select this feat. More...
 
ushort RequiredSkill2MinRanks [get]
 Gets the number of skill ranks needed for RequiredSkill2. More...
 
bool RequiresAction [get]
 Gets if this feat requires a character action.
If this is true and the character uses this feat, it is added to the character's action queue, instead of running instantly. More...
 
bool RequiresEpic [get]
 Gets if only epic characters can choose this feat. More...
 
NwSpellSpell [get]
 The Spell associated with this feat. More...
 
NwFeatSuccessorFeat [get]
 Gets the feat which follows this feat. For example, the Disarm feat has Improved Disarm as a successor. More...
 
TalentCategory TalentCategory [get]
 This determines how the AI treats this feat. It is an ID value in categories.2da. More...
 
int TalentMaxCR [get]
 To do with the functions around Talents. The "Level" of the feat when we are searching for feats we want to not use if the enemy is of a certain CR.
Just as a reference spells.2da entries just double the spell level (so enemy is CR5, we cast level 1 or 2 spells, but not level 3 which doubles to 6). More...
 
bool TargetSelf [get]
 Gets whether this feat targets the character using the feat (so when using it, it doesn't pop up a selection for who to target).
Overrides spells.2da targeting options for PCs. More...
 
byte UsesPerDay [get]
 Gets the number of uses per day that this feat can be used. More...
 

Detailed Description

A creature/character feat(ure) definition.

Member Function Documentation

◆ FromFeatId()

static ? NwFeat Anvil.API.NwFeat.FromFeatId ( int  featId)
inlinestatic

Resolves a NwFeat from a feat id.

Parameters
featIdThe id of the feat to resolve.
Returns
The associated NwFeat instance. Null if the feat id is invalid.

◆ FromFeatType()

static ? NwFeat Anvil.API.NwFeat.FromFeatType ( Feat  featType)
inlinestatic

Resolves a NwFeat from a Anvil.API.Feat.

Parameters
featTypeThe feat type to resolve.
Returns
The associated NwFeat instance. Null if the feat type is invalid.

◆ GetRequiredAbilityScore()

byte Anvil.API.NwFeat.GetRequiredAbilityScore ( Ability  ability)
inline

Gets the minimum ability score a character must have to select this feat.

Parameters
abilityThe ability to query.
Returns
The ability score requirement.

Property Documentation

◆ AllClassesCanUse

bool Anvil.API.NwFeat.AllClassesCanUse
get

Gets whether all classes can use this feat or not.

◆ Description

StrRef Anvil.API.NwFeat.Description
get

Gets the description of this feat, as shown in the in-game skill window.

◆ FeatType

Feat Anvil.API.NwFeat.FeatType
get

Gets the associated Feat type for this feat.

◆ IconResRef

string? Anvil.API.NwFeat.IconResRef
get

Gets the ResRef for the icon representing this skill.

◆ Id

ushort Anvil.API.NwFeat.Id
get

Gets the id of this feat.

◆ IsHostileFeat

bool Anvil.API.NwFeat.IsHostileFeat
get

Gets whether the use of this feat is considered as a hostile act.

◆ MasterFeat

byte Anvil.API.NwFeat.MasterFeat
get

This number references masterfeats.2da. The master feat is used when a feat falls into a subcategory, such as the way "improved critical (longsword)" is a subcategory of improved critical.

◆ MaxLevel

byte Anvil.API.NwFeat.MaxLevel
get

Gets the maximum character level allowed a character to be able to select this feat.

◆ MinAttackBonus

byte Anvil.API.NwFeat.MinAttackBonus
get

Gets the minimum attack bonus a character must have to select this feat.

◆ MinFortSave

byte Anvil.API.NwFeat.MinFortSave
get

Gets the minimum fortitude saving throw bonus a character must have to be able to select this feat.

◆ MinLevel

byte Anvil.API.NwFeat.MinLevel
get

Gets the minimum level a character must have to be able to take this feat.

◆ MinLevelClass

NwClass? Anvil.API.NwFeat.MinLevelClass
get

Gets the corresponding class the character must have MinLevel levels in.

◆ MinSpellLevel

byte Anvil.API.NwFeat.MinSpellLevel
get

The minimum spell level a spellcasting character must be able to cast in order to select this feat.
To determine eligibility, a check is made in classes.2da, examining the "SpellGainTable" and either the "SpellKnownTable" (for bards and sorcerers) or the "PrimaryAbil" (for other classes).

◆ Name

StrRef Anvil.API.NwFeat.Name
get

Gets the name of this feat, as shown in the in-game skill window.

◆ RequiredFeatsAll

IEnumerable<NwFeat> Anvil.API.NwFeat.RequiredFeatsAll
get

Gets all feats that need to be selected before this one may be chosen.

◆ RequiredFeatsSome

IReadOnlyList<NwFeat> Anvil.API.NwFeat.RequiredFeatsSome
get

Gets feats that need to be selected before this one may be chosen.
Unlike RequiredFeatsAll, the creature only needs one of these feats to be able to take this feat.

◆ RequiredSkill1

NwSkill? Anvil.API.NwFeat.RequiredSkill1
get

Gets the first required skill the character must have to be able to select this feat.

◆ RequiredSkill1MinRanks

ushort Anvil.API.NwFeat.RequiredSkill1MinRanks
get

Gets the number of skill ranks needed for RequiredSkill1.

◆ RequiredSkill2

NwSkill? Anvil.API.NwFeat.RequiredSkill2
get

Gets the second required skill the character must have to be able to select this feat.

◆ RequiredSkill2MinRanks

ushort Anvil.API.NwFeat.RequiredSkill2MinRanks
get

Gets the number of skill ranks needed for RequiredSkill2.

◆ RequiresAction

bool Anvil.API.NwFeat.RequiresAction
get

Gets if this feat requires a character action.
If this is true and the character uses this feat, it is added to the character's action queue, instead of running instantly.

◆ RequiresEpic

bool Anvil.API.NwFeat.RequiresEpic
get

Gets if only epic characters can choose this feat.

◆ Spell

NwSpell? Anvil.API.NwFeat.Spell
get

The Spell associated with this feat.

◆ SuccessorFeat

NwFeat? Anvil.API.NwFeat.SuccessorFeat
get

Gets the feat which follows this feat. For example, the Disarm feat has Improved Disarm as a successor.

◆ TalentCategory

TalentCategory Anvil.API.NwFeat.TalentCategory
get

This determines how the AI treats this feat. It is an ID value in categories.2da.

◆ TalentMaxCR

int Anvil.API.NwFeat.TalentMaxCR
get

To do with the functions around Talents. The "Level" of the feat when we are searching for feats we want to not use if the enemy is of a certain CR.
Just as a reference spells.2da entries just double the spell level (so enemy is CR5, we cast level 1 or 2 spells, but not level 3 which doubles to 6).

◆ TargetSelf

bool Anvil.API.NwFeat.TargetSelf
get

Gets whether this feat targets the character using the feat (so when using it, it doesn't pop up a selection for who to target).
Overrides spells.2da targeting options for PCs.

◆ UsesPerDay

byte Anvil.API.NwFeat.UsesPerDay
get

Gets the number of uses per day that this feat can be used.


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