Player - CraftTweaker Documentation

Version:

Language:

Home Commands Examples Getting Started With Scripts Global Keywords

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

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

Methods

addItem

Name: addItem

Return Type: boolean

ZenScript
 Copy
Player.addItem(stack as ItemStack) as boolean

Parameter	Type
Parameter stack	Type ItemStack

attack

Name: attack

ZenScript
 Copy
Player.attack(entity as Entity)

Parameter	Type
Parameter entity	Type Entity

awardStat

Name: awardStat

ZenScript
 Copy
Player.awardStat(stat as ResourceLocation)

Parameter	Type
Parameter stat	Type ResourceLocation

awardStat

Name: awardStat

ZenScript
 Copy
Player.awardStat(stat as ResourceLocation, amount as int)

Parameter	Type
Parameter stat	Type ResourceLocation
Parameter amount	Type int

canEat

Name: canEat

Return Type: boolean

ZenScript
 Copy
Player.canEat(ignoreHunger as boolean) as boolean

Parameter	Type
Parameter ignoreHunger	Type boolean

canHarmPlayer

Name: canHarmPlayer

Return Type: boolean

ZenScript
 Copy
Player.canHarmPlayer(player as Player) as boolean

Parameter	Type
Parameter player	Type Player

canUseGameMasterBlocks

Name: canUseGameMasterBlocks

Return Type: boolean

ZenScript
 Copy
// Player.canUseGameMasterBlocks() as boolean

myPlayer.canUseGameMasterBlocks();

causeFoodExhaustion

Name: causeFoodExhaustion

ZenScript
 Copy
Player.causeFoodExhaustion(exhaustion as float)

Parameter	Type
Parameter exhaustion	Type float

crit

Name: crit

ZenScript
 Copy
Player.crit(entity as Entity)

Parameter	Type
Parameter entity	Type Entity

disableShield

Name: disableShield

ZenScript
 Copy
Player.disableShield(usingAxe as boolean)

Parameter	Type
Parameter usingAxe	Type boolean

displayClientMessage

Name: displayClientMessage

ZenScript
 Copy
Player.displayClientMessage(component as Component, actionBar as boolean)

Parameter	Type
Parameter component	Type Component
Parameter actionBar	Type boolean

drop

Name: drop

Return Type: ItemEntity?

ZenScript
 Copy
Player.drop(stack as ItemStack, traceItem as boolean) as ItemEntity?

Parameter	Type
Parameter stack	Type ItemStack
Parameter traceItem	Type boolean

getAbilities

Name: getAbilities

Return Type: Abilities

ZenScript
 Copy
// Player.getAbilities() as Abilities

myPlayer.getAbilities();

getCooldowns

Name: getCooldowns

Return Type: ItemCooldowns

ZenScript
 Copy
// Player.getCooldowns() as ItemCooldowns

myPlayer.getCooldowns();

getCurrentItemAttackStrengthDelay

Name: getCurrentItemAttackStrengthDelay

Return Type: float

ZenScript
 Copy
// Player.getCurrentItemAttackStrengthDelay() as float

myPlayer.getCurrentItemAttackStrengthDelay();

getDestroySpeed

Name: getDestroySpeed

Return Type: float

ZenScript
 Copy
Player.getDestroySpeed(state as BlockState) as float

Parameter	Type
Parameter state	Type BlockState

getEnchantmentSeed

Name: getEnchantmentSeed

Return Type: int

ZenScript
 Copy
// Player.getEnchantmentSeed() as int

myPlayer.getEnchantmentSeed();

getExperienceLevel

Name: getExperienceLevel

Return Type: int

ZenScript
 Copy
// Player.getExperienceLevel() as int

myPlayer.getExperienceLevel();

getFoodData

Name: getFoodData

Return Type: FoodData

ZenScript
 Copy
// Player.getFoodData() as FoodData

myPlayer.getFoodData();

getInventory

Name: getInventory

Return Type: Inventory

ZenScript
 Copy
