Package openmw.types¶

openmw.types defines functions for specific types of game objects.

Usage:

local types = require('openmw.types')

Type `types`

types.Activator	#Activator functions
types.Actor	Common #Actor functions for Creature, NPC, and Player.
types.Apparatus	#Apparatus functions
types.Armor	#Armor functions
types.Book	#Book functions
types.Container	#Container functions
types.Creature	#Creature functions
types.Door	#Door functions
types.Ingredient	#Ingredient functions
types.Item	#Item functions (all pickable items that can be placed to an inventory or container)
types.Light	#Light functions
types.Lockpick	#Lockpick functions
types.Miscellaneous	Functions for #Miscellaneous objects
types.NPC	#NPC functions
types.Player	#Player functions
types.Potion	#Potion functions
types.Probe	#Probe functions
types.Repair	#Repair functions
types.Static	Functions for #Static objects
types.Weapon	#Weapon functions

Type `Activator`

Activator.objectIsInstance(object)	Whether the object is an Activator.
Activator.record(objectOrRecordId)	Returns the read-only #ActivatorRecord of an activator

Type `ActivatorRecord`

ActivatorRecord.id	Record id
ActivatorRecord.model	VFS path to the model
ActivatorRecord.mwscript	MWScript on this activator (can be empty)
ActivatorRecord.name	Human-readable name

Type `Actor`

Actor.EQUIPMENT_SLOT	Available #EQUIPMENT_SLOT values.
Actor.STANCE	#STANCE
Actor.canMove(object)	Returns true if the object is an actor and is able to move.
Actor.currentSpeed(actor)	Current speed.
Actor.equipment(actor, slot)	Get equipment.
Actor.getPathfindingAgentBounds(actor)	Agent bounds to be used for pathfinding functions.
Actor.inventory(actor)	Actor inventory.
Actor.isEquipped(actor, item)	Returns `true` if the item is equipped on the actor.
Actor.isOnGround(actor)	Is the actor standing on ground.
Actor.isSwimming(actor)	Is the actor in water.
Actor.objectIsInstance(object)	Whether the object is an actor.
Actor.runSpeed(actor)	Speed of running.
Actor.setEquipment(actor, equipment)	Set equipment.
Actor.stance(actor)	Returns the current stance (whether a weapon/spell is readied), see the list of #STANCE values.
Actor.stats	The actor's stats.
Actor.walkSpeed(actor)	Speed of walking.

Type `ActorStats`

