TerrainComponent - acrimi/Raven GitHub Wiki

TerrainComponent allows an entity to present a specified terrain to other entities similar to a tile. Any terrain specified will be honored by TerrainSystem and AIPatrolSystem, and should be honored by any additional terrain-aware systems for consistency. It is generally assumed the entity will function as a ground level entity, i.e. it will have no z position or a z position of 0.

Configuration

When used inside the components block, the initial state of the component can be configured with the following parameters:

Key	Type	Description
terrain	string	The name of the terrain that this entity should present to systems

Example:

"TerrainComponent": {
  "terrain": "ice"
}

Properties

The following properties are readable by property accessors (eg render state and persistence definitions):

Key	Type	Description
terrain	string	The name of the terrain for this entity