Mainmenu¶

This page documents the hooks defined by the mainmenu module.

GetMainCharacterID()View Source

Allows code to override which character ID should be treated as the player's main character.

Client

number|nil Return the character ID that should be loaded as the main character.

OpenCharacterMenuOverride()View Source

Allows code to replace the default character menu panel creation.

Client

Panel|boolean|nil Return a panel to use instead of the default character menu, or any non-nil value to stop the default menu from opening.

ThirdPersonToggled(enabled)View Source

Called whenever the third-person option is toggled through the main menu or option system.

Client

boolean enabled The new third-person enabled state.