Package net.ixdarklord.coolcatcanvas.internal.sound

Record Class SoundFilterPayload

java.lang.Object

java.lang.Record

net.ixdarklord.coolcatcanvas.internal.sound.SoundFilterPayload

All Implemented Interfaces:

CustomPacketPayload

public record SoundFilterPayload(net.minecraft.resources.ResourceLocation id, boolean clear, float gain, float gainHF, float distortion, float reverb, int fadeTicks)
extends Record
implements CustomPacketPayload

The server setting a named sound filter on a client (gain, highs, distortion, reverb), or clearing it (clear, the filter's parts then unused), over fadeTicks.

Nested Class Summary

Nested classes/interfaces inherited from interface net.ixdarklord.coolcatcore.api.network.CustomPacketPayload

CustomPacketPayload.Type<T extends CustomPacketPayload>, CustomPacketPayload.TypeAndCodec<B extends io.netty.buffer.ByteBuf,T extends CustomPacketPayload>

Field Summary

Fields

Modifier and Type	Field	Description
static final StreamCodec<net.minecraft.network.FriendlyByteBuf,SoundFilterPayload>	STREAM_CODEC
static final CustomPacketPayload.Type<SoundFilterPayload>	TYPE

Constructor Summary

Constructors

Constructor	Description
SoundFilterPayload(net.minecraft.resources.ResourceLocation id, boolean clear, float gain, float gainHF, float distortion, float reverb, int fadeTicks)	Creates an instance of a SoundFilterPayload record class.

Method Summary

Modifier and Type	Method	Description
boolean	clear()	Returns the value of the clear record component.
float	distortion()	Returns the value of the distortion record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
int	fadeTicks()	Returns the value of the fadeTicks record component.
float	gain()	Returns the value of the gain record component.
float	gainHF()	Returns the value of the gainHF record component.
final int	hashCode()	Returns a hash code value for this object.
net.minecraft.resources.ResourceLocation	id()	Returns the value of the id record component.
float	reverb()	Returns the value of the reverb record component.
final String	toString()	Returns a string representation of this record class.
CustomPacketPayload.Type<? extends CustomPacketPayload>	type()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

TYPE

public static final CustomPacketPayload.Type<SoundFilterPayload> TYPE

STREAM_CODEC

public static final StreamCodec<net.minecraft.network.FriendlyByteBuf,SoundFilterPayload> STREAM_CODEC

Constructor Details

SoundFilterPayload

public SoundFilterPayload(net.minecraft.resources.ResourceLocation id,
 boolean clear,
 float gain,
 float gainHF,
 float distortion,
 float reverb,
 int fadeTicks)

Creates an instance of a SoundFilterPayload record class.

Parameters:

id - the value for the id record component

clear - the value for the clear record component

gain - the value for the gain record component

gainHF - the value for the gainHF record component

distortion - the value for the distortion record component

reverb - the value for the reverb record component

fadeTicks - the value for the fadeTicks record component

Method Details

type

public CustomPacketPayload.Type<? extends CustomPacketPayload> type()

Specified by:

type in interface CustomPacketPayload

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

id

public net.minecraft.resources.ResourceLocation id()

Returns the value of the id record component.

Returns:

the value of the id record component

clear

public boolean clear()

Returns the value of the clear record component.

Returns:

the value of the clear record component

gain

public float gain()

Returns the value of the gain record component.

Returns:

the value of the gain record component

gainHF

public float gainHF()

Returns the value of the gainHF record component.

Returns:

the value of the gainHF record component

distortion

public float distortion()

Returns the value of the distortion record component.

Returns:

the value of the distortion record component

reverb

public float reverb()

Returns the value of the reverb record component.

Returns:

the value of the reverb record component

fadeTicks

public int fadeTicks()

Returns the value of the fadeTicks record component.

Returns:

the value of the fadeTicks record component