JsMacrosCE

Appearance

OptionsHelper.VideoOptionsHelper ​

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

Graphics and display settings.

js
const options = Client.getGameOptions();  
options.video.getGraphicsMode();

Nested type declared in OptionsHelper.

Constructors ​

new OptionsHelper.VideoOptionsHelper ​

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

Methods ​

areEntityShadowsEnabled ​

areEntityShadowsEnabled(): booleanSince1.8.4#
Returns: true if entity shadows are enabled; false otherwise.

enableAutosaveIndicator ​

enableAutosaveIndicator(boolean val): OptionsHelper.VideoOptionsHelperSince1.8.4#

Parameters:

  • val: whether to show the autosave indicator
Returns: this helper for chaining.

enableEntityShadows ​

enableEntityShadows(boolean val): OptionsHelper.VideoOptionsHelperSince1.8.4#
Enables or disables entity shadows.

Parameters:

  • val: whether to enable entity shadows
Returns: this helper for chaining.

enableViewBobbing ​

enableViewBobbing(boolean val): OptionsHelper.VideoOptionsHelperSince1.8.4#

Parameters:

  • val: true to enable view bobbing; false to disable it
Returns: self for chaining.

enableVsync ​

enableVsync(boolean val): OptionsHelper.VideoOptionsHelperSince1.8.4#

Parameters:

  • val: true to enable vsync; false to disable it
Returns: self for chaining.

getAttackIndicatorType ​

getAttackIndicatorType(): StringSince1.8.4#
Returns: "off", "crosshair", or "hotbar", according to the selected attack indicator

getBiomeBlendRadius ​

getBiomeBlendRadius(): intSince1.8.4#
Returns: the current biome blend radius, in blocks.

getBrightness ​

getBrightness(): doubleSince1.8.4#
Returns: the current brightness value.

getChunkBuilderMode ​

getChunkBuilderMode(): StringSince1.8.4#
Returns: the selected chunk builder mode.

getCloudsMode ​

getCloudsMode(): StringSince1.8.4#
Returns: the current cloud rendering mode.

getDistortionEffect ​

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

getEntityDistance ​

getEntityDistance(): doubleSince1.8.4#
Returns: the current entity-distance scaling value.

getFovEffects ​

getFovEffects(): doubleSince1.8.4#
Returns: the current field-of-view effect scale.

getFullscreenResolution ​

getFullscreenResolution(): StringSince1.8.4#
Returns: the configured fullscreen video mode string, such as 1920x1080@60:24 (width x height @ refresh rate : total color bits), or null if none is configured; this may not match the active display mode

getGamma ​

getGamma(): doubleSince1.8.4#
Returns: the current brightness (gamma) value.

getGraphicsMode ​

getGraphicsMode(): String#
Returns the selected graphics mode name.
Returns: "fast", "fancy", or "fabulous"; an unrecognized stored mode throws IllegalArgumentException.

getGuiScale ​

getGuiScale(): intSince1.8.4#
Returns: the configured GUI scale factor; Minecraft may calculate a different effective scale to fit the display.

getMaxFps ​

getMaxFps(): intSince1.8.4#
Returns: the current upper fps limit.

getMipMapLevels ​

getMipMapLevels(): intSince1.8.4#
Returns: the current mip map level.

getParent ​

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

getParticleMode ​

getParticleMode(): StringSince1.8.4#
Returns: the current particle rendering mode.

getRenderDistance ​

getRenderDistance(): intSince1.8.4#
Returns: the current render distance in chunks.

getSimulationDistance ​

getSimulationDistance(): intSince1.8.4#
Returns: the current simulation distance in chunks.

getSmoothLightningMode ​

getSmoothLightningMode(): booleanSince1.8.4#
Returns: whether ambient occlusion is enabled.

isAutosaveIndicatorEnabled ​

isAutosaveIndicatorEnabled(): booleanSince1.8.4#
Returns: true if the autosave indicator is enabled; false otherwise.

isFullscreen ​

isFullscreen(): booleanSince1.8.4#
Returns: true if the game is running in fullscreen mode, false otherwise.

isViewBobbingEnabled ​

isViewBobbingEnabled(): booleanSince1.8.4#
Returns: true if view bobbing is enabled, false otherwise.

isVsyncEnabled ​

isVsyncEnabled(): booleanSince1.8.4#
Returns: true if vsync is enabled, false otherwise.

setAttackIndicatorType ​

