Genisys  Genisys API 1.9.3
A server software for Minecraft: Pocket Edition with many features
Public Member Functions | Static Public Member Functions | Data Fields | Protected Member Functions | Protected Attributes
Human Class Reference
Inheritance diagram for Human:
[legend]
Collaboration diagram for Human:
[legend]

Public Member Functions

 getSkinData ()
 
 getSkinId ()
 
 getUniqueId ()
 
 getRawUniqueId ()
 
 setSkin ($str, $skinId)
 
 getFood ()
 
 setFood (float $new)
 
 getMaxFood ()
 
 addFood (float $amount)
 
 getSaturation ()
 
 setSaturation (float $saturation)
 
 addSaturation (float $amount)
 
 getExhaustion ()
 
 setExhaustion (float $exhaustion)
 
 exhaust (float $amount, int $cause=PlayerExhaustEvent::CAUSE_CUSTOM)
 
 getXpLevel ()
 
 setXpLevel (int $level)
 
 addXpLevel (int $level)
 
 takeXpLevel (int $level)
 
 getXpProgress ()
 
 setXpProgress (float $progress)
 
 getTotalXp ()
 
 setTotalXp (int $xp, bool $syncLevel=false)
 
 addXp (int $xp, bool $syncLevel=false)
 
 takeXp (int $xp, bool $syncLevel=false)
 
 getRemainderXp ()
 
 getFilledXp ()
 
 recalculateXpProgress ()
 
 getXpSeed ()
 
 resetXpCooldown ()
 
 canPickupXp ()
 
 getInventory ()
 
 getEnderChestInventory ()
 
 getFloatingInventory ()
 
 getTransactionQueue ()
 
 getAbsorption ()
 
 setAbsorption (int $absorption)
 
 entityBaseTick ($tickDiff=1, $EnchantL=0)
 
 getName ()
 
 getDrops ()
 
 saveNBT ()
 
 spawnTo (Player $player)
 
 despawnFrom (Player $player)
 
 close ()
 
- Public Member Functions inherited from Creature
 onUpdate ($tick)
 
 willMove ($distance=36)
 
 attack ($damage, EntityDamageEvent $source)
 
 ifjump (Level $level, Vector3 $v3, $hate=false, $reason=false)
 
 whatBlock (Level $level, $v3)
 
 getMyYaw ($mx, $mz)
 
 getMyPitch (Vector3 $from, Vector3 $to)
 
- Public Member Functions inherited from Living
 setHealth ($amount)
 
 saveNBT ()
 
 getName ()
 
 hasLineOfSight (Entity $entity)
 
 heal ($amount, EntityRegainHealthEvent $source)
 
 attack ($damage, EntityDamageEvent $source)
 
 knockBack (Entity $attacker, $damage, $x, $z, $base=0.4)
 
 kill ()
 
 entityBaseTick ($tickDiff=1, $EnchantL=0)
 
 getDrops ()
 
 getLineOfSight ($maxDistance, $maxLength=0, array $transparent=[])
 
 getTargetBlock ($maxDistance, array $transparent=[])
 
