Overview
PlatformEntity represents an entity in the underlying platform (Bukkit, Folia, etc.). It provides a platform-agnostic interface for accessing basic entity properties like UUID and location, as well as integration with BetterModel’s entity tracking system.
Package: kr.toxicity.model.api.platform
Extends: PlatformRegionHolder
Since: 2.0.0
Core Methods
uuid()
Returns the unique identifier of the entity.
Returns: The entity’s UUID
Since: 2.0.0
location()
@NotNull PlatformLocation location()
Tracking Integration
registry()
default @NotNull Optional<EntityTrackerRegistry> registry()
PlatformEntity entity = ...;
entity.registry().ifPresent(registry -> {
// Access entity's tracker registry
int trackerCount = registry.trackers().size();
});
tracker()
default @NotNull Optional<EntityTracker> tracker(@NotNull String name)
name - The name of the tracker
Returns: An optional containing the tracker if found
Since: 2.0.0
Example:
PlatformEntity entity = ...;
entity.tracker("helmet").ifPresent(tracker -> {
// Work with the helmet tracker
tracker.visible(true);
});
Task Scheduling
Inherited from PlatformRegionHolder:
task()
default @Nullable ModelTask task(@NotNull Runnable runnable)
runnable - The task to run
Returns: The scheduled task, or null if scheduling failed
Since: 2.0.0
On Folia servers, tasks are automatically scheduled on the entity’s region thread.
taskLater()
default @Nullable ModelTask taskLater(long delay, @NotNull Runnable runnable)
delay - The delay in ticksrunnable - The task to run
Returns: The scheduled task, or null if scheduling failed
Since: 2.0.0
Use BukkitAdapter to convert Bukkit entities to PlatformEntity:
import kr.toxicity.model.api.bukkit.platform.BukkitAdapter;
import org.bukkit.entity.Entity;
// Convert Bukkit entity
Entity bukkitEntity = ...; // Get from Bukkit API
PlatformEntity platformEntity = BukkitAdapter.adapt(bukkitEntity);
// Access platform-agnostic properties
UUID entityId = platformEntity.uuid();
PlatformLocation location = platformEntity.location();
// Schedule region-safe task
platformEntity.task(() -> {
// This runs on the correct region thread
System.out.println("Entity location: " + location.x() + ", " + location.y());
});
Hierarchy
PlatformEntity is extended by:
PlatformLivingEntity - Adds living entity properties (eye location)PlatformPlayer - Adds player-specific properties (name, online status)
Usage Example
import kr.toxicity.model.api.platform.PlatformEntity;
import kr.toxicity.model.api.bukkit.platform.BukkitAdapter;
public void handleEntity(org.bukkit.entity.Entity bukkitEntity) {
PlatformEntity entity = BukkitAdapter.adapt(bukkitEntity);
// Get entity properties
UUID id = entity.uuid();
PlatformLocation loc = entity.location();
// Check for tracker registry
entity.registry().ifPresent(registry -> {
// Entity has custom models attached
System.out.println("Entity has " + registry.trackers().size() + " trackers");
// Get specific tracker
registry.tracker("weapon").ifPresent(tracker -> {
// Manipulate weapon tracker
tracker.yaw(45.0f);
});
});
// Schedule a delayed task on the entity's region
entity.taskLater(20L, () -> {
System.out.println("Entity moved to: " + entity.location());
});
}
- BaseEntity - Enhanced entity adapter with model data
- PlatformLocation - Location representation
- PlatformPlayer - Player-specific interface
EntityTrackerRegistry - Entity tracker managementPlatformRegionHolder - Region-aware task scheduling
