NPC

Part of openmw.types

Usage:

local NPC = require('openmw.types').NPC

Type types

types.NPC

#NPC functions

Type NPC

NPC.baseType	#Actor
NPC.isWerewolf(actor)	Whether the NPC or player is in the werewolf form at the moment.
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.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.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

Type NpcStats

NpcStats.skills

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 types

Field(s)

#NPC types.NPC

#NPC functions

Type Actor

Type NPC

Extends #Actor

NPC functions

Field(s)

#Actor NPC.baseType

#Actor

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.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.

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

Type NpcStats

Field(s)

#SkillStats NpcStats.skills

Type SkillStat

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 bool