Importing the class

Link to importing-the-class

It might be required for you to import the package if you encounter any issues (like casting an Array), so better be safe than sorry and add the import at the very top of the file.

ZenScript
Copy
import crafttweaker.api.entity.type.player.Player;

Extending LivingEntity

Link to extending-livingentity

Player extends LivingEntity. That means all methods available in LivingEntity are also available in Player

Name: addItem

Return Type: boolean

ZenScript
Copy
Player.addItem(stack as ItemStack) as boolean
ParameterTypeDescription
Parameter
stack
Type
ItemStack
Description
No Description Provided

Name: attack

Return Type: void

ZenScript
Copy
Player.attack(entity as Entity) as void
ParameterTypeDescription
Parameter
entity
Type
Entity
Description
No Description Provided

Name: awardStat

Return Type: void

ZenScript
Copy
Player.awardStat(stat as ResourceLocation) as void
ParameterTypeDescription
Parameter
stat
Type
ResourceLocation
Description
No Description Provided

Name: awardStat

Return Type: void

ZenScript
Copy
Player.awardStat(stat as ResourceLocation, amount as int) as void
ParameterTypeDescription
Parameter
stat
Type
ResourceLocation
Description
No Description Provided
Parameter
amount
Type
int
Description
No Description Provided

Name: canEat

Return Type: boolean

ZenScript
Copy
Player.canEat(ignoreHunger as boolean) as boolean
ParameterTypeDescription
Parameter
ignoreHunger
Type
boolean
Description
No Description Provided

Name: canHarmPlayer

Return Type: boolean

ZenScript
Copy
Player.canHarmPlayer(player as Player) as boolean
ParameterTypeDescription
Parameter
player
Type
Player
Description
No Description Provided

Link to canUseGameMasterBlocks

Name: canUseGameMasterBlocks

Return Type: boolean

ZenScript
Copy
// Player.canUseGameMasterBlocks() as boolean

myPlayer.canUseGameMasterBlocks();

Link to causeFoodExhaustion

Name: causeFoodExhaustion

Return Type: void

ZenScript
Copy
Player.causeFoodExhaustion(exhaustion as float) as void
ParameterTypeDescription
Parameter
exhaustion
Type
float
Description
No Description Provided

Name: crit

Return Type: void

ZenScript
Copy
Player.crit(entity as Entity) as void
ParameterTypeDescription
Parameter
entity
Type
Entity
Description
No Description Provided

Name: disableShield

Return Type: void

ZenScript
Copy
Player.disableShield(usingAxe as boolean) as void
ParameterTypeDescription
Parameter
usingAxe
Type
boolean
Description
No Description Provided

Link to displayClientMessage

Name: displayClientMessage

Return Type: void

ZenScript
Copy
Player.displayClientMessage(component as Component, actionBar as boolean) as void
ParameterTypeDescription
Parameter
component
Type
Component
Description
No Description Provided
Parameter
actionBar
Type
boolean
Description
No Description Provided

Name: drop

Return Type: ItemEntity

ZenScript
Copy
Player.drop(stack as ItemStack, traceItem as boolean) as ItemEntity
ParameterTypeDescription
Parameter
stack
Type
ItemStack
Description
No Description Provided
Parameter
traceItem
Type
boolean
Description
No Description Provided

Name: getAbilities

Return Type: Abilities

ZenScript
Copy
// Player.getAbilities() as Abilities

myPlayer.getAbilities();

Name: getCooldowns

Return Type: ItemCooldowns

ZenScript
Copy
// Player.getCooldowns() as ItemCooldowns

myPlayer.getCooldowns();

Link to getCurrentItemAttackStrengthDelay

Name: getCurrentItemAttackStrengthDelay

Return Type: float

ZenScript
Copy
// Player.getCurrentItemAttackStrengthDelay() as float

myPlayer.getCurrentItemAttackStrengthDelay();

Name: getDestroySpeed

Return Type: float

ZenScript
Copy
Player.getDestroySpeed(state as BlockState) as float
ParameterTypeDescription
Parameter
state
Type
BlockState
Description
No Description Provided

Link to getEnchantmentSeed

Name: getEnchantmentSeed

Return Type: int

ZenScript
Copy
// Player.getEnchantmentSeed() as int

myPlayer.getEnchantmentSeed();

Name: getFoodData

Return Type: FoodData

ZenScript
Copy
// Player.getFoodData() as FoodData

myPlayer.getFoodData();

