Module CorsixTH.CorsixTH.Lua.entities.object

An `Entity` which occupies at least a single map tile and does not move.

Functions

Object.slaveMixinClass (class_method_table) Add methods to a class for creating and controlling a slave object
Object:getRenderAttachTile () Get the primary tile which the object is attached to for rendering For objects which attach to a single tile for rendering, this method will return the X and Y Lua world coordinates of that tile.
Object:initOrientation (direction) Initializes the footprint, finds out what to draw and checks for split animations.
Object:updateDynamicInfo (only_update) Updates the object's dynamic info


Functions

Object.slaveMixinClass (class_method_table)
Add methods to a class for creating and controlling a slave object

Parameters:

  • class_method_table
Object:getRenderAttachTile ()
Get the primary tile which the object is attached to for rendering For objects which attach to a single tile for rendering, this method will return the X and Y Lua world coordinates of that tile. For objects which split their rendering over multiple tiles, one of them is arbitrarily designated as the primary tile, and its coordinates are returned.
Object:initOrientation (direction)
Initializes the footprint, finds out what to draw and checks for split animations.

Parameters:

  • direction The orientation in which the object is facing.
Object:updateDynamicInfo (only_update)
Updates the object's dynamic info

Parameters:

  • only_update (bool) If true, do not increase times_used.
generated by LDoc TESTING Last updated 2015-01-01 12:00:00