API Documentation

API Information

Type: BindableFunction Location: Engine -> API Execution method:

API:Invoke("CommandName", ...) -- additional arguments can be added

API Commands

AreProductsRegistered

Returns a boolean if all products have been successfully registered by the system.

FindProductUPIFromName

RETURNS NIL IF PRODUCTS NOT REGISTERED

Returns the product's Unique Product Identifier (UPI) as a number. Product's name required as first argument.

GetProductInfo

RETURNS NIL IF PRODUCTS NOT REGISTERED

Returns a Table with stock information about a product. Product's Unique Product Identifier (UPI) required as first argument.

Response:

Name

string

UniqueProductIdentifier

number

MaxStock

number

RemainingStock

number

GetProducts

RETURNS NIL IF PRODUCTS NOT REGISTERED

Returns a Dictionary with stock information for all products registered in the system. Refer to GetProductInfo for response.

Restock

RETURNS NIL IF PRODUCTS NOT REGISTERED

Restocks a product. Product's folder required as first argument. An Player can optionally be as the second argument if restocker whitelist is enabled.