Package com.ticxo.modelengine.api.entity

Class BukkitPlayer

java.lang.Object

com.ticxo.modelengine.api.entity.BukkitPlayer

All Implemented Interfaces:

BaseEntity<org.bukkit.entity.Player>

public class BukkitPlayer
extends Object
implements BaseEntity<org.bukkit.entity.Player>

Default implementation of BaseEntity to wrap the default bukkit's Player class.
This is mainly used for players to disguise themselves as a model.

Constructor Summary

Constructors

Constructor	Description
BukkitPlayer(@NotNull org.bukkit.entity.Player entity)

Method Summary

Modifier and Type	Method	Description
void	broadcastDespawnPacket()	Called when the target becomes invisible. For bukkit entities and players, use EntityHandler.broadcastDespawnPacket(BaseEntity, boolean)
void	broadcastSpawnPacket()	Called when the target becomes visible again. For bukkit entities and players, use EntityHandler.broadcastSpawnPacket(BaseEntity, boolean)
int	getEntityId()	Get the entity ID of this entity. If the target is not a bukkit entity, you have to be absolutely sure that this ID does not overlap with an existing entity, as it is used to identify interactions between models. Use EntityHandler.getEntityCounter() to generate unique integer ID if you are unsure.
org.bukkit.inventory.ItemStack	getItemInSlot(org.bukkit.inventory.EquipmentSlot slot)
org.bukkit.Location	getLocation()	Get the location of this entity.
List<org.bukkit.entity.Entity>	getPassengers()
UUID	getUniqueId()	Get the UUID of this entity. This UUID is used to retrieve the instance of ModeledEntity associated with this entity.
org.bukkit.World	getWorld()	Get the world of this entity.
float	getXHeadRot()
float	getYBodyRot()
float	getYHeadRot()
boolean	isDead()
boolean	isGlowing()
boolean	isMoving()
boolean	isOnGround()
boolean	onHurt(IDamageSource damageSource, float damage)	Called when a sub-hitbox of this entity detects an attack. For default bukkit behavior, use EntityHandler.hurt(Entity, IDamageSource, float).
void	onInteract(org.bukkit.entity.Player player, org.bukkit.inventory.EquipmentSlot hand)	Called when a sub-hitbox of this entity detects an interaction. For default bukkit behavior, use EntityHandler.interact(Entity, Player, EquipmentSlot).
void	setCollidableToLiving(org.bukkit.entity.LivingEntity living, boolean isRemove)	Configure whether the targeted living entity can collide with this entity
void	setHitbox(Hitbox hitbox)	Set the hitbox of this entity. For bukkit entities, use EntityHandler.setHitbox(Entity, Hitbox).
void	setStepHeight(double height)	Set the step height of this entity. For bukkit entities, use EntityHandler.setStepHeight(Entity, double)
void	setYBodyRot(float rot)
void	setYHeadRot(float rot)
BodyRotationController	wrapBodyRotationControl()	Create a wrapper for the body rotation control of this entity. For bukkit entities, wrap with EntityHandler.wrapBodyRotationControl(Entity).
LookController	wrapLookControl()	Create a wrapper for the look control of this entity. For bukkit entities, wrap with EntityHandler.wrapLookControl(Entity).
MoveController	wrapMoveControl()	Create a wrapper for the movement control of this entity. For bukkit entities, wrap with EntityHandler.wrapMoveControl(Entity).
void	wrapNavigation()	Patch Minecraft's faulty pathfinding to accept different hitbox sizes. For bukkit entities, wrap with EntityHandler.wrapNavigation(Entity).
RangeManager	wrapRangeManager(IModel model)	Create a wrapper for the render range manager of this entity. For bukkit entities, wrap with EntityHandler.wrapRangeManager(Entity).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.ticxo.modelengine.api.entity.BaseEntity

getHitbox, getModelHitbox, getOriginal, getRangeManager, getStepHeight

Constructor Details

BukkitPlayer

public BukkitPlayer(@NotNull
 @NotNull org.bukkit.entity.Player entity)

Method Details

wrapMoveControl

public MoveController wrapMoveControl()

Description copied from interface: BaseEntity

Create a wrapper for the movement control of this entity.
For bukkit entities, wrap with EntityHandler.wrapMoveControl(Entity).

Specified by:

wrapMoveControl in interface BaseEntity<org.bukkit.entity.Player>

wrapLookControl

public LookController wrapLookControl()

Description copied from interface: BaseEntity

Create a wrapper for the look control of this entity.
For bukkit entities, wrap with EntityHandler.wrapLookControl(Entity).

Specified by:

wrapLookControl in interface BaseEntity<org.bukkit.entity.Player>

wrapBodyRotationControl

public BodyRotationController wrapBodyRotationControl()

Description copied from interface: BaseEntity

Create a wrapper for the body rotation control of this entity.
For bukkit entities, wrap with EntityHandler.wrapBodyRotationControl(Entity).

Specified by:

wrapBodyRotationControl in interface BaseEntity<org.bukkit.entity.Player>

wrapNavigation

public void wrapNavigation()

Description copied from interface: BaseEntity

Patch Minecraft's faulty pathfinding to accept different hitbox sizes.
For bukkit entities, wrap with EntityHandler.wrapNavigation(Entity).

Specified by:

wrapNavigation in interface BaseEntity<org.bukkit.entity.Player>

wrapRangeManager

public RangeManager wrapRangeManager(IModel model)

Description copied from interface: BaseEntity

Create a wrapper for the render range manager of this entity.
For bukkit entities, wrap with EntityHandler.wrapRangeManager(Entity).

