bc-stubs 96.0.0

package/bc/Screens/Online/ChatRoom/Commands.d.ts

@@ -0,0 +1,66 @@
+/**
+ * Loads the commands for the Player
+ * @returns {void} - Nothing
+ */
+declare function CommandsLoad(): void;
+/**
+ * Translates the help for commands
+ * @returns {void} - Nothing
+ */
+declare function CommandsTranslate(): void;
+/**
+ * Gets all available commands
+ * @returns [ICommand[]]
+ */
+declare function GetCommands(): ICommand[];
+/**
+ * Fill the user input with the command
+ * @param {string} command
+ * @returns {void} - Nothing
+ */
+declare function CommandSet(command: string): void;
+/**
+ * Add a list of commands
+ * @param {ICommand | ICommand[]} add - Commands to add
+ * @returns {void} - Nothing
+ */
+declare function CommandCombine(add: ICommand | ICommand[]): void;
+/**
+ * Parse the input chat message
+ * @param {string} msg - Input string, cannot be empty
+ */
+declare function CommandParse(msg: string): void;
+/**
+ * Prints out the help for commands with tags that include low
+ * @param {string} low - lower case search keyword for tags
+ * @param {number} [timeout] - total time to display the help message in ms
+ * @returns {void} - Nothing
+ */
+declare function CommandHelp(low: string, timeout?: number): void;
+/**
+ * Prints out the help for commands
+ * @param {Optional<ICommand, 'Action'>[]} CommandList - list of commands
+ * @param {number} Timeout - total time to display the help message in ms
+ */
+declare function CommandPrintHelpFor(CommandList: Optional<ICommand, 'Action'>[], Timeout: number): void;
+/**
+ * Finds command and executes it from the message
+ * @param {string} msg - User input
+ * @returns {void} - Nothing
+ */
+declare function CommandExecute(msg: string): void;
+/**
+ * Tries to complete the message to a command or print help about it
+ * @param {string} msg - InputChat content
+ */
+declare function CommandAutoComplete(msg: string): void;
+/** @type {ICommand[]} */
+declare var Commands: ICommand[];
+/** @readonly */
+declare let CommandsKey: "/";
+/** @type {TextCache} */
+declare let CommandText: TextCache;
+/**
+ * @type {ICommand[]}
+ */
+declare const CommonCommands: ICommand[];

package/bc/Screens/Online/ChatSearch/ChatSearch.d.ts

