A zone allows you to define an area that requires one or more Ability to traverse using pathfinding. Each zone contains a cost specified by the user; as a result based on that cost, the Navigation paths computed can drastically vary since the system will always choose the path of less resistance (based on cost); in other words the lower the cost the better the path.

Additionally, a zone can be used as a junction that connects one or more Map together. At Navigation query time theses junctions can be used to extend the Navigation path to other Map.

See Also

Navigation, Map, Ability

Static Variables

Name	Description
`map`	Current Map where the active Zone is maintained.
Declaration Map *map
`sector_count`	Total amount of Sector maintained by the current Zone.
Declaration unsigned char sector_count
`type`	Identity the Zone type.
Declaration unsigned char type
`uid`	Unique id to identify the Zone globally.
Declaration unsigned int uid

Variables

Name	Description
`junction`	Determine wether or not the Zone should be used as a junction that connect multiple Map togheter.
Declaration bool junction
`name`	Name to identify the current Zone within its parent Map.
Declaration char *name
`ability_mask`	Bit mask created from Ability caps that specifies the required Ability to pass the Zone.
Declaration int ability_mask
`cost`	Value that represent the cost of the current Zone and subsequent Sector.
Declaration unsigned char cost
`color`	A color to visually identify the Zone and Sector inside the editor viewport.
Declaration vec4 color

Functions

Name	Description
`AddSector`	Add a new Sector to the active Zone.
Declaration unsigned char AddSector( void ) Return Value Index of the new Sector.
`GetSectorAt`	Function that return the reference of a Sector pointed by index.
Declaration Sector GetSectorAt( unsigned char index ) Parameters* `index`: Index of the Sector to retrieve. Return Value `nil` if the index provided is out of bounds; else return the reference of the Sector pointed by index.
`GetSectorAtLocation`	Return the reference of a Sector that is located at an arbitrary point in space.
Declaration Sector GetSectorAtLocation( const vec3 location ) Parameters* `location`: The position to test in 3d space. Return Value `nil` if no Sector is located at the position received in parameter; else return the reference to the Sector.
`GetSectorIndex`	Function that retrieve the internal index of an existing Sector.
Declaration int GetSectorIndex( const Sector sector ) Parameters* `sector`: A valid reference to a Sector associated to the current Zone. Return Value `-1` if the reference received in parameter is invalid; else return the internal index of the Sector.
`RemoveSector`	Remove a Sector from the current Zone.
Declaration bool RemoveSector( Sector sector ) Parameters* `sector`: Reference to the Sector to remove. Return Value `true` if the Sector was remove successfully; else return `false` if the reference reveived by the function is invalid.
`RemoveSectorAt`	Remove a Sector from the active Zone using its internal index as key.
Declaration bool RemoveSectorAt( int index ) Parameters `index`: Index of the Sector to remove. Return Value `false` if the index is invalid; `true` if the Sector is removed successfully.
`BuildSector`	Function that build an existing Sector.
Declaration bool BuildSector( unsigned char index ) Parameters `index`: Index of the Sector to build. Return Value `true` if the operation is successfull; `false` if the index provided does not exists.
`AddPoint`	Add a control point to a specific Sector.
Declaration bool AddPoint( unsigned char sector_index, const vec3 point ) Parameters `index`: Index of the Sector to use. `point`: Position of the control point to add. Return Value `true` if the point is appended successfully; `false` if the Sector index is invalid.
`ClearPoints`	Clear the controls points associated to a specific Sector.
Declaration bool ClearPoints( unsigned char sector_index ) Parameters `sector_index`: Index of the Sector to clear the points. Return Value `true` if the point cache have been cleared; else return `false` if the sector index does not exists.
`CreateOutline`	Create the outline of a Sector based on the control points associated to it.
Declaration bool CreateOutline( unsigned char sector_index ) Parameters `sector_index`: Index of the Sector to clear the points. Return Value `true` if the outline is built; `false` if not enough control points were provided or if the Sector index is invalid.
`UpdateOutline`	Update the height of an existing Sector outline.
Declaration bool UpdateOutline( unsigned char sector_index, float height_offset ) Parameters `sector_index`: Index of the Sector to update. `height_offset`: Specify the new height offset to use for the Sector outline. Return Value `true` if updated; `false` if the Sector index does not correspond to any Sector maintained by the active Zone; or no outline was previously built.

TileHeader

Header data associated with each Tile representing their location on the Map.