Rumble Functions

The Cronus allows you to completely control the Rumble Motors on your controller, including the Trigger Rumble motors on an Xbox One controller. Below are the GPC commands relating to these motors.

Function Name	Description	Zen	Plus
get_rumble	Returns the current value of a Rumble Motor	✔️	✔️
set_rumble	Sets the speed of a Rumble Motor	✔️	️✔️
block_rumble	Blocks any rumble signals from the console	✔️	✔️
reset_rumble	Resets the rumble state and returns condition of the motors to the console	✔️	✔️

get_rumble

get_rumble returns the speed of the chosen rumble motor on the controller in the form of an int. The value returned can range from 0 to 100 which represents the speed as a percentage ( % ).

main {
 
    if(get_rumble(RUMBLE_A) > 50) {  // If Rumble Motor A is running greater than 50% 
                                     // do something
    }
 
}

🔴 Syntax

get_rumble ( <rumble_identifier> );

⚪ Parameters

<rumble_identifier> : the identifier of a rumble motor.

🔵 Returns

An int ranging from 0 to 100 which represents the current speed of the chosen motor.

set_rumble

set_rumble sets the speed of the chosen rumble motor on the controller.

The rumble motors are numbered 0 to 3. To make it easier to remember which motor is which, four constants have been created:

Name	Description	Value
RUMBLE_A	Strong Rumble Motor (Usually the Left Motor)	0
RUMBLE_B	Weak Rumble Motor (Usually the Right Motor)	1
RUMBLE_RT	Right Trigger Motor (Xbox One controllers only)	2
RUMBLE_LT	Left Trigger Motor (Xbox One controllers only)	3

set_rumble(RUMBLE_A, 50);

🔴 Syntax

set_rumble (<rumble_identifier>,<rumble_speed>);

⚪ Parameters

<rumble_identifier> : the identifier of a rumble motor. <rumble_speed> : Percentage value of the rumble motor ranging 0 - 100 represented as an int.

🔵 Returns

None

block_rumble

block_rumble does as it implies and blocks any rumble signals to the controller. Once this function is used, it remains active until such time as it is reset in the script or the script is unloaded. Example of usage:

main {     
       if(event_press(XB1_A)) {  // If A / Cross is pressed...        
              block_rumble();  // Block rumble signals to the controller
              } 
       }

🔴 Syntax

block_rumble ( );

⚪ Parameters

None

reset_rumble

reset_rumble returns control of the rumble motors to the console. It also deactivates block_rumble if it is active. Example of usage:

main {     
    if(event_press(XB1_A)) {  // If A / Cross is pressed...        
        reset_rumble();  // Reset the rumble state    
        } 
    }

🔴 Syntax

reset_rumble ( );

⚪ Parameters

None