Player - CraftTweaker Documentation

Version:

Language:

Home Getting Started With Scripts Commands Examples

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	Description
Parameter stack	Type ItemStack	Description No Description Provided

attack

Name: attack

Return Type: void

ZenScript
 Copy
Player.attack(entity as Entity) as void

Parameter	Type	Description
Parameter entity	Type Entity	Description No Description Provided

awardStat

Name: awardStat

Return Type: void

ZenScript
 Copy
Player.awardStat(stat as ResourceLocation) as void

Parameter	Type	Description
Parameter stat	Type ResourceLocation	Description No Description Provided

awardStat

Name: awardStat

Return Type: void

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

Parameter	Type	Description
Parameter stat	Type ResourceLocation	Description No Description Provided
Parameter amount	Type int	Description No Description Provided

canEat

Name: canEat

Return Type: boolean

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

Parameter	Type	Description
Parameter ignoreHunger	Type boolean	Description No Description Provided

canHarmPlayer

Name: canHarmPlayer

Return Type: boolean

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

Parameter	Type	Description
Parameter player	Type Player	Description No Description Provided

canUseGameMasterBlocks

Name: canUseGameMasterBlocks

Return Type: boolean

ZenScript
 Copy
// Player.canUseGameMasterBlocks() as boolean

myPlayer.canUseGameMasterBlocks();

causeFoodExhaustion

Name: causeFoodExhaustion

Return Type: void

ZenScript
 Copy
Player.causeFoodExhaustion(exhaustion as float) as void

Parameter	Type	Description
Parameter exhaustion	Type float	Description No Description Provided

crit

Name: crit

Return Type: void

ZenScript
 Copy
Player.crit(entity as Entity) as void

Parameter	Type	Description
Parameter entity	Type Entity	Description No Description Provided

disableShield

Name: disableShield

Return Type: void

ZenScript
 Copy
Player.disableShield(usingAxe as boolean) as void

Parameter	Type	Description
Parameter usingAxe	Type boolean	Description No Description Provided

displayClientMessage

Name: displayClientMessage

Return Type: void

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

Parameter	Type	Description
Parameter component	Type Component	Description No Description Provided
Parameter actionBar	Type boolean	Description No Description Provided

drop

Name: drop

Return Type: ItemEntity

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

Parameter	Type	Description
Parameter stack	Type ItemStack	Description No Description Provided
Parameter traceItem	Type boolean	Description No Description Provided

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	Description
Parameter state	Type BlockState	Description No Description Provided

getEnchantmentSeed

Name: getEnchantmentSeed

Return Type: int

ZenScript
 Copy
// Player.getEnchantmentSeed() as int

myPlayer.getEnchantmentSeed();

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

Return Type: void

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

Parameter	Type	Description	Optional	DefaultValue
Parameter stack	Type IItemStack	Description No Description Provided	Optional false	DefaultValue
Parameter slot	Type int	Description No Description Provided	Optional true	DefaultValue -1

giveExperienceLevels

Name: giveExperienceLevels

Return Type: void

ZenScript
 Copy
Player.giveExperienceLevels(levels as int) as void

Parameter	Type	Description
Parameter levels	Type int	Description No Description Provided

giveExperiencePoints

Name: giveExperiencePoints

Return Type: void

ZenScript
 Copy
Player.giveExperiencePoints(amount as int) as void

Parameter	Type	Description
Parameter amount	Type int	Description No Description Provided

hasCorrectToolForDrops

Name: hasCorrectToolForDrops

Return Type: boolean

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

Parameter	Type	Description
Parameter state	Type BlockState	Description No Description Provided

increaseScore

Name: increaseScore

Return Type: void

ZenScript
 Copy
Player.increaseScore(score as int) as void

Parameter	Type	Description
Parameter score	Type int	Description No Description Provided

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

Return Type: void

ZenScript
 Copy
// Player.jumpFromGround() as void

myPlayer.jumpFromGround();

magicCrit

Name: magicCrit

Return Type: void

ZenScript
 Copy
Player.magicCrit(entity as Entity) as void

