grandma3-tstl-plugin

grandMA3 TypeScriptToLua Plugin

a TypeScriptToLua plugin that allows for direct export to grandMA3 compatible Lua files

install for production

npm install -D grandMA3-tstl-plugin

install for development

git clone https://github.com/LightYourWay/grandMA3-tstl-plugin.git && \
cd <your-plugin-folder> && \
npm link ../grandMA3-tstl-plugin

integrate into tsconfig.json

{
    "tstl": {
        "luaPlugins": [
            { "name": "grandMA3-tstl-plugin" }
        ]
    }
}

usage example

// ****************************************************************
// plugin main entry point 
// ****************************************************************
local function Main(display_handle: number, argument: any) {

}

// ****************************************************************
// plugin exit cleanup entry point 
// ****************************************************************
local function Cleanup() {

}

// ****************************************************************
// plugin execute entry point 
// ****************************************************************
local function Execute(Type: string, ...args: any[]) {

}

// ****************************************************************
// return the entry points of this plugin
// ****************************************************************
export = [Main, Cleanup, Execute]

transpiles to:

local function Main(display_handle, argument)
end

local function Cleanup()
end

local function Execute(Type, ...)
end

return Main, Cleanup, Execute