bettermodel-api/kr.toxicity.model.api.tracker/EntityTrackerRegistry

EntityTrackerRegistry

Manages all entity trackers for a specific entity.

This registry handles the lifecycle of trackers attached to an entity, including loading, saving, spawning, and despawning. It acts as a central hub for accessing and manipulating models on an entity.

Since

1.15.2

Types

MountedHitBox

class MountedHitBox : Record

Represents a hitbox that has an entity mounted on it.

Functions

open fun close(): Boolean

Closes the registry.

open fun close(@NotNull reason: @NotNull Tracker.CloseReason): Boolean

Closes the registry with a specific reason.

create

@ApiStatus.Internal

@NotNull

open fun create(@NotNull key: @NotNull String, @NotNull supplier: @NotNull (EntityTrackerRegistry) -> EntityTracker): @NotNull EntityTracker

Creates a new tracker in this registry.

despawn

open fun despawn()

Despawns all trackers in the registry.

displays

@NotNull

open fun displays(): @NotNull Stream<ModelDisplay>

Returns a stream of all displays from all trackers.

entity

@NotNull

open fun entity(): @NotNull BaseEntity

Returns the source entity.

first

@Nullable

open fun first(): @Nullable EntityTracker

Returns the first tracker in the registry.

getOrCreate

@ApiStatus.Internal

@NotNull

open fun getOrCreate(@NotNull entity: @NotNull BaseEntity): @NotNull EntityTrackerRegistry

Gets or creates a registry for a base entity.

@ApiStatus.Internal

@NotNull

open fun getOrCreate(@NotNull key: @NotNull String, @NotNull supplier: @NotNull (EntityTrackerRegistry) -> EntityTracker): @NotNull EntityTracker

Gets or creates a tracker in this registry.

hasControllingPassenger

open fun hasControllingPassenger(): Boolean

Checks if any hitbox has a controlling passenger.

hasPassenger

open fun hasPassenger(): Boolean

Checks if any hitbox has a passenger.

hideOption

@NotNull

open fun hideOption(@NotNull uuid: @NotNull UUID): @NotNull EntityHideOption

Returns the hide option for a specific player.

hitBoxes

@NotNull

@Unmodifiable

open fun hitBoxes(): @NotNull @Unmodifiable Collection<HitBox>

Returns a collection of all active hitboxes for this registry.

open fun id(): Int

Returns the entity ID.

isClosed

open fun isClosed(): Boolean

Checks if the registry is closed.

isSpawned

open fun isSpawned(@NotNull uuid: @NotNull UUID): Boolean

Checks if any tracker is spawned for a player UUID.

open fun isSpawned(@NotNull player: @NotNull PlatformPlayer): Boolean

Checks if any tracker is spawned for a player.

load

open fun load()

Loads trackers from the entity's persistent data.

open fun load(@NotNull stream: @NotNull Stream<TrackerData>)

Loads trackers from a stream of data.

mountedHitBox

@NotNull

@Unmodifiable

open fun mountedHitBox(): @NotNull @Unmodifiable Map<UUID, EntityTrackerRegistry.MountedHitBox>

Returns the map of currently mounted hitboxes.

refresh

open fun refresh()

Refreshes the registry state.

registries

@NotNull

@Unmodifiable

open fun registries(): @NotNull @Unmodifiable List<EntityTrackerRegistry>

Returns a list of all active registries.

open fun registries(@NotNull consumer: @NotNull Consumer<EntityTrackerRegistry>)

Iterates over all active registries.

registry

@Nullable

open fun registry(id: Int): @Nullable EntityTrackerRegistry

Retrieves a registry by entity ID.

@Nullable

open fun registry(@NotNull uuid: @NotNull UUID): @Nullable EntityTrackerRegistry

Retrieves a registry by entity UUID.

@Nullable

open fun registry(@NotNull entity: @NotNull BaseEntity): @Nullable EntityTrackerRegistry

Retrieves a registry for a base entity.

reload

open fun reload()

Reloads the registry, refreshing all trackers.

remove

open fun remove(@NotNull key: @NotNull String): Boolean

Removes a tracker from the registry.

open fun remove(@NotNull player: @NotNull PlatformPlayer): Boolean

Removes a player from viewing this registry.

save

open fun save()

Saves the current tracker state to the entity's persistent data.

serialize

@NotNull

open fun serialize(): @NotNull JsonArray

Serializes the registry state to a JSON array.

spawn

open fun spawn(@NotNull player: @NotNull PlatformPlayer): Boolean

Spawns trackers for a player.

spawnIfNotSpawned

open fun spawnIfNotSpawned(@NotNull player: @NotNull PlatformPlayer): Boolean

Spawns trackers for a player only if not already spawned.

tracker

@Nullable

open fun tracker(@Nullable key: @Nullable String): @Nullable EntityTracker

Retrieves a tracker by key.

trackers

@NotNull

@Unmodifiable

open fun trackers(): @NotNull @Unmodifiable Collection<EntityTracker>

Returns all trackers in this registry.

uuid

@NotNull

open fun uuid(): @NotNull UUID

Returns the entity UUID.

viewedPlayer

@NotNull

open fun viewedPlayer(): @NotNull Stream<PlayerChannelHandler>

Returns a stream of all players viewing this registry.