Skip to content

uLua Documentation v1.0.0

Compare
Choose a tag to compare
@atrapalis atrapalis released this 03 Jul 08:46
· 12 commits to main since this release

uLua is a Game API framework for Unity. It aims to streamline the development of a Game API in Lua for your Unity Project.

uLua wraps around MoonSharp and provides an object oriented framework for API development in Lua.
It works by setting up an application-wide Lua context and exposing game objects to it.
Objects exposed to Lua can then be accessed in Lua scripts to implement game behaviour.
In addition, user-defined Lua scripts may be executed at runtime to allow modding of your project.

uLua implements the following features:

  • Script execution framework which allows Lua scripts to be executed from the Resources folder or an external directory.
  • Event handling system which allows you to invoke events in C# and handle them in Lua.
  • Base classes which expose your game objects and data structures to Lua in order to develop your Game API.
  • Callback function system for your Game API objects.