Browse docsrumble.set
On this page
API method

rumble.set

Sends Remote Play rumble to "left", "right", or "both" from 0 to 100.

Syntax

Atlas Script
rumble.set(motor, value)

Parameters

motor
Remote Play rumble motor selector: left, right, or both.
value
Value written, converted, or evaluated by this method. Its required type and range are described in Remarks.

Return value

See the remarks for the returned value and runtime behavior.

Remarks

Sends Remote Play rumble to "left", "right", or "both" from 0 to 100. Motor and value are both required. Non-Remote-Play hosts reject feedback.

Examples

Rumble while held.atlas
event on_input() {
    if (input.held("L1")) {
        rumble.set("left", 45);
        rumble.set("right", 20);
    } else if (input.released("L1")) {
        rumble.clear();
    }
}
Reference details are generated from the Atlas Script schema in this documentation source snapshot. Confirm release-specific behavior in the Atlas for Windows build you use.