Skip to content

tes3race⚓︎

A core object representing a character race.

This type inherits the following: tes3baseObject

Properties⚓︎

abilities⚓︎

Read-only. A list of abilities that NPCs of that race have access to. It is a tes3spellList, which is a list wrapper with helper functions. The actual list is iterated over using pairs. E.g. for _, ability in pairs(race.abilities) do print(ability.name) end

Returns:

baseAttributes⚓︎

Read-only. Array-style table access to base 8 attributes for the race. Each element in the array is a tes3raceBaseAttribute.

Returns:

blocked⚓︎

The blocked state of the object.

Returns:

  • result (boolean)

deleted⚓︎

Read-only. The deleted state of the object.

Returns:

  • result (boolean)

description⚓︎

Read-only. Loads from disk and returns the description of the race.

Returns:

  • result (string)

disabled⚓︎

Read-only. The disabled state of the object.

Returns:

  • result (boolean)

femaleBody⚓︎

Read-only. Access to all the body parts that will be used for female actors of this race.

Returns:

flags⚓︎

Raw bit-based flags.

Returns:

  • result (number)

height⚓︎

Read-only. Access to the the height pair for males/females of the race. It corresponds to the scaling along the Z axis.

Returns:

id⚓︎

Read-only. The unique identifier for the object.

Returns:

  • result (string)

isBeast⚓︎

Access to the beast race flag.

Returns:

  • result (boolean)

isPlayable⚓︎

Access to the playable race flag.

Returns:

  • result (boolean)

maleBody⚓︎

Read-only. Access to all the body parts that will be used for male actors of this race.

Returns:

modified⚓︎

The modification state of the object since the last save.

Returns:

  • result (boolean)

name⚓︎

Read-only. The player-facing name for the object.

Returns:

  • result (string)

objectFlags⚓︎

Read-only. The raw flags of the object.

Returns:

  • result (number)

objectType⚓︎

Read-only. The type of object. Maps to values in tes3.objectType.

Returns:

persistent⚓︎

The persistent flag of the object.

Returns:

  • result (boolean)

skillBonuses⚓︎

Read-only. Array-style table access for 7 skill bonuses for the race. Each element in the array is a tes3raceSkillBonus.

Returns:

sourceless⚓︎

The soruceless flag of the object.

Returns:

  • result (boolean)

sourceMod⚓︎

Read-only. The filename (including the extension) of the mod that owns this object. It has nil value if the object was anything other than loaded from an ESP or ESM file.

Returns:

  • result (string)

supportsLuaData⚓︎

If true, references of this object can store temporary or persistent lua data.

Returns:

  • result (boolean)

weight⚓︎

Read-only. Access to the the height pair for males/females of the race. It corresponds to the scaling along the X and Y axes.

Returns:

Methods⚓︎

__tojson⚓︎

Serializes the object to json.

local string = myObject:__tojson()

Returns:

  • string (string)