Documentation Index
Fetch the complete documentation index at: https://mintlify.com/toxicity188/BetterModel/llms.txt
Use this file to discover all available pages before exploring further.
Overview
BaseEntity is the primary entity adapter interface in BetterModel. It provides a unified way to access entity properties, manage custom models, and interact with the entity tracking system. This interface acts as a bridge between platform-specific entities and BetterModel’s internal entity management.
Package: kr.toxicity.model.api.entity
Extends: Identifiable
Factory Method
of()
static @NotNull BaseEntity of(@NotNull PlatformEntity entity)
BaseEntity adapter from a platform-specific entity.
Parameters:
entity - Platform entity to adapt
Returns: Base entity adapter
Example:
PlatformEntity platformEntity = ...; // Get from platform
BaseEntity base = BaseEntity.of(platformEntity);
Core Methods
@NotNull PlatformEntity platform()
location()
default @NotNull PlatformLocation location()
handle()
Gets the vanilla (NMS) entity handle.
Returns: Vanilla entity object
id()
Gets the entity’s network ID.
Returns: Entity ID
State Queries
dead()
Checks if the entity is dead.
Returns: true if dead
ground()
Checks if the entity is on the ground.
Returns: true if on ground
invisible()
Checks if the entity has the invisible effect.
Returns: true if invisible
glow()
Checks if the entity has the glowing effect.
Returns: true if glowing
onWalk()
Checks if the entity is currently walking.
Returns: true if walking
fly()
Checks if the entity is flying.
Returns: true if flying
Appearance Properties
customName()
@Nullable Component customName()
null if none
scale()
Gets the entity’s scale multiplier.
Returns: Scale value
Rotation Properties
pitch()
Gets the entity’s pitch (x-rotation).
Returns: Pitch in degrees
yaw()
Gets the entity’s yaw (y-rotation).
Returns: Yaw in degrees
bodyYaw()
Gets the entity’s body yaw (y-rotation).
Returns: Body yaw in degrees
headYaw()
Gets the entity’s head yaw (y-rotation).
Returns: Head yaw in degrees
Movement Properties
walkSpeed()
Gets the entity’s walk speed.
Returns: Walk speed value
damageTick()
Gets the entity’s damage animation tick.
Returns: Damage tick value
passengerPosition()
@NotNull Vector3f passengerPosition(@NotNull Vector3f dest)
dest - Destination vector to write result
Returns: The destination vector with passenger position
Equipment
mainHand()
@NotNull TransformedItemStack mainHand()
offHand()
@NotNull TransformedItemStack offHand()
Tracking
trackedBy()
@NotNull Stream<PlatformPlayer> trackedBy()
registry()
default @NotNull Optional<EntityTrackerRegistry> registry()
hasControllingPassenger()
default boolean hasControllingPassenger()
true if has controlling passenger
Model Data
modelData()
@Nullable String modelData()
null if none
modelData(String)
void modelData(@Nullable String modelData)
modelData - Model data key to set, or null to clear
hasModelData()
default boolean hasModelData()
true if model data is present
Usage Example
// Get entity and check its state
PlatformEntity platformEntity = ...; // From platform
BaseEntity entity = BaseEntity.of(platformEntity);
// Check entity state
if (!entity.dead() && entity.ground()) {
// Entity is alive and on ground
float yaw = entity.yaw();
PlatformLocation loc = entity.location();
}
// Assign a custom model
entity.modelData("custom:warrior");
// Check if entity has tracker registry
entity.registry().ifPresent(registry -> {
// Work with entity trackers
registry.tracker("helmet").ifPresent(tracker -> {
// Manipulate tracker
});
});
// Get tracked players
entity.trackedBy().forEach(player -> {
// Send updates to tracking players
});
- PlatformEntity - Platform abstraction layer
- PlatformLocation - Location representation
EntityTrackerRegistry - Entity tracker managementTransformedItemStack - Item stack wrapper
