Comment on page
⌨

InputService

Service for tracking user input.
Example usage:
-- Start a 10 second tornado event whenever the host presses the X key
InputService.registerInputBegan(KeyCode.X, function (player)
if (player == MatchService.getHost()) then
DisasterService.startDisaster(DisasterType.TORNADO, 10)
end
end)
​
-- Start a 10 second meteors event whenever the host stops pressing the Z key
InputService.registerInputEnded(KeyCode.Z, function (player)
if (player == MatchService.getHost()) then
DisasterService.startDisaster(DisasterType.METEORS, 10)
end
end)

Functions

registerInputBegan(keyCode: KeyCode, function: (player: Player) => nil)

Begins tracking the beginning of user input of the key code from all players. The callback function will run every time the key code is pressed.

registerInputEnded(keyCode: KeyCode, function: (player: Player) => nil)

Begins tracking the end of user input of the key code from all players. The callback function will run every time the key code is pressed.