@@ -0,0 +1,241 @@
+/**
+ * Loads the chat search screen properties, creates the inputs and loads up the first 24 rooms.
+ * @returns {void} - Nothing
+ */
+declare function ChatSearchLoad(): void;
+/**
+ * When the chat Search screen runs, draws the screen
+ * @returns {void} - Nothing
+ */
+declare function ChatSearchRun(): void;
+/**
+ * Handles the click events on the chat search screen. Is called from CommonClick()
+ * @returns {void} - Nothing
+ */
+declare function ChatSearchClick(): void;
+/**
+ * @returns {boolean} - True if the player changed the options and the apply/revert buttons should show
+ */
+declare function ChatSearchChangedLanguageOrFilterTerms(): boolean;
+/**
+ * While in filter view, called when player clicks apply, presses enter, or returns to the normal view.
+ * Saves the "temp" options into their normal variables, and sends them to the server.
+ * Also refreshes the displayed rooms accordingly.
+ * @returns {void} - Nothing
+ */
+declare function ChatSearchSaveLanguageAndFilterTerms(): void;
+/**
+ * While in filter view, calls when player clicks revert.
+ * Also called when entering the filter view, so that the values are correct on first load or if they got changed in any other way somehow.
+ * Loads the "temp" options from their normal variables, and updates the search box.
+ * @returns {void} - Nothing
+ */
+declare function ChatSearchLoadLanguageAndFilterTerms(): void;
+/**
+ * Handles the key presses while in the chat search screen.
+ * When the user presses enter, we launch the search query or save the temp options.
+ * @returns {void} - Nothing
+ */
+declare function ChatSearchKeyDown(): void;
+/**
+ * Handles exiting from the chat search screen, removes the input.
+ * @returns {void} - Nothing
+ */
+declare function ChatSearchExit(): void;
+/**
+ * Draws the filter mode help screen: just text and a back button.
+ * @returns {void} - Nothing
+ */
+declare function ChatSearchFilterHelpDraw(): void;
+/**
+ * Draws the filter mode unhide confirm screen: just text and confirm/cancel buttons.
+ * @returns {void} - Nothing
+ */
+declare function ChatSearchFilterUnhideConfirmDraw(): void;
+/**
+ * Draws the list of rooms in normal mode.
+ * @returns {void} - Nothing
+ */
+declare function ChatSearchNormalDraw(): void;
+/**
+ * Garbles based on immersion settings
+ * @param {string} Text - The text to garble
+ * @returns {string} - Garbled text
+ */
+declare function ChatSearchMuffle(Text: string): string;
+/**
+ * Draws the list of rooms in permission mode.
+ * @returns {void} - Nothing
+ */
+declare function ChatSearchPermissionDraw(): void;
+/**
+ * Handles the clicks related to the chatroom list when in normal mode
+ * @returns {void} - Nothing
+ */
+declare function ChatSearchJoin(): void;
+/**
+ * Switch the search screen between the normal view and the filter mode which allows hiding of rooms
+ * @returns {void} - Nothing
+ */
+declare function ChatSearchToggleSearchMode(): void;
+/**
+ * Switch to the Hidden Rooms view or back again.
+ * Correctly handles adding/removing the input box as needed.
+ * @returns {void} - Nothing
+ */
+declare function ChatSearchToggleHiddenMode(): void;
+/**
+ * Switch to the Filter Help view or back again.
+ * Correctly handles adding/removing the input box as needed.
+ * @returns {void} - Nothing
+ */
+declare function ChatSearchToggleHelpMode(): void;
+/**
+ * Adds/removes event listeners to the input box when entering/exiting filter view.
+ * @param {boolean} add - true to add listeners, false to remove.
+ * @returns {void} - Nothing
+ */
+declare function ChatSearchSetFilterChangeHandler(add: boolean): void;
+/**
+ * Handles the input box being changed in any way, while in filter view.
+ * Makes sure the "temp" filter terms variable is kept updated, so the apply/revert buttons will appear/disappear at the correct times.
+ * @returns {void} - Nothing
+ */
+declare function ChatSearchFilterChangeHandler(): void;
+/**
+ * Handles the clicks related to the chatroom list when in permission mode
+ * @returns {void} - Nothing
+ */
+declare function ChatSearchClickPermission(): void;
+/**
+ * Does whatever is necessary to unhide a room.
+ * Shows a confirmation screen first, unless the only reason is "TempHidden".
+ * This is called when clicking a room in the list and also, if a confirmation is shown, called again when the confirm button is clicked.
+ *
+ * @param {number} C - Index of the room within ChatSearchHiddenResult
+ * @param {boolean} Confirmed - False when clicking on room list, true when clicking Confirm button
+ */
+declare function ChatSearchClickUnhideRoom(C: number, Confirmed: boolean): void;
+/**
+ * Handles the reception of the server response when joining a room or when getting banned/kicked
+ * @param {string} data - Response from the server
+ * @returns {void} - Nothing
+ */
+declare function ChatSearchResponse(data: string): void;
+/**
+ * Censors the chat search result name and description based on the player preference
+ * @returns {void} - Nothing
+ */
+declare function ChatSearchCensor(): void;
+/**
+ * Handles the reception of the server data when it responds to the search query
+ * @param {readonly any[]} data - Response from the server, contains the room list matching the query
+ * @returns {void} - Nothing
+ */
+declare function ChatSearchResultResponse(data: readonly any[]): void;
+/**
+ * Automatically join a room, for example due to leashes or reconnect
+ * @returns {void} - Nothing
+ */
+declare function ChatSearchAutoJoinRoom(): void;
+/**
+ * Sends the search query data to the server. The response will be handled by ChatSearchResponse once it is received
+ * @returns {void} - Nothing
+ */
+declare function ChatSearchQuery(): void;
+/**
+ * Sorts the room result based on a player's settings
+ * @returns {void} - Nothing
+ */
+declare function ChatSearchQuerySort(): void;
+/**
+ * Remove any rooms from the room list which contain the player's filter terms in the name
+ * @returns {void} - Nothing
+ */
+declare function ChatSearchApplyFilterTerms(): void;
+/**
+ * Get a list of reasons why a room should be hidden.
+ * If the returned array is empty, the room should be shown.
+ * @param {{ Name: string, CreatorMemberNumber: number }} Room - the room object to check
+ * @returns {string[]} - list of reasons
+ */
+declare function ChatSearchGetFilterReasons(Room: {
+    Name: string;
+    CreatorMemberNumber: number;
+}): string[];
+/**
+ * Check if a room matches filtered-out terms and should thus be hidden.
+ * Also used when deciding which terms need to be removed from the filter option in order to make a room be no longer hidden.
+ * Only checks the room name, not the description.
+ * @param {{ Name: string }} Room - the room object to check
+ * @param {string[]} Terms - list of terms to check
+ * @returns {boolean} - true if room matches, false otherwise
+ */
+declare function ChatSearchMatchesTerms(Room: {
+    Name: string;
+}, Terms: string[]): boolean;
+/**
+ * Calculates starting offset for the ignored rooms list when displaying results in filter/permission mode.
+ * @param {number} shownRooms - Number of rooms shown before the ignored rooms.
+ * @returns {number} - Starting offset for ingored rooms
+ */
+declare function ChatSearchCalculateIgnoredRoomsOffset(shownRooms: number): number;
+declare var ChatSearchBackground: string;
+/** @type {{ Name: string, CreatorMemberNumber: number, MemberLimit: number, MemberCount: number, DisplayName: string, BlockCategory: ChatRoomBlockCategory[], Game: ChatRoomGame, Friends: { MemberName: string, MemberNumber: number, Type: string }[], Description: string, Creator: string, Order: number }[]} */
+declare var ChatSearchResult: {
+    Name: string;
+    CreatorMemberNumber: number;
+    MemberLimit: number;
+    MemberCount: number;
+    DisplayName: string;
+    BlockCategory: ChatRoomBlockCategory[];
+    Game: ChatRoomGame;
+    Friends: {
+        MemberName: string;
+        MemberNumber: number;
+        Type: string;
+    }[];
+    Description: string;
+    Creator: string;
+    Order: number;
+}[];
+/** @type {typeof ChatSearchResult} */
+declare var ChatSearchHiddenResult: typeof ChatSearchResult;
+declare var ChatSearchLastSearchDataJSON: string;
+declare var ChatSearchLastQuerySearchTime: number;
+declare var ChatSearchLastQueryJoin: string;
+declare var ChatSearchLastQueryJoinTime: number;
+declare var ChatSearchResultOffset: number;
+declare var ChatSearchRoomsPerPage: number;
+declare var ChatSearchMessage: string;
+declare var ChatSearchLeaveRoom: string;
+/** @type {ModuleType} */
+declare var ChatSearchLeaveSpace: ModuleType;
+/** @type {null | Item[]} */
+declare var ChatSearchSafewordAppearance: null | Item[];
+/** @type {null | AssetPoseName[]} */
+declare var ChatSearchSafewordPose: null | AssetPoseName[];
+/** @type {null | AssetPoseName[]} */
+declare var ChatSearchPreviousActivePose: null | AssetPoseName[];
+/** @type {number[]} */
+declare var ChatSearchTempHiddenRooms: number[];
+/** @type {"" | "Filter"} */
+declare var ChatSearchMode: "" | "Filter";
+declare var ChatSearchGhostPlayerOnClickActive: boolean;
+declare var ChatSearchShowHiddenRoomsActive: boolean;
+declare var ChatSearchFilterHelpActive: boolean;
+/** @type {null | { Index: number, RoomLabel: string, MemberLabel: string, WordsLabel: string }} */
+declare var ChatSearchFilterUnhideConfirm: null | {
+    Index: number;
+    RoomLabel: string;
+    MemberLabel: string;
+    WordsLabel: string;
+};
+declare var ChatSearchRejoinIncrement: number;
+/** @type {null | string} */
+declare var ChatSearchReturnToScreen: null | string;
+/** @type {"" | ChatRoomLanguage} */
+declare var ChatSearchLanguage: "" | ChatRoomLanguage;
+/** @type {"" | ChatRoomLanguage} */
+declare var ChatSearchLanguageTemp: "" | ChatRoomLanguage;
+declare var ChatSearchFilterTermsTemp: string;

