input_rumble_params table reference

Description

This table provides settings for a new rumble effect.

You can create a table with any or all of these keys, and pass it in a call to [stingray.InputController.rumble_effect()] for types of input controllers that support rumble effects.

Note that for any key that you leave out of this table, the default value will be used. So you only need to specify the keys for which you want to set a different value.

Other related reference items

stingray.InputController.rumble_effect() stingray.Keyboard.rumble_effect() stingray.Mouse.rumble_effect() stingray.Pad1.rumble_effect() stingray.Pad2.rumble_effect() stingray.Pad3.rumble_effect() stingray.Pad4.rumble_effect() stingray.PS4Pad1.rumble_effect() stingray.PS4Pad2.rumble_effect() stingray.PS4Pad3.rumble_effect() stingray.PS4Pad4.rumble_effect() stingray.SynergyKeyboard.rumble_effect() stingray.SynergyMouse.rumble_effect() stingray.Tablet.rumble_effect()

User Input

Data Members

attack : number The duration of the attack part of the envelope.

If omitted, the default value of 0 is used.

attack_level : number The strength of the rumble at its maximum attack position.

If omitted, the default value of 1 is used.

decay : number The duration of the decay part of the envelope.

If omitted, the default value of 0 is used.

frequency : number The frequency of a sine wave that will determine the amplitude of the rumble strength over time, expressed in Hertz (Hz).

A frequency of 0 means that no sine wave will be used, and the strength of the rumble will only be affected by the ADSR envelope.

Note that since the motors on most controllers cannot change speed instantly, it does not make sense to use frequencies above approximately 6 Hz.

If omitted, the default value of 0 is used.

offset : number The offset of the sine wave.

Normally the sine wave is offset so that it starts in its lowest position. You can specify a value between 0 and 1 to start the oscillation at a different position. For example, with a value of 0.5, the sine wave will start in its highest position.

If omitted, the default value of 0 is used.

period : number The period of the sine wave, which is the inverse of the frequency: period = 1 / frequency.

You can use this value instead of the frequency if you want.

If omitted, the default value of #inf is used.

release : number The duration of the release part of the envelope.

If omitted, the default value of 0 is used.

sustain : number The duration of the sustain part of the envelope.

If omitted, the default value of 0 is used.

sustain_level : number The strength of the rumble during the sustain part of the envelope.

If omitted, the default value of 1 is used.