Input - stingray.Input namespace reference - Stingray Lua API Reference

stingray.Input namespace reference

Description

This table contains functions, enums and more to help you parse input-events sent from the user as an alternative to the state-based functions available in the InputControllers.

Enumerations

Supported event types used for input streaming.

Functions

Parameters

events :

stingray.Input.RemoteEvent[]

Array of events

The [] notation indicates that this type is an array: a table in which the keys of the members are sequential integers, and the value of each element is an instance of the type shown.
Returns
This function does not return any values.

The events are represented as an array. This function is mainly used for Storm Cloud input streaming.

Parameters
This function does not accept any parameters.
Returns

InputEvent[]

The InputEvent contains all info about the event such as exactly what occured and from what controller.

The [] notation indicates that this type is an array: a table in which the keys of the members are sequential integers, and the value of each element is an instance of the type shown.

Every input event read in the engine during the last frame will be sent to this table in the same order they were received. Duplicated events may be read if the user does the same action multiple times during a single frame.