Module entityutil

Provides various utility methods for manipulating entities.

Functions

is_builtin_item (entity) Checks the given entity if it is a builtin item.
move_to (entity, position, acceleration_x, acceleration_y, acceleration_z) Moves the given entity towards the given point by setting its velocity into the correct direction.

Fields

BUILTIN_ITEM_NAME The name of builtin items.


Functions

is_builtin_item (entity)
Checks the given entity if it is a builtin item.

Parameters:

  • entity The entity to test.

Returns:

    true if the given entity is a builtin item.
move_to (entity, position, acceleration_x, acceleration_y, acceleration_z)
Moves the given entity towards the given point by setting its velocity into the correct direction.

Parameters:

  • entity The entity to move, a LuaEntitySAO.
  • position The position to move the entity towards.
  • acceleration_x Optional. The acceleration to use in the x direction, defaults to 1.
  • acceleration_y Optional. The acceleration to use in the y direction, defaults to acceleration_x.
  • acceleration_z Optional. The acceleration to use in the x direction, defaults to acceleration_x.

Fields

BUILTIN_ITEM_NAME
The name of builtin items.
generated by LDoc 1.4.2