MCPlayerEntity - CraftTweaker Documentation

Version:

Language:

Home Migration Guide 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.player.MCPlayerEntity;

Extending MCLivingEntity

MCPlayerEntity extends MCLivingEntity. That means all methods available in MCLivingEntity are also available in MCPlayerEntity

Methods

addExhaustion

Name: addExhaustion

Return Type: void

ZenScript
 Copy
MCPlayerEntity.addExhaustion(exhaustion as float) as void

Parameter	Type	Description
Parameter exhaustion	Type float	Description No Description Provided

addExperienceLevels

Name: addExperienceLevels

Return Type: void

ZenScript
 Copy
MCPlayerEntity.addExperienceLevels(levels as int) as void

Parameter	Type	Description
Parameter levels	Type int	Description No Description Provided

canUseCommandBlock

Name: canUseCommandBlock

Return Type: boolean

ZenScript
 Copy
// MCPlayerEntity.canUseCommandBlock() as boolean

myMCPlayerEntity.canUseCommandBlock();

drop

Name: drop

Return Type: boolean

ZenScript
 Copy
MCPlayerEntity.drop(p_225609_1_ as boolean) as boolean

Parameter	Type	Description
Parameter p_225609_1_	Type boolean	Description No Description Provided

getCurrentItem

Name: getCurrentItem

Return Type: IItemStack

ZenScript
 Copy
// MCPlayerEntity.getCurrentItem() as IItemStack

myMCPlayerEntity.getCurrentItem();

getExperience

Name: getExperience

Return Type: float

ZenScript
 Copy
// MCPlayerEntity.getExperience() as float

myMCPlayerEntity.getExperience();

getExperienceLevel

Name: getExperienceLevel

Return Type: int

ZenScript
 Copy
// MCPlayerEntity.getExperienceLevel() as int

myMCPlayerEntity.getExperienceLevel();

getExperienceTotal

Name: getExperienceTotal

Return Type: int

ZenScript
 Copy
// MCPlayerEntity.getExperienceTotal() as int

myMCPlayerEntity.getExperienceTotal();

getFoodLevel

Name: getFoodLevel

Return Type: int

ZenScript
 Copy
// MCPlayerEntity.getFoodLevel() as int

myMCPlayerEntity.getFoodLevel();

getHeldItem

Name: getHeldItem

Return Type: IItemStack

ZenScript
 Copy
MCPlayerEntity.getHeldItem(hand as MCHand) as IItemStack

Parameter	Type	Description
Parameter hand	Type MCHand	Description No Description Provided

getInventory

Name: getInventory

Return Type: PlayerInventory

ZenScript
 Copy
// MCPlayerEntity.getInventory() as PlayerInventory

myMCPlayerEntity.getInventory();

getInventoryItemStack

Name: getInventoryItemStack

Return Type: IItemStack

ZenScript
 Copy
MCPlayerEntity.getInventoryItemStack(slotIndex as int) as IItemStack

Parameter	Type	Description
Parameter slotIndex	Type int	Description No Description Provided

getLuck

Name: getLuck

Return Type: float

ZenScript
 Copy
// MCPlayerEntity.getLuck() as float

myMCPlayerEntity.getLuck();

getMaxInPortalTime

Name: getMaxInPortalTime

Return Type: int

ZenScript
 Copy
// MCPlayerEntity.getMaxInPortalTime() as int

myMCPlayerEntity.getMaxInPortalTime();

getName

Name: getName

Return Type: MCTextComponent

ZenScript
 Copy
// MCPlayerEntity.getName() as MCTextComponent

myMCPlayerEntity.getName();

getPersistentData

Name: getPersistentData

Gets the persisted NBT tag that is saved between deaths. Many mods use this to keep track of if they have given the player an item or not.

Return Type: MapData

ZenScript
 Copy
// MCPlayerEntity.getPersistentData() as MapData

myMCPlayerEntity.getPersistentData();

getPortalCooldown

Name: getPortalCooldown

Return Type: int

ZenScript
 Copy
// MCPlayerEntity.getPortalCooldown() as int

myMCPlayerEntity.getPortalCooldown();

getSaturationLevel

Name: getSaturationLevel

Return Type: float

ZenScript
 Copy
// MCPlayerEntity.getSaturationLevel() as float

myMCPlayerEntity.getSaturationLevel();

getSleepTimer

Name: getSleepTimer

Return Type: int

ZenScript
 Copy
// MCPlayerEntity.getSleepTimer() as int

myMCPlayerEntity.getSleepTimer();

give

Name: give

Return Type: void

ZenScript
 Copy
