ESM4Door

Part of openmw.types

Usage:

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

Type `types`

Functions for #ESM4Door objects

Type `ESM4Door`

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

Field(s)

#ESM4Door types.ESM4Door: Functions for #ESM4Door objects

Type `ESM4Door`

Functions for ESM4Door objects

Field(s)

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

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