bettermodel-api/kr.toxicity.model.api.data.renderer/RenderSource

RenderSource

Represents a source for rendering models, providing necessary context such as location and entity data.

This interface serves as the entry point for creating Tracker instances, which manage the lifecycle of a rendered model. It supports both entity-based and location-based (dummy) rendering sources.

Since

1.15.2

Parameters

<T>

the type of tracker created by this source

Inheritors

Entity

Dummy

Types

BaseDummy

class BaseDummy : Record, RenderSource.Dummy

A basic implementation of Dummy with a location.

BaseEntity

class BaseEntity : Record, RenderSource.Entity

A basic implementation of Entity wrapping a kr.toxicity.model.api.entity.BaseEntity.

BasePlayer

class BasePlayer : Record, RenderSource.Entity, Profiled

A basic implementation of Entity wrapping a kr.toxicity.model.api.entity.BasePlayer.

Dummy

interface Dummy : RenderSource<DummyTracker>

Represents a render source at a fixed location, not attached to an entity.

Entity

interface Entity : RenderSource<EntityTracker>

Represents a render source attached to an entity.

ProfiledDummy

class ProfiledDummy : Record, RenderSource.Dummy

A profiled implementation of Dummy with a location and a model profile.

ProfiledEntity

class ProfiledEntity : Record, RenderSource.Entity

A profiled implementation of Entity wrapping a kr.toxicity.model.api.entity.BaseEntity and a model profile.

ProfiledPlayer

class ProfiledPlayer : Record, RenderSource.Entity, Profiled

A profiled implementation of Entity wrapping a kr.toxicity.model.api.entity.BasePlayer and a model profile.

Functions

completeContext

@NotNull

abstract fun completeContext(): @NotNull CompletableFuture<BoneRenderContext>

Asynchronously completes the bone render context for this source.

create

abstract fun create(@NotNull pipeline: @NotNull RenderPipeline, @NotNull modifier: @NotNull TrackerModifier, @NotNull preUpdateConsumer: @NotNull Consumer<T>): T

Creates a new tracker for this render source.

fallbackContext

open fun fallbackContext(): BoneRenderContext

Returns a fallback bone render context.

location

@NotNull

abstract fun location(): @NotNull PlatformLocation

Returns the location of this render source.

@ApiStatus.Internal

@NotNull

open fun of(@NotNull entity: @NotNull BaseEntity): @NotNull RenderSource.Entity

Creates an entity render source for the given entity.

@ApiStatus.Internal

@NotNull

open fun of(@NotNull location: @NotNull PlatformLocation): @NotNull RenderSource.Dummy

Creates a dummy render source at the specified location.

@ApiStatus.Internal

@NotNull

open fun of(@NotNull entity: @NotNull BaseEntity, @NotNull profile: @NotNull ModelProfile.Uncompleted): @NotNull RenderSource.Entity

Creates an entity render source for the given entity with a specific model profile.

@ApiStatus.Internal

@NotNull

open fun of(@NotNull location: @NotNull PlatformLocation, @NotNull profile: @NotNull ModelProfile.Uncompleted): @NotNull RenderSource.Dummy

Creates a dummy render source at the specified location with a specific model profile.