PlayerEntityHelper
com.jsmacrosce.jsmacros.client.api.helper.world.entity.PlayerEntityHelper
Provides player-specific entity data, including experience, score, and sleep state.
Equipment accessors are inherited in behavior from LivingEntityHelper; the player overrides return those same six hand and armor slots, not additional slots.
A player helper from an entity list is an EntityHelpers.Player; the local player is also an EntityHelpers.ClientPlayer.
js
// the local player, which is the only one a client has any business with
const player = Player.getPlayer();
if (player !== null) {
Chat.log(`${player.getPlayerName()} on ${player.getXPLevel()} `
+ `(${player.getXP()} xp total), score ${player.getScore()}`);
}Available in scripts as EntityHelpers.Player.
Type Parameters
T: the player entity type wrapped by this helper
Constructors
new PlayerEntityHelper
Methods
getAbilities
Returns a helper wrapping this player's abilities object; setter calls modify that object.
Returns: a wrapper on this player's abilities
getAttackCooldownProgress
the player's attack cooldown progress, clamped to the range
0.0 to 1.0.Returns: the attack charge as a fraction from zero to one
getAttackCooldownProgressPerTick
the number of ticks in a full attack cooldown, calculated from the player's attack speed attribute.
Returns: the number of ticks a full attack charge takes
getChestArmor
Returns the player's chest-armor-slot stack.
Returns: the player's chest-armor-slot item stack, empty when the slot is empty
getFishingBobber
this player's fishing bobber, or
null when none is attached. The returned wrapper refers to that bobber entity; this works for local and other players.Returns: the fishing bobber of the player, or
null if the player is not fishing.getFootArmor
Returns the player's boots-slot stack.
Returns: the player's boots-slot item stack, empty when the slot is empty
getHeadArmor
Returns the player's helmet-slot stack.
Returns: the player's helmet-slot item stack, empty when the slot is empty
getLegArmor
Returns the player's leggings-slot stack.
Returns: the player's leggings-slot item stack, empty when the slot is empty
getMainHand
Returns the player's main-hand stack.
Returns: the player's main-hand item stack, empty when the hand is empty
getOffHand
Returns the player's off-hand stack.
Returns: the player's off-hand item stack, empty when the hand is empty
getPlayerName
getScore
the integer score stored on the player entity.
Returns: the player's score
getXP
Returns the player's accumulated total experience points, distinct from current-level progress.
Returns: the total experience the player has collected
getXPLevel
the player's current experience level.
Returns: the player's experience level
getXPProgress
the player's progress through the current experience level, as a fraction of the level's total cost.
Returns: the fraction of the current level the player has filled
getXPToLevelUp
the total experience-point cost of the next level, determined by the player's current level, not the points remaining in it.
Returns: the experience needed to reach the next level
isSleeping
whether the player is currently sleeping.
Returns:
true if the player is asleep, false otherwise.isSleepingLongEnough
whether the player is sleeping and has met the game's 100-tick sleep threshold.
Returns: if the player has slept the minimum amount of time to pass the night.