MCPlayerEntity.give(stack as IItemStack) as void

Parameter	Type	Description
Parameter stack	Type IItemStack	Description No Description Provided

giveExperiencePoints

Name: giveExperiencePoints

Return Type: void

ZenScript
 Copy
MCPlayerEntity.giveExperiencePoints(experience as int) as void

Parameter	Type	Description
Parameter experience	Type int	Description No Description Provided

isCreative

Name: isCreative

Return Type: boolean

ZenScript
 Copy
// MCPlayerEntity.isCreative() as boolean

myMCPlayerEntity.isCreative();

isFake

Name: isFake

Return Type: boolean

ZenScript
 Copy
// MCPlayerEntity.isFake() as boolean

myMCPlayerEntity.isFake();

isPushedByWater

Name: isPushedByWater

Return Type: boolean

ZenScript
 Copy
// MCPlayerEntity.isPushedByWater() as boolean

myMCPlayerEntity.isPushedByWater();

isSecondaryUseActive

Name: isSecondaryUseActive

Return Type: boolean

ZenScript
 Copy
// MCPlayerEntity.isSecondaryUseActive() as boolean

myMCPlayerEntity.isSecondaryUseActive();

isSpectator

Name: isSpectator

Return Type: boolean

ZenScript
 Copy
// MCPlayerEntity.isSpectator() as boolean

myMCPlayerEntity.isSpectator();

isSwimming

Name: isSwimming

Return Type: boolean

ZenScript
 Copy
// MCPlayerEntity.isSwimming() as boolean

myMCPlayerEntity.isSwimming();

isUser

Name: isUser

Return Type: boolean

ZenScript
 Copy
// MCPlayerEntity.isUser() as boolean

myMCPlayerEntity.isUser();

needFood

Name: needFood

Return Type: boolean

ZenScript
 Copy
// MCPlayerEntity.needFood() as boolean

myMCPlayerEntity.needFood();

sendMessage

Name: sendMessage

Return Type: void

ZenScript
 Copy
MCPlayerEntity.sendMessage(text as MCTextComponent) as void

Parameter	Type	Description
Parameter text	Type MCTextComponent	Description No Description Provided

sendStatusMessage

Name: sendStatusMessage

Return Type: void

ZenScript
 Copy
MCPlayerEntity.sendStatusMessage(text as MCTextComponent, actionBar as boolean) as void

Parameter	Type	Description
Parameter text	Type MCTextComponent	Description No Description Provided
Parameter actionBar	Type boolean	Description No Description Provided

setFoodLevel

Name: setFoodLevel

Return Type: void

ZenScript
 Copy
MCPlayerEntity.setFoodLevel(value as int) as void

Parameter	Type	Description
Parameter value	Type int	Description No Description Provided

swing

Name: swing

Return Type: void

ZenScript
 Copy
MCPlayerEntity.swing(hand as MCHand, updateSelf as boolean) as void

Parameter	Type	Description
Parameter hand	Type MCHand	Description No Description Provided
Parameter updateSelf	Type boolean	Description No Description Provided

unlockRecipes

Name: unlockRecipes

Return Type: void

ZenScript
 Copy
MCPlayerEntity.unlockRecipes(p_193102_1_ as MCResourceLocation[]) as void

Parameter	Type	Description
Parameter p_193102_1_	Type MCResourceLocation[]	Description No Description Provided

updatePersistentData

Name: updatePersistentData

Updates the player's persisted data that is saved between deaths.

Return Type: void

ZenScript
 Copy
MCPlayerEntity.updatePersistentData(data as MapData) as void

Parameter	Type	Description
Parameter data	Type MapData	Description No Description Provided

wakeUp

Name: wakeUp

Return Type: void

ZenScript
 Copy
// MCPlayerEntity.wakeUp() as void

myMCPlayerEntity.wakeUp();

Properties

Name	Type	Has Getter	Has Setter	Description
Name experience	Type float	Has Getter true	Has Setter false	Description No Description Provided
Name experienceLevel	Type int	Has Getter true	Has Setter false	Description No Description Provided
Name experienceTotal	Type int	Has Getter true	Has Setter false	Description No Description Provided
Name fake	Type boolean	Has Getter true	Has Setter false	Description No Description Provided
Name foodLevel	Type int	Has Getter true	Has Setter true	Description No Description Provided
Name inventory	Type PlayerInventory	Has Getter true	Has Setter false	Description No Description Provided
Name name	Type MCTextComponent	Has Getter true	Has Setter false	Description No Description Provided
Name saturationLevel	Type float	Has Getter true	Has Setter false	Description No Description Provided