bc-stubs 96.0.0

package/bc/Screens/Character/FriendList/FriendList.d.ts

@@ -0,0 +1,102 @@
+/**
+ * Loads the online friend list from the server. This function is called dynamically, when the player invokes the friendlist dialog.
+ * @returns {void} - Nothing
+ */
+declare function FriendListLoad(): void;
+/**
+ * Run the friend list screen - Draw the controls and print the result of the server query to the screen.
+ * This function is called dynamically on a regular basis. So don't do complex loops within
+ * @returns {void} - Nothing
+ */
+declare function FriendListRun(): void;
+/**
+ * Creates beep message menu
+ * @param {number} MemberNumber Member number of target player
+ * @param {IFriendListBeepLogMessage|null} data Beep data of received beep
+ */
+declare function FriendListBeep(MemberNumber: number, data?: IFriendListBeepLogMessage | null): void;
+/**
+ * Closes the beep menu
+ */
+declare function FriendListBeepMenuClose(): void;
+/**
+ * Sends the beep and message on send click
+ */
+declare function FriendListBeepMenuSend(): void;
+/**
+ * Shows the wanted beep on click from beep list
+ * @param {number} i index of the beep
+ */
+declare function FriendListShowBeep(i: number): void;
+/**
+ * Handles the click events in the friend list. Clicks are propagated to this function from CommonClick()
+ * @returns {void} - Nothing
+ */
+declare function FriendListClick(): void;
+/**
+ * This function is called, when the user exists the friend list. From here we either get back to the InformationSheet
+ * or the ChatRoom search, depending on the value of the global variable 'FriendListReturn'
+ * @returns {void} - Nothing
+ */
+declare function FriendListExit(): void;
+/**
+ * Exits the friendlist
+ * @param {string} room The room to search for
+ */
+declare function FriendListChatSearch(room: string): void;
+/**
+ * Loads the friend list data into the HTML div element.
+ * @param {{
+ * MemberName: string;
+ * MemberNumber: number;
+ * ChatRoomName: string | null;
+ * ChatRoomSpace: ChatRoomSpaceType | null;
+ * Private?: boolean
+ * Type: "Submissive" | "Friend";
+ * }[]} data - An array of data, we receive from the server
+ *
+ * `data.MemberName` - The name of the player
+ *
+ * `data.MemberNumber` - The ID of the player
+ *
+ * `data.ChatRoomName` - The name of the ChatRoom
+ *
+ * `data.ChatRoomSpace` - The space, where this room was created. Currently this can be the Asylum or the LARP arena
+ *
+ * `data.Type` - The relationship that exists between the player and the friend of the list.
+ * Currently, only "submissive" is supported
+ * @returns {void} - Nothing
+ */
+declare function FriendListLoadFriendList(data: {
+    MemberName: string;
+    MemberNumber: number;
+    ChatRoomName: string | null;
+    ChatRoomSpace: ChatRoomSpaceType | null;
+    Private?: boolean;
+    Type: "Submissive" | "Friend";
+}[]): void;
+/**
+ * When the user wants to delete someone from her friend list this must be confirmed.
+ * This function either displays the confirm message or deletes the friend from the player's friendlist
+ * @param {number} MemberNumber - The member to delete from the friendlist
+ * @returns {void} - Nothing
+ */
+declare function FriendListDelete(MemberNumber: number): void;
+declare var FriendListBackground: string;
+declare var FriendListContent: string;
+/** @type {number[]} */
+declare var FriendListConfirmDelete: number[];
+/** @type {null | { Screen: string, Module: ModuleType, IsInChatRoom?: boolean, hasScrolledChat?: boolean }} */
+declare var FriendListReturn: null | {
+    Screen: string;
+    Module: ModuleType;
+    IsInChatRoom?: boolean;
+    hasScrolledChat?: boolean;
+};
+declare var FriendListMode: string[];
+declare var FriendListModeIndex: number;
+/** @type {IFriendListBeepLogMessage[]} */
+declare var FriendListBeepLog: IFriendListBeepLogMessage[];
+/** @type {number|null} MemberNumber of the player to send beep to */
+declare let FriendListBeepTarget: number | null;
+declare var FriendListBeepShowRoom: boolean;

package/bc/Screens/Character/InformationSheet/InformationSheet.d.ts

