Interface EncounterMemberConsumer

All Superinterfaces:

Cloneable, Component<EntityStore>

All Known Implementing Classes:

EncounterAudioState, EncounterBossBarState, EncounterWeatherState

public interface EncounterMemberConsumer
extends Component<EntityStore>

A per-player effect an encounter drives over its EncounterMembers.

Both methods run every tick for every member, so an implementation must be cheap and idempotent.

Field Summary

Fields inherited from interface Component

EMPTY_ARRAY

Method Summary

Modifier and Type	Method	Description
void	applyToPlayer(ComponentAccessor<EntityStore> accessor, Ref<EntityStore> encounterRef, Ref<EntityStore> playerRef)
default void	beginTick(ComponentAccessor<EntityStore> accessor)	Called once per tick before any member is served, for state that has to be resolved from the world.
default void	forgetPlayer(Ref<EntityStore> playerRef)	Called instead of revertPlayer(ComponentAccessor, Ref, Ref) for a member whose ref died, such as a player who disconnected.
void	revertPlayer(ComponentAccessor<EntityStore> accessor, Ref<EntityStore> encounterRef, Ref<EntityStore> playerRef)

Methods inherited from interface Component

clone, cloneSerializable

Method Details

beginTick

default void beginTick(@Nonnull
 ComponentAccessor<EntityStore> accessor)

Called once per tick before any member is served, for state that has to be resolved from the world.

applyToPlayer

void applyToPlayer(@Nonnull
 ComponentAccessor<EntityStore> accessor,
 @Nonnull
 Ref<EntityStore> encounterRef,
 @Nonnull
 Ref<EntityStore> playerRef)

revertPlayer

void revertPlayer(@Nonnull
 ComponentAccessor<EntityStore> accessor,
 @Nonnull
 Ref<EntityStore> encounterRef,
 @Nonnull
 Ref<EntityStore> playerRef)

forgetPlayer

default void forgetPlayer(@Nonnull
 Ref<EntityStore> playerRef)

Called instead of revertPlayer(ComponentAccessor, Ref, Ref) for a member whose ref died, such as a player who disconnected. Without it their state is retained for the lifetime of the encounter.