Record Class RenderSource.BasePlayer

java.lang.Object
java.lang.Record
kr.toxicity.model.api.data.renderer.RenderSource.BasePlayer
Record Components:
entity - the player entity
All Implemented Interfaces:
RenderSource<EntityTracker>, RenderSource.Entity, Profiled
Enclosing interface:
RenderSource<T extends Tracker>
public static record RenderSource.BasePlayer(BasePlayer entity) extends Record implements RenderSource.Entity, Profiled
A basic implementation of RenderSource.Entity wrapping a BasePlayer.
Since:
1.15.2

  • Constructor Details

    • BasePlayer

      public BasePlayer(@NotNull BasePlayer entity)
      Creates an instance of a BasePlayer 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

    • profile

      @NotNull public @NotNull ModelProfile profile()
      Description copied from interface: Profiled
      Returns the model profile (skin) of the entity.
      Specified by:
      profile in interface Profiled
      Returns:
      the model profile

    • armors

      @NotNull public @NotNull PlayerArmor armors()
      Description copied from interface: Profiled
      Returns the armor equipment of the entity.
      Specified by:
      armors in interface Profiled
      Returns:
      the player armor

    • skinParts

      @NotNull public @NotNull PlayerSkinParts skinParts()
      Description copied from interface: Profiled
      Returns the skin customization parts (e.g., jacket, hat) of the entity.
      Specified by:
      skinParts in interface Profiled
      Returns:
      the skin parts

    • 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 BasePlayer entity()
      Returns the value of the entity record component.
      Specified by:
      entity in interface RenderSource.Entity
      Returns:
      the value of the entity record component