@@ -0,0 +1,46 @@
+/**
+ * Loads the Information Sheet, cache the sub screens
+ * @returns {void} - Nothing
+ */
+declare function InformationSheetLoad(): void;
+/**
+ * Draw the lover for the character
+ * @param {Character} C - The character whose information sheet should be displayed
+ * @param {number} L - The lover index
+ * @returns {void} - Nothing
+ */
+declare function InformationSheetDrawLover(C: Character, L: number): void;
+/**
+ * Main function of the character info screen. It's called continuously, so be careful
+ * to add time consuming functions or loops here
+ * @returns {void} - Nothing
+ */
+declare function InformationSheetRun(): void;
+/**
+ * Display the second part of the information sheet for reputation & skills
+ * @returns {void} - Nothing
+ */
+declare function InformationSheetSecondScreenRun(): void;
+/**
+ * Handles the click events on the screen
+ * @returns {void} - Nothing
+ */
+declare function InformationSheetClick(): void;
+/**
+ * Cleanup all elements, if the user exits the screen
+ * @returns {void} - Nothing
+ */
+declare function InformationSheetExit(): void;
+/**
+ * Loads the information sheet for a character
+ * @param {Character} C - The character whose information sheet should be displayed
+ * @returns {void} - Nothing
+ */
+declare function InformationSheetLoadCharacter(C: Character): void;
+declare var InformationSheetBackground: string;
+/** @type {null | Character} */
+declare var InformationSheetSelection: null | Character;
+/** @type {"" | ModuleType} */
+declare var InformationSheetPreviousModule: "" | ModuleType;
+declare var InformationSheetPreviousScreen: string;
+declare var InformationSheetSecondScreen: boolean;

package/bc/Screens/Character/ItemColor/ItemColor.d.ts

