Record Class HudPlacement

java.lang.Object

java.lang.Record

com.render.api.HudPlacement

Record Components:

x - absolute x position in design-space pixels

y - absolute y position in design-space pixels

scale - user-facing scale multiplier

textOpacity - multiplier applied to text components inside the element

contentOpacity - multiplier applied to non-text components inside the element

public record HudPlacement(float x, float y, float scale, float textOpacity, float contentOpacity)
extends Record

Default or saved absolute placement for a top-level managed HUD element.

Field Summary

Fields

Modifier and Type	Field	Description
static final float	MAX_OPACITY
static final float	MAX_SCALE
static final float	MIN_OPACITY
static final float	MIN_SCALE

Constructor Summary

Constructors

Constructor	Description
HudPlacement(float x, float y, float scale)
HudPlacement(float x, float y, float scale, float textOpacity, float contentOpacity)	Creates an instance of a HudPlacement record class.

Method Summary

Modifier and Type	Method	Description
static float	clampOpacity(float opacity)
static float	clampScale(float scale)
float	contentOpacity()	Returns the value of the contentOpacity 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	scale()	Returns the value of the scale record component.
float	textOpacity()	Returns the value of the textOpacity record component.
final String	toString()	Returns a string representation of this record class.
HudPlacement	withContentOpacity(float contentOpacity)
HudPlacement	withPosition(float x, float y)
HudPlacement	withScale(float scale)
HudPlacement	withTextOpacity(float textOpacity)
float	x()	Returns the value of the x record component.
float	y()	Returns the value of the y record component.

Methods inherited from class Object

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

Field Details

MIN_SCALE

public static final float MIN_SCALE

See Also:

• Constant Field Values

MAX_SCALE

public static final float MAX_SCALE

See Also:

• Constant Field Values

MIN_OPACITY

public static final float MIN_OPACITY

See Also:

• Constant Field Values

MAX_OPACITY

public static final float MAX_OPACITY

See Also:

• Constant Field Values

Constructor Details

HudPlacement

public HudPlacement(float x,
 float y,
 float scale)

HudPlacement

public HudPlacement(float x,
 float y,
 float scale,
 float textOpacity,
 float contentOpacity)

Creates an instance of a HudPlacement record class.

Parameters:

x - the value for the x record component

y - the value for the y record component

scale - the value for the scale record component

textOpacity - the value for the textOpacity record component

contentOpacity - the value for the contentOpacity record component

Method Details

withPosition

public HudPlacement withPosition(float x,
 float y)

withScale

public HudPlacement withScale(float scale)

withTextOpacity

public HudPlacement withTextOpacity(float textOpacity)

withContentOpacity

public HudPlacement withContentOpacity(float contentOpacity)

clampScale

public static float clampScale(float scale)

clampOpacity

public static float clampOpacity(float opacity)

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.

x

public float x()

Returns the value of the x record component.

Returns:

the value of the x record component

y

public float y()

Returns the value of the y record component.

Returns:

the value of the y record component

scale

public float scale()

Returns the value of the scale record component.

Returns:

the value of the scale record component

textOpacity

public float textOpacity()

Returns the value of the textOpacity record component.

Returns:

the value of the textOpacity record component

contentOpacity

public float contentOpacity()

Returns the value of the contentOpacity record component.

Returns:

the value of the contentOpacity record component