- Public Member Functions inherited from Entity
 __construct (Level $level, CompoundTag $nbt)
 
 getDropExpMin ()
 
 getDropExpMax ()
 
 getNameTag ()
 
 isNameTagVisible ()
 
 isNameTagAlwaysVisible ()
 
 setNameTag ($name)
 
 setNameTagVisible ($value=true)
 
 setNameTagAlwaysVisible ($value=true)
 
 getScale ()
 
 setScale (float $value)
 
 isSneaking ()
 
 setSneaking ($value=true)
 
 isSprinting ()
 
 setSprinting ($value=true)
 
 isImmobile ()
 
 setImmobile ($value=true)
 
 getEffects ()
 
 removeAllEffects ()
 
 removeEffect ($effectId)
 
 getEffect ($effectId)
 
 hasEffect ($effectId)
 
 addEffect (Effect $effect)
 
 getSaveId ()
 
 saveNBT ()
 
 getViewers ()
 
 spawnTo (Player $player)
 
 sendPotionEffects (Player $player)
 
 sendData ($player, array $data=null)
 
 despawnFrom (Player $player)
 
 attack ($damage, EntityDamageEvent $source)
 
 heal ($amount, EntityRegainHealthEvent $source)
 
 getHealth ()
 
 isAlive ()
 
 setHealth ($amount)
 
 setLastDamageCause (EntityDamageEvent $type)
 
 getLastDamageCause ()
 
 getAttributeMap ()
 
 getMaxHealth ()
 
 setMaxHealth ($amount)
 
 canCollideWith (Entity $entity)
 
 entityBaseTick ($tickDiff=1)
 
 getDirectionVector ()
 
 getDirectionPlane ()
 
 onUpdate ($currentTick)
 
 scheduleUpdate ()
 
 isOnFire ()
 
 setOnFire ($seconds)
 
 isFireProof ()
 
 getDirection ()
 
 extinguish ()
 
 canTriggerWalking ()
 
 resetFallDistance ()
 
 getBoundingBox ()
 
 fall ($fallDistance)
 
 handleLavaMovement ()
 
 getEyeHeight ()
 
 moveFlying ()
 
 onCollideWithPlayer (Human $entityPlayer)
 
 getPosition ()
 
 getLocation ()
 
 isInsideOfPortal ()
 
 isInsideOfWater ()
 
 isInsideOfSolid ()
 
 isInsideOfFire ()
 
 fastMove ($dx, $dy, $dz)
 
 move ($dx, $dy, $dz)
 
 getBlocksAround ()
 
 setPositionAndRotation (Vector3 $pos, $yaw, $pitch)
 
 setRotation ($yaw, $pitch)
 
 setLocation (Location $pos)
 
 setPosition (Vector3 $pos)
 
 getMotion ()
 
 setMotion (Vector3 $motion)
 
 isOnGround ()
 
 kill ()
 
 teleport (Vector3 $pos, $yaw=null, $pitch=null)
 
 getId ()
 
 respawnToAll ()
 
 spawnToAll ()
 
 despawnFromAll ()
 
 close ()
 
 setDataProperty ($id, $type, $value)
 
 linkEntity (Entity $entity)
 
 sendLinkedData ()
 
 setLinked ($type=0, Entity $entity)
 
 getLinkedEntity ()
 
 getLinkedType ()
 
 getDataProperty ($id)
 
 getDataPropertyType ($id)
 
 setDataFlag ($propertyId, $id, $value=true, $type=self::DATA_TYPE_LONG)
 
 getDataFlag ($propertyId, $id)
 
 setMetadata ($metadataKey, MetadataValue $metadataValue)
 
 getMetadata ($metadataKey)
 
 hasMetadata ($metadataKey)
 
 removeMetadata ($metadataKey, Plugin $plugin)
 
 __toString ()
 
- Public Member Functions inherited from Location
 __construct ($x=0, $y=0, $z=0, $yaw=0.0, $pitch=0.0, Level $level=null)
 
 add ($x, $y=0, $z=0, $yaw=0, $pitch=0)
 
 getYaw ()
 
 getPitch ()
 
 fromObjectAdd (Vector3 $pos, $x, $y, $z)
 
 __toString ()
 
- Public Member Functions inherited from Position
 __construct ($x=0, $y=0, $z=0, Level $level=null)
 
 add ($x, $y=0, $z=0)
 
 getLevel ()
 
 setLevel (Level $level=null)
 
 isValid ()
 
 getSide ($side, $step=1)
 
 __toString ()
 
 setComponents ($x, $y, $z)
 
 fromObjectAdd (Vector3 $pos, $x, $y, $z)
 
- Public Member Functions inherited from Vector3
 __construct ($x=0, $y=0, $z=0)
 
 getX ()
 
 getY ()
 
 getZ ()
 
 getFloorX ()
 
 getFloorY ()
 
 getFloorZ ()
 
 getRight ()
 
 getUp ()
 
 getForward ()
 
 getSouth ()
 
 getWest ()
 
 add ($x, $y=0, $z=0)
 
 subtract ($x=0, $y=0, $z=0)
 
 multiply ($number)
 
 divide ($number)
 
 ceil ()
 
 floor ()
 
 round ()
 
 abs ()
 
 getSide ($side, $step=1)
 
 distance (Vector3 $pos)
 
 distanceSquared (Vector3 $pos)
 
 maxPlainDistance ($x=0, $z=0)
 
 length ()
 
 lengthSquared ()
 
 normalize ()
 
 dot (Vector3 $v)
 
 cross (Vector3 $v)
 
 equals (Vector3 $v)
 
 getIntermediateWithXValue (Vector3 $v, $x)
 
 getIntermediateWithYValue (Vector3 $v, $y)
 
 getIntermediateWithZValue (Vector3 $v, $z)
 
 setComponents ($x, $y, $z)
 
 fromObjectAdd (Vector3 $pos, $x, $y, $z)
 
 __toString ()
 

Static Public Member Functions

static getTotalXpRequirement (int $level)
 
static getLevelXpRequirement (int $level)
 
static getLevelFromXp (int $xp)
 
- Static Public Member Functions inherited from Entity
static init ()
 
static createEntity ($type, Level $level, CompoundTag $nbt,...$args)
 
static registerEntity ($className, $force=false)
 
- Static Public Member Functions inherited from Location
static fromObject (Vector3 $pos, Level $level=null, $yaw=0.0, $pitch=0.0)
 
- Static Public Member Functions inherited from Position
static fromObject (Vector3 $pos, Level $level=null)
 
