JsMacrosCE

Appearance

OptionsHelper.ChatOptionsHelper ​

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

Chat visibility and layout settings.

js
const options = Client.getGameOptions();  
Chat.log(options.chat.getChatVisibility());

Nested type declared in OptionsHelper.

Constructors ​

new OptionsHelper.ChatOptionsHelper ​

new OptionsHelper.ChatOptionsHelper(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 options helper that owns this settings group; the same instance is returned by getParent().

Methods ​

areColorsShown ​

areColorsShown(): booleanSince1.8.4#
Returns: whether chat colors are enabled

areCommandSuggestionsEnabled ​

areCommandSuggestionsEnabled(): booleanSince1.8.4#
Returns: true if command suggestions are enabled, false otherwise.

areMatchedNamesHidden ​

areMatchedNamesHidden(): booleanSince1.8.4#
Returns: true if messages from blocked players are hidden, false otherwise.

areWebLinksEnabled ​

areWebLinksEnabled(): booleanSince1.8.4#
Returns: whether opening web links from chat is enabled

enableCommandSuggestions ​

enableCommandSuggestions(boolean val): OptionsHelper.ChatOptionsHelperSince1.8.4#

Parameters:

  • val: whether to enable command suggestions
Returns: self for chaining.

enableHideMatchedNames ​

enableHideMatchedNames(boolean val): OptionsHelper.ChatOptionsHelperSince1.8.4#

Parameters:

  • val: whether to hide messages from blocked players
Returns: self for chaining.

enableWebLinkPrompt ​

enableWebLinkPrompt(boolean val): OptionsHelper.ChatOptionsHelperSince1.8.4#
Sets whether to show a warning prompt before opening chat links.

Parameters:

  • val: whether the warning prompt is enabled
Returns: this helper

enableWebLinks ​

enableWebLinks(boolean val): OptionsHelper.ChatOptionsHelperSince1.8.4#
Sets whether opening web links from chat is enabled.

Parameters:

  • val: whether opening chat links is enabled
Returns: this helper

getChatDelay ​

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

getChatFocusedHeight ​

getChatFocusedHeight(): doubleSince1.8.4#
Returns the configured chat height scale while chat is focused.
Returns: the focused chat height scale.

getChatLineSpacing ​

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

getChatOpacity ​

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

getChatUnfocusedHeight ​

getChatUnfocusedHeight(): doubleSince1.8.4#
Returns: the chat height scale while chat is unfocused.

getChatVisibility ​

getChatVisibility(): StringSince1.8.4#
Returns: the final segment of the chat-visibility translation key, including its leading dot (for example, .full).

getChatWidth ​

getChatWidth(): doubleSince1.8.4#
Returns the configured chat width scale.
Returns: the current chat width scale.

getNarratorMode ​

getNarratorMode(): StringSince1.8.4#
Returns: the final segment of the narrator translation key, including its leading dot (for example, .all).

getParent ​

getParent(): OptionsHelperSince1.8.4#
Returns: the options helper that owns this settings group.

getTextBackgroundOpacity ​

getTextBackgroundOpacity(): doubleSince1.8.4#
Returns the configured opacity for text backgrounds.
Returns: the current text background opacity.

getTextSize ​

getTextSize(): doubleSince1.8.4#
Returns the configured chat text scale.
Returns: the current text scale.

isDebugInfoReduced ​

isDebugInfoReduced(): booleanSince1.8.4#
Returns: true if reduced debug information is enabled, false otherwise.

isWebLinkPromptEnabled ​

isWebLinkPromptEnabled(): booleanSince1.8.4#
Returns: whether a warning prompt is enabled before opening chat links

reduceDebugInfo ​

reduceDebugInfo(boolean val): OptionsHelper.ChatOptionsHelperSince1.8.4#

Parameters:

  • val: whether to enable reduced debug info or not
Returns: self for chaining.

setChatDelay ​

setChatDelay(double val): OptionsHelper.ChatOptionsHelperSince1.8.4#
Sets the delay between chat messages.

Parameters:

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

setChatFocusedHeight ​

setChatFocusedHeight(double val): OptionsHelper.ChatOptionsHelperSince1.8.4#

Parameters:

  • val: the chat height scale while chat is focused
Returns: self for chaining.

setChatLineSpacing ​

setChatLineSpacing(double val): OptionsHelper.ChatOptionsHelperSince1.8.4#
Sets the spacing between chat lines.

Parameters:

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

setChatOpacity ​

setChatOpacity(double val): OptionsHelper.ChatOptionsHelperSince1.8.4#
Sets the chat opacity.

Parameters:

  • val: the new opacity
Returns: this helper

setChatUnfocusedHeight ​

setChatUnfocusedHeight(double val): OptionsHelper.ChatOptionsHelperSince1.8.4#

Parameters:

  • val: the chat height scale while chat is unfocused
Returns: self for chaining.

setChatVisibility ​

setChatVisibility(String mode): OptionsHelper.ChatOptionsHelperSince1.8.4#
Sets chat visibility to FULL, SYSTEM, or HIDDEN; matching is case-insensitive. Unrecognized values leave the current setting unchanged.

Parameters:

  • mode: the visibility mode
Returns: this helper

setChatWidth ​

setChatWidth(double val): OptionsHelper.ChatOptionsHelperSince1.8.4#
Sets the chat width scale.

Parameters:

  • val: the new chat width scale
Returns: self for chaining.

setNarratorMode ​

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

Parameters:

  • mode: the narrator mode to set; accepts OFF, ALL, CHAT, or SYSTEM, case-insensitively. Other values leave the current mode unchanged.
Returns: self for chaining.

setShowColors ​

setShowColors(boolean val): OptionsHelper.ChatOptionsHelperSince1.8.4#
Sets whether chat colors are enabled.

Parameters:

  • val: whether chat colors are enabled
Returns: this helper

setTextBackgroundOpacity ​

setTextBackgroundOpacity(double val): OptionsHelper.ChatOptionsHelperSince1.8.4#
Sets the opacity of text backgrounds.

Parameters:

  • val: the new text background opacity
Returns: this helper

setTextSize ​

setTextSize(double val): OptionsHelper.ChatOptionsHelperSince1.8.4#
Sets the chat text scale.

Parameters:

  • val: the new text scale
Returns: self for chaining.