Global Class "Options"⚓︎

Info

You can get this class by using the Options global table.

The Options class represents the values contained within the user's options.ini file. For example, this is useful so that mods that add things to the HUD can properly account for the HUDOffset.

Note that mods have free reign to modify these values, so it is possible for a mod to e.g. change the volume to max and play sound effects. Please use this class responsibly.

The Options class is a singleton that is exposed as a global variable. Thus, you can directly get and set values in the class without having to do anything first:

Example Code

local bulletVisibility = Options.BulletVisibility -- "bulletVisibility" is now set to true or false
Options.ChargeBars = true -- Force charge bars to be on for the player

Variables⚓︎

Announcer·Voice·Mode⚓︎

int AnnouncerVoiceMode⚓︎

0: random, 1: off, 2: always on

Bullet·Visibility⚓︎

boolean BulletVisibility⚓︎

Camera·Style⚓︎

int CameraStyle⚓︎

active cam 1: on, 2: off

Charge·Bars⚓︎

boolean ChargeBars⚓︎

Console·Font⚓︎

int ConsoleFont⚓︎

0: default, 1: small, 2: tiny

Debug·Console·Enabled⚓︎

boolean DebugConsoleEnabled⚓︎

Display·Popups⚓︎

boolean DisplayPopups⚓︎

Extra·HUD·Style⚓︎

int ExtraHUDStyle⚓︎

0: off, 1: on, 2: mini

Faded·Console·Display⚓︎

boolean FadedConsoleDisplay⚓︎

Filter⚓︎

boolean Filter⚓︎

Found·HUD⚓︎

boolean FoundHUD⚓︎

Fullscreen⚓︎

boolean Fullscreen⚓︎

Gamma⚓︎

float Gamma⚓︎

0.5-1.5

HUD·Offset⚓︎

float HUDOffset⚓︎

0-1

Each notch in the options menu increments or decrements this by 0.1.

Language⚓︎

string Language⚓︎

Read only

Map·Opacity⚓︎

float MapOpacity⚓︎

0-1

Max·Render·Scale⚓︎

int MaxRenderScale⚓︎

1-99

Max·Scale⚓︎

int MaxScale⚓︎