Parameter	Type	Description
Parameter entity	Type Entity	Description No Description Provided

mayBuild

Name: mayBuild

Return Type: boolean

ZenScript
 Copy
// Player.mayBuild() as boolean

myPlayer.mayBuild();

playNotifySound

Name: playNotifySound

Return Type: void

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

Parameter	Type	Description
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

respawn

Name: respawn

Return Type: void

ZenScript
 Copy
// Player.respawn() as void

myPlayer.respawn();

sendMessage

Name: sendMessage

Return Type: void

ZenScript
 Copy
Player.sendMessage(text as Component) as void

Parameter	Type	Description
Parameter text	Type Component	Description No Description Provided

setEntityOnShoulder

Name: setEntityOnShoulder

Return Type: boolean

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

Parameter	Type	Description
Parameter entityData	Type MapData	Description No Description Provided

setMainArm

Name: setMainArm

Return Type: void

ZenScript
 Copy
Player.setMainArm(arm as HumanoidArm) as void

Parameter	Type	Description
Parameter arm	Type HumanoidArm	Description No Description Provided

setReducedDebugInfo

Name: setReducedDebugInfo

Return Type: void

ZenScript
 Copy
Player.setReducedDebugInfo(reducedDebugInfo as boolean) as void

Parameter	Type	Description
Parameter reducedDebugInfo	Type boolean	Description No Description Provided

setScore

Name: setScore

Return Type: void

ZenScript
 Copy
Player.setScore(score as int) as void

Parameter	Type	Description
Parameter score	Type int	Description No Description Provided

stopSleeping

Name: stopSleeping

Return Type: void

ZenScript
 Copy
// Player.stopSleeping() as void

myPlayer.stopSleeping();

sweepAttack

Name: sweepAttack

Return Type: void

ZenScript
 Copy
// Player.sweepAttack() as void

myPlayer.sweepAttack();

Properties

Name	Type	Has Getter	Has Setter	Description
Name abilities	Type Abilities	Has Getter true	Has Setter false	Description No Description Provided
Name canUseGameMasterBlocks	Type boolean	Has Getter true	Has Setter false	Description No Description Provided
Name cooldowns	Type ItemCooldowns	Has Getter true	Has Setter false	Description No Description Provided
Name currentItemAttackStrengthDelay	Type float	Has Getter true	Has Setter false	Description No Description Provided
Name enchantmentSeed	Type int	Has Getter true	Has Setter false	Description No Description Provided
Name foodData	Type FoodData	Has Getter true	Has Setter false	Description No Description Provided
Name inventory	Type Inventory	Has Getter true	Has Setter false	Description No Description Provided
Name isCreative	Type boolean	Has Getter true	Has Setter false	Description No Description Provided
Name isHurt	Type boolean	Has Getter true	Has Setter false	Description No Description Provided
Name isLocalPlayer	Type boolean	Has Getter true	Has Setter false	Description No Description Provided
Name isReducedDebugInfo	Type boolean	Has Getter true	Has Setter false	Description No Description Provided
Name isScoping	Type boolean	Has Getter true	Has Setter false	Description No Description Provided
Name isSecondaryUseActive	Type boolean	Has Getter true	Has Setter false	Description No Description Provided
Name isSleepingLongEnough	Type boolean	Has Getter true	Has Setter false	Description No Description Provided
Name luck	Type float	Has Getter true	Has Setter false	Description No Description Provided
Name mainArm	Type HumanoidArm	Has Getter true	Has Setter false	Description No Description Provided
Name mayBuild	Type boolean	Has Getter true	Has Setter false	Description No Description Provided
Name score	Type int	Has Getter true	Has Setter false	Description No Description Provided
Name shoulderEntityLeft	Type MapData	Has Getter true	Has Setter false	Description No Description Provided
Name shoulderEntityRight	Type MapData	Has Getter true	Has Setter false	Description No Description Provided
Name sleepTimer	Type int	Has Getter true	Has Setter false	Description No Description Provided
Name xpNeededForNextLevel	Type int	Has Getter true	Has Setter false	Description No Description Provided