libraryDocs / menu / options

menu.options

libraryclientsource

The game's menu options module.

Functions

`menu.options.allowCustomLoadingScreen`	Sets whether the loading URL is enabled.
`menu.options.getCloseCaptions`	Checks if close captions are enabled.
`menu.options.getCrosshair`	Returns whether the crosshair is enabled.
`menu.options.getDrawHUD`	Returns whether the HUD render (health, ammo, etc) is enabled.
`menu.options.getEffectsVolume`	Gets the effects volume.
`menu.options.getFastWeaponSwitch`	Returns whether the fast weapon switch is enabled.
`menu.options.getFullscreen`	Returns whether the game window is fullscreen.
`menu.options.getLanguage`	Returns the selected game language.
`menu.options.getMasterVolume`	Gets the master volume.
`menu.options.getMouseSensitivity`	Returns client's mouse sensitivity.
`menu.options.getMusicVolume`	Gets the music volume.
`menu.options.getMuteVolumeOnLoseFocus`	Gets whether to mute the volume when the game loses focus.
`menu.options.getQuickInfo`	Returns whether the quick info is enabled.
`menu.options.getScreenResolution`	Returns the width and height of the game's window (in pixels).
`menu.options.getSuitVolume`	Gets the HEV suit volume.
`menu.options.getVSync`	Returns whether the game is running in VSync mode.
`menu.options.isCustomLoadingScreenAllowed`	Returns whether the loading URL is enabled.
`menu.options.open`	Opens the options dialog.
`menu.options.setCloseCaptions`	Enables or disables close captions.
`menu.options.setCrosshair`	Sets whether the crosshair is enabled.
`menu.options.setDrawHUD`	Sets whether the HUD render (health, ammo, etc) is enabled.
`menu.options.setEffectsVolume`	Sets the effects volume.
`menu.options.setFastWeaponSwitch`	Sets whether the fast weapon switch is enabled.
`menu.options.setFullscreen`	Sets the fullscreen state of the game window.
`menu.options.setLanguage`	Sets the selected game language.
`menu.options.setMasterVolume`	Sets the master volume.
`menu.options.setMouseSensitivity`	Sets the mouse sensitivity.
`menu.options.setMusicVolume`	Sets the music volume.
`menu.options.setMuteVolumeOnLoseFocus`	Sets whether to mute the volume when the game loses focus.
`menu.options.setQuickInfo`	Sets whether the quick info is enabled.
`menu.options.setScreenResolution`	Changes the resolution of the game window.
`menu.options.setSuitVolume`	Sets the HEV suit volume.
`menu.options.setVSync`	Sets whether the game is running in VSync mode.

#menu.options.allowCustomLoadingScreen

source

function menu.options.allowCustomLoadingScreen(value: boolean)

Sets whether the loading URL is enabled.

Parameters

Name	Type	Description
`value`	`boolean`	Whether the loading URL is enabled.

#menu.options.getCloseCaptions

clientnodiscardsource

function menu.options.getCloseCaptions(): boolean

Checks if close captions are enabled.

Returns

Type	Name	Description
`boolean`	`is_enabled`	`true` if close captions are enabled, `false` otherwise.

#menu.options.getCrosshair

clientnodiscardsource

function menu.options.getCrosshair(): boolean

Returns whether the crosshair is enabled.

Returns

Type	Name	Description
`boolean`	`enabled`	Whether the crosshair is enabled.

#menu.options.getDrawHUD

clientnodiscardsource

function menu.options.getDrawHUD(): boolean

Returns whether the HUD render (health, ammo, etc) is enabled.

Returns

Type	Name	Description
`boolean`	`enabled`	Whether the HUD render is enabled.

#menu.options.getEffectsVolume

clientnodiscardsource

function menu.options.getEffectsVolume(): number

Gets the effects volume.

Returns

Type	Name	Description
`number`	`sfx_volume`	The volume, from 0 to 1.

#menu.options.getFastWeaponSwitch

clientnodiscardsource

function menu.options.getFastWeaponSwitch(): boolean

Returns whether the fast weapon switch is enabled.

Returns

Type	Name	Description
`boolean`	`enabled`	Whether the fast weapon switch is enabled.

#menu.options.getFullscreen

clientnodiscardsource

function menu.options.getFullscreen(): boolean

Alias of window.isFullscreen.

Returns whether the game window is fullscreen.

Returns

Type	Name	Description
`boolean`	`is_on`	`true` if the game window is fullscreen, `false` if not.

#menu.options.getLanguage

clientnodiscardsource

function menu.options.getLanguage(): string

Returns the selected game language.

All language codes https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes.

Returns

Type	Name	Description
`string`	`language_code`	ISO 639-1 language code.

#menu.options.getMasterVolume

clientnodiscardsource

function menu.options.getMasterVolume(): number

Gets the master volume.

Returns

Type	Name	Description
`number`	`master_volume`	The volume, from 0 to 1.

#menu.options.getMouseSensitivity

clientnodiscardsource

function menu.options.getMouseSensitivity(): number

Returns client's mouse sensitivity.

Returns

Type	Name	Description
`number`	`sensitivity`	The mouse sensitivity.

#menu.options.getMusicVolume

clientnodiscardsource

function menu.options.getMusicVolume(): number

Gets the music volume.

