Record Class RenderSource.BaseEntity

java.lang.Object

java.lang.Record

kr.toxicity.model.api.data.renderer.RenderSource.BaseEntity

Record Components:

entity - the entity

All Implemented Interfaces:

RenderSource<EntityTracker>, RenderSource.Entity

Enclosing interface:

RenderSource<T extends Tracker>

public static record RenderSource.BaseEntity(BaseEntity entity)
extends Record
implements RenderSource.Entity

A basic implementation of RenderSource.Entity wrapping a BaseEntity.

Since:

1.15.2

Nested Class Summary

Nested classes/interfaces inherited from interface RenderSource

RenderSource.BaseDummy, RenderSource.BaseEntity, RenderSource.BasePlayer, RenderSource.Dummy, RenderSource.Entity, RenderSource.ProfiledDummy, RenderSource.ProfiledEntity, RenderSource.ProfiledPlayer

Constructor Summary

Constructors

Constructor	Description
BaseEntity(BaseEntity entity)	Creates an instance of a BaseEntity record class.

Method Summary

Modifier and Type	Method	Description
@NotNull CompletableFuture<BoneRenderContext>	completeContext()	Asynchronously completes the bone render context for this source.
@NotNull EntityTracker	create(@NotNull RenderPipeline pipeline, @NotNull TrackerModifier modifier, @NotNull Consumer<EntityTracker> preUpdateConsumer)	Creates a new tracker for this render source.
BaseEntity	entity()	Returns the value of the entity record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
@NotNull EntityTracker	getOrCreate(@NotNull String name, @NotNull Supplier<RenderPipeline> supplier, @NotNull TrackerModifier modifier, @NotNull Consumer<EntityTracker> preUpdateConsumer)	Gets or creates an entity tracker for this source.
final int	hashCode()	Returns a hash code value for this object.
@NotNull PlatformLocation	location()	Returns the location of this render source.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

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

Methods inherited from interface RenderSource

fallbackContext

Constructor Details

BaseEntity

public BaseEntity(@NotNull
 BaseEntity entity)

Creates an instance of a BaseEntity record class.

Parameters:

entity - the value for the entity record component

Method Details

create

@NotNull
public @NotNull EntityTracker create(@NotNull
 @NotNull RenderPipeline pipeline,
 @NotNull
 @NotNull TrackerModifier modifier,
 @NotNull
 @NotNull Consumer<EntityTracker> preUpdateConsumer)

Description copied from interface: RenderSource

Creates a new tracker for this render source.

Specified by:

create in interface RenderSource<EntityTracker>

Parameters:

pipeline - the render pipeline to use

modifier - the tracker modifier

preUpdateConsumer - a consumer to run before updates

Returns:

the created tracker

getOrCreate

@NotNull
public @NotNull EntityTracker getOrCreate(@NotNull
 @NotNull String name,
 @NotNull
 @NotNull Supplier<RenderPipeline> supplier,
 @NotNull
 @NotNull TrackerModifier modifier,
 @NotNull
 @NotNull Consumer<EntityTracker> preUpdateConsumer)

Description copied from interface: RenderSource.Entity

Gets or creates an entity tracker for this source.

Specified by:

getOrCreate in interface RenderSource.Entity

Parameters:

name - the name of the tracker

supplier - a supplier for the render pipeline

modifier - the tracker modifier

preUpdateConsumer - a consumer to run before updates

Returns:

the entity tracker

location

@NotNull
public @NotNull PlatformLocation location()

Description copied from interface: RenderSource

Returns the location of this render source.

Specified by:

location in interface RenderSource<EntityTracker>

Returns:

the location

completeContext

@NotNull
public @NotNull CompletableFuture<BoneRenderContext> completeContext()

Description copied from interface: RenderSource

Asynchronously completes the bone render context for this source.

This method may involve fetching skin data or other resources.

Specified by:

completeContext in interface RenderSource<EntityTracker>

Returns:

a future completing with the bone render context

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.

entity

@NotNull
public BaseEntity entity()

Returns the value of the entity record component.

Specified by:

entity in interface RenderSource.Entity

Returns:

the value of the entity record component