Package me.nabdev.pathfinding.modifiers

Class ZoneModifier

java.lang.Object

me.nabdev.pathfinding.modifiers.ObstacleModifier

me.nabdev.pathfinding.modifiers.ZoneModifier

public class ZoneModifier
extends ObstacleModifier

Marks the obstacle as a zone. This means it will not invalidate obstacle points and start points will not snap outside of it.

Nested Class Summary

Nested classes/interfaces inherited from class me.nabdev.pathfinding.modifiers.ObstacleModifier

ObstacleModifier.MatchPhase, ObstacleModifier.ObstacleModifierTypes

Constructor Summary

Constructors

Constructor	Description
ZoneModifier()

Method Summary

Modifier and Type	Method	Description
ObstacleModifier.ObstacleModifierTypes	getType()	Get the modifier type of this modifier
boolean	isActive()	Whether or not the obstacle is active at this time.
boolean	requiredForActive()	Whether or not this modifier MUST be active to have the obstacle active.

Methods inherited from class me.nabdev.pathfinding.modifiers.ObstacleModifier

getCurrentPhase, getModifier

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ZoneModifier

public ZoneModifier()

Method Details

isActive

public boolean isActive()

Description copied from class: ObstacleModifier

Whether or not the obstacle is active at this time.

Specified by:

isActive in class ObstacleModifier

Returns:

true if the obstacle is currently active, false if not

requiredForActive

public boolean requiredForActive()

Description copied from class: ObstacleModifier

Whether or not this modifier MUST be active to have the obstacle active. If true, will use the AND operator with other modifiers, if false, uses OR.

Specified by:

requiredForActive in class ObstacleModifier

Returns:

True if required to keep the obstacle active, false if not required.

getType

public ObstacleModifier.ObstacleModifierTypes getType()

Description copied from class: ObstacleModifier

Get the modifier type of this modifier

Specified by:

getType in class ObstacleModifier

Returns:

the modifier type of this modifier