Record Class ScreenEffectPayload

java.lang.Object

java.lang.Record

net.ixdarklord.coolcatcanvas.internal.effect.ScreenEffectPayload

Record Components:

ticks - the duration of ScreenEffectPayload.Action.ENABLE_FOR and ScreenEffectPayload.Action.TINT, or of the transition of ScreenEffectPayload.Action.SET_STRENGTH and ScreenEffectPayload.Action.SET_UNIFORM (0 for instant)

uniform - the uniform ScreenEffectPayload.Action.SET_UNIFORM changes, empty otherwise

values - the strength (first value) or uniform components

All Implemented Interfaces:

net.minecraft.network.protocol.common.custom.CustomPacketPayload

public record ScreenEffectPayload(net.minecraft.resources.Identifier effect, ScreenEffectPayload.Action action, int ticks, String uniform, float[] values)
extends Record
implements net.minecraft.network.protocol.common.custom.CustomPacketPayload

The server telling a client what to do with one of its registered screen effects.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ScreenEffectPayload.Action

Nested classes/interfaces inherited from interface net.minecraft.network.protocol.common.custom.CustomPacketPayload

net.minecraft.network.protocol.common.custom.CustomPacketPayload.FallbackProvider<B>, net.minecraft.network.protocol.common.custom.CustomPacketPayload.Type<T>, net.minecraft.network.protocol.common.custom.CustomPacketPayload.TypeAndCodec<B,T>

Field Summary

Fields

Modifier and Type	Field	Description
static final net.minecraft.network.codec.StreamCodec<net.minecraft.network.RegistryFriendlyByteBuf, ScreenEffectPayload>	STREAM_CODEC
static final net.minecraft.network.protocol.common.custom.CustomPacketPayload.Type<ScreenEffectPayload>	TYPE

Constructor Summary

Constructors

Constructor	Description
ScreenEffectPayload(net.minecraft.resources.Identifier effect, ScreenEffectPayload.Action action, int ticks, String uniform, float[] values)	Creates an instance of a ScreenEffectPayload record class.

Method Summary

Modifier and Type	Method	Description
ScreenEffectPayload.Action	action()	Returns the value of the action record component.
net.minecraft.resources.Identifier	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.
int	ticks()	Returns the value of the ticks record component.
final String	toString()	Returns a string representation of this record class.
net.minecraft.network.protocol.common.custom.CustomPacketPayload.Type<? extends net.minecraft.network.protocol.common.custom.CustomPacketPayload>	type()
String	uniform()	Returns the value of the uniform record component.
float[]	values()	Returns the value of the values record component.

Methods inherited from class Object

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

Field Details

TYPE

public static final net.minecraft.network.protocol.common.custom.CustomPacketPayload.Type<ScreenEffectPayload> TYPE

STREAM_CODEC

public static final net.minecraft.network.codec.StreamCodec<net.minecraft.network.RegistryFriendlyByteBuf, ScreenEffectPayload> STREAM_CODEC

Constructor Details

ScreenEffectPayload

public ScreenEffectPayload(net.minecraft.resources.Identifier effect,
 ScreenEffectPayload.Action action,
 int ticks,
 String uniform,
 float[] values)

Creates an instance of a ScreenEffectPayload record class.

Parameters:

effect - the value for the effect record component

action - the value for the action record component

ticks - the value for the ticks record component

uniform - the value for the uniform record component

values - the value for the values record component

Method Details

type

public net.minecraft.network.protocol.common.custom.CustomPacketPayload.Type<? extends net.minecraft.network.protocol.common.custom.CustomPacketPayload> type()

Specified by:

type in interface net.minecraft.network.protocol.common.custom.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 the compare method from their corresponding wrapper classes.

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.Identifier effect()

Returns the value of the effect record component.

Returns:

the value of the effect record component

action

public ScreenEffectPayload.Action action()

Returns the value of the action record component.

Returns:

the value of the action record component

ticks

public int ticks()

Returns the value of the ticks record component.

Returns:

the value of the ticks record component

uniform

public String uniform()

Returns the value of the uniform record component.

Returns:

the value of the uniform record component

values

public float[] values()

Returns the value of the values record component.

Returns:

the value of the values record component