setAttackIndicatorType(String type): OptionsHelper.VideoOptionsHelperSince1.8.4#

Parameters:

  • type: the attack indicator type: "off", "crosshair", or "hotbar"; other values leave the current setting unchanged
Returns: self for chaining.

setBiomeBlendRadius ​

setBiomeBlendRadius(int radius): OptionsHelper.VideoOptionsHelperSince1.8.4#

Parameters:

  • radius: the new biome blend radius, in blocks
Returns: self for chaining.

setBrightness ​

setBrightness(double gamma): OptionsHelper.VideoOptionsHelperSince1.8.4#

Parameters:

  • gamma: the brightness (gamma) value to set
Returns: self for chaining.

setChunkBuilderMode ​

setChunkBuilderMode(String mode): OptionsHelper.VideoOptionsHelperSince1.8.4#

Parameters:

  • mode: the chunk builder mode; "none", "nearby", or "player_affected", case-insensitively. Other values leave the current mode unchanged.
Returns: self for chaining.

setCloudsMode ​

setCloudsMode(String mode): OptionsHelper.VideoOptionsHelperSince1.8.4#

Parameters:

  • mode: the cloud rendering mode; accepts "off", "fast", or "fancy" (case-insensitive). Other values leave the setting unchanged
Returns: self for chaining.

setDistortionEffects ​

setDistortionEffects(double val): OptionsHelper.VideoOptionsHelperSince1.8.4#
Sets the screen-effect scale.

Parameters:

  • val: the screen-effect scale to set
Returns: this helper for chaining.

setEntityDistance ​

setEntityDistance(double val): OptionsHelper.VideoOptionsHelperSince1.8.4#
Sets the entity-distance scaling value.

Parameters:

  • val: the scaling value to set
Returns: this helper for chaining.

setFovEffects ​

setFovEffects(double val): OptionsHelper.VideoOptionsHelperSince1.8.4#
Sets the field-of-view effect scale.

Parameters:

  • val: the scale to set
Returns: this helper for chaining.

setFullScreen ​

setFullScreen(boolean fullscreen): OptionsHelper.VideoOptionsHelperSince1.8.4#

Parameters:

  • fullscreen: whether to enable fullscreen mode
Returns: self for chaining.

setGamma ​

setGamma(double gamma): OptionsHelper.VideoOptionsHelperSince1.8.4#

Parameters:

  • gamma: the gamma (brightness) value to set
Returns: self for chaining.

setGraphicsMode ​

setGraphicsMode(String mode): OptionsHelper.VideoOptionsHelper#
Sets the graphics mode. Matching is case-insensitive; an unrecognized value retains the current selection but still calls the option setter.

Parameters:

  • mode: non-null mode name; recognized values are "fast", "fancy", and "fabulous"
Returns: self for chaining

setGuiScale ​

setGuiScale(int scale): OptionsHelper.VideoOptionsHelperSince1.8.4#

Parameters:

  • scale: the GUI scale factor to set; Minecraft may adjust the effective scale to fit the display
Returns: self for chaining.

setMaxFps ​

setMaxFps(int maxFps): OptionsHelper.VideoOptionsHelperSince1.8.4#

Parameters:

  • maxFps: the maximum frame-rate limit to set
Returns: self for chaining.

setMipMapLevels ​

setMipMapLevels(int val): OptionsHelper.VideoOptionsHelperSince1.8.4#
Sets the mipmap level.

Parameters:

  • val: the mipmap level to set
Returns: this helper for chaining.

setParticleMode ​

setParticleMode(String mode): OptionsHelper.VideoOptionsHelperSince1.8.4#

Parameters:

  • mode: the particle rendering mode; accepts "minimal", "decreased", or "all" (case-insensitive). Other values leave the setting unchanged
Returns: self for chaining.

setRenderDistance ​

setRenderDistance(int radius): OptionsHelper.VideoOptionsHelperSince1.8.4#

Parameters:

  • radius: the new render distance, in chunks
Returns: self for chaining.

setSimulationDistance ​

setSimulationDistance(int radius): OptionsHelper.VideoOptionsHelperSince1.8.4#

Parameters:

  • radius: the new simulation distance, in chunks
Returns: self for chaining.

setSmoothLightningMode ​

setSmoothLightningMode(boolean mode): OptionsHelper.VideoOptionsHelperSince1.8.4#

Parameters:

  • mode: true to enable ambient occlusion; false to disable it
Returns: self for chaining.