Package net.citizensnpcs.api.ai.flocking

Class Flocker

java.lang.Object

net.citizensnpcs.api.ai.flocking.Flocker

All Implemented Interfaces:

Runnable

public class Flocker
extends Object
implements Runnable

Implements a simple flocking controller as a Runnable. This should be run every tick, for example as part of an overridden Trait.run().

See Also:

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

Field Summary

Fields

Modifier and Type	Field	Description
static double	HIGH_INFLUENCE	Sample weight indicating high amount of influence from flocking.
static double	LOW_INFLUENCE	Sample weight indicating low amount of influence from flocking.

Constructor Summary

Constructors

Constructor	Description
Flocker(NPC npc, NPCFlock flock, FlockBehavior... behaviors)

Method Summary

Modifier and Type	Method	Description
void	run()
void	setMaxForce(double maxForce)	Sets the maximum length of the resultant flocking vector.

Methods inherited from class java.lang.Object

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

Field Details

HIGH_INFLUENCE

public static double HIGH_INFLUENCE

Sample weight indicating high amount of influence from flocking.

LOW_INFLUENCE

public static double LOW_INFLUENCE

Sample weight indicating low amount of influence from flocking.

Constructor Details

Flocker

public Flocker(NPC npc,
 NPCFlock flock,
 FlockBehavior... behaviors)

Method Details

run

public void run()

Specified by:

run in interface Runnable

setMaxForce

public void setMaxForce(double maxForce)

Sets the maximum length of the resultant flocking vector.

Parameters:

maxForce - the new maximum length