@@ -0,0 +1,232 @@
+/**
+ * Loads the item color UI with the provided character, item and positioning parameters.
+ * @param {Character} c - The character being colored
+ * @param {Item} item - The item being colored
+ * @param {number} x - The x-coordinate at which to draw the UI
+ * @param {number} y - The y-coordinate at which to draw the UI
+ * @param {number} width - The width the UI should be drawn at
+ * @param {number} height - The height the UI should be drawn at
+ * @param {boolean} [includeResetButton] - Whether or not to include the "Reset to default" button
+ * @returns {void} - Nothing
+ */
+declare function ItemColorLoad(c: Character, item: Item, x: number, y: number, width: number, height: number, includeResetButton?: boolean): void;
+/**
+ * Draws the item color UI according to its current state
+ * @param {Character} c - The character being colored
+ * @param {AssetGroupName} group - The name of the item group being colored
+ * @param {number} x - The x-coordinate at which to draw the UI
+ * @param {number} y - The y-coordinate at which to draw the UI
+ * @param {number} width - The width the UI should be drawn at
+ * @param {number} height - The height the UI should be drawn at
+ * @param {boolean} includeResetButton - Whether or not to include the "Reset to default" button
+ * @returns {void} - Nothing
+ */
+declare function ItemColorDraw(c: Character, group: AssetGroupName, x: number, y: number, width: number, height: number, includeResetButton: boolean): void;
+/**
+ * Draws the item color UI in default mode
+ * @param {number} x - The x-coordinate at which to draw the default UI
+ * @param {number} y - The y-coordinate at which to draw the default UI
+ * @returns {void} - Nothing
+ */
+declare function ItemColorDrawDefault(x: number, y: number): void;
+/**
+ * Click handler for the item color UI according to its current state
+ * @param {Character} c - The character being colored
+ * @param {AssetGroupName} group - The name of the item group being colored
+ * @param {number} x - The x-coordinate at which the UI was drawn
+ * @param {number} y - The y-coordinate at which the UI was drawn
+ * @param {number} width - The width with which the UI was drawn
+ * @param {number} height - The height with which the UI was drawn
+ * @param {boolean} includeResetButton - Whether or not to include the "Reset to default" button
+ * @returns {void} - Nothing
+ */
+declare function ItemColorClick(c: Character, group: AssetGroupName, x: number, y: number, width: number, height: number, includeResetButton: boolean): void;
+/**
+ * Click handler for the item color UI when it's in default mode
+ * @param {number} x - The x-coordinate at which the default UI was drawn
+ * @param {number} y - The y-coordinate at which the default UI was drawn
+ * @param {number} width - The width with which the default UI was drawn
+ * @returns {void} - Nothing
+ */
+declare function ItemColorClickDefault(x: number, y: number, width: number): void;
+/**
+ * Handles pagination clicks on the item color UI
+ * @returns {void} - Nothing
+ */
+declare function ItemColorPaginationClick(): void;
+/**
+ *  Handles exit button clicks on the item color UI
+ *  @returns {void} - Nothing
+ */
+declare function ItemColorExitClick(): void;
+/**
+ * Saves any item color changes and exits the item color screen completely
+ * @returns {void} - Nothing
+ */
+declare function ItemColorSaveAndExit(): void;
+/**
+ * Discards any item color changes and exits the item color screen completely
+ * @returns {void} - Nothing
+ */
+declare function ItemColorCancelAndExit(): void;
+/**
+ * Handles save button clicks on the item color UI
+ * @returns {void} - Nothing
+ */
+declare function ItemColorSaveClick(): void;
+/**
+ * Handles color picker cancellation clicks when the item color UI is in color picker mode
+ * @returns {void} - Nothing
+ */
+declare function ItemColorPickerCancel(): void;
+/**
+ * Takes the item color UI out of color picker mode. If the item being colored only has a single color index, this function calls any
+ * registered item color exit handlers
+ * @param {boolean} save - Whether or not changes should be saved on exiting color picker mode
+ * @returns {void} - Nothing
+ */
+declare function ItemColorCloseColorPicker(save: boolean): void;
+/**
+ * Gets the color indices that belong in the provided color group
+ * @param {ColorGroup} colorGroup - The color group to fetch color indices for
+ * @returns {number[]} - A list of color indices for any layers within the provided color group
+ */
+declare function ItemColorGetColorIndices(colorGroup: ColorGroup): number[];
+/**
+ * Toggles the item color UI into color picker mode
+ * @param {ColorGroup} colorGroup - The color group that is being colored
+ * @returns {void} - Nothing
+ */
+declare function ItemColorOpenPicker(colorGroup: ColorGroup): void;
+/**
+ * Cycles a color group's color to the next color in the asset group's color schema, or to "Default" if the color group is not currently
+ * colored with a single color from the color schema
+ * @param {ColorGroup} colorGroup - The color group that is being colored
+ * @returns {void} - Nothing
+ */
+declare function ItemColorNextColor(colorGroup: ColorGroup): void;
+/**
+ * Switches the item color UI to the next layer within the provided color group
+ * @param {ColorGroup} colorGroup - The color group whose layers to cycle
+ * @returns {void} - Nothing
+ */
+declare function ItemColorNextLayer(colorGroup: ColorGroup): void;
+/**
+ * Switches the item color UI to the previous layer within the provided color group
+ * @param {ColorGroup} colorGroup - The color group whose layers to cycle
+ * @returns {void} - Nothing
+ */
+declare function ItemColorPreviousLayer(colorGroup: ColorGroup): void;
+/**
+ * @param {Item} item
+ * @param {readonly AssetLayer[]} colorableLayers
+ * @returns {ColorGroup[]}
+ */
+declare function ItemColorGetGroups(item: Item, colorableLayers: readonly AssetLayer[]): ColorGroup[];
+/**
+ * Builds the item color UI's current state based on the provided character, item and position parameters. This only rebuilds the state if
+ * needed.
+ * @param {Character} c - The character being colored
+ * @param {Item} item - The item being colored
+ * @param {number} x - The x-coordinate at which to draw the UI
+ * @param {number} y - The y-coordinate at which to draw the UI
+ * @param {number} width - The width the UI should be drawn at
+ * @param {number} height - The height the UI should be drawn at
+ * @param {boolean} [includeResetButton=false] - Whether or not to include the "Reset to default" button
+ * @returns {void} - Nothing
+ */
+declare function ItemColorStateBuild(c: Character, item: Item, x: number, y: number, width: number, height: number, includeResetButton?: boolean): void;
+/**
+ * Returns layers of the asset which can be given distinct colors
+ * @param {Item} item - The item to be colored
+ * @returns {AssetLayer[]} - The colourable layers
+ */
+declare function ItemColorGetColorableLayers(item: Item): AssetLayer[];
+/**
+ * Returns whether or not the item can have only a single color or multiple colors
+ * @param {Item} item - The item to be colored
+ * @returns {boolean} - Whether the item only allows one color
+ */
+declare function ItemColorIsSimple(item: Item): boolean;
+/**
+ * Fetches the color button text key for the provided item color. If the item's color is already a string, the color string is returned.
+ * Otherwise, returns "Many" or "Default" as appropriate.
+ * @param {string | readonly string[]} color - The item color
+ * @returns {string} - The appropriate color button key for the provided item color(s)
+ */
+declare function ItemColorGetColorButtonTextKey(color: string | readonly string[]): string;
+/**
+ * Fetches the color button text for the provided item color. If the item's color is already a string, the color string is returned.
+ * Otherwise, returns "Many" or "Default" as appropriate.
+ * @param {string | readonly string[]} color - The item color
+ * @returns {string} - The appropriate color button text for the provided item color(s), translated to the current game language
+ */
+declare function ItemColorGetColorButtonText(color: string | readonly string[]): string;
+/**
+ * Registers an exit callback to the item color UI which will be called when the UI is exited.
+ * @param {itemColorExitListener} callback - The exit listener to register
+ * @returns {void} - Nothing
+ */
+declare function ItemColorOnExit(callback: itemColorExitListener): void;
+/**
+ * Handles exiting the item color UI. Appropriate text caches are dropped, and any registered exit listeners are called.
+ * @param {boolean} save - Whether or not the appearance changes applied by the item color UI should be saved
+ * @returns {void} - Nothing
+ */
+declare function ItemColorFireExit(save: boolean): void;
+/**
+ * Resets color UI related global variables back to their default states.
+ * @returns {void} - Nothing
+ */
+declare function ItemColorReset(): void;
+/**
+ * Check whether the current colors of the item match the item's default colors
+ * @param {Item} Item - The appearance item to check
+ * @returns {boolean} - Whether the item has default color(s)
+ */
+declare function ItemColorIsDefault(Item: Item): boolean;
+declare namespace ItemColorConfig {
+    const buttonSpacing: number;
+    const buttonSize: number;
+    const headerButtonSize: number;
+    const colorPickerButtonWidth: number;
+    const colorDisplayWidth: number;
+    const colorInputHeight: number;
+}
+/**
+ * An enum for the possible item color UI modes
+ * @readonly
+ * @type {{DEFAULT: "Default", COLOR_PICKER: "ColorPicker"}}
+ */
+declare const ItemColorMode: {
+    DEFAULT: "Default";
+    COLOR_PICKER: "ColorPicker";
+};
+/** @type {Character} */
+declare let ItemColorCharacter: Character;
+/** @type {Item} */
+declare let ItemColorItem: Item;
+/** @type {ItemColorMode} */
+declare let ItemColorCurrentMode: ItemColorMode;
+/** @type {string} */
+declare let ItemColorStateKey: string;
+/** @type {ItemColorStateType} */
+declare let ItemColorState: ItemColorStateType;
+/** @type {number} */
+declare let ItemColorPage: number;
+/** @type {Record<string, number>} */
+declare let ItemColorLayerPages: Record<string, number>;
+/** @type {string} */
+declare let ItemColorPickerBackup: string;
+/** @type {number[]} */
+declare let ItemColorPickerIndices: number[];
+/** @type {itemColorExitListener[]} */
+declare let ItemColorExitListeners: itemColorExitListener[];
+/** @type {string} */
+declare let ItemColorBackup: string;
+declare let ItemColorText: TextCache;
+/** @type {TextCache} */
+declare let ItemColorLayerNames: TextCache;
+/** @type {TextCache} */
+declare let ItemColorGroupNames: TextCache;
+declare function ItemColorOnPickerChange(color: any): void;

