RPG in a Box
Official Documentation

User Tools

Site Tools

Trace:
tile

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
tile [2021/11/05 19:52] – justintile [2025/03/11 20:23] (current) – justin
Line 11: Line 11:
 |<tile>.coord|[[Coordinate]] of the tile.| |<tile>.coord|[[Coordinate]] of the tile.|
 |<tile>.direction|[[Cardinal direction]] (NORTH, SOUTH, WEST, EAST) in which the tile is rotated. The default direction of an [[entity]] is SOUTH.| |<tile>.direction|[[Cardinal direction]] (NORTH, SOUTH, WEST, EAST) in which the tile is rotated. The default direction of an [[entity]] is SOUTH.|
 +|<tile>.objects|An [[array]] of [[object|objects]] currently occupying the tile, or null if there are none.|
 |<tile>.characters|An [[array]] of [[character|characters]] currently occupying the tile, or null if there are none.| |<tile>.characters|An [[array]] of [[character|characters]] currently occupying the tile, or null if there are none.|
 +|<tile>.items|An [[array]] of [[item|items]] currently occupying the tile, or null if there are none (e.g. those dropped out of the player's [[inventory]] or placed via the [[Add Item To Tile]] function).|
 |<tile>.groups|An [[array]] of [[groups]] to which the tile is assigned. The [[array]] will be empty if the tile is not assigned to any [[groups]].| |<tile>.groups|An [[array]] of [[groups]] to which the tile is assigned. The [[array]] will be empty if the tile is not assigned to any [[groups]].|
 |<tile>.tags|An [[array]] of tags (as [[string|strings]]) for the tile, as set in the [[Voxel Editor]] from the [[Model Properties]] panel.| |<tile>.tags|An [[array]] of tags (as [[string|strings]]) for the tile, as set in the [[Voxel Editor]] from the [[Model Properties]] panel.|
 |<tile>.interact_cursor|Interaction cursor for the tile, as set in the [[Map Editor]] from the [[Entity Properties]] panel. This can be used to either retrieve or change the interaction cursor for the tile. Valid values include "default", "walk", "interact", "speak", "attack", or any custom cursor defined in your [[game configuration]].| |<tile>.interact_cursor|Interaction cursor for the tile, as set in the [[Map Editor]] from the [[Entity Properties]] panel. This can be used to either retrieve or change the interaction cursor for the tile. Valid values include "default", "walk", "interact", "speak", "attack", or any custom cursor defined in your [[game configuration]].|
 |<tile>.property["x"]|Custom property stored on the tile, where "x" is a [[string]] containing the name of the property. This can be used to either retrieve or change the property's value.| |<tile>.property["x"]|Custom property stored on the tile, where "x" is a [[string]] containing the name of the property. This can be used to either retrieve or change the property's value.|
 +|<tile>.properties|All custom properties defined for the tile. As it's a [[codex]], its keys can be iterated using a “for” loop (refer to the [[codex]] documentation for an example).|
 |<tile>.model|Name of the tile's model (e.g. "grass").| |<tile>.model|Name of the tile's model (e.g. "grass").|
-|<tile>.frame|Current [[animation]] frame (as a [[number]]). This can be used to either retrieve or change the model's current frame. If an [[animation]] is playing, it will be stopped.|+|<tile>.frame|Current [[animation]] frame (as a [[number]], with the first frame being 1). This can be used to either retrieve or change the model's current frame. If this property is changed and an [[animation]] is playing, the [[animation]] will first be stopped.| 
 +|<tile>.animation|Name of the [[animation]] currently playing for this tile (as a [[string]]). Value will be null if no [[animation]] is playing.|
 |<tile>.animations|An [[array]] of [[animation]] names defined for this tile. The names will be [[string]] values.| |<tile>.animations|An [[array]] of [[animation]] names defined for this tile. The names will be [[string]] values.|
 +|<tile>.attach_points|An [[array]] of [[attach_points|attach point]] names defined for this tile (across all [[animation]] frames). The names will be [[string]] values. The [[array]] will be empty if no [[attach points]] are defined.|
 +|<tile>.attachment["x"]|[[Object]] attached to the tile, where "x" is the [[attach_points|attach point]] ID.|
 +|<tile>.effect["x"]|[[Effect]] attached to the tile, where "x" is the [[attach_points|attach point]] ID.|
 +|<tile>.textures|An [[array]] of texture names defined for this tile. The names will be [[string]] values.|
 |<tile>.terrain_type|[[terrain_types|Terrain type]] assigned to the tile (as a [[string]], or null if none is assigned).| |<tile>.terrain_type|[[terrain_types|Terrain type]] assigned to the tile (as a [[string]], or null if none is assigned).|
-|<tile>.attach_points|An [[array]] of [[attach_points|attach point]] names defined for this tile (across all [[animation]] frames). The names will be [[string]] values. The [[array]] will be empty is no [[attach points]] are defined.| +|<tile>.waypoints|An [[array]] of waypoint names defined for this tile. This property will be null if the tile is not currently configured as a moving [[platforms|platform]].| 
-|<tile>.waypoints|An [[array]] of waypoint names defined for this tile. This property will be null if the tile isn't currently configured as a moving [[platforms|platform]].|+|<tile>.north_tile|[[Tile]] to the north of this tile (if one is connected via navigation, otherwise null is returned).| 
 +|<tile>.south_tile|[[Tile]] to the south of this tile (if one is connected via navigation, otherwise null is returned).| 
 +|<tile>.west_tile|[[Tile]] to the west of this tile (if one is connected via navigation, otherwise null is returned).| 
 +|<tile>.east_tile|[[Tile]] to the east of this tile (if one is connected via navigation, otherwise null is returned).|
  
 ~~NOTOC~~ ~~NOTOC~~
tile.1636167137.txt.gz · Last modified: 2021/11/05 19:52 by justin

Page Tools

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki