JsMacrosCE

Appearance

OptionsHelper.ControlOptionsHelper ​

com.jsmacrosce.jsmacros.client.api.helper.OptionsHelper.ControlOptionsHelper

Input and mouse settings, including key bindings.

js
const options = Client.getGameOptions();  
options.control.getMouseSensitivity();

Nested type declared in OptionsHelper.

Constructors ​

new OptionsHelper.ControlOptionsHelper ​

new OptionsHelper.ControlOptionsHelper(OptionsHelper optionsHelper, OptionsHelper OptionsHelper)#
Stores the supplied parent reference; settings methods use the enclosing OptionsHelper instance, which may differ.

Parameters:

  • OptionsHelper: parent helper reference to retain

Fields ​

parent ​

parent: OptionsHelperSince1.8.4read-only#
the whole options helper this group belongs to. Each group is a view onto one part of the settings, and this is the way back to the rest of them, so a script that starts in a group and needs a setting from another does not have to keep the outer handle around separately. It is the same object the field was created with, and the same one the group's getParent() returns. The six group fields hold the same thing, so the example on SkinOptionsHelper.parent, the first of them, covers this one too.

Methods ​

enableAutoJump ​

enableAutoJump(boolean val): OptionsHelper.ControlOptionsHelperSince1.8.4#
Sets whether auto-jump is enabled.

Parameters:

  • val: true to enable auto-jump
Returns: this helper for chaining.

enableDiscreteScrolling ​

enableDiscreteScrolling(boolean val): OptionsHelper.ControlOptionsHelperSince1.8.4#
Sets whether discrete mouse scrolling is enabled.

Parameters:

  • val: true to enable discrete scrolling
Returns: this helper for chaining.

enableRawMouseInput ​

enableRawMouseInput(boolean val): OptionsHelper.ControlOptionsHelperSince1.8.4#
Sets whether raw mouse input is enabled. Has no effect on Minecraft 26.3 and later, where the setting no longer exists and SDL relative mouse mode uses raw input by default.

Parameters:

  • val: true to enable raw mouse input
Returns: this helper for chaining.

enableTouchscreen ​

enableTouchscreen(boolean val): OptionsHelper.ControlOptionsHelperSince1.8.4#
Sets whether touchscreen mode is enabled. Minecraft 26.2 removed touchscreen mode with no replacement. On 26.2 and later, this method is deprecated and has no effect; it is retained for script compatibility.

Parameters:

  • val: true to enable touchscreen mode; ignored on Minecraft 26.2 and later
Returns: self for chaining

getCategories ​

getCategories(): List<String>Since1.8.4#
Returns: distinct category identifiers used by the key mappings.

getKeyBinds ​

getKeyBinds(): Map<String, String>Since1.8.4#
Returns: translated key-mapping names mapped to their translated bound-key labels.

getKeyBindsByCategory ​

getKeyBindsByCategory(String category): Map<String, String>Since1.8.4#

Parameters:

  • category: the category identifier
Returns: translated key-mapping names and bound-key labels for the category, or null if absent.
getKeyBindsByCategory(): Map<String, Map<String, String>>Since1.8.4#
Returns: category identifiers mapped to translated key-mapping names and bound-key labels.

getKeys ​

getKeys(): List<String>Since1.8.4#
Returns: the key-mapping names, in mapping-array order.

getMouseSensitivity ​

getMouseSensitivity(): doubleSince1.8.4#
Returns: the current mouse sensitivity.

getMouseWheelSensitivity ​

getMouseWheelSensitivity(): doubleSince1.8.4#
Returns: the current mouse wheel sensitivity.

getParent ​

getParent(): OptionsHelperSince1.8.4#
Returns: the parent options helper.

getRawKeys ​

getRawKeys(): KeyMapping[]Since1.8.4#
Returns: a shallow clone of Minecraft's key-mapping array; the mappings themselves are not cloned.

invertMouse ​

invertMouse(boolean val): OptionsHelper.ControlOptionsHelperSince1.8.4#

Parameters:

  • val: whether to invert the mouse direction or not
Returns: self for chaining.

isAutoJumpEnabled ​

isAutoJumpEnabled(): booleanSince1.8.4#
Returns whether auto-jump is enabled.
Returns: true if enabled; false otherwise.

isDiscreteScrollingEnabled ​

isDiscreteScrollingEnabled(): booleanSince1.8.4#
This option was introduced due to a bug on some systems where the mouse wheel would scroll too fast.
Returns: true if discrete scrolling is enabled, false otherwise.

isMouseInverted ​

isMouseInverted(): booleanSince1.8.4#
Returns: true if the mouse direction should be inverted.

isRawMouseInputEnabled ​

isRawMouseInputEnabled(): booleanSince1.8.4#
Returns whether raw mouse input is enabled. Minecraft 26.3 removed the setting; its SDL relative mouse mode uses raw input by default, so this returns true on that target and cannot be changed there.
Returns: true if enabled; false otherwise.

isSneakTogglingEnabled ​

isSneakTogglingEnabled(): booleanSince1.8.4#
Returns whether sneak toggling is enabled.
Returns: true if enabled; false otherwise.

isSprintTogglingEnabled ​

isSprintTogglingEnabled(): booleanSince1.8.4#
Returns whether sprint toggling is enabled.
Returns: true if enabled; false otherwise.

isTouchscreenEnabled ​

isTouchscreenEnabled(): booleanSince1.8.4#
Returns whether touchscreen mode is enabled. Minecraft 26.2 removed touchscreen mode with no replacement. On 26.2 and later, this method is deprecated and always returns false for compatibility.
Returns: true if enabled; false otherwise.

setMouseSensitivity ​

setMouseSensitivity(double val): OptionsHelper.ControlOptionsHelperSince1.8.4#

Parameters:

  • val: the new mouse sensitivity
Returns: self for chaining.

setMouseWheelSensitivity ​

setMouseWheelSensitivity(double val): OptionsHelper.ControlOptionsHelperSince1.8.4#

Parameters:

  • val: the new mouse wheel sensitivity
Returns: self for chaining.

toggleSneak ​

toggleSneak(boolean val): OptionsHelper.ControlOptionsHelperSince1.8.4#
Sets whether sneak toggling is enabled.

Parameters:

  • val: true to enable sneak toggling
Returns: this helper for chaining.

toggleSprint ​

toggleSprint(boolean val): OptionsHelper.ControlOptionsHelperSince1.8.4#

Parameters:

  • val: whether sprint toggling is enabled
Returns: this helper, for chaining.