Package net.ixdarklord.coolcatcanvas.api.client.effect

Record Class ScreenEffectDefinition.Target

java.lang.Object

java.lang.Record

net.ixdarklord.coolcatcanvas.api.client.effect.ScreenEffectDefinition.Target

Enclosing class:

ScreenEffectDefinition

public static record ScreenEffectDefinition.Target(Optional<Integer> width, Optional<Integer> height)
extends Record

A target's size; screen-sized where not given. Screen-sized targets follow the window.

Field Summary

Fields

Modifier and Type	Field	Description
static final ScreenEffectDefinition.Target	SCREEN_SIZED

Constructor Summary

Constructors

Constructor	Description
Target(Optional<Integer> width, Optional<Integer> height)	Creates an instance of a Target record class.

Method Summary

Modifier and Type	Method	Description
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.
Optional<Integer>	height()	Returns the value of the height record component.
static ScreenEffectDefinition.Target	sized(int width, int height)
final String	toString()	Returns a string representation of this record class.
Optional<Integer>	width()	Returns the value of the width record component.

Methods inherited from class java.lang.Object

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

Field Details

SCREEN_SIZED

public static final ScreenEffectDefinition.Target SCREEN_SIZED

Constructor Details

Target

public Target(Optional<Integer> width,
 Optional<Integer> height)

Creates an instance of a Target record class.

Parameters:

width - the value for the width record component

height - the value for the height record component

Method Details

sized

public static ScreenEffectDefinition.Target sized(int width,
 int height)

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.

width

public Optional<Integer> width()

Returns the value of the width record component.

Returns:

the value of the width record component

height

public Optional<Integer> height()

Returns the value of the height record component.

Returns:

the value of the height record component