Skip to content

Floor

Floor entitiessource

Derived from Entity

Derived types: Altar, Arrowtrap, BigSpearTrap, Door, ForceField, Generator, HorizontalForceField, JungleSpearTrap, LaserTrap, MotherStatue, Pipe, PoleDeco, QuickSand, SlidingWallCeiling, SparkTrap, SpikeballTrap, StickyTrap, TeleportingBorder, TentacleBottom, TotemTrap, TransferFloor

Fields

deco_bottom

integer

source

deco_left

integer

source

deco_right

integer

source

deco_top

integer

source

Methods

add_decoration

function Floor:add_decoration(side: FLOOR_SIDE)
side: FLOOR_SIDE
source

clear_virtual

function Floor:clear_virtual(callback_id: integer)
callback_id: integer
source

decorate_internal

function Floor:decorate_internal()
source

fix_border_tile_animation

function Floor:fix_border_tile_animation()
source

fix_decorations

function Floor:fix_decorations(fix_also_neighbors: boolean, fix_styled_floor: boolean)
fix_also_neighbors: boolean
fix_styled_floor: boolean
source

get_floor_type

function Floor:get_floor_type(): ENT_TYPE

Returns ENT_TYPE

source

remove_decoration

function Floor:remove_decoration(side: FLOOR_SIDE)
side: FLOOR_SIDE
source

set_post_floor_update

function Floor:set_post_floor_update(fun: fun(self: Entity?)): integer
fun: fun(self: Entity?)

Returns integer

source

set_post_virtual

function Floor:set_post_virtual(index: integer, fun: function): integer?
index: integer
fun: function
Callback signature not known from the code.

Returns integer? (may be nil)

source

set_pre_floor_update

function Floor:set_pre_floor_update(fun: fun(self: Entity?): boolean): integer
fun: fun(self: Entity?): boolean
Returning nil (or nothing): treated as false: the original function runs (true skips it).

Returns integer

source

set_pre_virtual

function Floor:set_pre_virtual(index: integer, fun: function): integer?
index: integer
fun: function
Callback signature not known from the code.

Returns integer? (may be nil)

source