Record Class WorldVfxParameter

java.lang.Object

java.lang.Record

com.render.api.world.WorldVfxParameter

public record WorldVfxParameter(String name, WorldVfxValueType type, WorldVfxValue defaultValue)
extends Record

Named, typed graph parameter with an immutable default value.

Constructor Summary

Constructors

Constructor	Description
WorldVfxParameter(String name, WorldVfxValueType type, WorldVfxValue defaultValue)	Creates an instance of a WorldVfxParameter record class.

Method Summary

Modifier and Type	Method	Description
WorldVfxValue	defaultValue()	Returns the value of the defaultValue 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.
String	name()	Returns the value of the name record component.
final String	toString()	Returns a string representation of this record class.
WorldVfxValueType	type()	Returns the value of the type record component.

Methods inherited from class Object

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

Constructor Details

WorldVfxParameter

public WorldVfxParameter(String name,
 WorldVfxValueType type,
 WorldVfxValue defaultValue)

Creates an instance of a WorldVfxParameter record class.

Parameters:

name - the value for the name record component

type - the value for the type record component

defaultValue - the value for the defaultValue 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 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.

name

public String name()

Returns the value of the name record component.

Returns:

the value of the name record component

type

public WorldVfxValueType type()

Returns the value of the type record component.

Returns:

the value of the type record component

defaultValue

public WorldVfxValue defaultValue()

Returns the value of the defaultValue record component.

Returns:

the value of the defaultValue record component