BaseGridMap Interface Reference

Represent a grid map. More...

Inheritance diagram for BaseGridMap:

Public Member Functions
void	BaseGridMap (float cellSize=100.0)
proto external void	UpdatePosition (notnull IEntity entity, vector newPosition)
	Force update the position of an entity.
proto external void	Remove (IEntity entity)
	Remove the entity from the GridMap.
proto external void	Update ()
	Update the grid map entities positions. Update the position of dynamic entities and static entities if set up.
proto external int	FindEntitiesInRange (out notnull array< IEntity > entities, vector origin, float range, int mask=0)
	Returns registered entities in given categories within a given range with a specific mask.
proto external void	SetUpdateOfStaticEntities (bool state)
	Set if the static entities should still be checked during the update.
proto external void	SetNmbOfStaticEntitiesUpdated (int nmb)
	Set the number of static entities updated per update.

Detailed Description

Represent a grid map.

Mask in all methods should be a bit mask. The value 0 means no check of the mask.

Constructor & Destructor Documentation

BaseGridMap()

void BaseGridMap.BaseGridMap

(

float

cellSize = 100::0

)

Member Function Documentation

FindEntitiesInRange()

proto external int BaseGridMap.FindEntitiesInRange	(	out notnull array< IEntity >	entities,
		vector	origin,
		float	range,
		int	mask = 0
	)

Returns registered entities in given categories within a given range with a specific mask.

Remove()

proto external void BaseGridMap.Remove

(

IEntity

entity

)

Remove the entity from the GridMap.

SetNmbOfStaticEntitiesUpdated()

proto external void BaseGridMap.SetNmbOfStaticEntitiesUpdated

(

int

nmb

)

Set the number of static entities updated per update.

SetUpdateOfStaticEntities()

proto external void BaseGridMap.SetUpdateOfStaticEntities

(

bool

state

)

Set if the static entities should still be checked during the update.

Update()

proto external void BaseGridMap.Update

(

)

Update the grid map entities positions. Update the position of dynamic entities and static entities if set up.

UpdatePosition()

proto external void BaseGridMap.UpdatePosition	(	notnull IEntity	entity,
		vector	newPosition
	)

Force update the position of an entity.

---

The documentation for this interface was generated from the following file:

• Game/generated/GridMap/BaseGridMap.c