// Player.getInventory() as Inventory

myPlayer.getInventory();

getLuck

Name: getLuck

Return Type: float

ZenScript
 Copy
// Player.getLuck() as float

myPlayer.getLuck();

getMainArm

Name: getMainArm

Return Type: HumanoidArm

ZenScript
 Copy
// Player.getMainArm() as HumanoidArm

myPlayer.getMainArm();

getScore

Name: getScore

Return Type: int

ZenScript
 Copy
// Player.getScore() as int

myPlayer.getScore();

getShoulderEntityLeft

Name: getShoulderEntityLeft

Return Type: MapData

ZenScript
 Copy
// Player.getShoulderEntityLeft() as MapData

myPlayer.getShoulderEntityLeft();

getShoulderEntityRight

Name: getShoulderEntityRight

Return Type: MapData

ZenScript
 Copy
// Player.getShoulderEntityRight() as MapData

myPlayer.getShoulderEntityRight();

getSleepTimer

Name: getSleepTimer

Return Type: int

ZenScript
 Copy
// Player.getSleepTimer() as int

myPlayer.getSleepTimer();

getXpNeededForNextLevel

Name: getXpNeededForNextLevel

Return Type: int

ZenScript
 Copy
// Player.getXpNeededForNextLevel() as int

myPlayer.getXpNeededForNextLevel();

give

Name: give

ZenScript
 Copy
Player.give(stack as IItemStack, slot as int)

Parameter	Type	Optional	Default Value
Parameter stack	Type IItemStack	Optional false	Default Value
Parameter slot	Type int	Optional true	Default Value -1

giveExperienceLevels

Name: giveExperienceLevels

ZenScript
 Copy
Player.giveExperienceLevels(levels as int)

Parameter	Type
Parameter levels	Type int

giveExperiencePoints

Name: giveExperiencePoints

ZenScript
 Copy
Player.giveExperiencePoints(amount as int)

Parameter	Type
Parameter amount	Type int

hasCorrectToolForDrops

Name: hasCorrectToolForDrops

Return Type: boolean

ZenScript
 Copy
Player.hasCorrectToolForDrops(state as BlockState) as boolean

Parameter	Type
Parameter state	Type BlockState

increaseScore

Name: increaseScore

ZenScript
 Copy
Player.increaseScore(score as int)

Parameter	Type
Parameter score	Type int

isCreative

Name: isCreative

Return Type: boolean

ZenScript
 Copy
// Player.isCreative() as boolean

myPlayer.isCreative();

isHurt

Name: isHurt

Return Type: boolean

ZenScript
 Copy
// Player.isHurt() as boolean

myPlayer.isHurt();

isLocalPlayer

Name: isLocalPlayer

Return Type: boolean

ZenScript
 Copy
// Player.isLocalPlayer() as boolean

myPlayer.isLocalPlayer();

isReducedDebugInfo

Name: isReducedDebugInfo

Return Type: boolean

ZenScript
 Copy
// Player.isReducedDebugInfo() as boolean

myPlayer.isReducedDebugInfo();

isScoping

Name: isScoping

Return Type: boolean

ZenScript
 Copy
// Player.isScoping() as boolean

myPlayer.isScoping();

isSecondaryUseActive

Name: isSecondaryUseActive

Return Type: boolean

ZenScript
 Copy
// Player.isSecondaryUseActive() as boolean

myPlayer.isSecondaryUseActive();

isSleepingLongEnough

Name: isSleepingLongEnough

Return Type: boolean

ZenScript
 Copy
// Player.isSleepingLongEnough() as boolean

myPlayer.isSleepingLongEnough();

jumpFromGround

Name: jumpFromGround

ZenScript
 Copy
// Player.jumpFromGround()

myPlayer.jumpFromGround();

magicCrit

Name: magicCrit

ZenScript
 Copy
Player.magicCrit(entity as Entity)

Parameter	Type
Parameter entity	Type Entity

mayBuild

Name: mayBuild

Return Type: boolean

