Class AmbienceFX

java.lang.Object

com.hypixel.hytale.protocol.AmbienceFX

public class AmbienceFX
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
AmbienceFXAmbientBed	ambientBed
int	audioCategoryIndex
int[]	blockedAmbienceFxIndices
AmbienceFXConditions	conditions
static final int	FIXED_BLOCK_SIZE
String	id
static final int	MAX_SIZE
int	musicContainerIndex
static final int	NULLABLE_BIT_FIELD_SIZE
int	priority
AmbienceStateWrite[]	setStates
AmbienceFXSoundEffect	soundEffect
AmbienceFXSound[]	sounds
static final int	VARIABLE_BLOCK_START
static final int	VARIABLE_FIELD_COUNT

Constructor Summary

Constructors

Constructor	Description
AmbienceFX()
AmbienceFX(AmbienceFX other)
AmbienceFX(String id, AmbienceFXConditions conditions, AmbienceFXSound[] sounds, int musicContainerIndex, AmbienceFXAmbientBed ambientBed, AmbienceFXSoundEffect soundEffect, int priority, int[] blockedAmbienceFxIndices, int audioCategoryIndex, AmbienceStateWrite[] setStates)

Method Summary

Modifier and Type	Method	Description
AmbienceFX	clone()
int	computeSize()
boolean	equals(Object obj)
static AmbienceFXAmbientBed	getAmbientBed(MemorySegment mem)
static AmbienceFXAmbientBed	getAmbientBed(MemorySegment mem, int offset)
static int	getAudioCategoryIndex(MemorySegment mem)
static int	getAudioCategoryIndex(MemorySegment mem, int offset)
static int[]	getBlockedAmbienceFxIndices(MemorySegment mem)
static int[]	getBlockedAmbienceFxIndices(MemorySegment mem, int offset)
static AmbienceFXConditions	getConditions(MemorySegment mem)
static AmbienceFXConditions	getConditions(MemorySegment mem, int offset)
static String	getId(MemorySegment mem)
static String	getId(MemorySegment mem, int offset)
static int	getMusicContainerIndex(MemorySegment mem)
static int	getMusicContainerIndex(MemorySegment mem, int offset)
static int	getPriority(MemorySegment mem)
static int	getPriority(MemorySegment mem, int offset)
static AmbienceStateWrite[]	getSetStates(MemorySegment mem)
static AmbienceStateWrite[]	getSetStates(MemorySegment mem, int offset)
static AmbienceFXSoundEffect	getSoundEffect(MemorySegment mem)
static AmbienceFXSoundEffect	getSoundEffect(MemorySegment mem, int offset)
static AmbienceFXSound[]	getSounds(MemorySegment mem)
static AmbienceFXSound[]	getSounds(MemorySegment mem, int offset)
static boolean	hasAmbientBed(MemorySegment mem, int offset)
static boolean	hasBlockedAmbienceFxIndices(MemorySegment mem, int offset)
static boolean	hasConditions(MemorySegment mem, int offset)
int	hashCode()
static boolean	hasId(MemorySegment mem, int offset)
static boolean	hasSetStates(MemorySegment mem, int offset)
static boolean	hasSoundEffect(MemorySegment mem, int offset)
static boolean	hasSounds(MemorySegment mem, int offset)
static void	requireBounds(MemorySegment mem, int offset)	Checks that the fixed block fits.
int	serialize(MemorySegment mem, int offset)
static AmbienceFX	toObject(MemorySegment mem)
static AmbienceFX	toObject(MemorySegment mem, int offset)
static AmbienceFX	toObject(MemorySegment mem, int offset, ReadCursor cursor)	Decodes one AmbienceFX and reports the end of its encoding through the cursor.

Methods inherited from class Object

getClass, notify, notifyAll, toString, wait, wait, wait

Field Details

NULLABLE_BIT_FIELD_SIZE

public static final int NULLABLE_BIT_FIELD_SIZE

See Also:

• Constant Field Values

FIXED_BLOCK_SIZE

public static final int FIXED_BLOCK_SIZE

See Also:

• Constant Field Values

VARIABLE_FIELD_COUNT

public static final int VARIABLE_FIELD_COUNT

See Also:

• Constant Field Values

VARIABLE_BLOCK_START

public static final int VARIABLE_BLOCK_START

See Also:

• Constant Field Values

MAX_SIZE

public static final int MAX_SIZE

See Also:

• Constant Field Values

id

@Nullable
public String id

conditions

@Nullable
public AmbienceFXConditions conditions

sounds

@Nullable
public AmbienceFXSound[] sounds

musicContainerIndex

public int musicContainerIndex

ambientBed

