Package com.ticxo.modelengine.api.entity

Class Dummy

java.lang.Object

com.ticxo.modelengine.api.entity.Dummy

All Implemented Interfaces:

BaseEntity<Object>

public class Dummy
extends Object
implements BaseEntity<Object>

Default implementation of BaseEntity that does not wrap anything and have all aspects controllable.
This is mainly used to spawn player-specific models, inanimate objects, or extended to implement custom logic.
Since this wrapper does not exist in the world, it would not automatically add or remove players from the list of viewers. Use ManualRangeManager to modify the viewer list.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Dummy.InteractAtHandler

Constructor Summary

Constructors

Constructor	Description
Dummy(int entityId, UUID uuid)	Do not use this constructor unless you know what you are doing. Use ModelEngineAPI.createDummy() or ModelEngineAPI.createDummy(UUID) instead.

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)
org.bukkit.inventory.ItemStack	getItemInSlot(org.bukkit.inventory.EquipmentSlot slot)
Object	getOriginal()	Get the wrapped target.
Double	getStepHeight()	Get the step height of this entity.
org.bukkit.World	getWorld()	Get the world of this entity.
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	onInteractAt(org.bukkit.entity.Player player, org.bukkit.inventory.EquipmentSlot hand, org.bukkit.util.Vector position)
void	setCollidableToLiving(org.bukkit.entity.LivingEntity living, boolean flag)	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)
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

getEntityId, getHitbox, getLocation, getModelHitbox, getPassengers, getRangeManager, getUniqueId, getXHeadRot, getYBodyRot, getYHeadRot, isDead, isGlowing, isMoving, isOnGround, setYBodyRot, setYHeadRot

Constructor Details

Dummy

public Dummy(int entityId,
 UUID uuid)

Do not use this constructor unless you know what you are doing.
Use ModelEngineAPI.createDummy() or ModelEngineAPI.createDummy(UUID) instead.

Method Details

getOriginal

public Object getOriginal()

Description copied from interface: BaseEntity

Get the wrapped target.

Specified by:

getOriginal in interface BaseEntity<Object>

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<Object>

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<Object>

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<Object>

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<Object>

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<Object>

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<Object>

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<Object>

Parameters:

player - the trigger

hand - hand used to interact

onInteractAt

public void onInteractAt(org.bukkit.entity.Player player,
 org.bukkit.inventory.EquipmentSlot hand,
 org.bukkit.util.Vector position)

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<Object>

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<Object>

Parameters:

height - height in blocks

getStepHeight

public Double getStepHeight()

Description copied from interface: BaseEntity

Get the step height of this entity.

Specified by:

getStepHeight in interface BaseEntity<Object>

Returns:

the step height, or null if it could not be determined.

setCollidableToLiving

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

Description copied from interface: BaseEntity

Configure whether the targeted living entity can collide with this entity

Specified by:

setCollidableToLiving in interface BaseEntity<Object>

Parameters:

living - The targeted living entity

flag - 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<Object>

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<Object>

getWorld

public org.bukkit.World getWorld()

Description copied from interface: BaseEntity

Get the world of this entity.

Specified by:

getWorld in interface BaseEntity<Object>

getItemInSlot

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

Specified by:

getItemInSlot in interface BaseEntity<Object>