Returns

Type	Name	Description
`number`	`music_volume`	The volume, from 0 to 1.

#menu.options.getMuteVolumeOnLoseFocus

clientnodiscardsource

function menu.options.getMuteVolumeOnLoseFocus(): boolean

Gets whether to mute the volume when the game loses focus.

Returns

Type	Name	Description
`boolean`	`muted`	Whether to mute the volume.

#menu.options.getQuickInfo

clientnodiscardsource

function menu.options.getQuickInfo(): boolean

Returns whether the quick info is enabled.

Returns

Type	Name	Description
`boolean`	`enabled`	Whether the quick info is enabled.

#menu.options.getScreenResolution

clientnodiscardsource

function menu.options.getScreenResolution(): number, number

Returns the width and height of the game's window (in pixels).

Returns

Type	Name	Description
`number`	`width`	The width of the game's window (in pixels).
`number`	`height`	The height of the game's window (in pixels).

#menu.options.getSuitVolume

clientnodiscardsource

function menu.options.getSuitVolume(): number

Gets the HEV suit volume.

Returns

Type	Name	Description
`number`	`hev_volume`	The volume, from 0 to 1.

#menu.options.getVSync

clientnodiscardsource

function menu.options.getVSync(): boolean

Returns whether the game is running in VSync mode.

Returns

Type	Name	Description
`boolean`	`is_on`	`true` if the game is running in VSync mode, `false` if not.

#menu.options.isCustomLoadingScreenAllowed

clientnodiscardsource

function menu.options.isCustomLoadingScreenAllowed(): boolean

Returns whether the loading URL is enabled.

Returns

Type	Name	Description
`boolean`	`allowed`	Whether the loading URL is enabled.

#menu.options.open

source

function menu.options.open()

Opens the options dialog.

#menu.options.setCloseCaptions

clientsource

function menu.options.setCloseCaptions(state: boolean)

Enables or disables close captions.

Parameters

Name	Type	Description
`state`	`boolean`	`true` to enable close captions, `false` to disable them.

#menu.options.setCrosshair

source

function menu.options.setCrosshair(value: boolean)

Sets whether the crosshair is enabled.

Parameters

Name	Type	Description
`value`	`boolean`	Whether the crosshair is enabled.

#menu.options.setDrawHUD

source

function menu.options.setDrawHUD(value: boolean)

Sets whether the HUD render (health, ammo, etc) is enabled.

Parameters

Name	Type	Description
`value`	`boolean`	Whether the HUD render is enabled.

#menu.options.setEffectsVolume

source

function menu.options.setEffectsVolume(volume: number)

Sets the effects volume.

Parameters

Name	Type	Description
`volume`	`number`	The volume to set, from 0 to 1.

#menu.options.setFastWeaponSwitch

source

function menu.options.setFastWeaponSwitch(value: boolean)

Sets whether the fast weapon switch is enabled.

Parameters

Name	Type	Description
`value`	`boolean`	Whether the fast weapon switch is enabled.

#menu.options.setFullscreen

source

function menu.options.setFullscreen(value: boolean)

Sets the fullscreen state of the game window.

Parameters

Name	Type	Description
`value`	`boolean`	`true` to set the game window to fullscreen, `false` to set it to windowed.

#menu.options.setLanguage

source

function menu.options.setLanguage(language: string)

Sets the selected game language.

All language codes https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes.

Parameters

Name	Type	Description
`language`	`string`	ISO 639-1 language code.

#menu.options.setMasterVolume

source

function menu.options.setMasterVolume(volume: number)

Sets the master volume.

Parameters

Name	Type	Description
`volume`	`number`	The volume to set, from 0 to 1.

#menu.options.setMouseSensitivity

source

function menu.options.setMouseSensitivity(value: number)

Sets the mouse sensitivity.

Parameters

Name	Type	Description
`value`	`number`	The mouse sensitivity.

#menu.options.setMusicVolume

source

function menu.options.setMusicVolume(volume: number)

Sets the music volume.

Parameters

Name	Type	Description
`volume`	`number`	The volume to set, from 0 to 1.

#menu.options.setMuteVolumeOnLoseFocus

source

function menu.options.setMuteVolumeOnLoseFocus(mute: boolean)

Sets whether to mute the volume when the game loses focus.

Parameters

Name	Type	Description
`mute`	`boolean`	Whether to mute the volume.

#menu.options.setQuickInfo

source

function menu.options.setQuickInfo(value: boolean)

Sets whether the quick info is enabled.

Parameters

Name	Type	Description
`value`	`boolean`	Whether the quick info is enabled.

#menu.options.setScreenResolution

source

function menu.options.setScreenResolution(width?: integer, height?: integer)

Changes the resolution of the game window.

Parameters

Name	Type	Description
`width`optional	`integer`	The width of the game window.
`height`optional	`integer`	The height of the game window.

#menu.options.setSuitVolume

source

function menu.options.setSuitVolume(volume: number)

Sets the HEV suit volume.

Parameters

Name	Type	Description
`volume`	`number`	The volume to set, from 0 to 1.

#menu.options.setVSync

source

function menu.options.setVSync(value: boolean)

Sets whether the game is running in VSync mode.

Parameters

Name	Type	Description
`value`	`boolean`	`true` to enable VSync, `false` to disable it.