Introduction

This documentation provides comprehensive information about the available APIs and functions to help you create powerful scripts.

Getting Started

If you're new to this Lua API, here are some recommended places to start:

1. Review the Engine API to understand core functionality and callbacks

2. Explore the Rendering API for creating visual elements

3. Check out the Input API to handle user interaction

4. Browse through game-specific APIs in the Game-Specific APIs section

Lua Environment Information

General Information

• Lua Version: 5.4.6

• Script Location: All Lua scripts must be stored in Documents/MyGames

• Asset Location: Files created using file-based APIs (e.g., render.create_bitmap_from_file(file_name)) must also be saved in Documents/MyGames

Available Libraries

Our Lua environment provides access to:

• Standard Lua libraries (string, table, math, etc.)

• Custom APIs for game interaction

• Memory and process manipulation

• Rendering and GUI capabilities

• File system access

• Network communication

Script Execution

Scripts are executed in a sandboxed environment with access to our custom APIs. The environment provides a balance between flexibility and security, allowing you to create powerful tools while maintaining system integrity.

Script Examples

Throughout the documentation, you'll find practical examples demonstrating how to use different APIs. These examples can be adapted and combined to create more complex functionality.

Security Notice

Please review our Security Warning document for important information about script security and best practices to protect your system.

Support

If you encounter any issues or have questions about the API, please refer to the documentation first. Most common questions are answered within these pages.

We hope you enjoy using our Lua API to create amazing scripts and tools!