io.lurkers.server.scripting.interfaces.lua

Class LuaEntity

java.lang.Object

io.lurkers.server.scripting.interfaces.lua.LuaEntity

public class LuaEntity
extends java.lang.Object

Lua interface for entities. This is not the actual Entity class itself. TODO: Add actual Lua Entity class to Lua reference.

Constructor Summary

Constructors

Constructor and Description
LuaEntity()

Method Summary

Modifier and Type	Method and Description
static AnyDeathListener	addAnyDeathListener(LuaClosure closure) Adds a listener which is triggered when any entity dies.
DeathListener	addDeathListener(Entity entity, LuaClosure closure) Adds a listener which is triggered when the entity dies.
DisposeListener	addDisposeListener(Entity entity, LuaClosure closure) Adds a listener which is triggered when the entity is disposed.
static void	addInventoryItems(Entity entity, LuaTable inventoryTable)
static void	delete(Entity entity) Deletes the provided entity without triggering kill effects.
static void	die(Entity entity) Immediately kill the provided entity.
static void	dispose()
static int	getDepth(PhysicalEntity physicalEntity) Returns the entity depth in meters below surface level.
static LuaTable	getEntities() Returns all the entities
static LuaTable	getEntitiesByType(java.lang.String type) Returns all the entities by type
static LuaTable	getEntitiesOfTypeInRange(Entity entity, java.lang.String type, float range) Returns a lua table of entities of a specific type within a range from this entity
static LuaTable	getEntitiesOfTypeInRange(Vector2 worldPosition, java.lang.String type, float range, PhysicalEntity ignoreEntity)
static Entity	getEntityById(int id)
static float	getNearestPlayer(Vector2 position) Returns the distance to the nearest player
static Peer	getPeer()
static Entity	getPlayer()
static Vector2	getRandomBotSpawn(PhysicalEntity physicalEntity, java.lang.String entityTypeToSpawn, boolean allowUndergroundSpawn)
static void	hurt(Entity entity, float damage) Applies damage to an entity.
static boolean	isA(Entity entity, java.lang.String type) Returns true if the entity is of the type provided.
static boolean	isUnderground(PhysicalEntity physicalEntity)
static PhysicalEntity	prepareNewPhysicalEntity(java.lang.String type, Vector2 position, LuaTable inventoryTable)
static void	register(Entity entity) Spawns the entity into the world.
static void	setAI(Living living, java.lang.String ai, float viewRange)
static void	setBaseAI(Living living)
static void	setSheepAI(Living living)
static void	setZombieAI(Living living)
static Entity	spawnPhysicalEntity(java.lang.String type, Vector2 position) Spawns an entity into the level
static Entity	spawnPhysicalEntity(java.lang.String type, Vector2 position, LuaTable inventoryTable)
static Entity	spawnPhysicalEntity(java.lang.String type, Vector2 position, LuaTable inventoryTable, Peer peer) Spawns an entity into the level
static Entity	spawnPhysicalEntityLuaPeer(java.lang.String type, Vector2 position, LuaTable inventoryTable, Peer peer)
static Shop	spawnShop(Vector2 position, Vector2 size, LuaTable inventoryTable, boolean hasInfiniteSupply, boolean receivesPayments, java.lang.String title) Spawns a shop into the level
static void	updateSkin(Peer peer, PhysicalEntity physicalEntity)

Methods inherited from class java.lang.Object

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

Constructor Detail

LuaEntity

public LuaEntity()

Method Detail

spawnPhysicalEntity

public static Entity spawnPhysicalEntity(java.lang.String type,
                                         Vector2 position)

Spawns an entity into the level

Parameters:

type - A string such as "Player", "Sheep", "Zombie"

position - Where the entity is spawned

spawnPhysicalEntity

public static Entity spawnPhysicalEntity(java.lang.String type,
                                         Vector2 position,
                                         LuaTable inventoryTable)

spawnPhysicalEntityLuaPeer

public static Entity spawnPhysicalEntityLuaPeer(java.lang.String type,
                                                Vector2 position,
                                                LuaTable inventoryTable,
                                                Peer peer)

spawnPhysicalEntity

public static Entity spawnPhysicalEntity(java.lang.String type,
                                         Vector2 position,
                                         LuaTable inventoryTable,
                                         Peer peer)

Spawns an entity into the level

Parameters:

type - A string such as "Player", "Sheep", "Zombie"

position - Where the entity is spawned

inventoryTable - Provide a custom inventory

updateSkin

