Record Class FoliosReveal.Look

java.lang.Object

java.lang.Record

net.ixdarklord.folios.api.client.FoliosReveal.Look

Enclosing interface:

FoliosReveal

public static record FoliosReveal.Look(float opacity, float dx, float dy, int tint, float runes)
extends Record

How a thing looks: how much it shows (0 not at all, 1 fully; items and scenes, which can't fade, show once past a half), how far it is moved from its place in page pixels, a colour it is tinted towards (tint's alpha is how far: 0 not at all), and what share of its letters, if it is text, show as runes (0 none, 1 all).

Field Summary

Fields

Modifier and Type	Field	Description
static final FoliosReveal.Look	HIDDEN
static final FoliosReveal.Look	SHOWN

Constructor Summary

Constructors

Constructor	Description
Look(float opacity, float dx, float dy)
Look(float opacity, float dx, float dy, int tint, float runes)	Creates an instance of a Look record class.

Method Summary

Modifier and Type	Method	Description
float	dx()	Returns the value of the dx record component.
float	dy()	Returns the value of the dy 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.
float	opacity()	Returns the value of the opacity record component.
float	runes()	Returns the value of the runes record component.
int	tint()	Returns the value of the tint record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

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

Field Details

SHOWN

public static final FoliosReveal.Look SHOWN

HIDDEN

public static final FoliosReveal.Look HIDDEN

Constructor Details

Look

public Look(float opacity,
 float dx,
 float dy)

Look

public Look(float opacity,
 float dx,
 float dy,
 int tint,
 float runes)

Creates an instance of a Look record class.

Parameters:

opacity - the value for the opacity record component

dx - the value for the dx record component

dy - the value for the dy record component

tint - the value for the tint record component

runes - the value for the runes record component

Method Details

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 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.

opacity

public float opacity()

Returns the value of the opacity record component.

Returns:

the value of the opacity record component

dx

public float dx()

Returns the value of the dx record component.

Returns:

the value of the dx record component

dy

public float dy()

Returns the value of the dy record component.

Returns:

the value of the dy record component

tint

public int tint()

Returns the value of the tint record component.

Returns:

the value of the tint record component

runes

public float runes()

Returns the value of the runes record component.

Returns:

the value of the runes record component