Name: getInventory

Return Type: Inventory

ZenScript
Copy
// Player.getInventory() as Inventory

myPlayer.getInventory();

Name: getLuck

Return Type: float

ZenScript
Copy
// Player.getLuck() as float

myPlayer.getLuck();

Name: getMainArm

Return Type: HumanoidArm

ZenScript
Copy
// Player.getMainArm() as HumanoidArm

myPlayer.getMainArm();

Name: getScore

Return Type: int

ZenScript
Copy
// Player.getScore() as int

myPlayer.getScore();

Link to getShoulderEntityLeft

Name: getShoulderEntityLeft

Return Type: MapData

ZenScript
Copy
// Player.getShoulderEntityLeft() as MapData

myPlayer.getShoulderEntityLeft();

Link to getShoulderEntityRight

Name: getShoulderEntityRight

Return Type: MapData

ZenScript
Copy
// Player.getShoulderEntityRight() as MapData

myPlayer.getShoulderEntityRight();

Name: getSleepTimer

Return Type: int

ZenScript
Copy
// Player.getSleepTimer() as int

myPlayer.getSleepTimer();

Link to getXpNeededForNextLevel

Name: getXpNeededForNextLevel

Return Type: int

ZenScript
Copy
// Player.getXpNeededForNextLevel() as int

myPlayer.getXpNeededForNextLevel();

Name: give

Return Type: void

ZenScript
Copy
Player.give(stack as IItemStack, slot as int) as void
ParameterTypeDescriptionOptionalDefaultValue
Parameter
stack
Type
IItemStack
Description
No Description Provided
Optional
false
DefaultValue
Parameter
slot
Type
int
Description
No Description Provided
Optional
true
DefaultValue
-1

Link to giveExperienceLevels

Name: giveExperienceLevels

Return Type: void

ZenScript
Copy
Player.giveExperienceLevels(levels as int) as void
ParameterTypeDescription
Parameter
levels
Type
int
Description
No Description Provided

Link to giveExperiencePoints

Name: giveExperiencePoints

Return Type: void

ZenScript
Copy
Player.giveExperiencePoints(amount as int) as void
ParameterTypeDescription
Parameter
amount
Type
int
Description
No Description Provided

Link to hasCorrectToolForDrops

Name: hasCorrectToolForDrops

Return Type: boolean

ZenScript
Copy
Player.hasCorrectToolForDrops(state as BlockState) as boolean
ParameterTypeDescription
Parameter
state
Type
BlockState
Description
No Description Provided

Name: increaseScore

Return Type: void

ZenScript
Copy
Player.increaseScore(score as int) as void
ParameterTypeDescription
Parameter
score
Type
int
Description
No Description Provided

Name: isCreative

Return Type: boolean

ZenScript
Copy
// Player.isCreative() as boolean

myPlayer.isCreative();

Name: isHurt

Return Type: boolean

ZenScript
Copy
// Player.isHurt() as boolean

myPlayer.isHurt();

Name: isLocalPlayer

Return Type: boolean

ZenScript
Copy
// Player.isLocalPlayer() as boolean

myPlayer.isLocalPlayer();

Link to isReducedDebugInfo

Name: isReducedDebugInfo

Return Type: boolean

ZenScript
Copy
// Player.isReducedDebugInfo() as boolean

myPlayer.isReducedDebugInfo();

Name: isScoping

Return Type: boolean

ZenScript
Copy
// Player.isScoping() as boolean

myPlayer.isScoping();

Link to isSecondaryUseActive

Name: isSecondaryUseActive

Return Type: boolean

ZenScript
Copy
// Player.isSecondaryUseActive() as boolean

myPlayer.isSecondaryUseActive();

Link to isSleepingLongEnough

Name: isSleepingLongEnough

Return Type: boolean

ZenScript
Copy
// Player.isSleepingLongEnough() as boolean

myPlayer.isSleepingLongEnough();

Name: jumpFromGround

Return Type: void

ZenScript
Copy
// Player.jumpFromGround() as void

myPlayer.jumpFromGround();

Name: magicCrit

Return Type: void

ZenScript
Copy
Player.magicCrit(entity as Entity) as void
ParameterTypeDescription
Parameter
entity
Type
Entity
Description
No Description Provided

Name: mayBuild

Return Type: boolean

ZenScript
Copy
// Player.mayBuild() as boolean

myPlayer.mayBuild();

Name: playNotifySound

Return Type: void