- Static Public Member Functions inherited from Vector3
static getOppositeSide (int $side)
 
static createRandomDirection (Random $random)
 

Data Fields

const DATA_PLAYER_FLAG_SLEEP = 1
 
const DATA_PLAYER_FLAG_DEAD = 2
 
const DATA_PLAYER_FLAGS = 27
 
const DATA_PLAYER_BED_POSITION = 29
 
 $width = 0.6
 
 $length = 0.6
 
 $height = 1.8
 
 $eyeHeight = 1.62
 
- Data Fields inherited from Creature
 $attackingTick = 0
 
- Data Fields inherited from Entity
const NETWORK_ID = -1
 
const DATA_TYPE_BYTE = 0
 
const DATA_TYPE_SHORT = 1
 
const DATA_TYPE_INT = 2
 
const DATA_TYPE_FLOAT = 3
 
const DATA_TYPE_STRING = 4
 
const DATA_TYPE_SLOT = 5
 
const DATA_TYPE_POS = 6
 
const DATA_TYPE_LONG = 7
 
const DATA_TYPE_VECTOR3F = 8
 
const DATA_FLAGS = 0
 
const DATA_VARIANT = 2
 
const DATA_COLOUR = 3
 
const DATA_NAMETAG = 4
 
const DATA_OWNER_EID = 5
 
const DATA_AIR = 7
 
const DATA_POTION_COLOR = 8
 
const DATA_POTION_AMBIENT = 9
 
const DATA_LEAD_HOLDER_EID = 38
 
const DATA_SCALE = 39
 
const DATA_INTERACTIVE_TAG = 40
 
const DATA_URL_TAG = 43
 
const DATA_MAX_AIR = 44
 
const DATA_MARK_VARIANT = 45
 
const DATA_BOUNDING_BOX_WIDTH = 54
 
const DATA_BOUNDING_BOX_HEIGHT = 55
 
const DATA_FUSE_LENGTH = 56
 
const DATA_AREA_EFFECT_CLOUD_RADIUS = 61
 
const DATA_AREA_EFFECT_CLOUD_WAITING = 62
 
const DATA_AREA_EFFECT_CLOUD_PARTICLE_ID = 63
 
const DATA_TRADING_PLAYER_EID = 68
 
const DATA_FLAG_ONFIRE = 0
 
const DATA_FLAG_SNEAKING = 1
 
const DATA_FLAG_RIDING = 2
 
const DATA_FLAG_SPRINTING = 3
 
const DATA_FLAG_ACTION = 4
 
const DATA_FLAG_INVISIBLE = 5
 
const DATA_FLAG_TEMPTED = 6
 
const DATA_FLAG_INLOVE = 7
 
const DATA_FLAG_SADDLED = 8
 
const DATA_FLAG_POWERED = 9
 
const DATA_FLAG_IGNITED = 10
 
const DATA_FLAG_BABY = 11
 
const DATA_FLAG_CONVERTING = 12
 
const DATA_FLAG_CRITICAL = 13
 
const DATA_FLAG_CAN_SHOW_NAMETAG = 14
 
const DATA_FLAG_ALWAYS_SHOW_NAMETAG = 15
 
const DATA_FLAG_IMMOBILE = 16
 
const DATA_FLAG_NO_AI = 16
 
const DATA_FLAG_SILENT = 17
 
const DATA_FLAG_WALLCLIMBING = 18
 
const DATA_FLAG_RESTING = 19
 
const DATA_FLAG_SITTING = 20
 
const DATA_FLAG_ANGRY = 21
 
const DATA_FLAG_INTERESTED = 22
 
const DATA_FLAG_CHARGED = 23
 
const DATA_FLAG_TAMED = 24
 
const DATA_FLAG_LEASHED = 25
 
const DATA_FLAG_SHEARED = 26
 
const DATA_FLAG_GLIDING = 27
 
const DATA_FLAG_FALL_FLYING = 27
 
const DATA_FLAG_ELDER = 28
 
const DATA_FLAG_MOVING = 29
 
const DATA_FLAG_BREATHING = 30
 
const DATA_FLAG_CHESTED = 31
 
const DATA_FLAG_STACKABLE = 32
 
const DATA_FLAG_IDLING = 36
 
const SOUTH = 0
 
const WEST = 1
 
const NORTH = 2
 
