CorsixTH Lua Documentation

function Entity:Entity(animation)

Parameters:

Declared on: line 29 of Lua/entity.lua.

function Entity:_tick()

Inner tick function that will skip every other tick when slow_animation is set.

Declared on: line 190 of Lua/entity.lua.

function Entity:afterLoad(old, new)

Stub to be extended in subclasses, if needed.

Parameters:

Declared on: line 347 of Lua/entity.lua.

function Entity:clearDynamicInfo()

Completely clears the dynamic info.

Declared on: line 342 of Lua/entity.lua.

function Entity:eraseObject()

Stub to be extended in subclasses, if needed.

Declared on: line 361 of Lua/entity.lua.

function Entity:getDrawingLayer()

Returns the drawing layer for this particular entity. Should be overridden in derived classes. The drawing layer specifies the order in which object are drawn in a tile (the object with the smallest layer is drawn first). Litter should have layer 0, side objects to the north layer 1, side objects to the west layer 2, normal objects should have layers between 3 and 7, east side object should have layer 8 and south side objects layer 9.

Declared on: line 371 of Lua/entity.lua.

function Entity:getDynamicInfo()

Returns a table of hover info about an object.

Declared on: line 324 of Lua/entity.lua.

function Entity:getRoom()

Declared on: line 149 of Lua/entity.lua.

function Entity:getTile()

Get the map tile which the entity is on.

Declared on: line 142 of Lua/entity.lua.

function Entity:notifyNewObject(id)

Notify the entity of a new object.

Parameters:

Declared on: line 309 of Lua/entity.lua.

function Entity:notifyNewRoom(room)

Notify the entity that a new room was built.

Parameters:

Declared on: line 316 of Lua/entity.lua.

function Entity:onDestroy()

Function which is called when the entity is to be permanently removed from the world.

Declared on: line 286 of Lua/entity.lua.

function Entity:onPickUp()

Function which is called when entity is picked up

Declared on: line 298 of Lua/entity.lua.

function Entity:playAfterLoadSound()

Declared on: line 351 of Lua/entity.lua.

function Entity:playEntitySounds(name_pattern, min_silence_lengths, max_silence_lengths, num_silences)

Plays a sequence of related sounds at an entity while entity.playing_sounds_in_random_sequence = true. The silences between these sounds can either have randomly generated lengths between the min and max length parameters or they can all be a specified length by providing min and max tables with one value for the desired pause duration.

Parameters:

Declared on: line 66 of Lua/entity.lua.

function Entity:playSound(name, played_callback, played_callback_delay)

This plays a sound "at" the entity, meaning the sound will not be played if the entity is off-screen, and the volume will be quieter the further the entity is from the center of the screen. If this is not what you want then use UI:playSound instead.

Parameters:

Declared on: line 47 of Lua/entity.lua.

function Entity:resetAnimation()

Declared on: line 366 of Lua/entity.lua.

function Entity:setAnimation(animation, flags)

Set which animation is used to give the entity a visual appearance.

Until an entity is given an animation, it is invisible to the player. Note that some "animations" consist of a single frame, and hence the term animation is used both to mean things which are animated and things which are static.

Parameters:

Declared on: line 89 of Lua/entity.lua.

function Entity:setDynamicInfo(type, value)

Sets a piece of Dynamic_info. type could be 'text', 'progress' or 'dividers'

Parameters:

Declared on: line 329 of Lua/entity.lua.

function Entity:setLayer(layer, id)

Set which parts of the animation to be displayed.

Each animation is made up of 13 layers, and generally has several different options for each layer. In the animation viewer tool, multiple options can be toggled on for each layer, however here only one option may be selected per layer.

Parameters:

Declared on: line 236 of Lua/entity.lua.

function Entity:setMood(mood_name, activate)

Parameters:

Declared on: line 321 of Lua/entity.lua.

function Entity:setMoodInfo(new_mood)

Used to set a mood icon over the entity.

Parameters:

Declared on: line 269 of Lua/entity.lua.

function Entity:setPosition(x, y)

Set the pixel position of the entity within the current tile.

Parameters:

Declared on: line 157 of Lua/entity.lua.

function Entity:setSpeed(x, y)

Set the rate at which the entity pixel position changes

Parameters:

Declared on: line 166 of Lua/entity.lua.

function Entity:setTile(x, y)

Set the map tile which the entity is on.

Parameters:

Declared on: line 112 of Lua/entity.lua.

function Entity:setTilePositionSpeed(tx, ty, px, py, sx, sy)

Combined form of `setTile`, `setPosition`, and `setSpeed`

Parameters:

Declared on: line 175 of Lua/entity.lua.

function Entity:setTimer(tick_count, f)

Register a function (related to the entity) to be called at a later time.

Each `Entity` can have a single timer associated with it, and due to this limit of one, it is almost always the case that the currently active humanoid action is the only thing which calls `setTimer`. If self.slow_animation is set then all timers will be doubled as animation length will be doubled.

Parameters:

Declared on: line 250 of Lua/entity.lua.

function Entity:setWaitingForSoundEffectsToBeTurnedOn()

Declared on: line 62 of Lua/entity.lua.

function Entity:tick()

Function which is called once every tick, where a tick is the smallest unit of time in the game engine. Typically used to advance animations and similar recurring or long-duration tasks.

Declared on: line 203 of Lua/entity.lua.

function Entity:tickDay()

Function which is called at the end of each ingame day. Should be used to implement behaviours which happen regularly, but not as frequently as to need them in `tick`.

Declared on: line 303 of Lua/entity.lua.