Anvil.API.NwRace Class Reference

The race type of a creature. Contains additional ruleset information about the race. More...

Public Member Functions
sbyte	GetAbilityAdjustment (Ability ability)
	Gets the ability score adjustment for the specified ability. More...
bool	IsFirstLevelGrantedFeat (NwFeat feat)
	Gets if the specified feat is one that is automatically granted by this race at first level. More...

Static Public Member Functions
static ? NwRace	FromRaceId (int? raceId)
	Resolves a NwRace from a race id. More...
static ? NwRace	FromRaceId (ushort? raceId)
	Creates a race structure from the specified race id. More...
static ? NwRace	FromRacialType (RacialType racialType)
	Resolves a NwRace from a Anvil.API.RacialType. More...
static implicit	operator NwRace? (RacialType racialType)

Properties
int	AbilityPointBuyAmount [get]
	Gets the amount of points granted to this race during ability score point buy in character creation. More...
int	DefaultAge [get]
	Gets the default age used during character creation. More...
string?	DefaultCharacterDescription [get]
	Gets the description used by default for the character's description. More...
string?	Description [get]
	Gets the description of this race. More...
int	ExtraFeatsAtFirstLevel [get]
	Gets the number of extra feats that this race grants characters at first level. More...
int	ExtraSkillPointsPerLevel [get]
	Gets the number of extra skill points that this race grants characters per level. More...
NwClass?	FavoredClass [get]
	Gets the favoured class for this race, for the purposes of multi-classing. More...
int	FirstLevelSkillPointsMultiplier [get]
	Gets the initial muliplier for skill points given at first level. More...
ushort	Id [get]
	Gets the id of this race. More...
bool	IsPlayerRace [get]
	Gets if this race can be chosen/used by players. More...
string?	Name [get]
	Gets the name of this race. More...
int	NormalFeatEveryNthLevel [get]
	Gets the level period that feats are granted from this race. More...
int	NumberNormalFeatsEveryNthLevel [get]
	Gets how many feats are given to the character every NormalFeatEveryNthLevel. More...
string?	PluralName [get]
	Gets the plural name of this race. More...
RacialType	RacialType [get]
	Gets the associated Id for this race. More...
Ability	SkillPointModifierAbility [get]
	Gets the ability score used to determine bonus skill points at level up. More...

Detailed Description

The race type of a creature. Contains additional ruleset information about the race.

Member Function Documentation

FromRaceId() [1/2]

static ? NwRace Anvil.API.NwRace.FromRaceId ( int?  raceId )

inlinestatic

Resolves a NwRace from a race id.

Parameters

raceId

The id of the race to resolve.

Returns

The associated NwRace instance. Null if the race id is invalid.

FromRaceId() [2/2]

static ? NwRace Anvil.API.NwRace.FromRaceId ( ushort?  raceId )

inlinestatic

Creates a race structure from the specified race id.

Parameters

raceId

The associated race id.

Returns

The associated NwRace structure, or null if the race has no matching entry.

FromRacialType()

static ? NwRace Anvil.API.NwRace.FromRacialType ( RacialType  racialType )

inlinestatic

Resolves a NwRace from a Anvil.API.RacialType.

Parameters

racialType

The racial type to resolve.

Returns

The associated NwRace instance. Null if the racial type is invalid.

GetAbilityAdjustment()

sbyte Anvil.API.NwRace.GetAbilityAdjustment ( Ability  ability )

inline

Gets the ability score adjustment for the specified ability.

Parameters

ability

The ability to query.

Returns

A signed byte of the adjustment to the creature's ability score.

IsFirstLevelGrantedFeat()

bool Anvil.API.NwRace.IsFirstLevelGrantedFeat ( NwFeat  feat )

inline

Gets if the specified feat is one that is automatically granted by this race at first level.

Parameters

feat	The feat to query.

Returns

True if this is a default granted feat for this race, otherwise false.

Property Documentation

AbilityPointBuyAmount

int Anvil.API.NwRace.AbilityPointBuyAmount

get

Gets the amount of points granted to this race during ability score point buy in character creation.

DefaultAge

int Anvil.API.NwRace.DefaultAge

get

Gets the default age used during character creation.

DefaultCharacterDescription

string? Anvil.API.NwRace.DefaultCharacterDescription

get

Gets the description used by default for the character's description.

Description

string? Anvil.API.NwRace.Description

get

Gets the description of this race.

ExtraFeatsAtFirstLevel

int Anvil.API.NwRace.ExtraFeatsAtFirstLevel

get

Gets the number of extra feats that this race grants characters at first level.

ExtraSkillPointsPerLevel

int Anvil.API.NwRace.ExtraSkillPointsPerLevel

get

Gets the number of extra skill points that this race grants characters per level.

FavoredClass

NwClass? Anvil.API.NwRace.FavoredClass

get

Gets the favoured class for this race, for the purposes of multi-classing.

FirstLevelSkillPointsMultiplier

int Anvil.API.NwRace.FirstLevelSkillPointsMultiplier

get

Gets the initial muliplier for skill points given at first level.

Id

ushort Anvil.API.NwRace.Id

get

Gets the id of this race.

IsPlayerRace

bool Anvil.API.NwRace.IsPlayerRace

get

Gets if this race can be chosen/used by players.

Name

string? Anvil.API.NwRace.Name

get

Gets the name of this race.

NormalFeatEveryNthLevel

int Anvil.API.NwRace.NormalFeatEveryNthLevel

get

Gets the level period that feats are granted from this race.

NumberNormalFeatsEveryNthLevel

int Anvil.API.NwRace.NumberNormalFeatsEveryNthLevel

get

Gets how many feats are given to the character every NormalFeatEveryNthLevel.

PluralName

string? Anvil.API.NwRace.PluralName

get

Gets the plural name of this race.

RacialType

RacialType Anvil.API.NwRace.RacialType

get

Gets the associated Id for this race.

SkillPointModifierAbility

Ability Anvil.API.NwRace.SkillPointModifierAbility

get

Gets the ability score used to determine bonus skill points at level up.

---

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

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