Package openmw.types¶

OpenMW version: 0.49.0

core.API_REVISION: 51 *

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.Clothing	#Clothing functions
types.Container	#Container functions
types.Creature	#Creature functions
types.Door	#Door functions
types.ESM4Activator	Functions for #ESM4Activator objects
types.ESM4Ammunition	Functions for #ESM4Ammunition objects
types.ESM4Armor	Functions for #ESM4Armor objects
types.ESM4Book	Functions for #ESM4Book objects
types.ESM4Clothing	Functions for #ESM4Clothing objects
types.ESM4Door	Functions for #ESM4Door objects
types.ESM4Flora	Functions for #ESM4Flora objects
types.ESM4Ingredient	Functions for #ESM4Ingredient objects
types.ESM4ItemMod	Functions for #ESM4ItemMod objects
types.ESM4Light	Functions for #ESM4Light objects
types.ESM4Miscellaneous	Functions for #ESM4Miscellaneous objects
types.ESM4MovableStatic	Functions for #ESM4MovableStatic objects
types.ESM4Potion	Functions for #ESM4Potion objects
types.ESM4Static	Functions for #ESM4Static objects
types.ESM4Terminal	Functions for #ESM4Terminal objects
types.ESM4Weapon	Functions for #ESM4Weapon objects
types.Ingredient	#Ingredient functions
types.Item	#Item functions (all items that can be placed to an inventory or container)
types.LevelledCreature	#CreatureLevelledList functions
types.Light	#Light functions
types.Lockable	#Lockable 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.createRecordDraft(activator)	Creates a #ActivatorRecord without adding it to the world database.
Activator.objectIsInstance(object)	Whether the object is an Activator.
Activator.record(objectOrRecordId)	Returns the read-only #ActivatorRecord of an activator
Activator.records	A read-only list of all #ActivatorRecords in the world database.

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.activeEffects(actor)	Return the active magic effects (#ActorActiveEffects) currently affecting the given actor.
Actor.activeSpells(actor)	Return the active spells (#ActorActiveSpells) currently affecting the given actor.
Actor.canMove(object)	Returns true if the object is an actor and is able to move.
Actor.clearSelectedCastable(actor)	Clears the actor's selected castable(spell or enchanted item)
Actor.getCurrentSpeed(actor)	Current speed.
Actor.getEncumbrance(actor)	Get the total weight of everything the actor is carrying, plus modifications from magic effects.
Actor.getEquipment(actor, slot)	Get equipment.
Actor.getPathfindingAgentBounds(actor)	Agent bounds to be used for pathfinding functions.
Actor.getRunSpeed(actor)	Speed of running.
Actor.getSelectedEnchantedItem(actor)	Get currently selected enchanted item
Actor.getSelectedSpell(actor)	Get currently selected spell
Actor.getStance(actor)	Returns the current stance (whether a weapon/spell is readied), see the list of #STANCE values.
Actor.getWalkSpeed(actor)	Speed of walking.
Actor.hasEquipped(actor, item)	Returns `true` if the item is equipped on the actor.
Actor.inventory(actor)	Actor inventory.
Actor.isDead(actor)	Check if the given actor is dead.
Actor.isInActorsProcessingRange(actor)	Check if given actor is in the actors processing range.
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.setEquipment(actor, equipment)	Set equipment.
Actor.setSelectedEnchantedItem(actor, item)	Set currently selected enchanted item, equipping it if applicable
Actor.setSelectedSpell(actor, spell)	Set selected spell
Actor.setStance(actor, stance)	Sets the current stance (whether a weapon/spell is readied), see the list of #STANCE values.
Actor.spells(actor)	Return the spells (#ActorSpells) of the given actor.
Actor.stats	The actor's stats.

Type `ActorActiveEffects`

ActorActiveEffects:getEffect(effectId, extraParam)	Get a specific active effect on the actor.
ActorActiveEffects:modify(value, effectId, extraParam)	Permanently modifies the magnitude of an active effect by increasing it by the provided value.
ActorActiveEffects:remove(effectId, extraParam)	Completely removes the active effect from the actor.
ActorActiveEffects:set(value, effectId, extraParam)	Permanently modifies the magnitude of an active effect to be exactly equal to the provided value.

Type `ActorActiveSpells`

ActorActiveSpells:isSpellActive(recordOrId)	Get whether a specific spell is active on the actor.
ActorActiveSpells:remove(spellOrId)	Remove the given spell and all its effects from the given actor's active spells.

Type `ActorSpells`

ActorSpells:add(spellOrId)	Add spell (only in global scripts or on self).
ActorSpells:clear()	Remove all spells (only in global scripts or on self).
ActorSpells:remove(spellOrId)	Remove spell (only in global scripts or on self).

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
Apparatus.records	A read-only list of all #ApparatusRecords in the world database.

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.TYPE	#ArmorTYPE
Armor.baseType	#Item
Armor.createRecordDraft(armor)	Creates a #ArmorRecord without adding it to the world database, for the armor to appear correctly on the body, make sure to use a template as described below.
Armor.objectIsInstance(object)	Whether the object is an Armor.
Armor.record(objectOrRecordId)	Returns the read-only #ArmorRecord of an Armor
Armor.records	A read-only list of all #ArmorRecords in the world database.

Type `ArmorRecord`

ArmorRecord.baseArmor	The base armor rating of this armor
ArmorRecord.enchant	The enchantment ID of this armor (can be empty)
ArmorRecord.enchantCapacity
ArmorRecord.health
ArmorRecord.icon	VFS path to the icon
ArmorRecord.id	Record id
ArmorRecord.model	VFS path to the model
ArmorRecord.mwscript	MWScript on this armor (can be empty)
ArmorRecord.name	Human-readable name
ArmorRecord.type	See Armor.TYPE
ArmorRecord.value
ArmorRecord.weight

Type `ArmorTYPE`

ArmorTYPE.Boots
ArmorTYPE.Cuirass
ArmorTYPE.Greaves
ArmorTYPE.Helmet
ArmorTYPE.LBracer
ArmorTYPE.LGauntlet
ArmorTYPE.LPauldron
ArmorTYPE.RBracer
ArmorTYPE.RGauntlet
ArmorTYPE.RPauldron
ArmorTYPE.Shield

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	DEPRECATED, use openmw.core#Skill
Book.baseType	#Item
Book.createRecordDraft(book)	Creates a #BookRecord without adding it to the world database.
Book.objectIsInstance(object)	Whether the object is a Book.
Book.record(objectOrRecordId)	Returns the read-only #BookRecord of a book
Book.records	A read-only list of all #BookRecords in the world database.

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 openmw.core#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 `CONTROL_SWITCH`

CONTROL_SWITCH.Controls	Ability to move
CONTROL_SWITCH.Fighting	Ability to attack
CONTROL_SWITCH.Jumping	Ability to jump
CONTROL_SWITCH.Looking	Ability to change view direction
CONTROL_SWITCH.Magic	Ability to use magic
CONTROL_SWITCH.VanityMode	Vanity view if player doesn't touch controls for a long time
CONTROL_SWITCH.ViewMode	Ability to toggle 1st/3rd person view

Type `ClassRecord`

ClassRecord.attributes	A read-only list containing the specialized attributes of the class.
ClassRecord.description	Class description
ClassRecord.id	Class id
ClassRecord.isPlayable	True if the player can play as this class
ClassRecord.majorSkills	A read-only list containing the major skills of the class.
ClassRecord.minorSkills	A read-only list containing the minor skills of the class.
ClassRecord.name	Class name
ClassRecord.specialization	Class specialization. Either combat, magic, or stealth.

Type `Classes`

Classes.record(recordId)	Returns a read-only #ClassRecord
Classes.records	A read-only list of all #ClassRecords in the world database.

Type `Clothing`

Clothing.TYPE	#ClothingTYPE
Clothing.baseType	#Item
Clothing.createRecordDraft(clothing)	Creates a #ClothingRecord without adding it to the world database, for the clothing to appear correctly on the body, make sure to use a template as described below.
Clothing.objectIsInstance(object)	Whether the object is a Clothing.
Clothing.record(objectOrRecordId)	Returns the read-only #ClothingRecord of a Clothing
Clothing.records	A read-only list of all #ClothingRecords in the world database.

Type `ClothingRecord`

ClothingRecord.enchant	The enchantment ID of this clothing (can be empty)
ClothingRecord.enchantCapacity
ClothingRecord.icon	VFS path to the icon
ClothingRecord.id	Record id
ClothingRecord.model	VFS path to the model
ClothingRecord.mwscript	MWScript on this clothing (can be empty)
ClothingRecord.name	Name of the clothing
ClothingRecord.type	See Clothing.TYPE
ClothingRecord.value
ClothingRecord.weight

Type `ClothingTYPE`

ClothingTYPE.Amulet
ClothingTYPE.Belt
ClothingTYPE.LGlove
ClothingTYPE.Pants
ClothingTYPE.RGlove
ClothingTYPE.Ring
ClothingTYPE.Robe
ClothingTYPE.Shirt
ClothingTYPE.Shoes
ClothingTYPE.Skirt

Type `Container`

Container.baseType	#Lockable
Container.content(object)	Container content.
Container.getCapacity(object)	Returns the capacity of a container
Container.getEncumbrance(object)	Returns the total weight of everything in a container
Container.inventory(object)	Container content (same as `Container.content`, added for consistency with `Actor.inventory`).
Container.objectIsInstance(object)	Whether the object is a Container.
Container.record(objectOrRecordId)	Returns the read-only #ContainerRecord of a container
Container.records	A read-only list of all #ContainerRecords in the world database.

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.TYPE	#CreatureTYPE
Creature.baseType	#Actor
Creature.objectIsInstance(object)	Whether the object is a creature.
Creature.record(objectOrRecordId)	Returns the read-only #CreatureRecord of a creature
Creature.records	A read-only list of all #CreatureRecords in the world database.

Type `CreatureLevelledList`

CreatureLevelledList.objectIsInstance(object)	Whether the object is a CreatureLevelledList.
CreatureLevelledList.record(objectOrRecordId)	Returns the read-only #CreatureLevelledListRecord of a levelled creature
CreatureLevelledList.records	A read-only list of all #CreatureLevelledListRecords in the world database.

Type `CreatureLevelledListRecord`

CreatureLevelledListRecord.calculateFromAllLevels	Calculate from all levels <= player level, not just the closest below player
CreatureLevelledListRecord.chanceNone	Chance this list won't spawn anything [0-1]
CreatureLevelledListRecord.creatures
CreatureLevelledListRecord.getRandomId(listRecord, MaxLvl)	Picks a random id from the levelled list.
CreatureLevelledListRecord.id	Record id

Type `CreatureRecord`

CreatureRecord.baseCreature	Record id of a base creature, which was modified to create this one
CreatureRecord.baseGold	The base barter gold of the creature
CreatureRecord.id	The record ID of the creature
CreatureRecord.model	VFS path to the creature's model
CreatureRecord.mwscript
CreatureRecord.name
CreatureRecord.servicesOffered	The services of the creature, in a table. Value is if the service is provided or not, and they are indexed by: Spells, Spellmaking, Enchanting, Training, Repair, Barter, Weapon, Armor, Clothing, Books, Ingredients, Picks, Probes, Lights, Apparatus, RepairItems, Misc, Potions, MagicItems, Travel.
CreatureRecord.soulValue	The soul value of the creature record
CreatureRecord.type	The Creature.TYPE of the creature

Type `CreatureTYPE`

CreatureTYPE.Creatures
CreatureTYPE.Daedra
CreatureTYPE.Humanoid
CreatureTYPE.Undead

Type `Door`

Door.baseType	#Lockable
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
Door.records	A read-only list of all #DoorRecords in the world database.

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 `ESM4Door`

ESM4Door.baseType	#Lockable
ESM4Door.destCell(object)	Destination cell (only if a teleport door).
ESM4Door.destPosition(object)	Destination (only if a teleport door).
ESM4Door.destRotation(object)	Destination rotation (only if a teleport door).
ESM4Door.isTeleport(object)	Whether the door is a teleport.
ESM4Door.objectIsInstance(object)	Whether the object is a ESM4Door.
ESM4Door.record(objectOrRecordId)	Returns the read-only #ESM4DoorRecord of a door
ESM4Door.records()	Returns a read-only list of all #ESM4DoorRecords in the world database.

Type `ESM4DoorRecord`

ESM4DoorRecord.id	Record id
ESM4DoorRecord.model	VFS path to the model
ESM4DoorRecord.name	Human-readable name

Type `ESM4Terminal`

ESM4Terminal.objectIsInstance(object)	Whether the object is a ESM4Terminal.
ESM4Terminal.record(objectOrRecordId)	Returns the read-only #ESM4TerminalRecord of a terminal
ESM4Terminal.records	A read-only list of all #ESM4TerminalRecords in the world database.

Type `ESM4TerminalRecord`

ESM4TerminalRecord.editorId	Human-readable ID
ESM4TerminalRecord.id	Record id (Form ID)
ESM4TerminalRecord.model	VFS path to the model
ESM4TerminalRecord.name	Human-readable name
ESM4TerminalRecord.resultText	Result text of the terminal record
ESM4TerminalRecord.text	Text body of the terminal record

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
Ingredient.records	A read-only list of all #IngredientRecords in the world database.

Type `IngredientRecord`

IngredientRecord.effects	The effects (openmw.core#MagicEffectWithParams) of the ingredient
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.getEnchantmentCharge(item)	Get this item's current enchantment charge.
Item.isCarriable(object)	Whether the object is supposed to be carriable.
Item.isRestocking(item)	Checks if the item restocks.
Item.itemData(item)	Set of properties that differentiates one item from another of the same record type.
Item.objectIsInstance(object)	Whether the object is an item.
Item.setEnchantmentCharge(item, charge)	Set this item's enchantment charge.

Type `ItemData`

ItemData.condition

The item's current condition. Time remaining for lights. Uses left for lockpicks and probes. Current health for weapons and armor.

Type `LevelStat`

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

Type `LevelledListItem`

LevelledListItem.id	Item id
LevelledListItem.level	The minimum player level at which this item can occur

Type `Light`

Light.baseType	#Item
Light.objectIsInstance(object)	Whether the object is a Light.
Light.record(objectOrRecordId)	Returns the read-only #LightRecord of a Light
Light.records	A read-only list of all #LightRecords in the world database.

Type `LightRecord`

LightRecord.color
LightRecord.duration
LightRecord.icon	VFS path to the icon
LightRecord.id	Record id
LightRecord.isCarriable
LightRecord.model	VFS path to the model
LightRecord.mwscript	MWScript on this light (can be empty)
LightRecord.name	Human-readable name
LightRecord.radius
LightRecord.sound	VFS path to the sound
LightRecord.value
LightRecord.weight

Type `Lockable`

Lockable.getKeyRecord(object)	Returns the key record of a lockable object(door, container)
Lockable.getLockLevel(object)	Returns the lock level of a lockable object(door, container).
Lockable.getTrapSpell(object)	Returns the trap spell of a lockable object(door, container)
Lockable.isLocked(object)	Returns true if the lockable object is locked, and false if it is not.
Lockable.lock(object, lockLevel)	Sets the lock level level of a lockable object(door, container);Locks if not already locked; Must be used in a global script.
Lockable.setKeyRecord(object, miscOrId)	Sets the key of a lockable object(door, container); removes it if empty string is provided.
Lockable.setTrapSpell(object, spellOrId)	Sets the trap spell of a lockable object(door, container); removes it if empty string is provided.
Lockable.unlock(object)	Unlocks the lockable object.

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
Lockpick.records	A read-only list of all #LockpickRecords in the world database.

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.createRecordDraft(miscellaneous)	Creates a #MiscellaneousRecord without adding it to the world database.
Miscellaneous.getSoul(object)	Returns the read-only soul of a miscellaneous item
Miscellaneous.objectIsInstance(object)	Whether the object is a Miscellaneous.
Miscellaneous.record(objectOrRecordId)	Returns the read-only #MiscellaneousRecord of a miscellaneous item
Miscellaneous.records	A read-only list of all #MiscellaneousRecords in the world database.
Miscellaneous.setSoul(object, soulId)	Sets the soul of a miscellaneous item, intended for soul gem objects; Must be used in a global script.

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.classes	#Classes: Class Data
NPC.clearExpelled(actor, faction)	Clear expelling of NPC from given faction.
NPC.expel(actor, faction)	Expel NPC from given faction.
NPC.getCapacity(actor)	Get the total weight that the actor can carry.
NPC.getDisposition(object, player)	Returns the current disposition of the provided NPC.
NPC.getFactionRank(actor, faction)	Get rank of given NPC in given faction.
NPC.getFactionReputation(actor, faction)	Get reputation of given actor in given faction.
NPC.getFactions(actor)	Get all factions in which NPC has a membership.
NPC.isExpelled(actor, faction)	Check if NPC is expelled from given faction.
NPC.isWerewolf(actor)	Whether the NPC or player is in the werewolf form at the moment.
NPC.joinFaction(actor, faction)	Add given actor to given faction.
NPC.leaveFaction(actor, faction)	Remove given actor from given faction.
NPC.modifyFactionRank(actor, faction, value)	Adjust rank of given NPC in given faction.
NPC.modifyFactionReputation(actor, faction, value)	Adjust reputation of given actor in given faction.
NPC.objectIsInstance(object)	Whether the object is an NPC or a Player.
NPC.record(objectOrRecordId)	Returns the read-only #NpcRecord of an NPC
NPC.records	A read-only list of all #NpcRecords in the world database.
NPC.setFactionRank(actor, faction, value)	Set rank of given NPC in given faction.
NPC.setFactionReputation(actor, faction, value)	Set reputation of given actor in given faction.
NPC.stats

Type `NpcRecord`

NpcRecord.baseDisposition	NPC's starting disposition
NpcRecord.baseGold	The base barter gold of the NPC
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.id	The record ID of the NPC
NpcRecord.isMale	The gender setting of the NPC
NpcRecord.mwscript	MWScript that is attached to this NPC
NpcRecord.name
NpcRecord.race
NpcRecord.servicesOffered	The services of the NPC, in a table. Value is if the service is provided or not, and they are indexed by: Spells, Spellmaking, Enchanting, Training, Repair, Barter, Weapon, Armor, Clothing, Books, Ingredients, Picks, Probes, Lights, Apparatus, RepairItems, Misc, Potions, MagicItems, Travel.

Type `Player`

Player.CONTROL_SWITCH	Values that can be used with getControlSwitch/setControlSwitch.
Player.baseType	#NPC
Player.getControlSwitch(player, key)	Get state of a control switch.
Player.getCrimeLevel(player)	Returns the bounty or crime level of the player
Player.isCharGenFinished(player)	Whether the character generation for this player is finished.
Player.isTeleportingEnabled(player)	Whether teleportation for this player is enabled.
Player.objectIsInstance(object)	Whether the object is a player.
Player.quests(player)	Returns a list containing quests #PlayerQuest for the specified player, indexed by quest ID.
Player.setControlSwitch(player, key, value)	Set state of a control switch.
Player.setTeleportingEnabled(player, state)	Enables or disables teleportation for this player.

Type `PlayerQuest`

PlayerQuest:addJournalEntry(stage, actor)	Sets the quest stage for the given quest, on the given player, and adds the entry to the journal, if there is an entry at the specified stage.
PlayerQuest.finished	Whether the quest is finished (global and player scripts can change it).
PlayerQuest.id	The quest id.
PlayerQuest.stage	The quest stage (global and player scripts can change it). Changing the stage starts the quest if it wasn't started.
PlayerQuest.started	Whether the quest is started.

Type `Potion`

Potion.baseType	#Item
Potion.createRecordDraft(potion)	Creates a #PotionRecord without adding it to the world database.
Potion.objectIsInstance(object)	Whether the object is a Potion.
Potion.record(objectOrRecordId)	Returns the read-only #PotionRecord of a potion
Potion.records	A read-only list of all #PotionRecords in the world database.

Type `PotionRecord`

PotionRecord.effects	The effects (openmw.core#MagicEffectWithParams) of the potion
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
Probe.records	A read-only list of all #ProbeRecords in the world database.

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
Repair.records	A read-only list of all #RepairRecords in the world database.

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.
Static.record(objectOrRecordId)	Returns the read-only #StaticRecord of a Static
Static.records	A read-only list of all #StaticRecords in the world database.

Type `StaticRecord`

StaticRecord.id	Record id
StaticRecord.model	VFS path to the model

Type `Weapon`

Weapon.TYPE	#WeaponTYPE
Weapon.baseType	#Item
Weapon.createRecordDraft(weapon)	Creates a #WeaponRecord without adding it to the world database.
Weapon.objectIsInstance(object)	Whether the object is a Weapon.
Weapon.record(objectOrRecordId)	Returns the read-only #WeaponRecord of a weapon
Weapon.records	A read-only list of all #WeaponRecords in the world database.

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

#Clothing types.Clothing: #Clothing functions

#Container types.Container: #Container functions

#Creature types.Creature: #Creature functions

#Door types.Door: #Door functions

#ESM4Activator types.ESM4Activator: Functions for #ESM4Activator objects

#ESM4Ammunition types.ESM4Ammunition: Functions for #ESM4Ammunition objects

#ESM4Armor types.ESM4Armor: Functions for #ESM4Armor objects

#ESM4Book types.ESM4Book: Functions for #ESM4Book objects

#ESM4Clothing types.ESM4Clothing: Functions for #ESM4Clothing objects

#ESM4Door types.ESM4Door: Functions for #ESM4Door objects

#ESM4Flora types.ESM4Flora: Functions for #ESM4Flora objects

#ESM4Ingredient types.ESM4Ingredient: Functions for #ESM4Ingredient objects

#ESM4ItemMod types.ESM4ItemMod: Functions for #ESM4ItemMod objects

#ESM4Light types.ESM4Light: Functions for #ESM4Light objects

#ESM4Miscellaneous types.ESM4Miscellaneous: Functions for #ESM4Miscellaneous objects

#ESM4MovableStatic types.ESM4MovableStatic: Functions for #ESM4MovableStatic objects

#ESM4Potion types.ESM4Potion: Functions for #ESM4Potion objects

#ESM4Static types.ESM4Static: Functions for #ESM4Static objects

#ESM4Terminal types.ESM4Terminal: Functions for #ESM4Terminal objects

#ESM4Weapon types.ESM4Weapon: Functions for #ESM4Weapon objects

#Ingredient types.Ingredient: #Ingredient functions

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

#CreatureLevelledList types.LevelledCreature: #CreatureLevelledList functions

#Light types.Light: #Light functions

#Lockable types.Lockable: #Lockable 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.createRecordDraft(activator)

Creates a #ActivatorRecord without adding it to the world database.

Use openmw_world#world.createRecord to add the record to the world.

Parameter

#ActivatorRecord activator : A Lua table with the fields of a ActivatorRecord, with an optional field template that accepts a #ActivatorRecord as a base.

Return value

#ActivatorRecord: A strongly typed Activator record.

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:

#list<#ActivatorRecord> Activator.records: A read-only list of all #ActivatorRecords in the world database.

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.activeEffects(actor)

Return the active magic effects (#ActorActiveEffects) currently affecting the given actor.

Parameter

openmw.core#GameObject actor :

Return value

#ActorActiveEffects:

Actor.activeSpells(actor)

Return the active spells (#ActorActiveSpells) currently affecting the given actor.

Parameter

openmw.core#GameObject actor :

Return value

#ActorActiveSpells:

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.clearSelectedCastable(actor)

Clears the actor's selected castable(spell or enchanted item)

Parameter

openmw.core#GameObject actor :

Actor.getCurrentSpeed(actor)

Current speed.

Parameter

openmw.core#GameObject actor :

Return value

#number:

Actor.getEncumbrance(actor)

Get the total weight of everything the actor is carrying, plus modifications from magic effects.

Parameter

openmw.core#GameObject actor :

Return value

#number:

Actor.getEquipment(actor, slot)

Get equipment.

Has two overloads:

With a 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.
With two arguments: returns an item equipped to the given slot.

Parameters

openmw.core#GameObject actor :
#number slot : Optional number of the equipment slot

Return value

#EquipmentTable, openmw.core#GameObject:

Actor.getPathfindingAgentBounds(actor)

Agent bounds to be used for pathfinding functions.

Parameter

openmw.core#GameObject actor :

Return value

#table: with shapeType and halfExtents

Actor.getRunSpeed(actor)

Speed of running.

For dead actors it still returns a positive value.

Parameter

openmw.core#GameObject actor :

Return value

#number:

Actor.getSelectedEnchantedItem(actor)

Get currently selected enchanted item

Parameter

openmw.core#GameObject actor :

Return value

openmw.core#GameObject, nil enchanted item or nil

Actor.getSelectedSpell(actor)

Get currently selected spell

Parameter

openmw.core#GameObject actor :

Return value

openmw.core#Spell, nil

Actor.getStance(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:

Actor.getWalkSpeed(actor)

Speed of walking.

For dead actors it still returns a positive value.

Parameter

openmw.core#GameObject actor :

Return value

#number:

Actor.hasEquipped(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.inventory(actor)

Actor inventory.

Parameter

openmw.core#GameObject actor :

Return value

openmw.core#Inventory:

Actor.isDead(actor)

Check if the given actor is dead.

Parameter

openmw.core#GameObject actor :

Return value

#boolean:

Actor.isInActorsProcessingRange(actor)

Check if given actor is in the actors processing range.

Parameter

openmw.core#GameObject actor :

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.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 :
#EquipmentTable equipment :

Usage:

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

Actor.setSelectedEnchantedItem(actor, item)

Set currently selected enchanted item, equipping it if applicable

Parameters

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

Actor.setSelectedSpell(actor, spell)

Set selected spell

Parameters

openmw.core#GameObject actor :
openmw.core#Spell spell : Spell (can be nil)

Actor.setStance(actor, stance)

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

Can be used only in local scripts on self.

Parameters

openmw.core#GameObject actor :
#number stance :

Actor.spells(actor)

Return the spells (#ActorSpells) of the given actor.

Parameter

openmw.core#GameObject actor :

Return value

#ActorSpells:

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

Type `ActorActiveEffects`

Read-only list of effects currently affecting the actor.

Usages:

-- print active effects
for _, effect in pairs(Actor.activeEffects(self)) do
    print('Active Effect: '..effect.id..', attribute='..tostring(effect.affectedAttribute)..', skill='..tostring(effect.affectedSkill)..', magnitude='..tostring(effect.magnitude))
end

-- Check for a specific effect
local effect = Actor.activeEffects(self):getEffect(core.magic.EFFECT_TYPE.Telekinesis)
if effect then
    print(effect.id..', attribute='..tostring(effect.affectedAttribute)..', skill='..tostring(effect.affectedSkill)..', magnitude='..tostring(effect.magnitude))
else
    print('No Telekinesis effect')
end

-- Check for a specific effect targeting a specific attribute.
local effect = Actor.activeEffects(self):getEffect(core.magic.EFFECT_TYPE.FortifyAttribute, core.ATTRIBUTE.Luck)
if effect then
    print(effect.id..', attribute='..tostring(effect.affectedAttribute)..', skill='..tostring(effect.affectedSkill)..', magnitude='..tostring(effect.magnitude))
else
    print('No Fortify Luck effect')
end

Field(s)

ActorActiveEffects:getEffect(effectId, extraParam)

Get a specific active effect on the actor.

Parameters

#string effectId : effect ID
#string extraParam : Optional skill or attribute ID

Return value

openmw.core#ActiveEffect: if such an effect is active, nil otherwise

ActorActiveEffects:modify(value, effectId, extraParam)

Permanently modifies the magnitude of an active effect by increasing it by the provided value.

This adds the effect to the list of active effects if not already active.

Parameters

#number value :
#string effectId : effect ID
#string extraParam : Optional skill or attribute ID

ActorActiveEffects:remove(effectId, extraParam)

Completely removes the active effect from the actor.

Parameters

#string effectId : effect ID
#string extraParam : Optional skill or attribute ID

ActorActiveEffects:set(value, effectId, extraParam)

Permanently modifies the magnitude of an active effect to be exactly equal to the provided value.

This adds the effect to the list of active effects if not already active. Note that although the modification is permanent, the magnitude will not stay equal to the value if any active spells with this effects are added/removed.

Parameters

#number value :
#string effectId : effect ID
#string extraParam : Optional skill or attribute ID

Type `ActorActiveSpells`

Read-only list of spells currently affecting the actor.

Can be iterated over for a list of openmw.core#ActiveSpell

Usages:

-- print active spells
for _, spell in pairs(Actor.activeSpells(self)) do
    print('Active Spell: '..tostring(spell))
end

-- Check for a specific spell
if Actor.activeSpells(self):isSpellActive('bound longbow') then
    print('Player has bound longbow')
else
    print('Player does not have bound longbow')
end

-- Print all information about active spells
for id, params in pairs(Actor.activeSpells(self)) do
    print('active spell '..tostring(id)..':')
    print('  name: '..tostring(params.name))
    print('  id: '..tostring(params.id))
    print('  item: '..tostring(params.item))
    print('  caster: '..tostring(params.caster))
    print('  effects: '..tostring(params.effects))
    for _, effect in pairs(params.effects) do
        print('  -> effects['..tostring(effect)..']:')
        print('       id: '..tostring(effect.id))
        print('       name: '..tostring(effect.name))
        print('       affectedSkill: '..tostring(effect.affectedSkill))
        print('       affectedAttribute: '..tostring(effect.affectedAttribute))
        print('       magnitudeThisFrame: '..tostring(effect.magnitudeThisFrame))
        print('       minMagnitude: '..tostring(effect.minMagnitude))
        print('       maxMagnitude: '..tostring(effect.maxMagnitude))
        print('       duration: '..tostring(effect.duration))
        print('       durationLeft: '..tostring(effect.durationLeft))
    end
end

Field(s)

ActorActiveSpells:isSpellActive(recordOrId)

Get whether a specific spell is active on the actor.

Parameter

#any recordOrId : record or string record ID of the active spell's source. valid records are openmw.core#Spell, openmw.core#Enchantment, #IngredientRecord, or #PotionRecord

Return value

true if spell is active, false otherwise

ActorActiveSpells:remove(spellOrId)

Remove the given spell and all its effects from the given actor's active spells.

Parameter

#any spellOrId : openmw.core#Spell or string spell id

Type `ActorSpells`

List of spells with additional functions add/remove/clear (modification are allowed only in global scripts or on self).

Usages:

-- print available spells
local mySpells = types.Actor.spells(self)
for _, spell in pairs(mySpells) do print(spell.id) end

-- print available spells (equivalent)
local mySpells = types.Actor.spells(self)
for i = 1, #mySpells do print(mySpells[i].id) end

-- add ALL spells that exist in the world
local mySpells = types.Actor.spells(self)
for _, spell in pairs(core.magic.spells) do
    if spell.type == core.magic.SPELL_TYPE.Spell then
        mySpells:add(spell)
    end
end

-- add specific spell
types.Actor.spells(self):add('thunder fist')

-- check specific spell
local mySpells = types.Actor.spells(self)
if mySpells['thunder fist'] then print('I have thunder fist') end

Field(s)

ActorSpells:add(spellOrId)

Add spell (only in global scripts or on self).

Parameter

#any spellOrId : openmw.core#Spell or string spell id

ActorSpells:clear(): Remove all spells (only in global scripts or on self).

ActorSpells:remove(spellOrId)

Remove spell (only in global scripts or on self).

Parameter

#any spellOrId : openmw.core#Spell or string spell id

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:

#list<#ApparatusRecord> Apparatus.records: A read-only list of all #ApparatusRecords in the world database.

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)

#ArmorTYPE Armor.TYPE: #ArmorTYPE

#Item Armor.baseType: #Item

Armor.createRecordDraft(armor)

Creates a #ArmorRecord without adding it to the world database, for the armor to appear correctly on the body, make sure to use a template as described below.

Use openmw_world#world.createRecord to add the record to the world.

Parameter

#ArmorRecord armor : A Lua table with the fields of a ArmorRecord, with an additional field template that accepts a #ArmorRecord as a base.

Return value

#ArmorRecord: A strongly typed Armor record.

Usage:

local armorTemplate = types.Armor.record('orcish_cuirass')
local armorTable = {name = "Better Orcish Cuirass",template = armorTemplate,baseArmor = armorTemplate.baseArmor + 10}
 --This is the new record we want to create, with a record provided as a template.
local recordDraft = types.Armor.createRecordDraft(armorTable)--Need to convert the table into the record draft
local newRecord = world.createRecord(recordDraft)--This creates the actual record
world.createObject(newRecord):moveInto(playerActor)--Create an instance of this object, and move it into the player's inventory

Armor.objectIsInstance(object)

Whether the object is an Armor.

Parameter

openmw.core#GameObject object :

Return value

#boolean:

Armor.record(objectOrRecordId)

Returns the read-only #ArmorRecord of an Armor

Parameter

#any objectOrRecordId :

Return value

#ArmorRecord:

#list<#ArmorRecord> Armor.records: A read-only list of all #ArmorRecords in the world database.

Type `ArmorRecord`

Field(s)

#number ArmorRecord.baseArmor: The base armor rating of this armor

#string ArmorRecord.enchant: The enchantment ID of this armor (can be empty)

#number ArmorRecord.enchantCapacity

#number ArmorRecord.health

#string ArmorRecord.icon: VFS path to the icon

#string ArmorRecord.id: Record id

#string ArmorRecord.model: VFS path to the model

#string ArmorRecord.mwscript: MWScript on this armor (can be empty)

#string ArmorRecord.name: Human-readable name

#number ArmorRecord.type: See Armor.TYPE

#number ArmorRecord.value

#number ArmorRecord.weight

Type `ArmorTYPE`

Armor.TYPE

Field(s)

#number ArmorTYPE.Boots

#number ArmorTYPE.Cuirass

#number ArmorTYPE.Greaves

#number ArmorTYPE.Helmet

#number ArmorTYPE.LBracer

#number ArmorTYPE.LGauntlet

#number ArmorTYPE.LPauldron

#number ArmorTYPE.RBracer

#number ArmorTYPE.RGauntlet

#number ArmorTYPE.RPauldron

#number ArmorTYPE.Shield

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: DEPRECATED, use openmw.core#Skill

#Item Book.baseType: #Item

Book.createRecordDraft(book)

Creates a #BookRecord without adding it to the world database.

Use openmw_world#world.createRecord to add the record to the world.

Parameter

#BookRecord book : A Lua table with the fields of a BookRecord, with an optional field template that accepts a #BookRecord as a base.

Return value

#BookRecord: A strongly typed Book record.

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:

#list<#BookRecord> Book.records: A read-only list of all #BookRecords in the world database.

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 openmw.core#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 `CONTROL_SWITCH`

Field(s)

#ControlSwitch CONTROL_SWITCH.Controls: Ability to move

#ControlSwitch CONTROL_SWITCH.Fighting: Ability to attack

#ControlSwitch CONTROL_SWITCH.Jumping: Ability to jump

#ControlSwitch CONTROL_SWITCH.Looking: Ability to change view direction

#ControlSwitch CONTROL_SWITCH.Magic: Ability to use magic

#ControlSwitch CONTROL_SWITCH.VanityMode: Vanity view if player doesn't touch controls for a long time

#ControlSwitch CONTROL_SWITCH.ViewMode: Ability to toggle 1st/3rd person view

Type `ClassRecord`

Class data record

Field(s)

#list<#string> ClassRecord.attributes: A read-only list containing the specialized attributes of the class.

#string ClassRecord.description: Class description

#string ClassRecord.id: Class id

#boolean ClassRecord.isPlayable: True if the player can play as this class

#list<#string> ClassRecord.majorSkills: A read-only list containing the major skills of the class.

#list<#string> ClassRecord.minorSkills: A read-only list containing the minor skills of the class.

#string ClassRecord.name: Class name

#string ClassRecord.specialization: Class specialization. Either combat, magic, or stealth.

Type `Classes`

Field(s)

Classes.record(recordId)

Returns a read-only #ClassRecord

Parameter

#string recordId :

Return value

#ClassRecord:

#list<#ClassRecord> Classes.records: A read-only list of all #ClassRecords in the world database.

Type `Clothing`

Extends #Item

Field(s)

#ClothingTYPE Clothing.TYPE: #ClothingTYPE

#Item Clothing.baseType: #Item

Clothing.createRecordDraft(clothing)

Creates a #ClothingRecord without adding it to the world database, for the clothing to appear correctly on the body, make sure to use a template as described below.

Use openmw_world#world.createRecord to add the record to the world.

Parameter

#ClothingRecord clothing : A Lua table with the fields of a ClothingRecord, with an additional field template that accepts a #ClothingRecord as a base.

Return value

#ClothingRecord: A strongly typed clothing record.

Usage:

local clothingTemplate = types.Clothing.record('exquisite_robe_01')
local clothingTable = {name = "Better Exquisite Robe",template = clothingTemplate,enchantCapacity = clothingTemplate.enchantCapacity + 10}
 --This is the new record we want to create, with a record provided as a template.
local recordDraft = types.Clothing.createRecordDraft(clothingTable)--Need to convert the table into the record draft
local newRecord = world.createRecord(recordDraft)--This creates the actual record
world.createObject(newRecord):moveInto(playerActor)--Create an instance of this object, and move it into the player's inventory

Clothing.objectIsInstance(object)

Whether the object is a Clothing.

Parameter

openmw.core#GameObject object :

Return value

#boolean:

Clothing.record(objectOrRecordId)

Returns the read-only #ClothingRecord of a Clothing

Parameter

#any objectOrRecordId :

Return value

#ClothingRecord:

#list<#ClothingRecord> Clothing.records: A read-only list of all #ClothingRecords in the world database.

Type `ClothingRecord`

Field(s)

#string ClothingRecord.enchant: The enchantment ID of this clothing (can be empty)

#number ClothingRecord.enchantCapacity

#string ClothingRecord.icon: VFS path to the icon

#string ClothingRecord.id: Record id

#string ClothingRecord.model: VFS path to the model

#string ClothingRecord.mwscript: MWScript on this clothing (can be empty)

#string ClothingRecord.name: Name of the clothing

#number ClothingRecord.type: See Clothing.TYPE

#number ClothingRecord.value

#number ClothingRecord.weight

Type `ClothingTYPE`

Clothing.TYPE

Field(s)

#number ClothingTYPE.Amulet

#number ClothingTYPE.Belt

#number ClothingTYPE.LGlove

#number ClothingTYPE.Pants

#number ClothingTYPE.RGlove

#number ClothingTYPE.Ring

#number ClothingTYPE.Robe

#number ClothingTYPE.Shirt

#number ClothingTYPE.Shoes

#number ClothingTYPE.Skirt

Type `Container`

Extends #Lockable

Field(s)

#Lockable Container.baseType: #Lockable

Container.content(object)

Container content.

Parameter

openmw.core#GameObject object :

Return value

openmw.core#Inventory:

Container.getCapacity(object)

Returns the capacity of a container

Parameter

openmw.core#GameObject object :

Return value

#number:

Container.getEncumbrance(object)

Returns the total weight of everything in a container

Parameter

openmw.core#GameObject object :

Return value

#number:

Container.inventory(object)

Container content (same as Container.content, added for consistency with Actor.inventory).

Parameter

openmw.core#GameObject object :

Return value

openmw.core#Inventory:

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:

#list<#ContainerRecord> Container.records: A read-only list of all #ContainerRecords in the world database.

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 `ControlSwitch`

String id of a #CONTROL_SWITCH

Type `Creature`

Extends #Actor

Field(s)

#CreatureTYPE Creature.TYPE: #CreatureTYPE

#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:

#list<#CreatureRecord> Creature.records: A read-only list of all #CreatureRecords in the world database.

Type `CreatureLevelledList`

Field(s)

CreatureLevelledList.objectIsInstance(object)

Whether the object is a CreatureLevelledList.

Parameter

openmw.core#GameObject object :

Return value

#boolean:

CreatureLevelledList.record(objectOrRecordId)

Returns the read-only #CreatureLevelledListRecord of a levelled creature

Parameter

#any objectOrRecordId :

Return value

#CreatureLevelledListRecord:

#list<#CreatureLevelledListRecord> CreatureLevelledList.records: A read-only list of all #CreatureLevelledListRecords in the world database.

Type `CreatureLevelledListRecord`

Field(s)

#boolean CreatureLevelledListRecord.calculateFromAllLevels: Calculate from all levels <= player level, not just the closest below player

#number CreatureLevelledListRecord.chanceNone: Chance this list won't spawn anything [0-1]

#list<#LevelledListItem> CreatureLevelledListRecord.creatures

CreatureLevelledListRecord.getRandomId(listRecord, MaxLvl)

Picks a random id from the levelled list.

Parameters

openmw.core#CreatureLevelledListRecord listRecord : The list
#number MaxLvl : The maximum level to select entries for

Return value

#string: An id

#string CreatureLevelledListRecord.id: Record id

Type `CreatureRecord`

Field(s)

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

#number CreatureRecord.baseGold: The base barter gold of the creature

#string CreatureRecord.id: The record ID of the creature

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

#string CreatureRecord.mwscript

#string CreatureRecord.name

#map<#string,#boolean> CreatureRecord.servicesOffered: The services of the creature, in a table. Value is if the service is provided or not, and they are indexed by: Spells, Spellmaking, Enchanting, Training, Repair, Barter, Weapon, Armor, Clothing, Books, Ingredients, Picks, Probes, Lights, Apparatus, RepairItems, Misc, Potions, MagicItems, Travel.

#number CreatureRecord.soulValue: The soul value of the creature record

#number CreatureRecord.type: The Creature.TYPE of the creature

Type `CreatureTYPE`

Creature.TYPE

Field(s)

#number CreatureTYPE.Creatures

#number CreatureTYPE.Daedra

#number CreatureTYPE.Humanoid

#number CreatureTYPE.Undead

Type `Door`

Extends #Lockable

Field(s)

#Lockable Door.baseType: #Lockable

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#Transform:

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:

#list<#DoorRecord> Door.records: A read-only list of all #DoorRecords in the world database.

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 `ESM4Activator`

Type `ESM4Ammunition`

Type `ESM4Armor`

Type `ESM4Book`

Type `ESM4Clothing`

Type `ESM4Door`

Extends #Lockable

Field(s)

#Lockable ESM4Door.baseType: #Lockable

ESM4Door.destCell(object)

Destination cell (only if a teleport door).

Parameter

openmw.core#GameObject object :

Return value

openmw.core#Cell:

ESM4Door.destPosition(object)

Destination (only if a teleport door).

Parameter

openmw.core#GameObject object :

Return value

openmw.util#Vector3:

ESM4Door.destRotation(object)

Destination rotation (only if a teleport door).

Parameter

openmw.core#GameObject object :

Return value

openmw.util#Transform:

ESM4Door.isTeleport(object)

Whether the door is a teleport.

Parameter

openmw.core#GameObject object :

Return value

#boolean:

ESM4Door.objectIsInstance(object)

Whether the object is a ESM4Door.

Parameter

openmw.core#GameObject object :

Return value

#boolean:

ESM4Door.record(objectOrRecordId)

Returns the read-only #ESM4DoorRecord of a door

Parameter

#any objectOrRecordId :

Return value

#ESM4DoorRecord:

ESM4Door.records()

Returns a read-only list of all #ESM4DoorRecords in the world database.

Return value

#list<#ESM4DoorRecord>:

Type `ESM4DoorRecord`

Field(s)

#string ESM4DoorRecord.id: Record id

#string ESM4DoorRecord.model: VFS path to the model

#string ESM4DoorRecord.name: Human-readable name

Type `ESM4Flora`

Type `ESM4Ingredient`

Type `ESM4ItemMod`

Type `ESM4Light`

Type `ESM4Miscellaneous`

Type `ESM4MovableStatic`

Type `ESM4Potion`

Type `ESM4Static`

Type `ESM4Terminal`

Field(s)

ESM4Terminal.objectIsInstance(object)

Whether the object is a ESM4Terminal.

Parameter

openmw.core#GameObject object :

Return value

#boolean:

ESM4Terminal.record(objectOrRecordId)

Returns the read-only #ESM4TerminalRecord of a terminal

Parameter

#any objectOrRecordId :

Return value

#ESM4TerminalRecord:

#list<#ESM4TerminalRecord> ESM4Terminal.records: A read-only list of all #ESM4TerminalRecords in the world database.

Type `ESM4TerminalRecord`

Field(s)

#string ESM4TerminalRecord.editorId: Human-readable ID

#string ESM4TerminalRecord.id: Record id (Form ID)

#string ESM4TerminalRecord.model: VFS path to the model

#string ESM4TerminalRecord.name: Human-readable name

#string ESM4TerminalRecord.resultText: Result text of the terminal record

#string ESM4TerminalRecord.text: Text body of the terminal record

Type `ESM4Weapon`

Type `EquipmentTable`

Map from values of #EQUIPMENT_SLOT to items openmw.core#GameObjects

EquipmentTable is a map of #number to openmw.core#GameObject.

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:

#list<#IngredientRecord> Ingredient.records: A read-only list of all #IngredientRecords in the world database.

Type `IngredientRecord`

Field(s)

#list<openmw.core#MagicEffectWithParams> IngredientRecord.effects: The effects (openmw.core#MagicEffectWithParams) of the ingredient

#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 items that can be placed to an inventory or container

Field(s)

Item.getEnchantmentCharge(item)

Get this item's current enchantment charge.

Parameter

openmw.core#GameObject item :

Return value

#number: The charge remaining. -1 if the enchantment has never been used, implying the charge is full. Unenchanted items will always return a value of -1.

Item.isCarriable(object)

Whether the object is supposed to be carriable.

It is true for all items except lights without the Carry flag. Non-carriable lights can still be put into an inventory with an explicit object:moveInto call.

Parameter

openmw.core#GameObject object :

Return value

#boolean:

Item.isRestocking(item)

Checks if the item restocks.

Returns true if the object restocks, and false otherwise.

Parameter

openmw.core#GameObject item :

Return value

#boolean:

Item.itemData(item)

Set of properties that differentiates one item from another of the same record type.

Parameter

openmw.core#GameObject item :

Return value

#ItemData:

Item.objectIsInstance(object)

Whether the object is an item.

Parameter

openmw.core#GameObject object :

Return value

#boolean:

Item.setEnchantmentCharge(item, charge)

Set this item's enchantment charge.

Parameters

openmw.core#GameObject item :
#number charge :

Type `ItemData`

Field(s)

#number ItemData.condition: The item's current condition. Time remaining for lights. Uses left for lockpicks and probes. Current health for weapons and armor.

Type `LevelStat`

Field(s)

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

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

Type `LevelledListItem`

Field(s)

#string LevelledListItem.id: Item id

#number LevelledListItem.level: The minimum player level at which this item can occur

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:

Light.record(objectOrRecordId)

Returns the read-only #LightRecord of a Light

Parameter

#any objectOrRecordId :

Return value

#LightRecord:

#list<#LightRecord> Light.records: A read-only list of all #LightRecords in the world database.

Type `LightRecord`

Field(s)

#number LightRecord.color

#number LightRecord.duration

#string LightRecord.icon: VFS path to the icon

#string LightRecord.id: Record id

#boolean LightRecord.isCarriable

#string LightRecord.model: VFS path to the model

#string LightRecord.mwscript: MWScript on this light (can be empty)

#string LightRecord.name: Human-readable name

#number LightRecord.radius

#string LightRecord.sound: VFS path to the sound

#number LightRecord.value

#number LightRecord.weight

Type `Lockable`

Field(s)

Lockable.getKeyRecord(object)

Returns the key record of a lockable object(door, container)

Parameter

openmw.core#GameObject object :

Return value

#MiscellaneousRecord:

Lockable.getLockLevel(object)

Returns the lock level of a lockable object(door, container).

Does not determine if an object is locked or not, if an object is locked while this is set above 0, this value will be used if no other value is specified.

Parameter

openmw.core#GameObject object :

Return value

#number:

Lockable.getTrapSpell(object)

Returns the trap spell of a lockable object(door, container)

Parameter

openmw.core#GameObject object :

Return value

openmw.core#Spell:

Lockable.isLocked(object)

Returns true if the lockable object is locked, and false if it is not.

Parameter

openmw.core#GameObject object :

Return value

#boolean:

Lockable.lock(object, lockLevel)

Sets the lock level level of a lockable object(door, container);Locks if not already locked; Must be used in a global script.

Parameters

openmw.core#GameObject object :
#number lockLevel : Level to lock the object at. Optional, if not specified, then 1 will be used, or the previous level if it was locked before.

Lockable.setKeyRecord(object, miscOrId)

Sets the key of a lockable object(door, container); removes it if empty string is provided.

Must be used in a global script.

Parameters

openmw.core#GameObject object :
#any miscOrId : #MiscellaneousRecord or string misc item id Record ID of the key to use.

Lockable.setTrapSpell(object, spellOrId)

Sets the trap spell of a lockable object(door, container); removes it if empty string is provided.

Must be used in a global script.

Parameters

openmw.core#GameObject object :
#any spellOrId : openmw.core#Spell or string spell id Record ID for the trap to use

Lockable.unlock(object)

Unlocks the lockable object.

Does not change the lock level, it can be kept for future use.

Parameter

openmw.core#GameObject object :

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:

#list<#LockpickRecord> Lockpick.records: A read-only list of all #LockpickRecords in the world database.

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.createRecordDraft(miscellaneous)

Creates a #MiscellaneousRecord without adding it to the world database.

Use openmw_world#world.createRecord to add the record to the world.

Parameter

#MiscellaneousRecord miscellaneous : A Lua table with the fields of a MiscellaneousRecord, with an optional field template that accepts a #MiscellaneousRecord as a base.

Return value

#MiscellaneousRecord: A strongly typed Miscellaneous record.

Miscellaneous.getSoul(object)

Returns the read-only soul of a miscellaneous item

Parameter

openmw.core#GameObject object :

Return value

#string:

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:

#list<#MiscellaneousRecord> Miscellaneous.records: A read-only list of all #MiscellaneousRecords in the world database.

Miscellaneous.setSoul(object, soulId)

Sets the soul of a miscellaneous item, intended for soul gem objects; Must be used in a global script.

Parameters

openmw.core#GameObject object :
#string soulId : Record ID for the soul of the creature to use

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

#Classes NPC.classes: #Classes: Class Data

NPC.clearExpelled(actor, faction)

Clear expelling of NPC from given faction.

Throws an exception if there is no such faction.

Parameters

openmw.core#GameObject actor : NPC object
#string faction : Faction ID

Usage:

local NPC = require('openmw.types').NPC;
NPC.clearExpell(player, "mages guild");

NPC.expel(actor, faction)

Expel NPC from given faction.

Throws an exception if there is no such faction. Note: expelled NPC still keeps his rank and reputation in faction, he just get an additonal flag for given faction.

Parameters

openmw.core#GameObject actor : NPC object
#string faction : Faction ID

Usage:

local NPC = require('openmw.types').NPC;
NPC.expel(player, "mages guild");

NPC.getCapacity(actor)

Get the total weight that the actor can carry.

Parameter

openmw.core#GameObject actor :

Return value

#number:

NPC.getDisposition(object, player)

Returns the current disposition of the provided NPC.

This is their derived disposition, after modifiers such as personality and faction relations are taken into account.

Parameters

openmw.core#GameObject object :
openmw.core#GameObject player : The player that you want to check the disposition for.

Return value

#number:

NPC.getFactionRank(actor, faction)

Get rank of given NPC in given faction.

Throws an exception if there is no such faction. Note: this function does not take in account an expelling state.

Parameters

openmw.core#GameObject actor : NPC object
#string faction : Faction ID

Return value

#number: rank Rank index (from 1), 0 if NPC is not in faction.

Usage:

local NPC = require('openmw.types').NPC;
print(NPC.getFactionRank(player, "mages guild");

NPC.getFactionReputation(actor, faction)

Get reputation of given actor in given faction.

Throws an exception if there is no such faction.

Parameters

openmw.core#GameObject actor : NPC object
#string faction : Faction ID

Return value

#number: reputation Reputation level, 0 if NPC is not in faction.

Usage:

local NPC = require('openmw.types').NPC;
print(NPC.getFactionReputation(player, "mages guild"));

NPC.getFactions(actor)

Get all factions in which NPC has a membership.

Note: this function does not take in account an expelling state.

Parameter

openmw.core#GameObject actor : NPC object

Return value

#list<#string>: factionIds List of faction IDs.

Usage:

local NPC = require('openmw.types').NPC;
for _, factionId in pairs(types.NPC.getFactions(actor)) do
    print(factionId);
end

NPC.isExpelled(actor, faction)

Check if NPC is expelled from given faction.

Throws an exception if there is no such faction.

Parameters

openmw.core#GameObject actor : NPC object
#string faction : Faction ID

Return value

#bool: isExpelled True if NPC is expelled from the faction.

Usage:

local NPC = require('openmw.types').NPC;
local result = NPC.isExpelled(player, "mages guild");

NPC.isWerewolf(actor)

Whether the NPC or player is in the werewolf form at the moment.

Parameter

openmw.core#GameObject actor :

Return value

#boolean:

NPC.joinFaction(actor, faction)

Add given actor to given faction.

Throws an exception if there is no such faction or target actor is not player. Function does nothing if valid target actor is already a member of target faction.

Parameters

openmw.core#GameObject actor : NPC object
#string faction : Faction ID

Usage:

local NPC = require('openmw.types').NPC;
NPC.joinFaction(player, "mages guild");

NPC.leaveFaction(actor, faction)

Remove given actor from given faction.

Function removes rank data and expelling state, but keeps a reputation in target faction. Throws an exception if there is no such faction or target actor is not player. Function does nothing if valid target actor is already not member of target faction.

Parameters

openmw.core#GameObject actor : NPC object
#string faction : Faction ID

Usage:

local NPC = require('openmw.types').NPC;
NPC.leaveFaction(player, "mages guild");

NPC.modifyFactionRank(actor, faction, value)

Adjust rank of given NPC in given faction.

Throws an exception if there is no such faction or actor is not a member of given faction. For NPCs faction also should be an NPC's primary faction. Notes:

If rank should become <= 0 after modification, function set rank to lowest available rank.
If rank should become > 0 after modification, but target rank does not exist, function set rank to the highest valid rank.

Parameters

openmw.core#GameObject actor : NPC object
#string faction : Faction ID
#number value : Rank index (from 1) modifier. If rank reaches 0 for player character, he leaves the faction.

Usage:

local NPC = require('openmw.types').NPC;
NPC.modifyFactionRank(player, "mages guild", 1);

NPC.modifyFactionReputation(actor, faction, value)

Adjust reputation of given actor in given faction.

Throws an exception if there is no such faction.

Parameters

openmw.core#GameObject actor : NPC object
#string faction : Faction ID
#number value : Reputation modifier value

Usage:

local NPC = require('openmw.types').NPC;
NPC.modifyFactionReputation(player, "mages guild", 5);

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:

#list<#NpcRecord> NPC.records: A read-only list of all #NpcRecords in the world database.

NPC.setFactionRank(actor, faction, value)

Set rank of given NPC in given faction.

Throws an exception if there is no such faction, target rank does not exist or actor is not a member of given faction. For NPCs faction also should be an NPC's primary faction.

Parameters

openmw.core#GameObject actor : NPC object
#string faction : Faction ID
#number value : Rank index (from 1).

Usage:

local NPC = require('openmw.types').NPC;
NPC.setFactionRank(player, "mages guild", 6);

NPC.setFactionReputation(actor, faction, value)

Set reputation of given actor in given faction.

Throws an exception if there is no such faction.

Parameters

openmw.core#GameObject actor : NPC object
#string faction : Faction ID
#number value : Reputation value

Usage:

local NPC = require('openmw.types').NPC;
NPC.setFactionReputation(player, "mages guild", 100);

#NpcStats NPC.stats

Type `NpcRecord`

Field(s)

#number NpcRecord.baseDisposition: NPC's starting disposition

#number NpcRecord.baseGold: The base barter gold of the NPC

#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.id: The record ID of the NPC

#bool NpcRecord.isMale: The gender setting of the NPC

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

#string NpcRecord.name

#string NpcRecord.race

#map<#string,#boolean> NpcRecord.servicesOffered: The services of the NPC, in a table. Value is if the service is provided or not, and they are indexed by: Spells, Spellmaking, Enchanting, Training, Repair, Barter, Weapon, Armor, Clothing, Books, Ingredients, Picks, Probes, Lights, Apparatus, RepairItems, Misc, Potions, MagicItems, Travel.

Type `NpcStats`

Field(s)

#SkillStats NpcStats.skills

Type `Player`

Extends #NPC

Field(s)

#CONTROL_SWITCH Player.CONTROL_SWITCH: Values that can be used with getControlSwitch/setControlSwitch.

#NPC Player.baseType: #NPC

Player.getControlSwitch(player, key)

Get state of a control switch.

I.e. is the player able to move/fight/jump/etc.

Parameters

openmw.core#GameObject player :
#ControlSwitch key : Control type (see openmw.types#CONTROL_SWITCH)

Return value

#boolean:

Player.getCrimeLevel(player)

Returns the bounty or crime level of the player

Parameter

openmw.core#GameObject player :

Return value

#number:

Player.isCharGenFinished(player)

Whether the character generation for this player is finished.

Parameter

openmw.core#GameObject player :

Return value

#boolean:

Player.isTeleportingEnabled(player)

Whether teleportation for this player is enabled.

Parameter

openmw.core#GameObject player :

Return value

#boolean:

Player.objectIsInstance(object)

Whether the object is a player.

Parameter

openmw.core#GameObject object :

Return value

#boolean:

Player.quests(player)

Returns a list containing quests #PlayerQuest for the specified player, indexed by quest ID.

Parameter

openmw.core#GameObject player :

Return value

#list<#PlayerQuest>:

Usages:

-- Get stage of a specific quest
stage = types.Player.quests(player)["ms_fargothring"].stage

-- Start a new quest, add it to the player's quest list but don't add any journal entries
types.Player.quests(player)["ms_fargothring"].stage = 0

Player.setControlSwitch(player, key, value)

Set state of a control switch.

I.e. forbid or allow the player to move/fight/jump/etc. Can be used only in global or player scripts.

Parameters

openmw.core#GameObject player :
#ControlSwitch key : Control type (see openmw.types#CONTROL_SWITCH)
#boolean value :

Player.setTeleportingEnabled(player, state)

Enables or disables teleportation for this player.

Parameters

openmw.core#GameObject player :
#boolean state : True to enable teleporting, false to disable.

Type `PlayerQuest`

Field(s)

PlayerQuest:addJournalEntry(stage, actor)

Sets the quest stage for the given quest, on the given player, and adds the entry to the journal, if there is an entry at the specified stage.

Can only be used in global or player scripts.

Parameters

#number stage : Quest stage
openmw.core#GameObject actor : (optional) The actor who is the source of the journal entry, it may be used in journal entries with variables such as %name(The speaker's name) or %race(The speaker's race).