JsMacrosCE

Appearance

OptionsHelper.AccessibilityOptionsHelper ​

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

Provides accessibility settings, including narrator, subtitle, and chat-display options, on the enclosing options object.

js
const options = Client.getGameOptions();  
const accessibility = options.accessibility;  
Chat.log(accessibility.getNarratorMode());

Nested type declared in OptionsHelper.

Constructors ​

new OptionsHelper.AccessibilityOptionsHelper ​

new OptionsHelper.AccessibilityOptionsHelper(OptionsHelper optionsHelper, OptionsHelper OptionsHelper)#
Stores the supplied parent reference; this does not replace the options object bound to this inner group.

Parameters:

  • OptionsHelper: optionshelper retained as the parent

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 ​

areLightningFlashesHidden ​

areLightningFlashesHidden(): booleanSince1.8.4#
Returns: true if lightning flashes are hidden; false otherwise.

areSubtitlesShown ​

areSubtitlesShown(): booleanSince1.8.4#
Returns: true if subtitles are enabled.

enableAutoJump ​

enableAutoJump(boolean val): OptionsHelper.AccessibilityOptionsHelperSince1.8.4#

Parameters:

  • val: whether to enable auto jump
Returns: self for chaining.

enableBackgroundForChatOnly ​

enableBackgroundForChatOnly(boolean val): OptionsHelper.AccessibilityOptionsHelperSince1.8.4#

Parameters:

  • val: whether to show the text background only behind chat
Returns: this helper for chaining.

enableMonochromeLogo ​

enableMonochromeLogo(boolean val): OptionsHelper.AccessibilityOptionsHelperSince1.8.4#

Parameters:

  • val: whether to enable the dark Mojang Studios background
Returns: the current helper instance for chaining.

getChatDelay ​

getChatDelay(): doubleSince1.8.4#
Returns: the current chat delay in seconds.

getChatLineSpacing ​

getChatLineSpacing(): doubleSince1.8.4#
Returns: the current chat line spacing.

getChatOpacity ​

getChatOpacity(): doubleSince1.8.4#
Returns: the current chat opacity.

getDistortionEffect ​

getDistortionEffect(): doubleSince1.8.4#
Returns: the current screen distortion effect scale.

getFovEffect ​

getFovEffect(): doubleSince1.8.4#
Returns: the current FOV effect scale.

getNarratorMode ​

getNarratorMode(): StringSince1.8.4#
Returns: the current narrator mode.

getParent ​

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

getTextBackgroundOpacity ​

getTextBackgroundOpacity(): doubleSince1.8.4#
Returns: the opacity of the text background.

isAutoJumpEnabled ​

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

isBackgroundForChatOnly ​

isBackgroundForChatOnly(): booleanSince1.8.4#
Returns: true if the text background is shown only behind chat.

isMonochromeLogoEnabled ​

isMonochromeLogoEnabled(): booleanSince1.8.4#
Returns: true if the dark Mojang Studios background is enabled; false otherwise.

isSneakTogglingEnabled ​

isSneakTogglingEnabled(): booleanSince1.8.4#
Returns: true if the toggle functionality for sneaking is enabled, false otherwise.

isSprintTogglingEnabled ​

isSprintTogglingEnabled(): booleanSince1.8.4#
Returns: true if sprinting uses toggle behavior; false otherwise.

setChatDelay ​

setChatDelay(double val): OptionsHelper.AccessibilityOptionsHelperSince1.8.4#

Parameters:

  • val: the new chat delay in seconds
Returns: self for chaining.

setChatLineSpacing ​

setChatLineSpacing(double val): OptionsHelper.AccessibilityOptionsHelperSince1.8.4#

Parameters:

  • val: the new chat line spacing
Returns: self for chaining.

setChatOpacity ​

setChatOpacity(double val): OptionsHelper.AccessibilityOptionsHelperSince1.8.4#

Parameters:

  • val: the new chat opacity
Returns: self for chaining.

setDistortionEffect ​

setDistortionEffect(double val): OptionsHelper.AccessibilityOptionsHelperSince1.8.4#

Parameters:

  • val: the new screen distortion effect scale
Returns: self for chaining.

setFovEffect ​

setFovEffect(double val): OptionsHelper.AccessibilityOptionsHelperSince1.8.4#

Parameters:

  • val: the new FOV effect scale
Returns: self for chaining.
setFovEffect(boolean val): OptionsHelper.AccessibilityOptionsHelperSince1.8.4#
Sets the FOV effect scale to 1.0 when enabled or 0.0 when disabled. Use setFovEffect(double) to set an intermediate scale.

Parameters:

  • val: whether to enable FOV effects at full scale
Returns: self for chaining.

setNarratorMode ​

setNarratorMode(String mode): OptionsHelper.AccessibilityOptionsHelperSince1.8.4#

Parameters:

  • mode: the narrator mode: "OFF", "ALL", "CHAT", or "SYSTEM" (case-insensitive); other values leave the current mode unchanged.
Returns: self for chaining.

setTextBackgroundOpacity ​

setTextBackgroundOpacity(double val): OptionsHelper.AccessibilityOptionsHelperSince1.8.4#

Parameters:

  • val: the new opacity for the text background
Returns: self for chaining.

showSubtitles ​

showSubtitles(boolean val): OptionsHelper.AccessibilityOptionsHelperSince1.8.4#

Parameters:

  • val: whether to show subtitles or not
Returns: self for chaining.

toggleSneak ​

toggleSneak(boolean val): OptionsHelper.AccessibilityOptionsHelperSince1.8.4#

Parameters:

  • val: whether sneaking uses toggle behavior
Returns: self for chaining.

toggleSprint ​

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

Parameters:

  • val: whether sprinting uses toggle behavior
Returns: self for chaining.