> For the complete documentation index, see [llms.txt](https://guide.cronuszen.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://guide.cronuszen.com/gpcscripting/gpc-script-guide/gpc-developer-guide/functions/controller-functions/rumble-functions.md). # Rumble Functions The functions in this section are specifically used to interact with the rumble motors of the controller. | **Function Name** | **Description** | | ----------------- | ------------------------------------------------------------------------------- | | 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 the condition of the motors to the console. | *** ### get\_rumble get\_rumble returns the current value of a rumble motor in the form of an int. The value represents the speed of the motor as a percentage from 0 to 100. Code-Snippet ``` main { if(get_rumble(RUMBLE_A) > 50) { // If the rumble motor A is vibrating more than 50%, do something } } ``` Syntax get\_rumble ( \ ); Parameters \ : the identifier of a rumble motor. Returns The current value of the specified identifier. Can range from 0 to 100. *** ### set\_rumble set\_rumble allows you to manually control the rumble motors of a controller. This will override the signals normally sent by the console. Code-Snippet ``` main { if(event_press(XB1_A)) { combo_run(Vibrate); } } combo Vibrate { set_rumble(RUMBLE_A, 100); wait(250); reset_rumble(); } ``` Syntax set\_rumble ( \ , \ ); Parameters \ : the identifier of a rumble motor. \ : the speed/strength of the vibration (0 to 100). Returns Nothing *** ### block\_rumble block\_rumble prevents any rumble signals from the console from being forwarded to the controller. This is useful if you wish to disable vibration in a game completely without changing in-game settings. Code-Snippet ``` init { block_rumble(); } ``` Syntax block\_rumble(); Parameters None Returns Nothing *** ### reset\_rumble reset\_rumble resets any modifications made to the rumble motors by set\_rumble and returns control to the console. It also immediately turns off any manually activated motors. Code-Snippet ``` main { if(event_release(XB1_A)) { reset_rumble(); } } ``` Syntax reset\_rumble(); Parameters None Returns Nothing --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://guide.cronuszen.com/gpcscripting/gpc-script-guide/gpc-developer-guide/functions/controller-functions/rumble-functions.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.