Input Manager

The input manager provides an easy to use API for adding input binding to your mod.

Pressing ctrl+p to fast-forward time to the next day.

lua

local inputManager = mjrequire "hammerstone/input/inputManager"

Using Input Manager

The input system in Sapiens is fully rebindable, so we have to use strings to keep track of inputs. Input can also be grouped together.

The built in groups for Sapiens are as follows:

When adding a key mapping, you have to use one of these groups:

lua

inputManager:addMapping("groupName", ...)

Hammerstone has support for adding a group like this:

lua

inputManager:addGroup("groupName")

Sapiens uses key codes instead of strings to determine default keys. The keyCodes and modifiers can be accessed with:

lua

local keyMapping = mjrequire "mainThread/keyMapping"
local keyCodes = keyMapping.keyCodes
local modifiers = keyMapping.modifiers

Full list of all keycodes

Full list of modifiers

The full process for adding a mapping is as follows. First, add the mapping:

lua

inputManager:addMapping("groupName", "keyBindName", keyCodes.[default key], modifiers.[modifier] or 0)

Then, bind a function to it:

lua

inputManager:addKeyChangedCallback("groupName", "keyBindName", function (isDown, isRepeat)
   -- Do whatever you want
end)

Everything should be working now!