ZenScript
Copy
Player.playNotifySound(event as SoundEvent, source as SoundSource, volume as float, pitch as float) as void
ParameterTypeDescription
Parameter
event
Type
SoundEvent
Description
No Description Provided
Parameter
source
Type
SoundSource
Description
No Description Provided
Parameter
volume
Type
float
Description
No Description Provided
Parameter
pitch
Type
float
Description
No Description Provided

Name: respawn

Return Type: void

ZenScript
Copy
// Player.respawn() as void

myPlayer.respawn();

Name: sendMessage

Return Type: void

ZenScript
Copy
Player.sendMessage(text as Component) as void
ParameterTypeDescription
Parameter
text
Type
Component
Description
No Description Provided

Link to setEntityOnShoulder

Name: setEntityOnShoulder

Return Type: boolean

ZenScript
Copy
Player.setEntityOnShoulder(entityData as MapData) as boolean
ParameterTypeDescription
Parameter
entityData
Type
MapData
Description
No Description Provided

Name: setMainArm

Return Type: void

ZenScript
Copy
Player.setMainArm(arm as HumanoidArm) as void
ParameterTypeDescription
Parameter
arm
Type
HumanoidArm
Description
No Description Provided

Link to setReducedDebugInfo

Name: setReducedDebugInfo

Return Type: void

ZenScript
Copy
Player.setReducedDebugInfo(reducedDebugInfo as boolean) as void
ParameterTypeDescription
Parameter
reducedDebugInfo
Type
boolean
Description
No Description Provided

Name: setScore

Return Type: void

ZenScript
Copy
Player.setScore(score as int) as void
ParameterTypeDescription
Parameter
score
Type
int
Description
No Description Provided

Name: stopSleeping

Return Type: void

ZenScript
Copy
// Player.stopSleeping() as void

myPlayer.stopSleeping();

Name: sweepAttack

Return Type: void

ZenScript
Copy
// Player.sweepAttack() as void

myPlayer.sweepAttack();
이름TypeHas GetterHas SetterDescription
이름
abilities
Type
Abilities
Has Getter
true
Has Setter
false
Description
No Description Provided
이름
canUseGameMasterBlocks
Type
boolean
Has Getter
true
Has Setter
false
Description
No Description Provided
이름
cooldowns
Type
ItemCooldowns
Has Getter
true
Has Setter
false
Description
No Description Provided
이름
currentItemAttackStrengthDelay
Type
float
Has Getter
true
Has Setter
false
Description
No Description Provided
이름
enchantmentSeed
Type
int
Has Getter
true
Has Setter
false
Description
No Description Provided
이름
foodData
Type
FoodData
Has Getter
true
Has Setter
false
Description
No Description Provided
이름
inventory
Type
Inventory
Has Getter
true
Has Setter
false
Description
No Description Provided
이름
isCreative
Type
boolean
Has Getter
true
Has Setter
false
Description
No Description Provided
이름
isHurt
Type
boolean
Has Getter
true
Has Setter
false
Description
No Description Provided
이름
isLocalPlayer
Type
boolean
Has Getter
true
Has Setter
false
Description
No Description Provided
이름
isReducedDebugInfo
Type
boolean
Has Getter
true
Has Setter
false
Description
No Description Provided
이름
isScoping
Type
boolean
Has Getter
true
Has Setter
false
Description
No Description Provided
이름
isSecondaryUseActive
Type
boolean
Has Getter
true
Has Setter
false
Description
No Description Provided
이름
isSleepingLongEnough
Type
boolean
Has Getter
true
Has Setter
false
Description
No Description Provided
이름
luck
Type
float
Has Getter
true
Has Setter
false
Description
No Description Provided
이름
mainArm
Type
HumanoidArm
Has Getter
true
Has Setter
false
Description
No Description Provided
이름
mayBuild
Type
boolean
Has Getter
true
Has Setter
false
Description
No Description Provided
이름
score
Type
int
Has Getter
true
Has Setter
false
Description
No Description Provided
이름
shoulderEntityLeft
Type
MapData
Has Getter
true
Has Setter
false
Description
No Description Provided
이름
shoulderEntityRight
Type
MapData
Has Getter
true
Has Setter
false
Description
No Description Provided
이름
sleepTimer
Type
int
Has Getter
true
Has Setter
false
Description
No Description Provided
이름
xpNeededForNextLevel
Type
int
Has Getter
true
Has Setter
false
Description
No Description Provided