@Nullable
public AmbienceFXAmbientBed ambientBed

soundEffect

@Nullable
public AmbienceFXSoundEffect soundEffect

priority

public int priority

blockedAmbienceFxIndices

@Nullable
public int[] blockedAmbienceFxIndices

audioCategoryIndex

public int audioCategoryIndex

setStates

@Nullable
public AmbienceStateWrite[] setStates

Constructor Details

AmbienceFX

public AmbienceFX()

AmbienceFX

public AmbienceFX(@Nullable
 String id,
 @Nullable
 AmbienceFXConditions conditions,
 @Nullable
 AmbienceFXSound[] sounds,
 int musicContainerIndex,
 @Nullable
 AmbienceFXAmbientBed ambientBed,
 @Nullable
 AmbienceFXSoundEffect soundEffect,
 int priority,
 @Nullable
 int[] blockedAmbienceFxIndices,
 int audioCategoryIndex,
 @Nullable
 AmbienceStateWrite[] setStates)

AmbienceFX

public AmbienceFX(@Nonnull
 AmbienceFX other)

Method Details

requireBounds

public static void requireBounds(MemorySegment mem,
 int offset)

Checks that the fixed block fits. The per-field getters read without their own bound check, so call this once before reading fields out of an untrusted segment.

getId

@Nullable
public static String getId(MemorySegment mem)

getId

@Nullable
public static String getId(MemorySegment mem,
 int offset)

getConditions

@Nullable
public static AmbienceFXConditions getConditions(MemorySegment mem)

getConditions

@Nullable
public static AmbienceFXConditions getConditions(MemorySegment mem,
 int offset)

getSounds

@Nullable
public static AmbienceFXSound[] getSounds(MemorySegment mem)

getSounds

@Nullable
public static AmbienceFXSound[] getSounds(MemorySegment mem,
 int offset)

getMusicContainerIndex

public static int getMusicContainerIndex(MemorySegment mem)

getMusicContainerIndex

public static int getMusicContainerIndex(MemorySegment mem,
 int offset)

getAmbientBed

@Nullable
public static AmbienceFXAmbientBed getAmbientBed(MemorySegment mem)

getAmbientBed

@Nullable
public static AmbienceFXAmbientBed getAmbientBed(MemorySegment mem,
 int offset)

getSoundEffect

@Nullable
public static AmbienceFXSoundEffect getSoundEffect(MemorySegment mem)

getSoundEffect

@Nullable
public static AmbienceFXSoundEffect getSoundEffect(MemorySegment mem,
 int offset)

getPriority

public static int getPriority(MemorySegment mem)

getPriority

public static int getPriority(MemorySegment mem,
 int offset)

getBlockedAmbienceFxIndices

@Nullable
public static int[] getBlockedAmbienceFxIndices(MemorySegment mem)

getBlockedAmbienceFxIndices

@Nullable
public static int[] getBlockedAmbienceFxIndices(MemorySegment mem,
 int offset)

getAudioCategoryIndex

public static int getAudioCategoryIndex(MemorySegment mem)

getAudioCategoryIndex

public static int getAudioCategoryIndex(MemorySegment mem,
 int offset)

getSetStates

@Nullable
public static AmbienceStateWrite[] getSetStates(MemorySegment mem)

getSetStates

@Nullable
public static AmbienceStateWrite[] getSetStates(MemorySegment mem,
 int offset)

hasSoundEffect

public static boolean hasSoundEffect(MemorySegment mem,
 int offset)

hasId

public static boolean hasId(MemorySegment mem,
 int offset)

hasConditions

public static boolean hasConditions(MemorySegment mem,
 int offset)

hasSounds

public static boolean hasSounds(MemorySegment mem,
 int offset)

hasAmbientBed

public static boolean hasAmbientBed(MemorySegment mem,
 int offset)

hasBlockedAmbienceFxIndices

public static boolean hasBlockedAmbienceFxIndices(MemorySegment mem,
 int offset)

hasSetStates

public static boolean hasSetStates(MemorySegment mem,
 int offset)

toObject

public static AmbienceFX toObject(MemorySegment mem)

toObject

public static AmbienceFX toObject(MemorySegment mem,
 int offset)

toObject

public static AmbienceFX toObject(MemorySegment mem,
 int offset,
 @Nullable
 ReadCursor cursor)

Decodes one AmbienceFX and reports the end of its encoding through the cursor. The variable block is decoded in field order against a running position, and each offset slot must name that position, so the fields decoded are the bytes walked.

serialize

public int serialize(@Nonnull
 MemorySegment mem,
 int offset)

computeSize

public int computeSize()

clone

public AmbienceFX clone()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object