Activator

Part of openmw.types

Usage:

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

Type `types`

types.Activator

#Activator 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 `types`

Field(s)

#Activator types.Activator: #Activator functions

Type `Activator`

Activator functions

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.

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