bettermodel-api/kr.toxicity.model.api.entity/BasePlayer

BasePlayer

interface BasePlayer : BaseEntity, Profiled

An adapter of player

Functions

Link copied to clipboard
@NotNull
abstract fun armors(): @NotNull PlayerArmor
Returns the armor equipment of the entity.
Link copied to clipboard
abstract fun bodyYaw(): Float
Gets entity's body yaw (y-rot)
Link copied to clipboard
@Nullable
abstract fun customName(): @Nullable Component
Gets custom name of this entity
Link copied to clipboard
abstract fun damageTick(): Float
Gets entity's damage tick
Link copied to clipboard
abstract fun dead(): Boolean
Checks source entity is dead
Link copied to clipboard
abstract fun fly(): Boolean
Check source entity is on the fly
Link copied to clipboard
abstract fun glow(): Boolean
Check source entity is on a glow
Link copied to clipboard
abstract fun ground(): Boolean
Checks source entity is on the ground
Link copied to clipboard
@NotNull
abstract fun handle(): @NotNull Any
Gets vanilla entity
Link copied to clipboard
open fun hasControllingPassenger(): Boolean
Checks this entity has controlling passenger
Link copied to clipboard
open fun hasModelData(): Boolean
Checks this entity has model data
Link copied to clipboard
abstract fun headYaw(): Float
Gets entity's head yaw (y-rot)
Link copied to clipboard
abstract fun id(): Int
Gets entity id
Link copied to clipboard
abstract fun invisible(): Boolean
Checks source entity is invisible
Link copied to clipboard
@NotNull
open fun location(): @NotNull PlatformLocation
Gets the current location of the entity.
Link copied to clipboard
@NotNull
abstract fun mainHand(): @NotNull TransformedItemStack
Gets main hand item
Link copied to clipboard
@Nullable
abstract fun modelData(): @Nullable String
Gets this entity's model data
abstract fun modelData(@Nullable modelData: @Nullable String)
Sets this entity's model data
Link copied to clipboard
@NotNull
open fun of(@NotNull entity: @NotNull PlatformEntity): @NotNull BaseEntity
Gets base entity
Link copied to clipboard
@NotNull
abstract fun offHand(): @NotNull TransformedItemStack
Gets offhand item
Link copied to clipboard
abstract fun onWalk(): Boolean
Check source entity is on a walk
Link copied to clipboard
@NotNull
abstract fun passengerPosition(@NotNull dest: @NotNull Vector3f): @NotNull Vector3f
Gets entity's passenger point
Link copied to clipboard
abstract fun pitch(): Float
Gets entity's pitch (x-rot)
Link copied to clipboard
@NotNull
abstract fun platform(): @NotNull PlatformPlayer
Gets the platform-specific entity object.
Link copied to clipboard
@NotNull
abstract fun profile(): @NotNull ModelProfile
Returns the model profile (skin) of the entity.
Link copied to clipboard
@NotNull
open fun registry(): @NotNull Optional<EntityTrackerRegistry>
Gets tracker registry of this adapter
Link copied to clipboard
abstract fun scale(): Double
Gets entity's scale
Link copied to clipboard
@NotNull
abstract fun skinParts(): @NotNull PlayerSkinParts
Returns the skin customization parts (e.g., jacket, hat) of the entity.
Link copied to clipboard
@NotNull
abstract fun trackedBy(): @NotNull Stream<PlatformPlayer>
Gets tracked player set
Link copied to clipboard
abstract fun updateInventory()
Updates current inventory
Link copied to clipboard
@NotNull
abstract fun uuid(): @NotNull UUID
Returns the UUID of the object.
Link copied to clipboard
abstract fun walkSpeed(): Float
Gets entity's walk speed
Link copied to clipboard
abstract fun yaw(): Float
Gets entity's yaw (y-rot)
Generated by Dokka
© 2026 Copyright