Player

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.

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

Return Type: boolean

Player.addItem(stack as ItemStack) as boolean

Parameter	Type
Parameter stack	Type ItemStack

attack

Player.attack(entity as Entity)

Parameter	Type
Parameter entity	Type Entity

awardStat

Player.awardStat(stat as ResourceLocation)

Parameter	Type
Parameter stat	Type ResourceLocation

awardStat

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

Parameter	Type
Parameter stat	Type ResourceLocation
Parameter amount	Type int

canEat

Return Type: boolean

Player.canEat(ignoreHunger as boolean) as boolean

Parameter	Type
Parameter ignoreHunger	Type boolean

canHarmPlayer

Return Type: boolean

Player.canHarmPlayer(player as Player) as boolean

Parameter	Type
Parameter player	Type Player

canUseGameMasterBlocks

Return Type: boolean

// Player.canUseGameMasterBlocks() as boolean

myPlayer.canUseGameMasterBlocks();

causeFoodExhaustion

Player.causeFoodExhaustion(exhaustion as float)

Parameter	Type
Parameter exhaustion	Type float

crit

Player.crit(entity as Entity)

Parameter	Type
Parameter entity	Type Entity

disableShield

Player.disableShield(usingAxe as boolean)

Parameter	Type
Parameter usingAxe	Type boolean

displayClientMessage

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

Parameter	Type
Parameter component	Type Component
Parameter actionBar	Type boolean

drop

Return Type: ItemEntity?

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

Parameter	Type
Parameter stack	Type ItemStack
Parameter traceItem	Type boolean

getAbilities

Return Type: Abilities

// Player.getAbilities() as Abilities

myPlayer.getAbilities();

getCooldowns

Return Type: ItemCooldowns

// Player.getCooldowns() as ItemCooldowns

myPlayer.getCooldowns();

getCurrentItemAttackStrengthDelay

Return Type: float

// Player.getCurrentItemAttackStrengthDelay() as float

myPlayer.getCurrentItemAttackStrengthDelay();

getDestroySpeed

Return Type: float

Player.getDestroySpeed(state as BlockState) as float

Parameter	Type
Parameter state	Type BlockState

getEnchantmentSeed

Return Type: int

// Player.getEnchantmentSeed() as int

myPlayer.getEnchantmentSeed();

getExperienceLevel

Return Type: int

// Player.getExperienceLevel() as int

myPlayer.getExperienceLevel();

getFoodData

Return Type: FoodData

// Player.getFoodData() as FoodData

myPlayer.getFoodData();

getInventory

Return Type: Inventory

// Player.getInventory() as Inventory

myPlayer.getInventory();

getLuck

Return Type: float

// Player.getLuck() as float

myPlayer.getLuck();

getMainArm

Return Type: HumanoidArm

// Player.getMainArm() as HumanoidArm

myPlayer.getMainArm();

getScore

Return Type: int

// Player.getScore() as int

myPlayer.getScore();

getShoulderEntityLeft

Return Type: MapData

// Player.getShoulderEntityLeft() as MapData

myPlayer.getShoulderEntityLeft();

getShoulderEntityRight

Return Type: MapData

// Player.getShoulderEntityRight() as MapData

myPlayer.getShoulderEntityRight();

getSleepTimer

Return Type: int

// Player.getSleepTimer() as int

myPlayer.getSleepTimer();

getXpNeededForNextLevel

Return Type: int

// Player.getXpNeededForNextLevel() as int

myPlayer.getXpNeededForNextLevel();

give

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

Player.giveExperienceLevels(levels as int)

Parameter	Type
Parameter levels	Type int

giveExperiencePoints

Player.giveExperiencePoints(amount as int)

Parameter	Type
Parameter amount	Type int

hasCorrectToolForDrops

Return Type: boolean

Player.hasCorrectToolForDrops(state as BlockState) as boolean

Parameter	Type
Parameter state	Type BlockState

increaseScore

Player.increaseScore(score as int)

Parameter	Type
Parameter score	Type int

isCreative

Return Type: boolean

// Player.isCreative() as boolean

myPlayer.isCreative();

isHurt

Return Type: boolean

// Player.isHurt() as boolean

myPlayer.isHurt();

isLocalPlayer

Return Type: boolean

// Player.isLocalPlayer() as boolean

myPlayer.isLocalPlayer();

isReducedDebugInfo

Return Type: boolean

// Player.isReducedDebugInfo() as boolean

myPlayer.isReducedDebugInfo();

isScoping

Return Type: boolean

// Player.isScoping() as boolean

myPlayer.isScoping();

isSecondaryUseActive

Return Type: boolean

// Player.isSecondaryUseActive() as boolean

myPlayer.isSecondaryUseActive();

isSleepingLongEnough

Return Type: boolean

// Player.isSleepingLongEnough() as boolean

myPlayer.isSleepingLongEnough();

jumpFromGround

// Player.jumpFromGround()

myPlayer.jumpFromGround();

magicCrit

Player.magicCrit(entity as Entity)

Parameter	Type
Parameter entity	Type Entity

mayBuild

Return Type: boolean

// Player.mayBuild() as boolean

myPlayer.mayBuild();

playNotifySound

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

// Player.respawn()

myPlayer.respawn();

sendMessage

Player.sendMessage(text as Component)

Parameter	Type
Parameter text	Type Component

setEntityOnShoulder

Return Type: boolean

Player.setEntityOnShoulder(entityData as MapData) as boolean

Parameter	Type
Parameter entityData	Type MapData

setExperienceLevel

Player.setExperienceLevel(level as int)

Parameter	Type
Parameter level	Type int

setMainArm

Player.setMainArm(arm as HumanoidArm)

Parameter	Type
Parameter arm	Type HumanoidArm

setReducedDebugInfo

Player.setReducedDebugInfo(reducedDebugInfo as boolean)

Parameter	Type
Parameter reducedDebugInfo	Type boolean

setScore

Player.setScore(score as int)

Parameter	Type
Parameter score	Type int

stopSleeping

// Player.stopSleeping()

myPlayer.stopSleeping();

sweepAttack

// Player.sweepAttack()

myPlayer.sweepAttack();

Properties

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