package/bc/Screens/Online/ChatSelect/ChatSelect.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Runs the chatroom search select screen
+ * @returns {void} - Nothing
+ */
+declare function ChatSelectRun(): void;
+/**
+ * Handles clicks on the chat select screen
+ * @returns {void} - Nothing
+ */
+declare function ChatSelectClick(): void;
+/**
+ * Loads the chat select screen, automatically joining a chat search space if configured
+ * @returns {void} - Nothing
+ */
+declare function ChatSelectLoad(): void;
+/**
+ * Start the chat search screen for the relevant chat room space
+ * @param {ChatRoomSpaceType} space - The space to join
+ */
+declare function ChatSelectStartSearch(space: ChatRoomSpaceType): void;
+declare function ChatSelectExit(): void;
+/**
+ * Returns whether all provided genders are allowed in the specified space
+ * @param {string} space - The chatroom space
+ * @param {string[]} genders - A list of relevant genders to check#
+ * @returns {boolean} - Whether the genders are allowed
+ */
+declare function ChatSelectGendersAllowed(space: string, genders: string[]): boolean;
+declare var ChatSelectBackground: string;
+/** @type {boolean} */
+declare var ChatSelectAllowedInFemaleOnly: boolean;
+/** @type {boolean} */
+declare var ChatSelectAllowedInMaleOnly: boolean;

