Skip to content

static class ItemGroundManager (server-side)

Static lookup and creation API for synchronized ground items.

Properties

No properties.


Methods

static getById

Available since version: 0.3.0

Returns a ground item by id.

ItemGround|nil getById(number id)

Parameters:

  • number id: Ground item id.

Returns ItemGround|nil:

Ground item object or nil if missing.


static destroy

Available since version: 0.3.0

Destroys a synchronized ground item.

boolean destroy(number|ItemGround itemGround)

Parameters:

  • number|ItemGround itemGround: Ground item id or object.

Returns boolean:

True if the ground item was destroyed.


static create

Creates a synchronized ground item.

number|nil, table|nil create(table options)

Parameters:

  • table options: instance, amount, physicsEnabled, position, rotationDegrees, world and virtualWorld.

Returns number|nil, table|nil:

Ground item id and nil on success; nil and {message = string} on failure.


Callbacks

No callbacks.