Package net.citizensnpcs.api.ai.flocking

Class SeparationBehavior

java.lang.Object

net.citizensnpcs.api.ai.flocking.SeparationBehavior

All Implemented Interfaces:

FlockBehavior

public class SeparationBehavior
extends Object
implements FlockBehavior

Implements separation flocking with a particular weight i.e. steering a flock of NPCs away from each other.

See Also:

• https://en.wikipedia.org/wiki/Flocking_(behavior)

Constructor Summary

Constructors

Constructor	Description
SeparationBehavior(double weight)
SeparationBehavior(double weight, double separation)

Method Summary

Modifier and Type	Method	Description
Vector	getVector(NPC npc, Collection<NPC> nearby)	Returns the displacement vector to be combined with other FlockBehavior vectors by a Flocker.

Methods inherited from class java.lang.Object

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

Constructor Details

SeparationBehavior

public SeparationBehavior(double weight)

SeparationBehavior

public SeparationBehavior(double weight,
 double separation)

Method Details

getVector

public Vector getVector(NPC npc,
 Collection<NPC> nearby)

Description copied from interface: FlockBehavior

Returns the displacement vector to be combined with other FlockBehavior vectors by a Flocker.

Specified by:

getVector in interface FlockBehavior

Parameters:

nearby - the set of NPCs to consider for flocking purposes

Returns:

the displacement Vector