package/bc/Screens/Online/ForbiddenWords/ForbiddenWords.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Loads the forbidden words screen, fetches the word list from the current character rules
+ * @returns {void} - Nothing
+ */
+declare function ForbiddenWordsLoad(): void;
+/**
+ * Starts the forbidden words screen and loads it
+ * @returns {void} - Nothing
+ */
+declare function ForbiddenWordsOpen(RuleType: any): void;
+/**
+ * Draws the forbidden words text and check boxes
+ * @returns {void} - Nothing
+ */
+declare function ForbiddenWordsRun(): void;
+/**
+ * Handles the click events.  Called from CommonClick()
+ * @returns {void} - Nothing
+ */
+declare function ForbiddenWordsClick(): void;
+/**
+ * Handles exiting from the screen, updates the sub rules
+ * @returns {void} - Nothing
+ */
+declare function ForbiddenWordsExit(): void;
+declare var ForbiddenWordsBackground: string;
+/** @type {null | Character } */
+declare var ForbiddenWordsTarget: null | Character;
+/** @type {string[]} */
+declare var ForbiddenWordsList: string[];
+declare var ForbiddenWordsOffset: number;
+declare var ForbiddenWordsConsequence: string;
+declare var ForbiddenWordsConsequenceList: string[];

package/bc/Screens/Online/Game/OnlineGame.d.ts

