Player
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
Return Type: boolean
Player.addItem(stack as ItemStack) as boolean
Parameter | Type |
---|---|
Parameter stack | Type ItemStack |
Player.attack(entity as Entity)
Parameter | Type |
---|---|
Parameter entity | Type Entity |
Player.awardStat(stat as ResourceLocation)
Parameter | Type |
---|---|
Parameter stat | Type ResourceLocation |
Player.awardStat(stat as ResourceLocation, amount as int)
Parameter | Type |
---|---|
Parameter stat | Type ResourceLocation |
Parameter amount | Type int |
Return Type: boolean
Player.canEat(ignoreHunger as boolean) as boolean
Parameter | Type |
---|---|
Parameter ignoreHunger | Type boolean |
Return Type: boolean
Player.canHarmPlayer(player as Player) as boolean
Parameter | Type |
---|---|
Parameter player | Type Player |
Return Type: boolean
// Player.canUseGameMasterBlocks() as boolean
myPlayer.canUseGameMasterBlocks();
Player.causeFoodExhaustion(exhaustion as float)
Parameter | Type |
---|---|
Parameter exhaustion | Type float |
Player.crit(entity as Entity)
Parameter | Type |
---|---|
Parameter entity | Type Entity |
Player.disableShield(usingAxe as boolean)
Parameter | Type |
---|---|
Parameter usingAxe | Type boolean |
Player.displayClientMessage(component as Component, actionBar as boolean)
Parameter | Type |
---|---|
Parameter component | Type Component |
Parameter actionBar | Type boolean |
Return Type: ItemEntity?
Player.drop(stack as ItemStack, traceItem as boolean) as ItemEntity?
Parameter | Type |
---|---|
Parameter stack | Type ItemStack |
Parameter traceItem | Type boolean |
Return Type: Abilities
// Player.getAbilities() as Abilities
myPlayer.getAbilities();
Return Type: ItemCooldowns
// Player.getCooldowns() as ItemCooldowns
myPlayer.getCooldowns();
Return Type: float
// Player.getCurrentItemAttackStrengthDelay() as float
myPlayer.getCurrentItemAttackStrengthDelay();
Return Type: float
Player.getDestroySpeed(state as BlockState) as float
Parameter | Type |
---|---|
Parameter state | Type BlockState |
Return Type: int
// Player.getEnchantmentSeed() as int
myPlayer.getEnchantmentSeed();
Return Type: int
// Player.getExperienceLevel() as int
myPlayer.getExperienceLevel();
Return Type: FoodData
// Player.getFoodData() as FoodData
myPlayer.getFoodData();
Return Type: Inventory
// Player.getInventory() as Inventory
myPlayer.getInventory();
Return Type: float
// Player.getLuck() as float
myPlayer.getLuck();
Return Type: HumanoidArm
// Player.getMainArm() as HumanoidArm
myPlayer.getMainArm();
Return Type: int
// Player.getScore() as int
myPlayer.getScore();
Return Type: MapData
// Player.getShoulderEntityLeft() as MapData
myPlayer.getShoulderEntityLeft();
Return Type: MapData
// Player.getShoulderEntityRight() as MapData
myPlayer.getShoulderEntityRight();
Return Type: int
// Player.getSleepTimer() as int
myPlayer.getSleepTimer();
Return Type: int
// Player.getXpNeededForNextLevel() as int
myPlayer.getXpNeededForNextLevel();
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 |
Player.giveExperienceLevels(levels as int)
Parameter | Type |
---|---|
Parameter levels | Type int |
Player.giveExperiencePoints(amount as int)
Parameter | Type |
---|---|
Parameter amount | Type int |
Return Type: boolean
Player.hasCorrectToolForDrops(state as BlockState) as boolean
Parameter | Type |
---|---|
Parameter state | Type BlockState |
Player.increaseScore(score as int)
Parameter | Type |
---|---|
Parameter score | Type int |
Return Type: boolean
// Player.isCreative() as boolean
myPlayer.isCreative();
Return Type: boolean
// Player.isHurt() as boolean
myPlayer.isHurt();
Return Type: boolean
// Player.isLocalPlayer() as boolean
myPlayer.isLocalPlayer();
Return Type: boolean
// Player.isReducedDebugInfo() as boolean
myPlayer.isReducedDebugInfo();
Return Type: boolean
// Player.isScoping() as boolean
myPlayer.isScoping();
Return Type: boolean
// Player.isSecondaryUseActive() as boolean
myPlayer.isSecondaryUseActive();
Return Type: boolean
// Player.isSleepingLongEnough() as boolean
myPlayer.isSleepingLongEnough();
// Player.jumpFromGround()
myPlayer.jumpFromGround();
Player.magicCrit(entity as Entity)
Parameter | Type |
---|---|
Parameter entity | Type Entity |
Return Type: boolean
// Player.mayBuild() as boolean
myPlayer.mayBuild();
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 |
// Player.respawn()
myPlayer.respawn();
Player.sendMessage(text as Component)
Parameter | Type |
---|---|
Parameter text | Type Component |
Return Type: boolean
Player.setEntityOnShoulder(entityData as MapData) as boolean
Parameter | Type |
---|---|
Parameter entityData | Type MapData |
Player.setExperienceLevel(level as int)
Parameter | Type |
---|---|
Parameter level | Type int |
Player.setMainArm(arm as HumanoidArm)
Parameter | Type |
---|---|
Parameter arm | Type HumanoidArm |
Player.setReducedDebugInfo(reducedDebugInfo as boolean)
Parameter | Type |
---|---|
Parameter reducedDebugInfo | Type boolean |
Player.setScore(score as int)
Parameter | Type |
---|---|
Parameter score | Type int |
// Player.stopSleeping()
myPlayer.stopSleeping();
// 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 |