public static void updateSkin(Peer peer,
                              PhysicalEntity physicalEntity)

spawnShop

public static Shop spawnShop(Vector2 position,
                             Vector2 size,
                             LuaTable inventoryTable,
                             boolean hasInfiniteSupply,
                             boolean receivesPayments,
                             java.lang.String title)

Spawns a shop into the level

Parameters:

position - Where the shop is spawned

size - The size of the shop

inventoryTable - The inventory of the shop

hasInfiniteSupply - If the shop has an infinite supply or not

receivesPayments - If the shop receives payments from buyers or not

title - Title of the shop

prepareNewPhysicalEntity

public static PhysicalEntity prepareNewPhysicalEntity(java.lang.String type,
                                                      Vector2 position,
                                                      LuaTable inventoryTable)
                                               throws ReflectionException

Throws:

ReflectionException

register

public static void register(Entity entity)

Spawns the entity into the world. If an entity already exists with the same ID, the entity is not registered.

Parameters:

entity -

addInventoryItems

public static void addInventoryItems(Entity entity,
                                     LuaTable inventoryTable)

addAnyDeathListener

public static AnyDeathListener addAnyDeathListener(LuaClosure closure)

Adds a listener which is triggered when any entity dies.

Parameters:

closure - The callback function to be triggered upon an entity death. The first argument passed will be the entity who killed this entity, if applicable, the second argument is the victim.

addDeathListener

public DeathListener addDeathListener(Entity entity,
                                      LuaClosure closure)

Adds a listener which is triggered when the entity dies.

Parameters:

closure - The callback function to be triggered upon the entity death. The first argument passed will be the entity who killed this entity, if applicable.

addDisposeListener

public DisposeListener addDisposeListener(Entity entity,
                                          LuaClosure closure)

Adds a listener which is triggered when the entity is disposed.

Parameters:

closure - The callback function to be triggered upon the entity disposal.

setZombieAI

public static void setZombieAI(Living living)

setSheepAI

public static void setSheepAI(Living living)

setBaseAI

public static void setBaseAI(Living living)

setAI

public static void setAI(Living living,
                         java.lang.String ai,
                         float viewRange)

dispose

public static void dispose()

getEntities

public static LuaTable getEntities()

Returns all the entities

Returns:

getPeer

public static Peer getPeer()

getPlayer

public static Entity getPlayer()

getEntitiesByType

public static LuaTable getEntitiesByType(java.lang.String type)

Returns all the entities by type

Returns:

getEntityById

public static Entity getEntityById(int id)

Parameters:

id -

Returns:

Returns an entity by the provided ID.

isA

public static boolean isA(Entity entity,
                          java.lang.String type)

Returns true if the entity is of the type provided. Example: `human:isA('Living')` will return true.

Parameters:

type -

Returns:

getEntitiesOfTypeInRange

public static LuaTable getEntitiesOfTypeInRange(Entity entity,
                                                java.lang.String type,
                                                float range)
                                         throws ReflectionException

Returns a lua table of entities of a specific type within a range from this entity

Parameters:

type - The entity type

range - The max range

Throws:

ReflectionException

getEntitiesOfTypeInRange

public static LuaTable getEntitiesOfTypeInRange(Vector2 worldPosition,
                                                java.lang.String type,
                                                float range,
                                                PhysicalEntity ignoreEntity)
                                         throws ReflectionException

Throws:

ReflectionException

getRandomBotSpawn

public static Vector2 getRandomBotSpawn(PhysicalEntity physicalEntity,
                                        java.lang.String entityTypeToSpawn,
                                        boolean allowUndergroundSpawn)

Returns:

Returns an open ground space at the edge of the players viewport. Returns null if no open ground space was found.

isUnderground

public static boolean isUnderground(PhysicalEntity physicalEntity)

getDepth

public static int getDepth(PhysicalEntity physicalEntity)

Returns the entity depth in meters below surface level.

Parameters:

physicalEntity -

Returns:

die

public static void die(Entity entity)

Immediately kill the provided entity.

Parameters:

entity -

delete

public static void delete(Entity entity)

Deletes the provided entity without triggering kill effects.

Parameters:

entity -

hurt

public static void hurt(Entity entity,
                        float damage)

Applies damage to an entity. Set to negative to heal.

Parameters:

entity -

damage -

getNearestPlayer

public static float getNearestPlayer(Vector2 position)

Returns the distance to the nearest player

Parameters:

position - The position to check against

Returns:

Distance to nearest player, or Float.MAX_VALUE if none found