Package net.ixdarklord.coolcatcanvas.internal.vfx

Record Class VfxPayload

java.lang.Object

java.lang.Record

net.ixdarklord.coolcatcanvas.internal.vfx.VfxPayload

All Implemented Interfaces:

CustomPacketPayload

public record VfxPayload(net.minecraft.resources.ResourceLocation effect, VfxParams params)
extends Record
implements CustomPacketPayload

The server telling a client to play one of its registered world effects.

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,VfxPayload>	STREAM_CODEC
static final CustomPacketPayload.Type<VfxPayload>	TYPE

Constructor Summary

Constructors

Constructor	Description
VfxPayload(net.minecraft.resources.ResourceLocation effect, VfxParams params)	Creates an instance of a VfxPayload record class.

Method Summary

Modifier and Type	Method	Description
net.minecraft.resources.ResourceLocation	effect()	Returns the value of the effect record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
VfxParams	params()	Returns the value of the params 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<VfxPayload> TYPE

STREAM_CODEC

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

Constructor Details

VfxPayload

public VfxPayload(net.minecraft.resources.ResourceLocation effect,
 VfxParams params)

Creates an instance of a VfxPayload record class.

Parameters:

effect - the value for the effect record component

params - the value for the params 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. All components in this record class are compared with Objects::equals(Object,Object).

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.

effect

public net.minecraft.resources.ResourceLocation effect()

Returns the value of the effect record component.

Returns:

the value of the effect record component

params

public VfxParams params()

Returns the value of the params record component.

Returns:

the value of the params record component