Interface IObstacle
The obstacle represents an area within the environment with a specific collision handling.
Assembly: Mars.Components.dll
Syntax
public interface IObstacle : IEntity, IModelObject
Methods
HandleCollision(ICharacter)
Handles a collision with given character and provides a collision kind for positionable resolution.
Declaration
CollisionKind? HandleCollision(ICharacter character)
Parameters
| Type |
Name |
Description |
| ICharacter |
character |
That collides into this obstacle. |
Returns
| Type |
Description |
| System.Nullable<CollisionKind> |
The collision kind that represents the continuing action; langword_csharp_null if no collision
handle is defined. |
HandleExploration(ICharacter)
Handles the visibility check for this obstacle.
Declaration
VisibilityKind? HandleExploration(ICharacter explorer)
Parameters
| Type |
Name |
Description |
| ICharacter |
explorer |
That requests the exploration. |
Returns
| Type |
Description |
| System.Nullable<VisibilityKind> |
The visibility kind of the obstacle, which means if the character may see/explore through this
obstacle or not; langword_csharp_null if no visibility handle is defined. |
IsRoutable(ICharacter)
Defines if the obstacle can be passed by given character in principle.
Declaration
bool IsRoutable(ICharacter character)
Parameters
| Type |
Name |
Description |
| ICharacter |
character |
For that the check is performed. |
Returns
| Type |
Description |
| System.Boolean |
langword_csharp_true if given character can generally pass the obstacle;
langword_csharp_false if given character should avoid the obstacle in its route search. |