Skip to content

static class ItemsGround (server-side)

Available since version: 0.1.0

This class represents item ground manager.

Properties

No properties.


Methods

getById

Available since version: 0.3.0

This method will retrieve the item ground object by its unique id.

ItemGround getById(int itemGroundId)

Parameters:

  • int itemGroundId: the unique item ground id.

Returns ItemGround:

the item ground object or null if the object cannot be found.


create

Available since version: 0.3.0

This method will create the item ground.

int create({instance, amount=1, physicsEnabled=false position={x=0,y=0,z=0}, rotation={x=0,y=0,z=0}, world=CONFIG_WORLD, virtualWorld=0}  arg)

Parameters:

  • {instance, amount=1, physicsEnabled=false position={x=0,y=0,z=0}, rotation={x=0,y=0,z=0}, world=CONFIG_WORLD, virtualWorld=0} arg:
    • string arg.instance: the scripting instance of game item.
    • int arg.amount: the item amount of the item ground.
    • bool arg.physicsEnabled: the physics state of the item ground.
    • table arg.position: the position of the item ground in the world.
    • table arg.rotation: the rotation of the item ground in the world.
    • string arg.world: the world the item ground is in (.ZEN file path).
    • int arg.virtualWorld: the virtual world id in range <0, 65535>.

Returns int:

the item ground id.


destroy

This method will destroy the item ground by it's unique id.

void destroy(int itemGroundId)

Parameters:

  • int itemGroundId: the item ground unique id.