SwingDoor Class
Inheritance: SwingDoor » Door » Object » Entity
Method Index
- _getUsageTile(usage_position_name) (inherited from Object)
- _tick() (inherited from Entity)
- addReservedUser(user) (inherited from Object)
- afterLoad(old, new) (overrides Door:afterLoad)
- cancelUsage() (inherited from Object)
- checkForDeadlock() (inherited from Door)
- checkPaired(x, y)
- clearDynamicInfo() (inherited from Entity)
- closeDoor() (inherited from Door)
- 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() (inherited from Door)
- getDynamicInfo() (overrides Entity:getDynamicInfo)
- getRenderAttachTile() (inherited from Object)
- getRoom() (inherited from Door)
- getSecondaryUsageTile() (inherited from Object)
- getState() (inherited from Object)
- getTile() (inherited from Entity)
- getWalkableTiles() (overrides Door: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 Door:onClick)
- onDestroy() (inherited from Object)
- onPickUp() (inherited from Object)
- pairDoors(x, y)
- 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) (inherited from Door)
- 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) (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)
- setWaitingForSoundEffectsToBeTurnedOn() (inherited from Entity)
- setupDoor(room, old_door) (inherited from Door)
- 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)
- usePositionNames() (inherited from Object)
Member Index
- animation_flags (*)
- animation_idx (*)
- direction
- dynamic_info
- footprint (*)
- hospital (*)
- hover_cursor (*)
- is_master
- layers (*)
- master
- mood_info (*)
- mood_marker (*)
- num_animation_ticks (*)
- object_type (*)
- old_anim
- old_flags
- orientation_before (*)
- paired
- 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 (*)
- 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 (*)
- waiting_for_sound_effects_to_be_turned_on (*)
- world
function SwingDoor:SwingDoor(hospital, object_type, x, y, direction, etc)
Parameters:
| Name | Type | Description |
|---|---|---|
| hospital | ? | ? |
| object_type | ? | ? |
| x | ? | ? |
| y | ? | ? |
| direction | ? | ? |
| etc | ? | ? |
Declared on: line 38 of Lua/objects/doors/swing_door_right.lua.
function SwingDoor:afterLoad(old, new)
Parameters:
| Name | Type | Description |
|---|---|---|
| old | ? | ? |
| new | ? | ? |
Overrides: Door:afterLoad.
Declared on: line 190 of Lua/objects/doors/swing_door_right.lua.
function SwingDoor:checkPaired(x, y)
Checks to see if the swing doors have paired correctly
Parameters:
| Name | Type | Description |
|---|---|---|
| x | ? | ? |
| y | ? | ? |
Declared on: line 77 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 110 of Lua/objects/doors/swing_door_right.lua.
function SwingDoor:getWalkableTiles()
Overrides: Door:getWalkableTiles.
Declared on: line 171 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 92 of Lua/objects/doors/swing_door_right.lua.
function SwingDoor:pairDoors(x, y)
Links the master to the slave swing door. This allows the slave to mimic the
master in interactions
Parameters:
| Name | Type | Description |
|---|---|---|
| x | num | Coordinate |
| y | num | Coordinate |
Declared on: line 48 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 151 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 129 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 115 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 101 of Lua/objects/doors/swing_door_right.lua.