Record Class ModelBlueprint

java.lang.Object

java.lang.Record

kr.toxicity.model.api.data.blueprint.ModelBlueprint

Record Components:

name - the name of the model

resolution - the texture resolution of the model

textures - the list of textures used by the model

elements - the hierarchical list of model elements (bones)

animations - a map of animations available for this model

@Internal
public record ModelBlueprint(@NotNull String name, @NotNull ModelResolution resolution, @NotNull List<BlueprintTexture> textures, @NotNull List<BlueprintElement> elements, @NotNull Map<String, BlueprintAnimation> animations)
extends Record

Represents a fully processed model blueprint, ready for generation and rendering.

This record contains all the necessary data derived from a raw model file, including textures, structural elements (bones/cubes), and animations.

Since:

1.15.2

Constructor Summary

Constructors

Constructor	Description
ModelBlueprint(@NotNull String name, @NotNull ModelResolution resolution, @NotNull List<BlueprintTexture> textures, @NotNull List<BlueprintElement> elements, @NotNull Map<String, BlueprintAnimation> animations)	Creates an instance of a ModelBlueprint record class.

Method Summary

Modifier and Type	Method	Description
@NotNull Map<String, BlueprintAnimation>	animations()	Returns the value of the animations record component.
@NotNull BlueprintLoadContext	context()	Creates a new load context for this blueprint.
@NotNull List<BlueprintElement>	elements()	Returns the value of the elements 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.
@NotNull String	name()	Returns the value of the name record component.
@NotNull ModelResolution	resolution()	Returns the value of the resolution record component.
@NotNull List<BlueprintTexture>	textures()	Returns the value of the textures 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

Constructor Details

ModelBlueprint

public ModelBlueprint(@NotNull
 @NotNull String name,
 @NotNull
 @NotNull ModelResolution resolution,
 @NotNull
 @NotNull List<BlueprintTexture> textures,
 @NotNull
 @NotNull List<BlueprintElement> elements,
 @NotNull
 @NotNull Map<String, BlueprintAnimation> animations)

Creates an instance of a ModelBlueprint record class.

Parameters:

name - the value for the name record component

resolution - the value for the resolution record component

textures - the value for the textures record component

elements - the value for the elements record component

animations - the value for the animations record component

Method Details

context

@NotNull
public @NotNull BlueprintLoadContext context()

Creates a new load context for this blueprint.

Returns:

a new blueprint load context

Since:

3.0.0

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

@NotNull
public @NotNull String name()

Returns the value of the name record component.

Returns:

the value of the name record component

resolution

@NotNull
public @NotNull ModelResolution resolution()

Returns the value of the resolution record component.

Returns:

the value of the resolution record component

textures

@NotNull
public @NotNull List<BlueprintTexture> textures()

Returns the value of the textures record component.

Returns:

the value of the textures record component

elements

@NotNull
public @NotNull List<BlueprintElement> elements()

Returns the value of the elements record component.

Returns:

the value of the elements record component

animations

@NotNull
public @NotNull Map<String, BlueprintAnimation> animations()

Returns the value of the animations record component.

Returns:

the value of the animations record component