tes3door⚓︎
A door game object. Data specific to a single door is stored on the door reference as destination and lock attachments. See tes3reference for details.
There is a special-case door with id PrisonMarker used for finding the nearest prison when the player is sent to jail. You should normally exclude this if you are iterating over all doors. Use the object.isLocationMarker property to detect these markers.
This type inherits the following: tes3physicalObject, tes3object, tes3baseObject
Properties⚓︎
blocked⚓︎
The blocked state of the object.
Returns:
result(boolean)
boundingBox⚓︎
The bounding box for the object.
Returns:
result(tes3boundingBox)
closeSound⚓︎
The sound to be played when the door closes.
Returns:
result(tes3sound)
deleted⚓︎
Read-only. The deleted state of the object.
Returns:
result(boolean)
disabled⚓︎
Read-only. The disabled state of the object.
Returns:
result(boolean)
id⚓︎
Read-only. The unique identifier for the object.
Returns:
result(string)
isLocationMarker⚓︎
True if this object is an editor marker for a gameplay location. These include travel, intervention, prison, door, and interior north markers. Markers are invisible in-game.
Returns:
result(boolean)
mesh⚓︎
The path to the object's mesh.
Returns:
result(string)
modified⚓︎
The modification state of the object since the last save.
Returns:
result(boolean)
name⚓︎
The player-facing name for the object.
Returns:
result(string)
nextInCollection⚓︎
The next object in parent collection's list.
Returns:
result(tes3object)
objectFlags⚓︎
Read-only. The raw flags of the object.
Returns:
result(number)
objectType⚓︎
Read-only. The type of object. Maps to values in tes3.objectType.
Returns:
result(tes3.objectType)
openSound⚓︎
The sound to be played when the door opens.
Returns:
result(tes3sound)
owningCollection⚓︎
The collection responsible for holding this object.
Returns:
result(tes3referenceList)
persistent⚓︎
The persistent flag of the object.
Returns:
result(boolean)
previousInCollection⚓︎
The previous object in parent collection's list.
Returns:
result(tes3object)
scale⚓︎
The object's scale. The value range is (0, 10).
Returns:
result(number)
sceneCollisionRoot⚓︎
The scene graph node for this object's physics collision, if its mesh has a root collision node.
Returns:
result(niNode)
sceneNode⚓︎
The scene graph node for this object.
Returns:
result(niNode)
script⚓︎
Read-only. The script that runs on the object.
Returns:
result(tes3script)
sourceless⚓︎
The soruceless flag of the object.
Returns:
result(boolean)
sourceMod⚓︎
Read-only. The filename (including the extension) of the mod that owns this object. It has nil value if the object was anything other than loaded from an ESP or ESM file.
Returns:
result(string)
stolenList⚓︎
A list of actors that the object has been stolen from.
Returns:
result(tes3baseObject[])
supportsLuaData⚓︎
If true, references of this object can store temporary or persistent lua data.
Returns:
result(boolean)
Methods⚓︎
__tojson⚓︎
Serializes the object to json.
local string = myObject:__tojson()
Returns:
string(string)