Specified by:

wrapRangeManager in interface BaseEntity<org.bukkit.entity.Player>

onHurt

public boolean onHurt(IDamageSource damageSource,
 float damage)

Description copied from interface: BaseEntity

Called when a sub-hitbox of this entity detects an attack.
For default bukkit behavior, use EntityHandler.hurt(Entity, IDamageSource, float).

Specified by:

onHurt in interface BaseEntity<org.bukkit.entity.Player>

Parameters:

damageSource - the damage source of this attack

damage - raw damage before reduction

Returns:

false to cancel the attack.

onInteract

public void onInteract(org.bukkit.entity.Player player,
 org.bukkit.inventory.EquipmentSlot hand)

Description copied from interface: BaseEntity

Called when a sub-hitbox of this entity detects an interaction.
For default bukkit behavior, use EntityHandler.interact(Entity, Player, EquipmentSlot).

Specified by:

onInteract in interface BaseEntity<org.bukkit.entity.Player>

Parameters:

player - the trigger

hand - hand used to interact

setHitbox

public void setHitbox(Hitbox hitbox)

Description copied from interface: BaseEntity

Set the hitbox of this entity.
For bukkit entities, use EntityHandler.setHitbox(Entity, Hitbox).

Specified by:

setHitbox in interface BaseEntity<org.bukkit.entity.Player>

setStepHeight

public void setStepHeight(double height)

Description copied from interface: BaseEntity

Set the step height of this entity.
For bukkit entities, use EntityHandler.setStepHeight(Entity, double)

Specified by:

setStepHeight in interface BaseEntity<org.bukkit.entity.Player>

Parameters:

height - height in blocks

setCollidableToLiving

public void setCollidableToLiving(org.bukkit.entity.LivingEntity living,
 boolean isRemove)

Description copied from interface: BaseEntity

Configure whether the targeted living entity can collide with this entity

Specified by:

setCollidableToLiving in interface BaseEntity<org.bukkit.entity.Player>

Parameters:

living - The targeted living entity

isRemove - Can be collided

broadcastSpawnPacket

public void broadcastSpawnPacket()

Description copied from interface: BaseEntity

Called when the target becomes visible again.
For bukkit entities and players, use EntityHandler.broadcastSpawnPacket(BaseEntity, boolean)

Specified by:

broadcastSpawnPacket in interface BaseEntity<org.bukkit.entity.Player>

broadcastDespawnPacket

public void broadcastDespawnPacket()

Description copied from interface: BaseEntity

Called when the target becomes invisible.
For bukkit entities and players, use EntityHandler.broadcastDespawnPacket(BaseEntity, boolean)

Specified by:

broadcastDespawnPacket in interface BaseEntity<org.bukkit.entity.Player>

getEntityId

public int getEntityId()

Description copied from interface: BaseEntity

Get the entity ID of this entity.
If the target is not a bukkit entity, you have to be absolutely sure that this ID does not overlap with an existing entity, as it is used to identify interactions between models.
Use EntityHandler.getEntityCounter() to generate unique integer ID if you are unsure.

Specified by:

getEntityId in interface BaseEntity<org.bukkit.entity.Player>

getUniqueId

public UUID getUniqueId()

Description copied from interface: BaseEntity

Get the UUID of this entity.
This UUID is used to retrieve the instance of ModeledEntity associated with this entity. See ModelEngineAPI.getModeledEntity(UUID).

Specified by:

getUniqueId in interface BaseEntity<org.bukkit.entity.Player>

getLocation

public org.bukkit.Location getLocation()

Description copied from interface: BaseEntity

Get the location of this entity.

Specified by:

getLocation in interface BaseEntity<org.bukkit.entity.Player>

getWorld

public org.bukkit.World getWorld()

Description copied from interface: BaseEntity

Get the world of this entity.

Specified by:

getWorld in interface BaseEntity<org.bukkit.entity.Player>

isDead

public boolean isDead()

Specified by:

isDead in interface BaseEntity<org.bukkit.entity.Player>

isGlowing

public boolean isGlowing()

Specified by:

isGlowing in interface BaseEntity<org.bukkit.entity.Player>

isOnGround

public boolean isOnGround()

Specified by:

isOnGround in interface BaseEntity<org.bukkit.entity.Player>

isMoving

public boolean isMoving()

Specified by:

isMoving in interface BaseEntity<org.bukkit.entity.Player>

setYHeadRot

public void setYHeadRot(float rot)

Specified by:

setYHeadRot in interface BaseEntity<org.bukkit.entity.Player>

getYHeadRot

public float getYHeadRot()

Specified by:

getYHeadRot in interface BaseEntity<org.bukkit.entity.Player>

getXHeadRot

public float getXHeadRot()

Specified by:

getXHeadRot in interface BaseEntity<org.bukkit.entity.Player>

setYBodyRot

public void setYBodyRot(float rot)

Specified by:

setYBodyRot in interface BaseEntity<org.bukkit.entity.Player>

getYBodyRot

public float getYBodyRot()

Specified by:

getYBodyRot in interface BaseEntity<org.bukkit.entity.Player>

getPassengers

public List<org.bukkit.entity.Entity> getPassengers()

Specified by:

getPassengers in interface BaseEntity<org.bukkit.entity.Player>

getItemInSlot

public org.bukkit.inventory.ItemStack getItemInSlot(org.bukkit.inventory.EquipmentSlot slot)

Specified by:

getItemInSlot in interface BaseEntity<org.bukkit.entity.Player>