const EAST = 3
 
 $passenger = null
 
 $vehicle = null
 
 $chunk
 
 $lastX = null
 
 $lastY = null
 
 $lastZ = null
 
 $motionX
 
 $motionY
 
 $motionZ
 
 $temporalVector
 
 $lastMotionX
 
 $lastMotionY
 
 $lastMotionZ
 
 $lastYaw
 
 $lastPitch
 
 $boundingBox
 
 $onGround
 
 $inBlock = false
 
 $positionChanged
 
 $motionChanged
 
 $deadTicks = 0
 
 $height
 
 $eyeHeight = null
 
 $width
 
 $length
 
 $keepMovement = false
 
 $fallDistance = 0
 
 $ticksLived = 0
 
 $lastUpdate
 
 $maxFireTicks
 
 $fireTicks = 0
 
 $namedtag
 
 $canCollide = true
 
 $isCollided = false
 
 $isCollidedHorizontally = false
 
 $isCollidedVertically = false
 
 $noDamageTicks
 
 $closed = false
 
 $dropExp = [0, 0]
 
- Data Fields inherited from Location
 $yaw
 
 $pitch
 
- Data Fields inherited from Position
 $level = null
 
- Data Fields inherited from Vector3
const SIDE_DOWN = 0
 
const SIDE_UP = 1
 
const SIDE_NORTH = 2
 
const SIDE_SOUTH = 3
 
const SIDE_WEST = 4
 
const SIDE_EAST = 5
 
 $x
 
 $y
 
 $z
 

Protected Member Functions

 initEntity ()
 
 addAttributes ()
 
- Protected Member Functions inherited from Living
 initEntity ()
 
- Protected Member Functions inherited from Entity
 recalculateEffectColor ()
 
 initEntity ()
 
 addAttributes ()
 
 checkObstruction ($x, $y, $z)
 
 updateMovement ()
 
 updateFallState ($distanceThisTick, $onGround)
 
 switchLevel (Level $targetLevel)
 
 checkGroundState ($movX, $movY, $movZ, $dx, $dy, $dz)
 
 checkChunks ()
 

Protected Attributes

 $inventory
 
 $enderChestInventory
 
 $floatingInventory
 
 $transactionQueue = null
 
 $uuid
 
 $rawUUID
 
 $skinId
 
 $skin
 
 $foodTickTimer = 0
 
 $totalXp = 0
 
 $xpSeed
 
 $xpCooldown = 0
 
- Protected Attributes inherited from Living
 $gravity = 0.08
 
 $drag = 0.02
 
 $attackTime = 0
 
 $invisible = false
 
- Protected Attributes inherited from Entity
 $hasSpawned = []
 
 $effects = []
 
 $id
 
 $dataFlags = 0
 
 $dataProperties
 
 $lastDamageCause = null
 
 $age = 0
 
 $ySize = 0
 
 $stepHeight = 0
 
 $isStatic = false
 
 $justCreated
 
 $attributeMap
 
 $gravity
 
 $drag
 
 $server
 
 $timings
 
 $isPlayer = false
 
 $linkedEntity = null
 
 $linkedType = null
 
 $riding = null
 
 $activatedPressurePlates = []
 

Additional Inherited Members

- Static Public Attributes inherited from Entity
static $entityCount = 1
 

Member Function Documentation

exhaust ( float  $amount,
int  $cause = PlayerExhaustEvent::CAUSE_CUSTOM 
)

Increases a human's exhaustion level.

Parameters
float$amount
int$cause
Returns
float the amount of exhaustion level increased
getInventory ( )

Get the object related inventory

Returns
Inventory

Implements InventoryHolder.

static getLevelFromXp ( int  $xp)
static

Converts a quantity of exp into a level and a progress percentage

Parameters
int$xp
Returns
int[]

These values are correct up to and including level 16

Modify the coefficients to fit the relevant equation

Levels 16-31

Level 32+

static getLevelXpRequirement ( int  $level)
static

Returns the amount of exp required to complete the specified level.

Parameters
int$level
Returns
int
getRawUniqueId ( )
Returns
string
static getTotalXpRequirement ( int  $level)
static

Returns the total amount of exp required to reach the specified level.

Parameters
int$level
Returns
int
getUniqueId ( )
Returns
UUID|null
setExhaustion ( float  $exhaustion)

WARNING: This method does not check if exhausted and does not consume saturation/food. Use Human::exhaust() for this purpose.

Parameters
float$exhaustion
setFood ( float  $new)

WARNING: This method does not check if full and may throw an exception if out of bounds. Use Human::addFood() for this purpose

Parameters
float$new
Exceptions
setSaturation ( float  $saturation)

WARNING: This method does not check if saturated and may throw an exception if out of bounds. Use Human::addSaturation() for this purpose

Parameters
float$saturation
Exceptions
setSkin (   $str,
  $skinId 
)
Parameters
string$str
string$skinId
setTotalXp ( int  $xp,
bool  $syncLevel = false 
)

Changes the total exp of a player

Parameters
int$xp
bool$syncLevelThis will reset the level to be in sync with the total. Usually you don't want to do this, because it'll mess up use of xp in anvils and enchanting tables.
Returns
bool
The documentation for this class was generated from the following file: