LuaAPI/plugins

General

A plugin is a Lua script loaded via the command-line option --plugin that runs as a coroutine in parallel with the game UI. Examples of their use in mainline are the host.lua and join.lua scripts which are used during CI to test hosting and joining a game through the multiplayer lobby.

Within the script, data from the game is retrieved via coroutine.yield() which returns three values: events, context, and info:

events, context, info = coroutine.yield()

Events

A table of events the plugin manager has been made aware of, with each event containing the event name in the [1] index and the event data in the [2] index.

Chat

Currently there is only the chat event, which occurs when a chat message or a whisper is sent and contains the following attributes:

• sender - String. The player sending the message.
• message - String. The message being sent.
• whisper - Boolean. Whether the message was sent as a whisper or as a general chat message.

Context

This object contains various functions which can be called to change or set data (mutators). The different contexts available are listed below.

Game

context.save_game

• 🔌 context.save_game(config)

Triggers a save of the game. The config argument must have an attribute filename, which will be the filename of the resulting save file.

context.save_replay

• 🔌 context.save_replay(config)

Saves a replay of the game. The config argument must have an attribute filename, which will be the filename of the resulting replay file.

context.quit

• 🔌 context.quit(config)

Leaves the currently joined game. The config argument provided should be an empty table.

Info

This object contains the name attribute which identifies which context the game is currently in, as well as various functions to retrieve data (accessors) based on the current context which are listed below.

Game

info.scenario_name

• 🔌 info.scenario_name().scenario_name → string

Returns the name of the current scenario. This is the translatable name as shown on the UI.