API Table Template - Windower/packages GitHub Wiki

Description of what the table is for.

local libname = require('libname')

local tablename = libname.tablename -- Exclude for library root tables

✔️ Dependency Not Required

This library does not require an explicit dependency in the manifest.xml file for your package.

❗ Dependency Required

To use this library, you must include libraryname in the manifest.xml file for your package:

<dependency>libraryname</dependency>

The libname.tablename table has the following entries:

• libname.tablename.entry1 : Description of the first table entry (function)
• libname.tablename.entry2 : Description of the second table entry (table)
• libname.tablename.entry3 : Description of third table entry (plain value)

Description of the function that is the first table entry.

// TypeScript formatted function definition
function libname.tablename.entry1(param1 : type1, param2 : type2 = 'default_value') : return_type

param1 type1

Description of parameter 1

param2 type2 [default: default_value]

Indicates the source of the command.

-- Lua example if necessary

entry1 return_type

Description of whatever the function returns.