Browse docsrumble.clear
On this page
API method

rumble.clear

Sends zero for both script-owned Remote Play rumble motors.

Syntax

Atlas Script
rumble.clear()

Parameters

This method does not accept arguments.

Return value

See the remarks for the returned value and runtime behavior.

Remarks

Sends zero for both script-owned Remote Play rumble motors. 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.