Interface ISensorEntityCollector

All Superinterfaces:

RoleStateChange

All Known Implementing Classes:

CombatTargetCollector, EncounterMemberCollector

public interface ISensorEntityCollector
extends RoleStateChange

An interface defining a collector component used by SensorEntityBase. A collector is called for every entity checked by the sensor and can be used to process matched or non-matched entities for various purposes (e.g. keeping a memory of all potential matched targets, not just the one selected).

Field Summary

Fields

Modifier and Type	Field	Description
static final ISensorEntityCollector	DEFAULT

Method Summary

Modifier and Type	Method	Description
void	cleanup()
void	collectMatching(Ref<EntityStore> ref, Ref<EntityStore> targetRef, ComponentAccessor<EntityStore> componentAccessor)
void	collectNonMatching(Ref<EntityStore> targetRef, ComponentAccessor<EntityStore> componentAccessor)
void	init(Ref<EntityStore> ref, ExecutionSupport executionSupport, ComponentAccessor<EntityStore> componentAccessor)
boolean	terminateOnFirstMatch()

Methods inherited from interface RoleStateChange

loaded, motionControllerChanged, registerWithSupport, removed, spawned, teleported, unloaded

Field Details

DEFAULT

static final ISensorEntityCollector DEFAULT

Method Details

init

void init(@Nonnull
 Ref<EntityStore> ref,
 @Nonnull
 ExecutionSupport executionSupport,
 @Nonnull
 ComponentAccessor<EntityStore> componentAccessor)

collectMatching

void collectMatching(@Nonnull
 Ref<EntityStore> ref,
 @Nonnull
 Ref<EntityStore> targetRef,
 @Nonnull
 ComponentAccessor<EntityStore> componentAccessor)

collectNonMatching

void collectNonMatching(@Nonnull
 Ref<EntityStore> targetRef,
 @Nonnull
 ComponentAccessor<EntityStore> componentAccessor)

terminateOnFirstMatch

boolean terminateOnFirstMatch()

cleanup

void cleanup()