package/bc/Screens/Character/Login/Login.d.ts

@@ -0,0 +1,194 @@
+/**
+ * Loads the next thank you bubble
+ * @returns {void} Nothing
+ */
+declare function LoginDoNextThankYou(): void;
+/**
+ * Draw the credits
+ * @returns {void} Nothing
+ */
+declare function LoginDrawCredits(): void;
+/**
+ * Loads the character login screen
+ * @returns {void} Nothing
+ */
+declare function LoginLoad(): void;
+/**
+ * Runs the character login screen
+ * @returns {void} Nothing
+ */
+declare function LoginRun(): void;
+/**
+ * Perform the inventory and appearance fixups needed.
+ *
+ * This is called by the login code, after the player's item lists are set up
+ * but before the inventory and appearance are loaded from the server's data,
+ * and applies the specified asset fixups by swapping Old with New in the list
+ * of owned items, in the various player item lists, and in the appearance.
+ *
+ * If you're only moving items around, it should work just fine as long as
+ * the `Old` and `New` asset definitions are compatible.
+ * If it's an asset merge (say 3 into one typed asset), it will either set
+ * the fixed up item to the specified `Option` or the first one if unspecified.
+ *
+ * TODO: only typed items are supported.
+ *
+ * @param {Record<string, string[]>} Inventory - The server-provided inventory object
+ * @param {{Group: AssetGroupName, Name: string, Property?: any}[]} Appearance - The server-provided appearance object
+ * @param {CraftingItem[]} Crafting - The server-provided, uncompressed crafting data
+ */
+declare function LoginPerformInventoryFixups(Inventory: Record<string, string[]>, Appearance: {
+    Group: AssetGroupName;
+    Name: string;
+    Property?: any;
+}[], Crafting: CraftingItem[]): void;
+/**
+ * Make sure the slave collar is equipped or unequipped based on the owner
+ * @returns {void} Nothing
+ */
+declare function LoginValidCollar(): void;
+/**
+ * Adds or confiscates Club Mistress items from the player. Only players that are club Mistresses can have the Mistress
+ * Padlock & Key
+ * @returns {void} Nothing
+ */
+declare function LoginMistressItems(): void;
+/**
+ * Give the matching RewardMemberNumber Club Card to the player
+ * @returns {void} Nothing
+ */
+declare function LoginClubCard(): void;
+/**
+ * Adds or confiscates pony equipment from the player. Only players that are ponies or trainers can have the pony
+ * equipment.
+ * @returns {void} Nothing
+ */
+declare function LoginStableItems(): void;
+/**
+ * Adds or confiscates maid items from the player. Only players that have joined the Maid Sorority can have these items.
+ * @returns {void} - Nothing
+ */
+declare function LoginMaidItems(): void;
+/**
+ * Ensures lover-exclusive items are removed if the player has no lovers.
+ * @returns {void} Nothing
+ */
+declare function LoginLoversItems(): void;
+/**
+ * Adds or removes Asylum items. Only players that have previously maxed out their patient or nurse reputation are
+ * eligible for their own set of Asylum restraints outside the Asylum.
+ * @returns {void} - Nothing
+ */
+declare function LoginAsylumItems(): void;
+/**
+ * Adds items if specific cheats are enabled
+ * @returns {void} - Nothing
+ */
+declare function LoginCheatItems(): void;
+/**
+ * Checks every owned item to see if its BuyGroup contains an item the player does not have. This allows the player to
+ * collect any items that have been added to the game which are in a BuyGroup that they have already purchased.
+ * @returns {void} Nothing
+ */
+declare function LoginValideBuyGroups(): void;
+/**
+ * Checks if the player arrays contains any item that does not exists and saves them.
+ * @returns {void} Nothing
+ */
+declare function LoginValidateArrays(): void;
+/**
+ * Makes sure the difficulty restrictions are applied to the player
+ * @param {boolean} applyDefaults - If changing to the difficulty, set this to True to set LimitedItems to the default settings
+ * @returns {void} Nothing
+ */
+declare function LoginDifficulty(applyDefaults: boolean): void;
+/**
+ * Set the item permissions for the Extreme difficulty
+ * @param {boolean} applyDefaults - When initially changing to extreme/whitelist, TRUE sets strong locks to limited permissions. When enforcing
+ * settings, FALSE allows them to remain as they are since the player could have changed them to fully open.
+ * @returns {void} Nothing
+ */
+declare function LoginExtremeItemSettings(applyDefaults: boolean): void;
+/**
+ * Handles server response, when login has been queued
+ * @param {number} Pos The position in queue
+ */
+declare function LoginQueue(Pos: number): void;
+/**
+ * Handles player login response data
+ * @param {object | string} C - The Login response data - this will either be the player's character data if the
+ * login was successful, or a string error message if the login failed.
+ * @returns {void} Nothing
+ */
+declare function LoginResponse(C: object | string): void;
+/**
+ * Handles player click events on the character login screen
+ * @returns {void} Nothing
+ */
+declare function LoginClick(): void;
+/**
+ * Handles player keyboard events on the character login screen, "enter" will login
+ * @returns {void} Nothing
+ */
+declare function LoginKeyDown(): void;
+/**
+ * Attempt to log the user in based on their input username and password
+ * @returns {void} Nothing
+ */
+declare function LoginDoLogin(): void;
+/**
+ * Sets the state of the login page to the submitted state
+ * @returns {void} Nothing
+ */
+declare function LoginSetSubmitted(): void;
+/**
+ * Resets the login submission state
+ * @param {string} [ErrorMessage] - the login error message to set if the login is invalid - if not specified, will clear the login error message
+ * @param {boolean} [IsRelog=false] - whether or not we're on the relog screen
+ * @returns {void} Nothing
+ */
+declare function LoginStatusReset(ErrorMessage?: string, IsRelog?: boolean): void;
+/**
+ * Updates the message on the login page
+ * @returns {void} Nothing
+ */
+declare function LoginUpdateMessage(): void;
+/**
+ * Retrieves the correct message key based on the current state of the login page
+ * @returns {string} The key of the message to display
+ */
+declare function LoginGetMessageKey(): string;
+/**
+ * Exit function - called when leaving the login page
+ * @returns {void} - Nothing
+ */
+declare function LoginExit(): void;
+declare var LoginBackground: string;
+declare var LoginMessage: string;
+/** @type {null | string[][]} */
+declare var LoginCredits: null | string[][];
+declare var LoginCreditsPosition: number;
+declare var LoginThankYou: string;
+declare var LoginThankYouList: string[];
+declare var LoginThankYouNext: number;
+declare var LoginSubmitted: boolean;
+declare var LoginIsRelog: boolean;
+declare var LoginErrorMessage: string;
+declare var LoginCharacter: any;
+declare let LoginTextCacheUnsubscribeCallback: any;
+/**
+ * The list of item fixups to apply on login.
+ *
+ * @type {{ Old: {Group: AssetGroupName, Name: string}, New: {Group: AssetGroupName, Name: string, Option?: string} }[]}
+ */
+declare let LoginInventoryFixups: {
+    Old: {
+        Group: AssetGroupName;
+        Name: string;
+    };
+    New: {
+        Group: AssetGroupName;
+        Name: string;
+        Option?: string;
+    };
+}[];