ActorStats.attributes
ActorStats.dynamic
ActorStats.level(actor)	Level (returns #LevelStat)

Type `Apparatus`

Apparatus.TYPE	#ApparatusTYPE
Apparatus.baseType	#Item
Apparatus.objectIsInstance(object)	Whether the object is an Apparatus.
Apparatus.record(objectOrRecordId)	Returns the read-only #ApparatusRecord of an apparatus

Type `ApparatusRecord`

ApparatusRecord.icon	VFS path to the icon
ApparatusRecord.id	The record ID of the apparatus
ApparatusRecord.model	VFS path to the model
ApparatusRecord.mwscript	MWScript on this apparatus (can be empty)
ApparatusRecord.name	The name of the apparatus
ApparatusRecord.quality	The quality of the apparatus
ApparatusRecord.type	The type of apparatus. See Apparatus.TYPE
ApparatusRecord.value
ApparatusRecord.weight

Type `ApparatusTYPE`

ApparatusTYPE.Alembic
ApparatusTYPE.Calcinator
ApparatusTYPE.MortarPestle
ApparatusTYPE.Retort

Type `Armor`

Armor.baseType	#Item
Armor.objectIsInstance(object)	Whether the object is an Armor.

Type `AttributeStat`

AttributeStat.base	The actor's base attribute value.
AttributeStat.damage	The amount the attribute has been damaged.
AttributeStat.modified	The actor's current attribute value (read-only.)
AttributeStat.modifier	The attribute's modifier.

Type `AttributeStats`

AttributeStats.agility(actor)	Agility (returns #AttributeStat)
AttributeStats.endurance(actor)	Endurance (returns #AttributeStat)
AttributeStats.intelligence(actor)	Intelligence (returns #AttributeStat)
AttributeStats.luck(actor)	Luck (returns #AttributeStat)
AttributeStats.personality(actor)	Personality (returns #AttributeStat)
AttributeStats.speed(actor)	Speed (returns #AttributeStat)
AttributeStats.strength(actor)	Strength (returns #AttributeStat)
AttributeStats.willpower(actor)	Willpower (returns #AttributeStat)

Type `Book`

Book.SKILL	#BookSKILL
Book.baseType	#Item
Book.objectIsInstance(object)	Whether the object is a Book.
Book.record(objectOrRecordId)	Returns the read-only #BookRecord of a book

Type `BookRecord`

BookRecord.enchant	The enchantment ID of this book (can be empty)
BookRecord.enchantCapacity
BookRecord.icon	VFS path to the icon
BookRecord.id	The record ID of the book
BookRecord.isScroll
BookRecord.model	VFS path to the model
BookRecord.mwscript	MWScript on this book (can be empty)
BookRecord.name	Name of the book
BookRecord.skill	The skill that this book teaches. See Book.SKILL
BookRecord.text	The text content of the book
BookRecord.value
BookRecord.weight

Type `BookSKILL`

BookSKILL.acrobatics	"acrobatics"
BookSKILL.alchemy	"alchemy"
BookSKILL.alteration	"alteration"
BookSKILL.armorer	"armorer"
BookSKILL.athletics	"athletics"
BookSKILL.axe	"axe"
BookSKILL.block	"block"
BookSKILL.bluntWeapon	"bluntweapon"
BookSKILL.conjuration	"conjuration"
BookSKILL.destruction	"destruction"
BookSKILL.enchant	"enchant"
BookSKILL.handToHand	"handtohand"
BookSKILL.heavyArmor	"heavyarmor"
BookSKILL.illusion	"illusion"
BookSKILL.lightArmor	"lightarmor"
BookSKILL.longBlade	"longblade"
BookSKILL.marksman	"marksman"
BookSKILL.mediumArmor	"mediumarmor"
BookSKILL.mercantile	"mercantile"
BookSKILL.mysticism	"mysticism"
BookSKILL.restoration	"restoration"
BookSKILL.security	"security"
BookSKILL.shortBlade	"shortblade"
BookSKILL.sneak	"sneak"
BookSKILL.spear	"spear"
BookSKILL.speechcraft	"speechcraft"
BookSKILL.unarmored	"unarmored"

Type `Clothing`

Clothing.baseType	#Item
Clothing.objectIsInstance(object)	Whether the object is a Clothing.

Type `Container`

Container.capacity(object)	Returns the capacity of a container
Container.content(object)	Container content.
Container.encumbrance(object)	Returns the total weight of everything in a container
Container.objectIsInstance(object)	Whether the object is a Container.
Container.record(objectOrRecordId)	Returns the read-only #ContainerRecord of a container

Type `ContainerRecord`

ContainerRecord.id	Record id
ContainerRecord.model	VFS path to the model
ContainerRecord.mwscript	MWScript on this container (can be empty)
ContainerRecord.name	Human-readable name
ContainerRecord.weight	capacity of this container

Type `Creature`

Creature.baseType	#Actor
Creature.objectIsInstance(object)	Whether the object is a creature.
Creature.record(objectOrRecordId)	Returns the read-only #CreatureRecord of a creature

Type `CreatureRecord`

CreatureRecord.baseCreature	Record id of a base creature, which was modified to create this one
CreatureRecord.model	VFS path to the creature's model
CreatureRecord.mwscript
CreatureRecord.name

Type `Door`

Door.destCell(object)	Destination cell (only if a teleport door).
Door.destPosition(object)	Destination (only if a teleport door).
Door.destRotation(object)	Destination rotation (only if a teleport door).
Door.isTeleport(object)	Whether the door is a teleport.
Door.objectIsInstance(object)	Whether the object is a Door.
Door.record(objectOrRecordId)	Returns the read-only #DoorRecord of a door

Type `DoorRecord`

DoorRecord.closeSound	VFS path to the sound of closing
DoorRecord.id	Record id
DoorRecord.model	VFS path to the model
DoorRecord.mwscript	MWScript on this door (can be empty)
DoorRecord.name	Human-readable name
DoorRecord.openSound	VFS path to the sound of opening

Type `DynamicStat`

DynamicStat.base
DynamicStat.current
DynamicStat.modifier

Type `DynamicStats`

DynamicStats.fatigue(actor)	Fatigue (returns #DynamicStat)
DynamicStats.health(actor)	Health (returns #DynamicStat)
DynamicStats.magicka(actor)	Magicka (returns #DynamicStat)

Type `EQUIPMENT_SLOT`

EQUIPMENT_SLOT.Ammunition
EQUIPMENT_SLOT.Amulet
EQUIPMENT_SLOT.Belt
EQUIPMENT_SLOT.Boots
EQUIPMENT_SLOT.CarriedLeft
EQUIPMENT_SLOT.CarriedRight
EQUIPMENT_SLOT.Cuirass
EQUIPMENT_SLOT.Greaves
EQUIPMENT_SLOT.Helmet
EQUIPMENT_SLOT.LeftGauntlet
EQUIPMENT_SLOT.LeftPauldron
EQUIPMENT_SLOT.LeftRing
EQUIPMENT_SLOT.Pants
EQUIPMENT_SLOT.RightGauntlet
EQUIPMENT_SLOT.RightPauldron
EQUIPMENT_SLOT.RightRing
EQUIPMENT_SLOT.Robe
EQUIPMENT_SLOT.Shirt
EQUIPMENT_SLOT.Skirt

Type `Ingredient`

Ingredient.baseType	#Item
Ingredient.objectIsInstance(object)	Whether the object is an Ingredient.
Ingredient.record(objectOrRecordId)	Returns the read-only #IngredientRecord of a Ingredient

Type `IngredientRecord`

IngredientRecord.icon	VFS path to the icon
IngredientRecord.id	Record id
IngredientRecord.model	VFS path to the model
IngredientRecord.mwscript	MWScript on this potion (can be empty)
IngredientRecord.name	Human-readable name
IngredientRecord.value
IngredientRecord.weight

Type `Item`

Item.objectIsInstance(object)

Whether the object is an item.

Type `LevelStat`

LevelStat.current	The actor's current level.
LevelStat.progress	The NPC's level progress (read-only.)

Type `Light`

Light.baseType	#Item
Light.objectIsInstance(object)	Whether the object is a Light.

Type `Lockpick`

Lockpick.baseType	#Item
Lockpick.objectIsInstance(object)	Whether the object is a Lockpick.
Lockpick.record(objectOrRecordId)	Returns the read-only #LockpickRecord of a lockpick

Type `LockpickRecord`

LockpickRecord.icon	VFS path to the icon
LockpickRecord.id	The record ID of the lockpick
LockpickRecord.maxCondition	The maximum number of uses of this lockpick
LockpickRecord.model	VFS path to the model
LockpickRecord.mwscript	MWScript on this lockpick (can be empty)
LockpickRecord.name	The name of the lockpick
LockpickRecord.quality	The quality of the lockpick
LockpickRecord.value
LockpickRecord.weight

Type `Miscellaneous`

Miscellaneous.baseType	#Item
Miscellaneous.objectIsInstance(object)	Whether the object is a Miscellaneous.
Miscellaneous.record(objectOrRecordId)	Returns the read-only #MiscellaneousRecord of a miscellaneous item

Type `MiscellaneousRecord`

MiscellaneousRecord.icon	VFS path to the icon
MiscellaneousRecord.id	The record ID of the miscellaneous item
MiscellaneousRecord.isKey
MiscellaneousRecord.model	VFS path to the model
MiscellaneousRecord.mwscript	MWScript on this miscellaneous item (can be empty)
MiscellaneousRecord.name	The name of the miscellaneous item
MiscellaneousRecord.value
MiscellaneousRecord.weight

Type `NPC`

NPC.baseType	#Actor
NPC.objectIsInstance(object)	Whether the object is an NPC or a Player.
NPC.record(objectOrRecordId)	Returns the read-only #NpcRecord of an NPC
NPC.stats

Type `NpcRecord`

NpcRecord.class	Name of the NPC's class (e. g. Acrobat)
NpcRecord.hair	Path to the hair body part model
NpcRecord.head	Path to the head body part model
NpcRecord.mwscript	MWScript that is attached to this NPC
NpcRecord.name
NpcRecord.race

Type `Player`

Player.baseType	#NPC
Player.objectIsInstance(object)	Whether the object is a player.

Type `Potion`

Potion.baseType	#Item
Potion.objectIsInstance(object)	Whether the object is a Potion.
Potion.record(objectOrRecordId)	Returns the read-only #PotionRecord of a potion

Type `PotionRecord`

PotionRecord.icon	VFS path to the icon
PotionRecord.id	Record id
PotionRecord.model	VFS path to the model
PotionRecord.mwscript	MWScript on this potion (can be empty)
PotionRecord.name	Human-readable name
PotionRecord.value
PotionRecord.weight

Type `Probe`

Probe.baseType	#Item
Probe.objectIsInstance(object)	Whether the object is a Probe.
Probe.record(objectOrRecordId)	Returns the read-only #ProbeRecord of a probe

Type `ProbeRecord`

ProbeRecord.icon	VFS path to the icon
ProbeRecord.id	The record ID of the probe
ProbeRecord.maxCondition	The maximum number of uses of this probe
ProbeRecord.model	VFS path to the model
ProbeRecord.mwscript	MWScript on this probe (can be empty)
ProbeRecord.name	The name of the probe
ProbeRecord.quality	The quality of the probe
ProbeRecord.value
ProbeRecord.weight

Type `Repair`

Repair.baseType	#Item
Repair.objectIsInstance(object)	Whether the object is a Repair.
Repair.record(objectOrRecordId)	Returns the read-only #RepairRecord of a repair tool

Type `RepairRecord`

RepairRecord.icon	VFS path to the icon
RepairRecord.id	The record ID of the repair tool
RepairRecord.maxCondition	The maximum number of uses of this repair tool
RepairRecord.model	VFS path to the model
RepairRecord.mwscript	MWScript on this repair tool (can be empty)
RepairRecord.name	The name of the repair tool
RepairRecord.quality	The quality of the repair tool
RepairRecord.value
RepairRecord.weight

Type `STANCE`

STANCE.Nothing	Default stance
STANCE.Spell	Magic stance
STANCE.Weapon	Weapon stance

Type `SkillStat`

SkillStat.base	The NPC's base skill value.
SkillStat.damage	The amount the skill has been damaged.
SkillStat.modified	The NPC's current skill value (read-only.)
SkillStat.modifier	The skill's modifier.
SkillStat.progress	[0-1] The NPC's skill progress.

Type `SkillStats`

SkillStats.acrobatics(actor)	Acrobatics (returns #SkillStat)
SkillStats.alchemy(actor)	Alchemy (returns #SkillStat)
SkillStats.alteration(actor)	Alteration (returns #SkillStat)
SkillStats.armorer(actor)	Armorer (returns #SkillStat)
SkillStats.athletics(actor)	Athletics (returns #SkillStat)
SkillStats.axe(actor)	Axe (returns #SkillStat)
SkillStats.block(actor)	Block (returns #SkillStat)
SkillStats.bluntweapon(actor)	Blunt Weapon (returns #SkillStat)
SkillStats.conjuration(actor)	Conjuration (returns #SkillStat)
SkillStats.destruction(actor)	Destruction (returns #SkillStat)
SkillStats.enchant(actor)	Enchant (returns #SkillStat)
SkillStats.handtohand(actor)	Hand To Hand (returns #SkillStat)
SkillStats.heavyarmor(actor)	Heavy Armor (returns #SkillStat)
SkillStats.illusion(actor)	Illusion (returns #SkillStat)
SkillStats.lightarmor(actor)	Light Armor (returns #SkillStat)
SkillStats.longblade(actor)	Long Blade (returns #SkillStat)
SkillStats.marksman(actor)	Marksman (returns #SkillStat)
SkillStats.mediumarmor(actor)	Medium Armor (returns #SkillStat)
SkillStats.mercantile(actor)	Mercantile (returns #SkillStat)
SkillStats.mysticism(actor)	Mysticism (returns #SkillStat)
SkillStats.restoration(actor)	Restoration (returns #SkillStat)
SkillStats.security(actor)	Security (returns #SkillStat)
SkillStats.shortblade(actor)	Short Blade (returns #SkillStat)
SkillStats.sneak(actor)	Sneak (returns #SkillStat)
SkillStats.spear(actor)	Spear (returns #SkillStat)
SkillStats.speechcraft(actor)	Speechcraft (returns #SkillStat)
SkillStats.unarmored(actor)	Unarmored (returns #SkillStat)

Type `Static`

Static.objectIsInstance(object)

Whether the object is a Static.

Type `Weapon`

Weapon.TYPE	#WeaponTYPE
Weapon.baseType	#Item
Weapon.objectIsInstance(object)	Whether the object is a Weapon.
Weapon.record(objectOrRecordId)	Returns the read-only #WeaponRecord of a weapon

Type `WeaponRecord`

WeaponRecord.chopMaxDamage
WeaponRecord.chopMinDamage
WeaponRecord.enchant
WeaponRecord.enchantCapacity
WeaponRecord.health
WeaponRecord.icon	VFS path to the icon
WeaponRecord.id	Record id
WeaponRecord.isMagical
WeaponRecord.isSilver
WeaponRecord.model	VFS path to the model
WeaponRecord.mwscript	MWScript on this weapon (can be empty)
WeaponRecord.name	Human-readable name
WeaponRecord.reach
WeaponRecord.slashMaxDamage
WeaponRecord.slashMinDamage
WeaponRecord.speed
WeaponRecord.thrustMaxDamage
WeaponRecord.thrustMinDamage
WeaponRecord.type	See Weapon.TYPE
WeaponRecord.value
WeaponRecord.weight

Type `WeaponTYPE`

WeaponTYPE.Arrow
WeaponTYPE.AxeOneHand
WeaponTYPE.AxeTwoHand
WeaponTYPE.BluntOneHand
WeaponTYPE.BluntTwoClose
WeaponTYPE.BluntTwoWide
WeaponTYPE.Bolt
WeaponTYPE.LongBladeOneHand
WeaponTYPE.LongBladeTwoHand
WeaponTYPE.MarksmanBow
WeaponTYPE.MarksmanCrossbow
WeaponTYPE.MarksmanThrown
WeaponTYPE.ShortBladeOneHand
WeaponTYPE.SpearTwoWide

Type `types`

Field(s)

#Activator types.Activator: #Activator functions

#Actor types.Actor: Common #Actor functions for Creature, NPC, and Player.

#Apparatus types.Apparatus: #Apparatus functions

#Armor types.Armor: #Armor functions

#Book types.Book: #Book functions

#Container types.Container: #Container functions

#Creature types.Creature: #Creature functions

#Door types.Door: #Door functions

#Ingredient types.Ingredient: #Ingredient functions

#Item types.Item: #Item functions (all pickable items that can be placed to an inventory or container)

#Light types.Light: #Light functions

#Lockpick types.Lockpick: #Lockpick functions

#Miscellaneous types.Miscellaneous: Functions for #Miscellaneous objects

#NPC types.NPC: #NPC functions

#Player types.Player: #Player functions

#Potion types.Potion: #Potion functions

#Probe types.Probe: #Probe functions

#Repair types.Repair: #Repair functions

#Static types.Static: Functions for #Static objects

#Weapon types.Weapon: #Weapon functions

Type `Activator`

Field(s)

Activator.objectIsInstance(object)

Whether the object is an Activator.

Parameter

openmw.core#GameObject object :

Return value

#boolean:

Activator.record(objectOrRecordId)

Returns the read-only #ActivatorRecord of an activator

Parameter

#any objectOrRecordId :

Return value

#ActivatorRecord:

Type `ActivatorRecord`

Field(s)

#string ActivatorRecord.id: Record id

#string ActivatorRecord.model: VFS path to the model

#string ActivatorRecord.mwscript: MWScript on this activator (can be empty)

#string ActivatorRecord.name: Human-readable name

Type `Actor`

Common functions for Creature, NPC, and Player.

Field(s)

#EQUIPMENT_SLOT Actor.EQUIPMENT_SLOT

Available #EQUIPMENT_SLOT values.

Used in Actor.equipment(obj) and Actor.setEquipment(obj, eqp).

#STANCE Actor.STANCE: #STANCE

Actor.canMove(object)

Returns true if the object is an actor and is able to move.

For dead, paralyzed, or knocked down actors it returns false.

Parameter

openmw.core#GameObject object :

Return value

#boolean:

Actor.currentSpeed(actor)

Current speed.

Parameter

openmw.core#GameObject actor :

Return value

#number:

Actor.equipment(actor, slot)

Get equipment.

Has two overloads:
1) With single argument: returns a table slot -> openmw.core#GameObject of currently equipped items. See #EQUIPMENT_SLOT. Returns empty table if the actor doesn't have equipment slots.
2) With two arguments: returns an item equipped to the given slot.

Parameters

openmw.core#GameObject actor :
#number slot : (optional argument)

Actor.getPathfindingAgentBounds(actor)

Agent bounds to be used for pathfinding functions.

Parameter

openmw.core#GameObject actor :

Return value

#table: with shapeType and halfExtents

Actor.inventory(actor)

Actor inventory.

Parameter

openmw.core#GameObject actor :

Return value

openmw.core#Inventory:

Actor.isEquipped(actor, item)

Returns true if the item is equipped on the actor.

Parameters

openmw.core#GameObject actor :
openmw.core#GameObject item :

Return value

#boolean:

Actor.isOnGround(actor)

Is the actor standing on ground.

Can be called only from a local script.

Parameter

openmw.core#GameObject actor :

Return value

#boolean:

Actor.isSwimming(actor)

Is the actor in water.

Can be called only from a local script.

Parameter

openmw.core#GameObject actor :

Return value

#boolean:

Actor.objectIsInstance(object)

Whether the object is an actor.

Parameter

openmw.core#GameObject object :

Return value

#boolean:

Actor.runSpeed(actor)

Speed of running.

For dead actors it still returns a positive value.

Parameter

openmw.core#GameObject actor :

Return value

#number:

Actor.setEquipment(actor, equipment)

Set equipment.

Keys in the table are equipment slots (see #EQUIPMENT_SLOT). Each value can be either a GameObject or recordId. Raises an error if the actor doesn't have equipment slots and table is not empty. Can be used only in local scripts and only on self.

Parameters

openmw.core#GameObject actor :
equipment :

Usage:

local self = require('openmw.self')
local Actor = require('openmw.types').Actor
Actor.setEquipment(self, {}) -- unequip all

Actor.stance(actor)

Returns the current stance (whether a weapon/spell is readied), see the list of #STANCE values.

Parameter

openmw.core#GameObject actor :

Return value

#number:

#ActorStats Actor.stats: The actor's stats.

Actor.walkSpeed(actor)

Speed of walking.

For dead actors it still returns a positive value.

Parameter

openmw.core#GameObject actor :

Return value

#number:

Type `ActorStats`

Field(s)

#AttributeStats ActorStats.attributes

#DynamicStats ActorStats.dynamic

ActorStats.level(actor)

Level (returns #LevelStat)

Parameter

openmw.core#GameObject actor :

Return value

#LevelStat:

Type `Apparatus`

Extends #Item

Field(s)

#ApparatusTYPE Apparatus.TYPE: #ApparatusTYPE

#Item Apparatus.baseType: #Item

Apparatus.objectIsInstance(object)

Whether the object is an Apparatus.

Parameter

openmw.core#GameObject object :

Return value

#boolean:

Apparatus.record(objectOrRecordId)

Returns the read-only #ApparatusRecord of an apparatus

Parameter

#any objectOrRecordId :

Return value

#ApparatusRecord:

Type `ApparatusRecord`

Field(s)

#string ApparatusRecord.icon: VFS path to the icon

#string ApparatusRecord.id: The record ID of the apparatus

#string ApparatusRecord.model: VFS path to the model

#string ApparatusRecord.mwscript: MWScript on this apparatus (can be empty)

#string ApparatusRecord.name: The name of the apparatus

#number ApparatusRecord.quality: The quality of the apparatus

#number ApparatusRecord.type: The type of apparatus. See Apparatus.TYPE

#number ApparatusRecord.value

#number ApparatusRecord.weight

Type `ApparatusTYPE`

Apparatus.TYPE

Field(s)

#number ApparatusTYPE.Alembic

#number ApparatusTYPE.Calcinator

#number ApparatusTYPE.MortarPestle

#number ApparatusTYPE.Retort

Type `Armor`

Extends #Item

Field(s)

#Item Armor.baseType: #Item

Armor.objectIsInstance(object)

Whether the object is an Armor.

Parameter

openmw.core#GameObject object :

Return value

#boolean:

Type `AttributeStat`

Field(s)

#number AttributeStat.base: The actor's base attribute value.

#number AttributeStat.damage: The amount the attribute has been damaged.

#number AttributeStat.modified: The actor's current attribute value (read-only.)

#number AttributeStat.modifier: The attribute's modifier.

Type `AttributeStats`

Field(s)

AttributeStats.agility(actor)

Agility (returns #AttributeStat)

Parameter

openmw.core#GameObject actor :

Return value

#AttributeStat:

AttributeStats.endurance(actor)

Endurance (returns #AttributeStat)

Parameter

openmw.core#GameObject actor :

Return value

#AttributeStat:

AttributeStats.intelligence(actor)

Intelligence (returns #AttributeStat)

Parameter

openmw.core#GameObject actor :

Return value

#AttributeStat:

AttributeStats.luck(actor)

Luck (returns #AttributeStat)

Parameter

openmw.core#GameObject actor :

Return value

#AttributeStat:

AttributeStats.personality(actor)

Personality (returns #AttributeStat)

Parameter

openmw.core#GameObject actor :

Return value

#AttributeStat:

AttributeStats.speed(actor)

Speed (returns #AttributeStat)

Parameter

openmw.core#GameObject actor :

Return value

#AttributeStat:

AttributeStats.strength(actor)

Strength (returns #AttributeStat)

Parameter

openmw.core#GameObject actor :

Return value

#AttributeStat:

AttributeStats.willpower(actor)

Willpower (returns #AttributeStat)

Parameter

openmw.core#GameObject actor :

Return value

#AttributeStat:

Type `Book`

Extends #Item

Field(s)

#BookSKILL Book.SKILL: #BookSKILL

#Item Book.baseType: #Item

Book.objectIsInstance(object)

Whether the object is a Book.

Parameter

openmw.core#GameObject object :

Return value

#boolean:

Book.record(objectOrRecordId)

Returns the read-only #BookRecord of a book

Parameter

#any objectOrRecordId :

Return value

#BookRecord:

Type `BookRecord`

Field(s)

#string BookRecord.enchant: The enchantment ID of this book (can be empty)

#number BookRecord.enchantCapacity

#string BookRecord.icon: VFS path to the icon

#string BookRecord.id: The record ID of the book

#boolean BookRecord.isScroll

#string BookRecord.model: VFS path to the model

#string BookRecord.mwscript: MWScript on this book (can be empty)

#string BookRecord.name: Name of the book

#string BookRecord.skill: The skill that this book teaches. See Book.SKILL

#string BookRecord.text: The text content of the book

#number BookRecord.value

#number BookRecord.weight

Type `BookSKILL`

Book.SKILL

Field(s)

#string BookSKILL.acrobatics: "acrobatics"

#string BookSKILL.alchemy: "alchemy"

#string BookSKILL.alteration: "alteration"

#string BookSKILL.armorer: "armorer"

#string BookSKILL.athletics: "athletics"

#string BookSKILL.axe: "axe"

#string BookSKILL.block: "block"

#string BookSKILL.bluntWeapon: "bluntweapon"

#string BookSKILL.conjuration: "conjuration"

#string BookSKILL.destruction: "destruction"

#string BookSKILL.enchant: "enchant"

#string BookSKILL.handToHand: "handtohand"

#string BookSKILL.heavyArmor: "heavyarmor"

#string BookSKILL.illusion: "illusion"

#string BookSKILL.lightArmor: "lightarmor"

#string BookSKILL.longBlade: "longblade"

#string BookSKILL.marksman: "marksman"

#string BookSKILL.mediumArmor: "mediumarmor"

#string BookSKILL.mercantile: "mercantile"

#string BookSKILL.mysticism: "mysticism"

#string BookSKILL.restoration: "restoration"

#string BookSKILL.security: "security"

#string BookSKILL.shortBlade: "shortblade"

#string BookSKILL.sneak: "sneak"

#string BookSKILL.spear: "spear"

#string BookSKILL.speechcraft: "speechcraft"

#string BookSKILL.unarmored: "unarmored"

Type `Clothing`

Extends #Item

Field(s)

#Item Clothing.baseType: #Item

Clothing.objectIsInstance(object)

Whether the object is a Clothing.

Parameter

openmw.core#GameObject object :

Return value

#boolean:

Type `Container`

Field(s)

Container.capacity(object)

Returns the capacity of a container

Parameter

openmw.core#GameObject object :

Return value

#number:

Container.content(object)

Container content.

Parameter

openmw.core#GameObject object :

Return value

openmw.core#Inventory:

Container.encumbrance(object)

Returns the total weight of everything in a container

Parameter

openmw.core#GameObject object :

Return value

#number:

Container.objectIsInstance(object)

Whether the object is a Container.

Parameter

openmw.core#GameObject object :

Return value

#boolean:

Container.record(objectOrRecordId)

Returns the read-only #ContainerRecord of a container

Parameter

#any objectOrRecordId :

Return value

#ContainerRecord:

Type `ContainerRecord`

Field(s)

#string ContainerRecord.id: Record id

#string ContainerRecord.model: VFS path to the model

#string ContainerRecord.mwscript: MWScript on this container (can be empty)

#string ContainerRecord.name: Human-readable name

#number ContainerRecord.weight: capacity of this container

Type `Creature`

Extends #Actor

Field(s)

#Actor Creature.baseType: #Actor

Creature.objectIsInstance(object)

Whether the object is a creature.

Parameter

openmw.core#GameObject object :

Return value

#boolean:

Creature.record(objectOrRecordId)

Returns the read-only #CreatureRecord of a creature

Parameter

#any objectOrRecordId :

Return value

#CreatureRecord:

Type `CreatureRecord`

Field(s)

#string CreatureRecord.baseCreature: Record id of a base creature, which was modified to create this one

#string CreatureRecord.model: VFS path to the creature's model

#string CreatureRecord.mwscript

#string CreatureRecord.name

Type `Door`

Field(s)

Door.destCell(object)

Destination cell (only if a teleport door).

Parameter

openmw.core#GameObject object :

Return value

openmw.core#Cell:

Door.destPosition(object)

Destination (only if a teleport door).

Parameter

openmw.core#GameObject object :

Return value

openmw.util#Vector3:

Door.destRotation(object)

Destination rotation (only if a teleport door).

Parameter

openmw.core#GameObject object :

Return value

openmw.util#Vector3:

Door.isTeleport(object)

Whether the door is a teleport.

Parameter

openmw.core#GameObject object :

Return value

#boolean:

Door.objectIsInstance(object)

Whether the object is a Door.

Parameter

openmw.core#GameObject object :

Return value

#boolean:

Door.record(objectOrRecordId)

Returns the read-only #DoorRecord of a door

Parameter

#any objectOrRecordId :

Return value

#DoorRecord:

Type `DoorRecord`

Field(s)

#string DoorRecord.closeSound: VFS path to the sound of closing

#string DoorRecord.id: Record id

#string DoorRecord.model: VFS path to the model

#string DoorRecord.mwscript: MWScript on this door (can be empty)

#string DoorRecord.name: Human-readable name

#string DoorRecord.openSound: VFS path to the sound of opening

Type `DynamicStat`

Field(s)

#number DynamicStat.base

#number DynamicStat.current

#number DynamicStat.modifier

Type `DynamicStats`

Field(s)

DynamicStats.fatigue(actor)

Fatigue (returns #DynamicStat)

Parameter

openmw.core#GameObject actor :

Return value

#DynamicStat:

DynamicStats.health(actor)

Health (returns #DynamicStat)

Parameter

openmw.core#GameObject actor :

Return value

#DynamicStat:

DynamicStats.magicka(actor)

Magicka (returns #DynamicStat)

Parameter

openmw.core#GameObject actor :

Return value

#DynamicStat:

Type `EQUIPMENT_SLOT`

Field(s)

#number EQUIPMENT_SLOT.Ammunition

#number EQUIPMENT_SLOT.Amulet

#number EQUIPMENT_SLOT.Belt

#number EQUIPMENT_SLOT.Boots

#number EQUIPMENT_SLOT.CarriedLeft

#number EQUIPMENT_SLOT.CarriedRight

#number EQUIPMENT_SLOT.Cuirass

#number EQUIPMENT_SLOT.Greaves

#number EQUIPMENT_SLOT.Helmet

#number EQUIPMENT_SLOT.LeftGauntlet

#number EQUIPMENT_SLOT.LeftPauldron

#number EQUIPMENT_SLOT.LeftRing

#number EQUIPMENT_SLOT.Pants

#number EQUIPMENT_SLOT.RightGauntlet

#number EQUIPMENT_SLOT.RightPauldron

#number EQUIPMENT_SLOT.RightRing

#number EQUIPMENT_SLOT.Robe

#number EQUIPMENT_SLOT.Shirt

#number EQUIPMENT_SLOT.Skirt

Type `Ingredient`

Extends #Item

Field(s)

#Item Ingredient.baseType: #Item

Ingredient.objectIsInstance(object)

Whether the object is an Ingredient.

Parameter

openmw.core#GameObject object :

Return value

#boolean:

Ingredient.record(objectOrRecordId)

Returns the read-only #IngredientRecord of a Ingredient

Parameter

#any objectOrRecordId :

Return value

#IngredientRecord:

Type `IngredientRecord`

Field(s)

#string IngredientRecord.icon: VFS path to the icon

#string IngredientRecord.id: Record id

#string IngredientRecord.model: VFS path to the model

#string IngredientRecord.mwscript: MWScript on this potion (can be empty)

#string IngredientRecord.name: Human-readable name

#number IngredientRecord.value

#number IngredientRecord.weight

Type `Item`

Functions for pickable items that can be placed to an inventory or container

Field(s)

Item.objectIsInstance(object)

Whether the object is an item.

Parameter

openmw.core#GameObject object :

Return value

#boolean:

Type `LevelStat`

Field(s)

#number LevelStat.current: The actor's current level.

#number LevelStat.progress: The NPC's level progress (read-only.)

Type `Light`

Extends #Item

Field(s)

#Item Light.baseType: #Item

Light.objectIsInstance(object)

Whether the object is a Light.

Parameter

openmw.core#GameObject object :

Return value

#boolean:

Type `Lockpick`

Extends #Item

Field(s)

#Item Lockpick.baseType: #Item

Lockpick.objectIsInstance(object)

Whether the object is a Lockpick.

Parameter

openmw.core#GameObject object :

Return value

#boolean:

Lockpick.record(objectOrRecordId)

Returns the read-only #LockpickRecord of a lockpick

Parameter

#any objectOrRecordId :

Return value

#LockpickRecord:

Type `LockpickRecord`

Field(s)

#string LockpickRecord.icon: VFS path to the icon

#string LockpickRecord.id: The record ID of the lockpick

#number LockpickRecord.maxCondition: The maximum number of uses of this lockpick

#string LockpickRecord.model: VFS path to the model

#string LockpickRecord.mwscript: MWScript on this lockpick (can be empty)

#string LockpickRecord.name: The name of the lockpick

#number LockpickRecord.quality: The quality of the lockpick

#number LockpickRecord.value

#number LockpickRecord.weight

Type `Miscellaneous`

Extends #Item

Field(s)

#Item Miscellaneous.baseType: #Item

Miscellaneous.objectIsInstance(object)

Whether the object is a Miscellaneous.

Parameter

openmw.core#GameObject object :

Return value

#boolean:

Miscellaneous.record(objectOrRecordId)

Returns the read-only #MiscellaneousRecord of a miscellaneous item

Parameter

#any objectOrRecordId :

Return value

#MiscellaneousRecord:

Type `MiscellaneousRecord`

Field(s)

#string MiscellaneousRecord.icon: VFS path to the icon

#string MiscellaneousRecord.id: The record ID of the miscellaneous item

#boolean MiscellaneousRecord.isKey

#string MiscellaneousRecord.model: VFS path to the model

#string MiscellaneousRecord.mwscript: MWScript on this miscellaneous item (can be empty)

#string MiscellaneousRecord.name: The name of the miscellaneous item

#number MiscellaneousRecord.value

#number MiscellaneousRecord.weight

Type `NPC`

Extends #Actor

Field(s)

#Actor NPC.baseType: #Actor

NPC.objectIsInstance(object)

Whether the object is an NPC or a Player.

Parameter

openmw.core#GameObject object :

Return value

#boolean:

NPC.record(objectOrRecordId)

Returns the read-only #NpcRecord of an NPC

Parameter

#any objectOrRecordId :

Return value

#NpcRecord:

#NpcStats NPC.stats

Type `NpcRecord`

Field(s)

#string NpcRecord.class: Name of the NPC's class (e. g. Acrobat)

#string NpcRecord.hair: Path to the hair body part model

#string NpcRecord.head: Path to the head body part model

#string NpcRecord.mwscript: MWScript that is attached to this NPC

#string NpcRecord.name

#string NpcRecord.race

Type `NpcStats`

Field(s)

#SkillStats NpcStats.skills

Type `Player`

Extends #NPC

Field(s)

#NPC Player.baseType: #NPC

Player.objectIsInstance(object)

Whether the object is a player.

Parameter

openmw.core#GameObject object :

Return value

#boolean:

Type `Potion`

Extends #Item

Field(s)

#Item Potion.baseType: #Item

Potion.objectIsInstance(object)

Whether the object is a Potion.

Parameter

openmw.core#GameObject object :

Return value

#boolean:

Potion.record(objectOrRecordId)

Returns the read-only #PotionRecord of a potion

Parameter

#any objectOrRecordId :

Return value

#PotionRecord:

Type `PotionRecord`

Field(s)

#string PotionRecord.icon: VFS path to the icon

#string PotionRecord.id: Record id

#string PotionRecord.model: VFS path to the model

#string PotionRecord.mwscript: MWScript on this potion (can be empty)

#string PotionRecord.name: Human-readable name

#number PotionRecord.value

#number PotionRecord.weight

Type `Probe`

Extends #Item

Field(s)

#Item Probe.baseType: #Item

Probe.objectIsInstance(object)

Whether the object is a Probe.

Parameter

openmw.core#GameObject object :

Return value

#boolean:

Probe.record(objectOrRecordId)

Returns the read-only #ProbeRecord of a probe

Parameter

#any objectOrRecordId :

Return value

#ProbeRecord:

Type `ProbeRecord`

Field(s)

#string ProbeRecord.icon: VFS path to the icon

#string ProbeRecord.id: The record ID of the probe

#number ProbeRecord.maxCondition: The maximum number of uses of this probe

#string ProbeRecord.model: VFS path to the model

#string ProbeRecord.mwscript: MWScript on this probe (can be empty)

#string ProbeRecord.name: The name of the probe

#number ProbeRecord.quality: The quality of the probe

#number ProbeRecord.value

#number ProbeRecord.weight

Type `Repair`

Extends #Item

Field(s)

#Item Repair.baseType: #Item

Repair.objectIsInstance(object)

Whether the object is a Repair.

Parameter

openmw.core#GameObject object :

Return value

#boolean:

Repair.record(objectOrRecordId)

Returns the read-only #RepairRecord of a repair tool

Parameter

#any objectOrRecordId :

Return value

#RepairRecord:

Type `RepairRecord`

Field(s)

#string RepairRecord.icon: VFS path to the icon

#string RepairRecord.id: The record ID of the repair tool

#number RepairRecord.maxCondition: The maximum number of uses of this repair tool

#string RepairRecord.model: VFS path to the model

#string RepairRecord.mwscript: MWScript on this repair tool (can be empty)

#string RepairRecord.name: The name of the repair tool

#number RepairRecord.quality: The quality of the repair tool

#number RepairRecord.value

#number RepairRecord.weight

Type `STANCE`

Field(s)

#number STANCE.Nothing: Default stance

#number STANCE.Spell: Magic stance

#number STANCE.Weapon: Weapon stance

Type `SkillStat`

Field(s)

#number SkillStat.base: The NPC's base skill value.

#number SkillStat.damage: The amount the skill has been damaged.

#number SkillStat.modified: The NPC's current skill value (read-only.)

#number SkillStat.modifier: The skill's modifier.

#number SkillStat.progress: [0-1] The NPC's skill progress.

Type `SkillStats`

Field(s)

SkillStats.acrobatics(actor)

Acrobatics (returns #SkillStat)

Parameter

openmw.core#GameObject actor :

Return value

#SkillStat:

SkillStats.alchemy(actor)

Alchemy (returns #SkillStat)

Parameter

openmw.core#GameObject actor :

Return value

#SkillStat:

SkillStats.alteration(actor)

Alteration (returns #SkillStat)

Parameter

openmw.core#GameObject actor :

Return value

#SkillStat:

SkillStats.armorer(actor)

Armorer (returns #SkillStat)

Parameter

openmw.core#GameObject actor :

Return value

#SkillStat:

SkillStats.athletics(actor)

Athletics (returns #SkillStat)

Parameter

openmw.core#GameObject actor :

Return value

#SkillStat:

SkillStats.axe(actor)

Axe (returns #SkillStat)

Parameter

openmw.core#GameObject actor :

Return value

#SkillStat:

SkillStats.block(actor)

Block (returns #SkillStat)

Parameter

openmw.core#GameObject actor :

Return value

#SkillStat:

SkillStats.bluntweapon(actor)

Blunt Weapon (returns #SkillStat)

Parameter

openmw.core#GameObject actor :

Return value

#SkillStat:

SkillStats.conjuration(actor)

Conjuration (returns #SkillStat)

Parameter

openmw.core#GameObject actor :

Return value

#SkillStat:

SkillStats.destruction(actor)

Destruction (returns #SkillStat)

Parameter

openmw.core#GameObject actor :

Return value

#SkillStat:

SkillStats.enchant(actor)

Enchant (returns #SkillStat)

Parameter

openmw.core#GameObject actor :

Return value

#SkillStat:

SkillStats.handtohand(actor)

Hand To Hand (returns #SkillStat)

Parameter

openmw.core#GameObject actor :

Return value

#SkillStat:

SkillStats.heavyarmor(actor)

Heavy Armor (returns #SkillStat)

Parameter

openmw.core#GameObject actor :

Return value

#SkillStat:

SkillStats.illusion(actor)

Illusion (returns #SkillStat)

Parameter

openmw.core#GameObject actor :

Return value

#SkillStat:

SkillStats.lightarmor(actor)

Light Armor (returns #SkillStat)

Parameter

openmw.core#GameObject actor :

Return value

#SkillStat:

SkillStats.longblade(actor)

Long Blade (returns #SkillStat)

Parameter

openmw.core#GameObject actor :

Return value

#SkillStat:

SkillStats.marksman(actor)

Marksman (returns #SkillStat)

Parameter

openmw.core#GameObject actor :

Return value

#SkillStat:

SkillStats.mediumarmor(actor)

Medium Armor (returns #SkillStat)

Parameter

openmw.core#GameObject actor :

Return value

#SkillStat:

SkillStats.mercantile(actor)

Mercantile (returns #SkillStat)

Parameter

openmw.core#GameObject actor :

Return value

#SkillStat:

SkillStats.mysticism(actor)

Mysticism (returns #SkillStat)

Parameter

openmw.core#GameObject actor :

Return value

#SkillStat:

SkillStats.restoration(actor)

Restoration (returns #SkillStat)

Parameter

openmw.core#GameObject actor :

Return value

#SkillStat:

SkillStats.security(actor)

Security (returns #SkillStat)

Parameter

openmw.core#GameObject actor :

Return value

#SkillStat:

SkillStats.shortblade(actor)

Short Blade (returns #SkillStat)

Parameter

openmw.core#GameObject actor :

Return value

#SkillStat:

SkillStats.sneak(actor)

Sneak (returns #SkillStat)

Parameter

openmw.core#GameObject actor :

Return value

#SkillStat:

SkillStats.spear(actor)

Spear (returns #SkillStat)

Parameter

openmw.core#GameObject actor :

Return value

#SkillStat:

SkillStats.speechcraft(actor)

Speechcraft (returns #SkillStat)

Parameter

openmw.core#GameObject actor :

Return value

#SkillStat:

SkillStats.unarmored(actor)

Unarmored (returns #SkillStat)

Parameter

openmw.core#GameObject actor :

Return value

#SkillStat:

Type `Static`

Field(s)

Static.objectIsInstance(object)

Whether the object is a Static.

Parameter

openmw.core#GameObject object :

Return value

#boolean:

Type `Weapon`

Extends #Item

Field(s)

#WeaponTYPE Weapon.TYPE: #WeaponTYPE

#Item Weapon.baseType: #Item

Weapon.objectIsInstance(object)

Whether the object is a Weapon.

Parameter

openmw.core#GameObject object :

Return value

#boolean:

Weapon.record(objectOrRecordId)

Returns the read-only #WeaponRecord of a weapon

Parameter

#any objectOrRecordId :

Return value

#WeaponRecord:

Type `WeaponRecord`

Field(s)

#number WeaponRecord.chopMaxDamage

#number WeaponRecord.chopMinDamage

#string WeaponRecord.enchant

#number WeaponRecord.enchantCapacity

#number WeaponRecord.health

#string WeaponRecord.icon: VFS path to the icon

#string WeaponRecord.id: Record id

#boolean WeaponRecord.isMagical

#boolean WeaponRecord.isSilver

#string WeaponRecord.model: VFS path to the model

#string WeaponRecord.mwscript: MWScript on this weapon (can be empty)

#string WeaponRecord.name: Human-readable name

#number WeaponRecord.reach

#number WeaponRecord.slashMaxDamage

#number WeaponRecord.slashMinDamage

#number WeaponRecord.speed

#number WeaponRecord.thrustMaxDamage

#number WeaponRecord.thrustMinDamage

#number WeaponRecord.type: See Weapon.TYPE

#number WeaponRecord.value

#number WeaponRecord.weight

Type `WeaponTYPE`

Weapon.TYPE

Field(s)

#number WeaponTYPE.Arrow

#number WeaponTYPE.AxeOneHand

#number WeaponTYPE.AxeTwoHand

#number WeaponTYPE.BluntOneHand

#number WeaponTYPE.BluntTwoClose

#number WeaponTYPE.BluntTwoWide

#number WeaponTYPE.Bolt

#number WeaponTYPE.LongBladeOneHand

#number WeaponTYPE.LongBladeTwoHand

#number WeaponTYPE.MarksmanBow

#number WeaponTYPE.MarksmanCrossbow

#number WeaponTYPE.MarksmanThrown

#number WeaponTYPE.ShortBladeOneHand

#number WeaponTYPE.SpearTwoWide