Table of Contents

SquidStd.Scripting.Lua

Lua scripting for SquidStd. Hosts a Lua engine (IScriptEngineService) that exposes .NET methods to scripts through attribute-decorated modules, bridges events to the SquidStd event bus, ships built-in modules (logging, events, random), generates .luarc typings/docs, and supports init scripts, constants, and callbacks.

Install

dotnet add package SquidStd.Scripting.Lua

Usage

using DryIoc;
using SquidStd.Generators.Scripting.Lua;
using SquidStd.Scripting.Lua.Attributes;
using SquidStd.Scripting.Lua.Attributes.Scripts;
using SquidStd.Scripting.Lua.Extensions.Scripts;

[RegisterScriptModule]
[ScriptModule("math2")]
public sealed class MathModule
{
    [ScriptFunction("add")]
    public int Add(int a, int b) => a + b;
}

var container = new Container();
container.RegisterGeneratedScriptModules();
// Resolve IScriptEngineService to load and execute scripts that call math2.add(1, 2).

Key types

Type Purpose
IScriptEngineService Lua engine: load/run scripts, register modules/constants/callbacks.
ILuaEventBridge Bridges Lua scripts to the event bus.
ScriptModuleAttribute / ScriptFunctionAttribute Expose .NET classes/methods to Lua.
RegisterScriptModuleAttribute Marks script modules for generated registration.
AddScriptModuleExtension RegisterScriptModule<T>() / RegisterLuaUserData<T>().

License

MIT — part of SquidStd.

Edit this page