SwingDoor Class
Inheritance: SwingDoor » Door » Object » Entity
Method Index
- _tick() (inherited from Entity)
- addReservedUser(user) (inherited from Object)
- afterLoad(old, new) (inherited from Door)
- checkForDeadlock() (inherited from Door)
- clearDynamicInfo() (inherited from Entity)
- closeDoor() (inherited from Door)
- getDrawingLayer() (inherited from Door)
- getDynamicInfo() (overrides Entity:getDynamicInfo)
- getRenderAttachTile() (inherited from Object)
- getRoom() (inherited from Door)
- getSecondaryUsageTile() (inherited from Object)
- getWalkableTiles() (overrides Door:getWalkableTiles)
- initOrientation(direction) (inherited from Object)
- isReservedFor(user) (inherited from Object)
- notifyNewObject(id) (inherited from Entity)
- onClick(ui, button) (overrides Door:onClick)
- onDestroy() (inherited from Object)
- playSound(name) (inherited from Entity)
- processTypeDefinition(object_type) (inherited from Object)
- removeReservedUser(user) (inherited from Object)
- removeUser(user) (inherited from Object)
- resetAnimation() (inherited from Object)
- setAnimation(animation, flags) (inherited from Door)
- setAsSlave(swing_door)
- setDynamicInfo(type, value) (inherited from Entity)
- 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)
- setTile(x, y) (inherited from Door)
- setTilePositionSpeed(tx, ty, px, py, sx, sy) (inherited from Entity)
- setTimer(tick_count, f) (inherited from Entity)
- setUser(user) (inherited from Object)
- slaveMixinClass(class_method_table) (inherited from Object)
- swing(anim, flags)
- swingDoors(direction, length)
- swingSlave(direction)
- tick() (inherited from Object)
- tickDay() (inherited from Entity)
- updateDynamicInfo() (overrides Door:updateDynamicInfo)
Member Index
- animation_flags (*)
- animation_idx (*)
- direction
- dynamic_info
- footprint (*)
- hospital (*)
- hover_cursor (*)
- init_anim_flags (*)
- is_master
- layers (*)
- master
- mood_info (*)
- num_animation_ticks (*)
- object_type (*)
- old_anim
- old_flags
- orientation_before (*)
- permanent_flags (*)
- picked_up (*)
- queue (*)
- reserved_for (*)
- reserved_for_list (*)
- room (*)
- set_passable_flags (*)
- skip_next_tick (*)
- slave
- slow_animation (*)
- split_anim_positions (*)
- split_anims (*)
- th
- ticks
- tile_x
- tile_y
- timer_function (*)
- timer_time (*)
- times_used (*)
- user (*)
- user_list (*)
- user_of (*)
- world
function SwingDoor:SwingDoor(world, object_type, x, y, direction, etc)
Parameters:
| Name | Type | Description |
|---|---|---|
| world | ? | ? |
| object_type | ? | ? |
| x | ? | ? |
| y | ? | ? |
| direction | ? | ? |
| etc | ? | ? |
Declared on: line 35 of Lua/objects/doors/swing_door_right.lua.
function SwingDoor:getDynamicInfo()
Depending on if this is a master or slave show the correct information.
Overrides: Entity:getDynamicInfo.
Declared on: line 80 of Lua/objects/doors/swing_door_right.lua.
function SwingDoor:getWalkableTiles()
Overrides: Door:getWalkableTiles.
Declared on: line 141 of Lua/objects/doors/swing_door_right.lua.
function SwingDoor:onClick(ui, button)
Depending on if this is a master or slave different onClick functions are called.
Parameters:
| Name | Type | Description |
|---|---|---|
| ui | ? | ? |
| button | ? | ? |
Overrides: Door:onClick.
Declared on: line 62 of Lua/objects/doors/swing_door_right.lua.
function SwingDoor:setAsSlave(swing_door)
Makes the door mimic its master when it comes to hover cursor and what happens
when the player clicks on it.
Parameters:
| Name | Type | Description |
|---|---|---|
| swing_door | Door | The master door to mimic. |
Declared on: line 53 of Lua/objects/doors/swing_door_right.lua.
function SwingDoor:swing(anim, flags)
The actual swinging is done in this class.
Parameters:
| Name | Type | Description |
|---|---|---|
| anim | integer | The animation to use. |
| flags | integer | Flags, if any, associated with the animation. |
Declared on: line 121 of Lua/objects/doors/swing_door_right.lua.
function SwingDoor:swingDoors(direction, length)
Makes the pair of swing doors start swinging in the correct fashion.
Parameters:
| Name | Type | Description |
|---|---|---|
| direction | string | The direction in which to swing. Allowed values are "in" and "out". |
| length | integer | How long the swing animation is for the entering/leaving entity. |
Declared on: line 99 of Lua/objects/doors/swing_door_right.lua.
function SwingDoor:swingSlave(direction)
Tell the associated slave door to start swinging.
Parameters:
| Name | Type | Description |
|---|---|---|
| direction | string | The direction in which to swing. Allowed values are "in" and "out". |
Declared on: line 85 of Lua/objects/doors/swing_door_right.lua.
function SwingDoor:updateDynamicInfo()
Depending on if this is a master or slave update the correct information.
Overrides: Door:updateDynamicInfo.
Declared on: line 71 of Lua/objects/doors/swing_door_right.lua.