package/bc/Screens/Character/OnlineProfile/OnlineProfile.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Loads the online profile screen by creating its input
+ * @returns {void} - Nothing
+ */
+declare function OnlineProfileLoad(): void;
+/**
+ * Runs and draws the online profile screen
+ * @returns {void} - Nothing
+ */
+declare function OnlineProfileRun(): void;
+/**
+ * Handles clicks in the online profile screen
+ * @returns {void} - Nothing
+ */
+declare function OnlineProfileClick(): void;
+/**
+ * Handles exiting while in the online profile screen. It removes the input and saves the description.
+ * @param {boolean} Save - Whether or not we should save the changes
+ * @returns {void} - Nothing
+ */
+declare function OnlineProfileExit(Save: boolean): void;
+declare var OnlineProfileBackground: string;
+/**
+ * Character used to signal, that description is compressed
+ * @readonly
+ */
+declare var ONLINE_PROFILE_DESCRIPTION_COMPRESSION_MAGIC: string;

package/bc/Screens/Character/PasswordReset/PasswordReset.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Loads the password reset screen
+ * @returns {void} Nothing
+ */
+declare function PasswordResetLoad(): void;
+/**
+ * Runs the password reset screen
+ * @returns {void} Nothing
+ */
+declare function PasswordResetRun(): void;
+/**
+ * Handles a password reset response
+ * @param {string} msg - The password reset response message to be displayed to the player
+ * @returns {void} Nothing
+ */
+declare function PasswordResetResponse(msg: string): void;
+/**
+ * Handles player click events on the password reset screen
+ * @returns {void} Nothing
+ */
+declare function PasswordResetClick(): void;
+/**
+ * Sends the player back to the login screen
+ * @returns {void} Nothing
+ */
+declare function PasswordResetExit(): void;
+declare var PasswordResetBackground: string;
+declare var PasswordResetMessage: string;