@@ -0,0 +1,69 @@
+/**
+ * Loads the online game dictionary that will be used throughout the game to output messages
+ * @returns {void} - Nothing
+ */
+declare function OnlneGameDictionaryLoad(): void;
+/**
+ * @param {string} CachePath
+ * @returns {void}
+ */
+declare function OnlineGameTranslate(CachePath: string): void;
+/**
+ * Searches in the dictionary for a specific keyword and returns the message linked to it
+ * @param {string} KeyWord - Keyword of the text to look for
+ * @returns {string} The text attached to the keyword, will return a missing text if it was not found
+ */
+declare function OnlineGameDictionaryText(KeyWord: string): string;
+/**
+ * Catches the character click from chat rooms and make sure the online game doesn't need to handle them
+ * @param {Character} C - Character that has been clicked on
+ * @return {boolean} Returns the return content of click function of the currently selected game, or false if there is no corresponding game
+ */
+declare function OnlineGameClickCharacter(C: Character): boolean;
+/**
+ * Catches the chat room clicks and make sure the online game doesn't need to handle them
+ * @return {boolean} Returns the return content of click function of the currently selected game, or false if there is no corresponding game
+ */
+declare function OnlineGameClick(): boolean;
+/**
+ * Run the corresponding online game scripts
+ * @returns {void} - Nothing
+ */
+declare function OnlineGameRun(): void;
+/**
+ * Checks if clothes can be changed in an online game space
+ * @returns {boolean} - Returns TRUE if there's no online game that currently blocks changing
+ */
+declare function OnlineGameAllowChange(): boolean;
+/**
+ * Checks if blocking items is currently allowed
+ * @returns {boolean} - Returns TRUE if the online game allows you to block items
+ */
+declare function OnlineGameAllowBlockItems(): boolean;
+/**
+ * Retrieves the current status of online games and stores it
+ * @returns {void} - Nothing
+ */
+declare function OnlineGameLoadStatus(): void;
+/**
+ * Resets the game status if needed when the chat room data is updated
+ * @returns {void} - Nothing
+ */
+declare function OnlineGameReset(): void;
+/**
+ * Returns TRUE if the MemberPlayer supplied is still in the current chat room
+ * @param {number} MemberNumber - The number to validate
+ * @returns {boolean} - Returns TRUE if that number is still in the room
+ */
+declare function OnlineGameCharacterInChatRoom(MemberNumber: number): boolean;
+/**
+ * Draws the online game images/text needed on the characters
+ * @param {Character} C - Character to draw the info for
+ * @param {number} X - Position of the character the X axis
+ * @param {number} Y - Position of the character the Y axis
+ * @param {number} Zoom - Amount of zoom the character has (Height)
+ * @returns {void} - Nothing
+ */
+declare function OnlineGameDrawCharacter(C: Character, X: number, Y: number, Zoom: number): void;
+/** @type {null | string[][]} */
+declare let OnlineGameDictionary: null | string[][];

package/bc/Screens/Online/GameClubCard/GameClubCard.d.ts

