Door

Part of openmw.types

Usage:

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

Type `types`

#Door functions

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

Field(s)

#Door types.Door: #Door functions

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

#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 `Lockable`