iGround::positionIsValid()

Description

Returns whether or not the specified position is a valid position on this ground.

Syntax

bool positionIsValid(const cPosition& p) const;

Parameters

Return Value

Remarks

All positions set by PathEngine (with positionFor3DPoint(), for example) are guaranteed to be valid or explicitly marked as invalid by having cell set to -1.
So most of the time this method is not required.
It can be useful, however, as a safety check when restoring positions from persistent store, or when working with multiple ground objects simultaneously.

See Also

C# Mapping

bool positionIsValid(PathEngine.Position p);

Java Mapping

boolean positionIsValid(Position p);