Door Class
Declared on: line 35 of Lua/objects/door.lua.
Inheritance: Door » Object » Entity
Subclasses: SwingDoor
Inheritance: Door » Object » Entity
Subclasses: SwingDoor
Method Index
- _getUsageTile(usage_position_name) (inherited from Object)
- _tick() (inherited from Entity)
- addReservedUser(user) (inherited from Object)
- afterLoad(old, new) (overrides Object:afterLoad)
- cancelUsage() (inherited from Object)
- checkForDeadlock()
- clearDynamicInfo() (inherited from Entity)
- closeDoor()
- denyReservation() (inherited from Object)
- deoccupyTilesByObjectFootprintAt(x, y) (inherited from Object)
- directionParameters() (inherited from Object)
- eraseObject() (inherited from Object)
- getAllUsageTiles() (inherited from Object)
- getComplementaryPassableFlag(passable_flag) (inherited from Object)
- getDrawingLayer() (overrides Entity:getDrawingLayer)
- getDynamicInfo() (inherited from Entity)
- getRenderAttachTile() (inherited from Object)
- getRoom() (overrides Entity:getRoom)
- getSecondaryUsageTile() (inherited from Object)
- getState() (inherited from Object)
- getTile() (inherited from Entity)
- getWalkableTiles() (overrides Object:getWalkableTiles)
- getXYforUsePosition(object_x, object_y, object_layout, usage_position_name) (inherited from Object)
- incrementUsedCount() (inherited from Object)
- initOrientation(direction) (inherited from Object)
- isMachine() (inherited from Object)
- isReservedFor(user) (inherited from Object)
- notifyNewObject(id) (inherited from Entity)
- notifyNewRoom(room) (inherited from Entity)
- occupyTilesByObjectFootprintAt(x, y) (inherited from Object)
- onClick(ui, button) (overrides Object:onClick)
- onDestroy() (inherited from Object)
- onPickUp() (inherited from Object)
- playAfterLoadSound() (inherited from Entity)
- playEntitySounds(name_pattern, min_silence_lengths, max_silence_lengths, num_silences) (inherited from Entity)
- playSound(name, played_callback, played_callback_delay) (inherited from Entity)
- processTypeDefinition(object_type) (inherited from Object)
- rebuildPassableCellFlags() (inherited from Object)
- removeReservedUser(user) (inherited from Object)
- removeUser(user) (inherited from Object)
- resetAnimation() (inherited from Object)
- resetUsageAndReservaton() (inherited from Object)
- setAnimation(animation, flags) (overrides Object:setAnimation)
- setDynamicInfo(type, value) (inherited from Entity)
- setInvisible(invisible) (inherited from Object)
- setLayer(layer, id) (inherited from Entity)
- setMood(mood_name, activate) (inherited from Entity)
- setMoodInfo(new_mood) (inherited from Entity)
- setPosition(x, y) (inherited from Object)
- setSpeed(x, y) (inherited from Entity)
- setState(state) (inherited from Object)
- setTile(x, y) (overrides Object:setTile)
- setTilePositionSpeed(tx, ty, px, py, sx, sy) (inherited from Entity)
- setTimer(tick_count, f) (inherited from Entity)
- setUser(user) (inherited from Object)
- setWaitingForSoundEffectsToBeTurnedOn() (inherited from Entity)
- setupDoor(room, old_door)
- slaveMixinClass(class_method_table) (inherited from Object)
- tick() (inherited from Object)
- tickDay() (inherited from Entity)
- updateDynamicInfo() (overrides Object:updateDynamicInfo)
- usePositionNames() (inherited from Object)
Member Index
- animation_flags (*)
- animation_idx (*)
- direction
- dynamic_info (*)
- footprint (*)
- hospital (*)
- hover_cursor
- layers (*)
- mood_info (*)
- mood_marker (*)
- num_animation_ticks (*)
- object_type (*)
- orientation_before (*)
- permanent_flags (*)
- picked_up (*)
- playing_sounds_in_random_sequence (*)
- queue
- random_sound_sequence_parameters (*)
- reserved_for
- reserved_for_list (*)
- room
- set_passable_flags (*)
- skip_next_tick (*)
- slow_animation (*)
- split_anim_positions (*)
- split_anims (*)
- th (*)
- ticks (*)
- tile_x
- tile_y
- timer_function (*)
- timer_time (*)
- times_used (*)
- user (*)
- user_list (*)
- user_of (*)
- waiting_for_sound_effects_to_be_turned_on (*)
- world
function Door:Door(...)
Parameters:
| Name | Type | Description |
|---|---|---|
| ... | ? | ? |
Declared on: line 40 of Lua/objects/door.lua.
function Door:afterLoad(old, new)
Parameters:
| Name | Type | Description |
|---|---|---|
| old | ? | ? |
| new | ? | ? |
Overrides: Object:afterLoad.
Declared on: line 192 of Lua/objects/door.lua.
function Door:closeDoor()
Declared on: line 158 of Lua/objects/door.lua.
function Door:getDrawingLayer()
Overrides: Entity:getDrawingLayer.
Declared on: line 167 of Lua/objects/door.lua.
function Door:getRoom()
Overrides: Entity:getRoom.
Declared on: line 65 of Lua/objects/door.lua.
function Door:getWalkableTiles()
Overrides: Object:getWalkableTiles.
Declared on: line 138 of Lua/objects/door.lua.
function Door:onClick(ui, button)
Parameters:
| Name | Type | Description |
|---|---|---|
| ui | ? | ? |
| button | ? | ? |
Overrides: Object:onClick.
Declared on: line 86 of Lua/objects/door.lua.
function Door:setAnimation(animation, flags)
Parameters:
| Name | Type | Description |
|---|---|---|
| animation | ? | ? |
| flags | ? | ? |
Overrides: Object:setAnimation.
Declared on: line 150 of Lua/objects/door.lua.
function Door:setTile(x, y)
Parameters:
| Name | Type | Description |
|---|---|---|
| x | ? | ? |
| y | ? | ? |
Overrides: Object:setTile.
Declared on: line 99 of Lua/objects/door.lua.
function Door:setupDoor(room, old_door)
Updates room new door with values from previous door.
New door is typically result of room editing.
Parameters:
| Name | Type | Description |
|---|---|---|
| room | Room | The room this door belongs to. |
| old_door | Door | Previous door of this room. |
Declared on: line 52 of Lua/objects/door.lua.
function Door:updateDynamicInfo()
Updates a door's dynamic info
Overrides: Object:updateDynamicInfo.
Declared on: line 69 of Lua/objects/door.lua.