@@ -0,0 +1,131 @@
+/**
+ * Gets the current state of online Club Card.
+ * @returns {OnlineGameStatus}
+ */
+declare function GameClubCardGetStatus(): OnlineGameStatus;
+/**
+ * Set the current state of online Club Card.
+ * @param {OnlineGameStatus} s
+ * @returns {void}
+ */
+declare function GameClubCardSetStatus(s: OnlineGameStatus): void;
+/**
+ * Checks if the character is an admin for the room/game.
+ * @param {Character} C - Character to check for
+ * @returns {boolean} -  Returns TRUE if that character is an admin/the game administrator
+ */
+declare function GameClubCardIsAdmin(C: Character): boolean;
+/**
+ * Draws the Club Card icon of a character
+ * @param {Character} C - Character for which to draw the icons
+ * @param {number} X - Position on the X axis of the canvas
+ * @param {number} Y - Position on the Y axis of the canvas
+ * @param {number} Zoom - Zoom factor of the character
+ * @returns {void} - Nothing
+ */
+declare function GameClubCardDrawIcon(C: Character, X: number, Y: number, Zoom: number): void;
+/**
+ * Draws the online game images/text needed on the characters
+ * @param {Character} C - Character to draw the info for
+ * @param {number} X - Position of the character the X axis
+ * @param {number} Y - Position of the character the Y axis
+ * @param {number} Zoom - Amount of zoom the character has (Height)
+ * @returns {void} - Nothing
+ */
+declare function GameClubCardDrawCharacter(C: Character, X: number, Y: number, Zoom: number): void;
+/**
+ * Loads the online Club Card configuration screen.
+ * @returns {void} - Nothing
+ */
+declare function GameClubCardLoad(): void;
+/**
+ * Runs the online Club Card configuration screen
+ * @returns {void} - Nothing
+ */
+declare function GameClubCardRun(): void;
+/**
+ * Handles clicks in the online Club Card configuration screen
+ * @returns {void} - Nothing
+ */
+declare function GameClubCardClick(): void;
+/**
+ * Triggered when the player exits the Club Card config screen.
+ * @returns {void} - Nothing
+ */
+declare function GameClubCardExit(): void;
+/**
+ * Checks there's 1 player in slot 1 and slot 2 so we can start the game.
+ * @returns {boolean} - Returns TRUE if the game can be launched
+ */
+declare function GameClubCardCanLaunchGame(): boolean;
+/**
+ * Returns TRUE if the game is running and can be joined
+ * @returns {boolean} - TRUE if the player can join
+ */
+declare function GameClubCardCanJoinGame(): boolean;
+/**
+ * Resets the online Club Card game so a new game might be started
+ * @returns {void} - Nothing
+ */
+declare function GameClubCardReset(): void;
+/**
+ * Ensure all character's Club Card game status are the same
+ * @returns {void} - Nothing
+ */
+declare function GameClubCardLoadStatus(): void;
+/**
+ * Creates a bundle of cards in a string to push to the server.
+ * @param {ClubCard[]} Cards - An array of c
+ * @param {boolean} IncludeTime - If we must include the time property
+ * @returns {string} - A string with all the cards
+ */
+declare function GameClubCardDoBundle(Cards: ClubCard[], IncludeTime?: boolean): string;
+/**
+ * Processes the club card game data received from the server
+ * @param {string} Bundle - An array of c
+ * @param {boolean} IncludeTime - If we must include the time property
+ * @param {string} Location - The location of the card
+ * @returns {ClubCard[]} - A string with all the cards
+ */
+declare function GameClubCardUndoBundle(Bundle: string, IncludeTime?: boolean, Location?: string): ClubCard[];
+/**
+ * Loads the full server bundle for a player
+ * @param {ClubCardPlayer} CCPlayer - The club card player
+ * @param {any} Bundle - An array of c
+ * @returns {void} - Nothing
+ */
+declare function GameClubCardLoadBundle(CCPlayer: ClubCardPlayer, Bundle: any): void;
+/**
+ * Assigns both club card players based on the players selection
+ * @param {IChatRoomGameResponse} Packet - The data packet to process
+ * @param {Character} Char - The character that's sending the packet
+ * @returns {void} - Nothing
+ */
+declare function GameClubCardAssignPlayers(Packet: IChatRoomGameResponse, Char: Character): void;
+/**
+ * Loads the club card game data
+ * @param {IChatRoomGameResponse} Packet - The data packet to process
+ * @returns {void} - Nothing
+ */
+declare function GameClubCardLoadData(Packet: IChatRoomGameResponse): void;
+/**
+ * Processes the club card game data received from the server
+ * @param {IChatRoomGameResponse} Packet - The data packet to process
+ * @returns {void} - Nothing
+ */
+declare function GameClubCardProcess(Packet: IChatRoomGameResponse): void;
+/**
+ * Syncs the online data with all players
+ * @param {string} Progress - The progress status to push (default to action)
+ * @returns {void} - Nothing
+ */
+declare function GameClubCardSyncOnlineData(Progress?: string): void;
+/**
+ * When the game ends, we go back to the online chat room
+ * @returns {void} - Nothing
+ */
+declare function GameClubCardEnd(): void;
+declare var GameClubCardBackground: string;
+declare var GameClubCardEntryPlayerSlot: number;
+declare var GameClubCardExpectQuery: boolean;
+declare var GameClubCardQueryAdmin: boolean;