Class EncounterAudioState

java.lang.Object

com.hypixel.hytale.builtin.encountermanager.EncounterAudioState

All Implemented Interfaces:

EncounterMemberConsumer, Component<EntityStore>, Cloneable

public class EncounterAudioState
extends Object
implements EncounterMemberConsumer

Per-encounter runtime audio state: the forced music and audio-state axis values the encounter currently wants its players to hear. The players it applies to are the encounter's EncounterMembers.

Field Summary

Fields inherited from interface Component

EMPTY_ARRAY

Constructor Summary

Constructors

Constructor	Description
EncounterAudioState()

Method Summary

Modifier and Type	Method	Description
void	applyToPlayer(ComponentAccessor<EntityStore> accessor, Ref<EntityStore> encounterRef, Ref<EntityStore> playerRef)	Pushes the desired music + audio-state values onto a player.
Component<EntityStore>	clone()
static ComponentType<EntityStore, EncounterAudioState>	getComponentType()
int	getDesiredMusicIndex()
void	resetDesiredToNeutral()
void	revertPlayer(ComponentAccessor<EntityStore> accessor, Ref<EntityStore> encounterRef, Ref<EntityStore> playerRef)	Returns a player to normal audio: clears forced music and resets every axis this encounter manages back to its declared default.
void	setDesiredAxisValue(int axisIndex, int valueIndex, StateTransition transition)
void	setDesiredMusicIndex(int index)

Methods inherited from class Object

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

Methods inherited from interface Component

cloneSerializable

Methods inherited from interface EncounterMemberConsumer

beginTick, forgetPlayer

Constructor Details

EncounterAudioState

public EncounterAudioState()

Method Details

getComponentType

@Nonnull
public static ComponentType<EntityStore, EncounterAudioState> getComponentType()

setDesiredMusicIndex

public void setDesiredMusicIndex(int index)

getDesiredMusicIndex

public int getDesiredMusicIndex()

setDesiredAxisValue

public void setDesiredAxisValue(int axisIndex,
 int valueIndex,
 @Nullable
 StateTransition transition)

resetDesiredToNeutral

public void resetDesiredToNeutral()

applyToPlayer

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

Pushes the desired music + audio-state values onto a player.

Specified by:

applyToPlayer in interface EncounterMemberConsumer

revertPlayer

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

Returns a player to normal audio: clears forced music and resets every axis this encounter manages back to its declared default.

Specified by:

revertPlayer in interface EncounterMemberConsumer

clone

@Nonnull
public Component<EntityStore> clone()

Specified by:

clone in interface Component<EntityStore>

Returns:

a clone instance of the original component instance.