Hyra provides a Roblox Lua wrapper for its Order Logging system
The Hyra Order Logging API is an advanced, real-time solution for monitoring and managing the lifecycle of an order. It offers comprehensive visibility from the moment an order is placed to when it’s ready for pickup, tracking each participant involved.
Hyra provides some out of the box solutions for order logging for popular solutions.
Each order must have a status associated with it. Depending on your system, you may decide to use different statuses. The following statuses are available:
handed_to
- The order has been handed to the customersubmitted
- The order has been submitted by the cashierwaiting_for_preparation
- The order is waiting for preparation by a chef or other staff memberfinding_new_colleague
- The order is waiting for a new colleague to take over preparation (for example, if the previous chef left the game)preparing
- The order is being prepared by a chef or other staff membercompleted
- The order has been completedwaiting_for_pickup
- The order is waiting for pickup by the customer or a delivery personcancelled
- The order has been cancelledThe module used for Order Logging is stateful and persists its authentication state with the Hyra API. If you use a single script order solution, you can directly require the module as follows:
If you use multiple scripts, you can create a module script exporter. You need one of these to maintain the state of the module across several scripts.
To authenticate, input your unique apiKey
and workspaceId
at the beginning of your main script:
You only need to do this once per game server.
Creating an order
To log a new order, input the customer and actor as player objects, along
with an argument table that can include an array of items
and the initial
status
.
The customer
and the actor
are both Player instances.
Updating order status
Using the unique order id
(not the order_number) you can update the status of an order