ZenScript
 Copy
// Player.mayBuild() as boolean

myPlayer.mayBuild();

playNotifySound

Name: playNotifySound

ZenScript
 Copy
Player.playNotifySound(event as SoundEvent, source as SoundSource, volume as float, pitch as float)

Parameter	Type
Parameter event	Type SoundEvent
Parameter source	Type SoundSource
Parameter volume	Type float
Parameter pitch	Type float

respawn

Name: respawn

ZenScript
 Copy
// Player.respawn()

myPlayer.respawn();

sendMessage

Name: sendMessage

ZenScript
 Copy
Player.sendMessage(text as Component)

Parameter	Type
Parameter text	Type Component

setEntityOnShoulder

Name: setEntityOnShoulder

Return Type: boolean

ZenScript
 Copy
Player.setEntityOnShoulder(entityData as MapData) as boolean

Parameter	Type
Parameter entityData	Type MapData

setExperienceLevel

Name: setExperienceLevel

ZenScript
 Copy
Player.setExperienceLevel(level as int)

Parameter	Type
Parameter level	Type int

setMainArm

Name: setMainArm

ZenScript
 Copy
Player.setMainArm(arm as HumanoidArm)

Parameter	Type
Parameter arm	Type HumanoidArm

setReducedDebugInfo

Name: setReducedDebugInfo

ZenScript
 Copy
Player.setReducedDebugInfo(reducedDebugInfo as boolean)

Parameter	Type
Parameter reducedDebugInfo	Type boolean

setScore

Name: setScore

ZenScript
 Copy
Player.setScore(score as int)

Parameter	Type
Parameter score	Type int

stopSleeping

Name: stopSleeping

ZenScript
 Copy
// Player.stopSleeping()

myPlayer.stopSleeping();

sweepAttack

Name: sweepAttack

ZenScript
 Copy
// Player.sweepAttack()

myPlayer.sweepAttack();

Properties

Name	Type	Has Getter	Has Setter	Description
Name abilities	Type Abilities	Has Getter true	Has Setter false	Description
Name canUseGameMasterBlocks	Type boolean	Has Getter true	Has Setter false	Description
Name cooldowns	Type ItemCooldowns	Has Getter true	Has Setter false	Description
Name currentItemAttackStrengthDelay	Type float	Has Getter true	Has Setter false	Description
Name enchantmentSeed	Type int	Has Getter true	Has Setter false	Description
Name experienceLevel	Type int	Has Getter true	Has Setter true	Description
Name foodData	Type FoodData	Has Getter true	Has Setter false	Description
Name inventory	Type Inventory	Has Getter true	Has Setter false	Description
Name isCreative	Type boolean	Has Getter true	Has Setter false	Description
Name isFakePlayer	Type boolean	Has Getter true	Has Setter false	Description Checks if this player is a fake player, mainly used for machines.
Name isHurt	Type boolean	Has Getter true	Has Setter false	Description
Name isLocalPlayer	Type boolean	Has Getter true	Has Setter false	Description
Name isReducedDebugInfo	Type boolean	Has Getter true	Has Setter false	Description
Name isScoping	Type boolean	Has Getter true	Has Setter false	Description
Name isSecondaryUseActive	Type boolean	Has Getter true	Has Setter false	Description
Name isSleepingLongEnough	Type boolean	Has Getter true	Has Setter false	Description
Name luck	Type float	Has Getter true	Has Setter false	Description
Name mainArm	Type HumanoidArm	Has Getter true	Has Setter false	Description
Name mayBuild	Type boolean	Has Getter true	Has Setter false	Description
Name score	Type int	Has Getter true	Has Setter false	Description
Name shoulderEntityLeft	Type MapData	Has Getter true	Has Setter false	Description
Name shoulderEntityRight	Type MapData	Has Getter true	Has Setter false	Description
Name sleepTimer	Type int	Has Getter true	Has Setter false	Description
Name xpNeededForNextLevel	Type int	Has Getter true	Has Setter false	Description