GameUI

Global methods for interacting with the base game UI.

Global Methods

GameUI.SetRegion(name: string)

Sets the region name displayed in the top-left corner of the screen.

Parameters:

• name (string): The region name to display
  • If "NONE" (without quotes): Nothing will show up where the region name is displayed
  • If empty string: The game will automatically display the region name based on the player's current location
  • If any other string: The specified name will be displayed

GameUI.EnableWeaponsHUD(enabled: boolean)

Enables or disables the weapons HUD.

Parameters:

• enabled: boolean - Whether to enable (true) or disable (false) the weapons HUD

GameUI.IsWeaponsHUDEnabled(): boolean

Returns whether the weapons HUD is currently enabled.

Returns: boolean - true if enabled, false otherwise