Anvil
Anvil.API.NwSkill Class Reference

A creature/character skill definition. More...

Static Public Member Functions

static ? NwSkill FromSkillId (int skillId)
 Resolves a NwSkill from a skill id. More...
 
static ? NwSkill FromSkillType (Skill skillType)
 Resolves a NwSkill from a Anvil.API.Skill. More...
 
static implicit operator NwSkill? (Skill skillType)
 

Properties

bool AllClassesCanUse [get]
 Gets if this skill can be used by all classes. More...
 
bool ArmorCheckPenalty [get]
 Gets if this skill is subject to the armor check penalty. More...
 
StrRef Description [get]
 Gets the description of this skill. More...
 
string? IconResRef [get]
 Gets the ResRef of the GUI icon representing this skill. More...
 
byte Id [get]
 Gets the ID of this skill. More...
 
bool IsHostileSkill [get]
 Gets if this skill is considered a hostile action. More...
 
bool IsUntrained [get]
 Gets if this skill is untrained. Trained skills require at least a single rank before they can be used. More...
 
Ability KeyAbility [get]
 Gets the ability that the skill uses as More...
 
StrRef Name [get]
 Gets the name of this skill. More...
 
Skill SkillType [get]
 Gets the associated Skill type for this skill. More...
 

Detailed Description

A creature/character skill definition.

Member Function Documentation

◆ FromSkillId()

static ? NwSkill Anvil.API.NwSkill.FromSkillId ( int  skillId)
inlinestatic

Resolves a NwSkill from a skill id.

Parameters
skillIdThe id of the skill to resolve.
Returns
The associated NwSkill instance. Null if the skill id is invalid.

◆ FromSkillType()

static ? NwSkill Anvil.API.NwSkill.FromSkillType ( Skill  skillType)
inlinestatic

Resolves a NwSkill from a Anvil.API.Skill.

Parameters
skillTypeThe skill type to resolve.
Returns
The associated NwSkill instance. Null if the skill type is invalid.

Property Documentation

◆ AllClassesCanUse

bool Anvil.API.NwSkill.AllClassesCanUse
get

Gets if this skill can be used by all classes.

◆ ArmorCheckPenalty

bool Anvil.API.NwSkill.ArmorCheckPenalty
get

Gets if this skill is subject to the armor check penalty.

◆ Description

StrRef Anvil.API.NwSkill.Description
get

Gets the description of this skill.

◆ IconResRef

string? Anvil.API.NwSkill.IconResRef
get

Gets the ResRef of the GUI icon representing this skill.

◆ Id

byte Anvil.API.NwSkill.Id
get

Gets the ID of this skill.

◆ IsHostileSkill

bool Anvil.API.NwSkill.IsHostileSkill
get

Gets if this skill is considered a hostile action.

◆ IsUntrained

bool Anvil.API.NwSkill.IsUntrained
get

Gets if this skill is untrained. Trained skills require at least a single rank before they can be used.

◆ KeyAbility

Ability Anvil.API.NwSkill.KeyAbility
get

Gets the ability that the skill uses as

◆ Name

StrRef Anvil.API.NwSkill.Name
get

Gets the name of this skill.

◆ SkillType

Skill Anvil.API.NwSkill.SkillType
get

Gets the associated Skill type for this skill.


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