bc-stubs 96.0.0

package/bc/Screens/MiniGame/PlayerAuction/PlayerAuction.d.ts

@@ -0,0 +1,36 @@
+/**
+ * Sets when the next bid will occur. It varies from 5 to 15 seconds, the auction gets slower and there are less bids the higher the price is.
+ * @returns {void} - Nothing
+ */
+declare function PlayerAuctionSetNextBidTime(): void;
+/**
+ * Creates a new customer to buy the player
+ * @param {number} Index - The index of the customer from the NPC table
+ * @returns {void} - Nothing
+ */
+declare function PlayerAuctionAddCustomer(Index: number): void;
+/**
+ * Loads the player auction mini game by setting the global variables and loading the NPCs required
+ * @returns {void} - Nothing
+ */
+declare function PlayerAuctionLoad(): void;
+/**
+ * Runs the player auction mini game by drawing the characters and related text on screen.
+ * @returns {void} - Nothing
+ */
+declare function PlayerAuctionRun(): void;
+/**
+ * Handles click events during the player auction minigame. The player can plead or end the auction.
+ * @returns {void} - Nothing
+ */
+declare function PlayerAuctionClick(): void;
+declare var PlayerAuctionBackground: string;
+/** @type {null | NPCCharacter[]} */
+declare var PlayerAuctionCustomer: null | NPCCharacter[];
+declare var PlayerAuctionBidCurrent: number;
+declare var PlayerAuctionBidTime: number;
+declare var PlayerAuctionBidNextTime: number;
+declare var PlayerAuctionBidAmount: number;
+declare var PlayerAuctionPlead: number;
+declare var PlayerAuctionSilenceMode: boolean;
+declare var PlayerAuctionEnd: boolean;

package/bc/Screens/MiniGame/PuppyWalker/PuppyWalker.d.ts

@@ -0,0 +1,39 @@
+/**
+ * Loads the puppy walker mini game and sets the difficulty, it's a little faster on mobile because it's easier.
+ * @returns {void} - Nothing
+ */
+declare function PuppyWalkerLoad(): void;
+/**
+ * Draws the puppy girl if she hasn't escaped
+ * @param {Character} Puppy - The puppy character to draw
+ * @param {number} X - Position on the X axis
+ * @param {number} Fail - Amount of failures for this puppy
+ * @returns {void} - Nothing
+ */
+declare function PuppyWalkerDraw(Puppy: Character, X: number, Fail: number): void;
+/**
+ * Runs the puppy walker mini game and draws the relevant information on the screen
+ * @returns {void} - Nothing
+ */
+declare function PuppyWalkerRun(): void;
+/**
+ * Validates if the mini game must end. The mini game ends when the timer is up or if a puppy escaped. Failing 3 moves of a given type counts as an escape.
+ * @returns {void} - Nothing
+ */
+declare function PuppyWalkerVerifyEnd(): void;
+/**
+ * Validate the moves, we raise the escape counter if it was invalid
+ * @param {number} MoveType - Type of move done, goes from 0 to 3. It represents the index of the PuppyWalkerEscape array
+ * @returns {void} - Nothing
+ */
+declare function PuppyWalkerDoMove(MoveType: number): void;
+/**
+ * Handles clicks during the puppy walker minigame
+ * @returns {void} - Nothing
+ */
+declare function PuppyWalkerClick(): void;
+declare var PuppyWalkerBackground: string;
+declare var PuppyWalkerMoves: number[];
+declare var PuppyWalkerMovesTimer: number[];
+declare var PuppyWalkerEscape: number[];
+declare var PuppyWalkerGenerateMoveTimer: number;

package/bc/Screens/MiniGame/RhythmGame/RhythmGame.d.ts

@@ -0,0 +1,76 @@
+/**
+ * Loads the rythm mini game after saving the main cancas to restore it once the game is done.
+ * @returns {void} - Nothing
+ */
+declare function RhythmGameLoad(): void;
+/**
+ * Runs and draws the canvas for the rythm mini game. The game uses objects to handle various processes.
+ * @returns {void} - Nothing
+ */
+declare function RhythmGameRun(): void;
+/**
+ * Handles the clicks in the rhythm mini-game.
+ * @returns {void} - Nothing
+ */
+declare function RhythmGameClick(): void;
+declare var RhythmGameBackground: string;
+declare let RhythmGameBeatmap: string;
+declare let RhythmGameDifficulty: string;
+declare let RhythmGameStarted: boolean;
+declare let RhythmGameEnded: boolean;
+declare let RhythmGamePassed: boolean;
+declare let RhythmGamePreloadCompleted: boolean;
+/**
+ * Rhythm game initialization object: Handles pre and post loading, invokes initialization of other objects.
+ * @constant
+ * @type {object} - The game initialization object. Contains the functions required to load the game.
+ */
+declare let RhythmGameInit: object;
+/**
+ * Rhythm game image object: Loads and caches the image resources.
+ * @constant
+ * @type {object} - The game image object. Contains the functions required to load the images.
+ */
+declare let RhythmGameImage: object;
+/**
+ * Rhythm game audio object: Handles loading audio and starting the music
+ * @constant
+ * @type {object} - The game audio object. Contains the functions required to load, start and stop the audio files.
+ */
+declare let RhythmGameAudio: object;
+/**
+ * Rhythm game chart object: Handles loading chart, parsing xml, caching chart for rendering and judging.
+ * @constant
+ * @type {object} - The game chart object. Contains the functions required to load the charts.
+ */
+declare let RhythmGameChart: object;
+/**
+ * Rhythm game keyboard input handler object: Handles keyboard inputs.
+ * @constant
+ * @type {object} - The game keyboard input handler object. Contains the functions and properties required to handle key press events.
+ */
+declare let RhythmGameKey: object;
+/**
+ * Rhythm game kernel object: Handles game timing.
+ * @constant
+ * @type {object} - The game kernel object. Contains the functions required to handle the game's timing.
+ */
+declare let RhythmGameKernel: object;
+/**
+ * Rhythm game script object: Handles game mechanics.
+ * @constant
+ * @type {object} - The game kernel object. Contains the functions related to game mechanics such as health, score and accuracy.
+ */
+declare let RhythmGameScript: object;
+/**
+ * Rhythm game render object: Handles game rendering.
+ * @constant
+ * @type {object} - The game render object. Contains the functions related to game rendering such as the visual effects and notes.
+ */
+declare let RhythmGameRender: object;
+/**
+ * Rhythm game integration object: Handles bondage club specific functions.
+ * @constant
+ * @type {object} - The game integration object. Contains the functions related to handling functions from the club such as punishing the player for being inaccurate.
+ */
+declare let RhythmGameIntegration: object;

package/bc/Screens/MiniGame/SlaveAuction/SlaveAuction.d.ts

@@ -0,0 +1,39 @@
+/**
+ * Sets when the next bid will occur. It varies from 5 to 15 seconds, the auction gets slower and there are less bids the higher the price is.
+ * @returns {void} - Nothing
+ */
+declare function SlaveAuctionSetNextBidTime(): void;
+/**
+ * Loads the slave auction mini game by setting the global variables and loading the NPCs required
+ * @returns {void} - Nothing
+ */
+declare function SlaveAuctionLoad(): void;
+/**
+ * Runs the slave auction mini game by drawing the characters and related text on screen.
+ * @returns {void} - Nothing
+ */
+declare function SlaveAuctionRun(): void;
+/**
+ * Handles click events during the slave auction minigame. The player can bid or end the auction.
+ * @returns {void} - Nothing
+ */
+declare function SlaveAuctionClick(): void;
+/**
+ * Handles the key press in the slave auction mini game, the C cheat key removes $50 from the current bid in progress
+ * @returns {void} - Nothing
+ */
+declare function SlaveAuctionKeyDown(): void;
+declare var SlaveAuctionBackground: string;
+/** @type {null | NPCCharacter} */
+declare var SlaveAuctionVendor: null | NPCCharacter;
+/** @type {null | NPCCharacter} */
+declare var SlaveAuctionSlave: null | NPCCharacter;
+/** @type {null | NPCCharacter} */
+declare var SlaveAuctionCustomerLeft: null | NPCCharacter;
+/** @type {null | NPCCharacter} */
+declare var SlaveAuctionCustomerRight: null | NPCCharacter;
+declare var SlaveAuctionBidCurrent: string;
+declare var SlaveAuctionBidTime: number;
+declare var SlaveAuctionBidNextTime: number;
+declare var SlaveAuctionBidAmount: number;
+declare var SlaveAuctionEnd: boolean;

package/bc/Screens/MiniGame/Tennis/Tennis.d.ts

@@ -0,0 +1,52 @@
+/**
+ * Called when a player servers, the angle can vary by 45 degrees up or down
+ * @param {boolean} CharacterLeftServe - TRUE if the character serving the ball is the left one.
+ * @returns {void} - Nothing
+ */
+declare function TennisServe(CharacterLeftServe: boolean): void;
+/**
+ * Gets the current score/status of the game
+ * @param {number} PointFor - Point of the player
+ * @param {number} PointAgainst - Point of the NPC
+ * @returns {string} - Score in text, or current status (Win, loss, advantage)
+ */
+declare function TennisGetScore(PointFor: number, PointAgainst: number): string;
+/**
+ * Loads the tennis mini game and sets the difficulty ratio before serving the first ball
+ * @returns {void} - Nothing
+ */
+declare function TennisLoad(): void;
+/**
+ * Runs the tennis mini game and draws its components on screen
+ * @returns {void} - Nothing
+ */
+declare function TennisRun(): void;
+/**
+ * Checks if the tennis game should end. The tennis game ends when a player has 4 or more points, and is leading by at least 2 points
+ * @returns {void} - Nothing
+ */
+declare function TennisVerifyEnd(): void;
+/**
+ * Handles clicks during the tennis mini game
+ * @returns {void} - Nothing
+ */
+declare function TennisClick(): void;
+/**
+ * Handles the key press in the tennis mini game, the C cheat key gives you one point toward winning
+ * @returns {void} - Nothing
+ */
+declare function TennisKeyDown(): void;
+declare var TennisBackground: string;
+/** @type {null | NPCCharacter} */
+declare var TennisCharacterLeft: null | NPCCharacter;
+/** @type {null | NPCCharacter} */
+declare var TennisCharacterRight: null | NPCCharacter;
+declare var TennisCharacterLeftPoint: number;
+declare var TennisCharacterRightPoint: number;
+declare var TennisCharacterLeftRacket: number;
+declare var TennisCharacterRightRacket: number;
+declare var TennisBallX: number;
+declare var TennisBallY: number;
+declare var TennisBallSpeed: number;
+/** Angle of the ball.  Angle is in radians (0 is right, PI / 2 is up, PI is left, 3 PI / 2 is down)*/
+declare var TennisBallAngle: number;

package/bc/Screens/MiniGame/Therapy/Therapy.d.ts

@@ -0,0 +1,39 @@
+/**
+ * Loads the therapy mini game and sets the difficulty. The game is a little faster on mobile since its easier.
+ * @returns {void} - Nothing
+ */
+declare function TherapyLoad(): void;
+/**
+ * Runs the therapy mini game.
+ * @returns {void} - Nothing
+ */
+declare function TherapyRun(): void;
+/**
+ * Checks if the therapy minigame should end. It ends when the therapy is completed, or when the patient is too stressed out.
+ * @returns {void} - Nothing
+ */
+declare function TherapyVerifyEnd(): void;
+/**
+ * Handles a given move type and validates it
+ * @param {number} MoveType - Move type (Index of the TherapyMoves array)
+ * @returns {void} - Nothing
+ */
+declare function TherapyDoMove(MoveType: number): void;
+/**
+ * Handles clicks in the therapy mini game
+ * @returns {void} - Nothing
+ */
+declare function TherapyClick(): void;
+/**
+ * Handles the key press in the therapy mini game, the C cheat key reduces the patient stress
+ * @returns {void} - Nothing
+ */
+declare function TherapyKeyDown(): void;
+declare var TherapyBackground: string;
+/** @type {null | NPCCharacter} */
+declare var TherapyCharacterLeft: null | NPCCharacter;
+/** @type {null | NPCCharacter} */
+declare var TherapyCharacterRight: null | NPCCharacter;
+declare var TherapyMoves: number[];
+declare var TherapyGenerateMoveTimer: number;
+declare var TherapyStress: number;

package/bc/Screens/MiniGame/WheelFortune/WheelFortune.d.ts

@@ -0,0 +1,105 @@
+/**
+ * Returns TRUE if the wheel of fortune can add an item on the specified asset slot
+ * @param {String} AssetName - The asset name
+ * @param {AssetGroupName} GroupName - The asset group to focus
+ * @returns {boolean} - TRUE if we can add
+ */
+declare function WheelFortuneCanWear(AssetName: string, GroupName: AssetGroupName): boolean;
+/**
+ * Puts the player in random futuristic bondage
+ * @returns {void} - Nothing
+ */
+declare function WheelFortuneFuturisticBondage(): void;
+/**
+ * Puts the player in random hogtie bondage
+ * @returns {void} - Nothing
+ */
+declare function WheelFortuneHogtie(): void;
+/**
+ * Puts the player in random shibari rope bondage
+ * @returns {void} - Nothing
+ */
+declare function WheelFortuneShibari(): void;
+/**
+ * Sends the player to the isolation for a number of minutes
+ * @param {number} Minutes - The number of minutes
+ * @returns {void} - Nothing
+ */
+declare function WheelFortuneIsolationCell(Minutes: number): void;
+/**
+ * Block the wardrobe for the user for a set time, or add to the current blocked time
+ * @param {number} Minutes - The number of minutes
+ * @returns {void} - Nothing
+ */
+declare function WheelFortuneBlockWardrobe(Minutes: number): void;
+/**
+ * Wears an item from the lucky wheel spin
+ * @param {AssetGroupName} Group - The asset group to focus
+ * @param {number} Minutes - The number of minutes
+ * @returns {void} - Nothing
+ */
+declare function WheelFortuneInventoryWear(Group: AssetGroupName, Minutes: number): void;
+/**
+ * Loads the lucky wheel mini game and builds the wheel
+ * @returns {void} - Nothing
+ */
+declare function WheelFortuneLoad(): void;
+/**
+ * Draws the full lucky wheel
+ * @returns {void} - Nothing
+ */
+declare function WheelFortuneDraw(FullWheel: any, Pos: any, MaxPos: any, X: any, Y: any, Zoom: any): void;
+/**
+ * Runs the lucky wheel mini game
+ * @returns {void} - Nothing
+ */
+declare function WheelFortuneRun(): void;
+/**
+ * Handles clicks during the mini game
+ * @returns {void} - Nothing
+ */
+declare function WheelFortuneClick(): void;
+/**
+ * If the user clicks to spin the wheel, we keep the starting position
+ * @returns {void} - Nothing
+ */
+declare function WheelFortuneMouseDown(): void;
+/**
+ * If the user releases the mouse/finger to spin the wheel
+ * @returns {void} - Nothing
+ */
+declare function WheelFortuneMouseUp(): void;
+/**
+ * When the wheel result is set, we publish it and return to the chat room
+ * @returns {void} - Nothing
+ */
+declare function WheelFortuneResult(): void;
+/**
+ * When the mini exits
+ * @returns {void} - Nothing
+ */
+declare function WheelFortuneExit(): void;
+declare var WheelFortuneBackground: string;
+/** @type {"" | ModuleType} */
+declare var WheelFortuneEntryModule: "" | ModuleType;
+declare var WheelFortuneEntryScreen: string;
+/** @type {null | Character} */
+declare var WheelFortuneCharacter: null | Character;
+declare var WheelFortuneRoleplay: boolean;
+declare var WheelFortuneForced: boolean;
+declare var WheelFortunePos: number;
+declare var WheelFortunePosMax: number;
+declare var WheelFortuneVelocity: number;
+declare var WheelFortuneVelocityTime: number;
+/** @type {null | number} */
+declare var WheelFortunePosY: null | number;
+declare var WheelFortuneInitY: number;
+declare var WheelFortuneInitTime: number;
+declare var WheelFortuneValue: string;
+declare var WheelFortuneList: string;
+declare var WheelFortuneEncaseList: string[];
+declare var WheelFortuneEncaseClosedList: string[];
+declare var WheelFortunePasswordChar: string[];
+declare var WheelFortuneDefault: string;
+/** @type {WheelFortuneOptionType[]} */
+declare var WheelFortuneOption: WheelFortuneOptionType[];

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

@@ -0,0 +1,32 @@
+/**
+ * Loads the advanced rule screen
+ * @returns {void} - Nothing
+ */
+declare function AdvancedRuleLoad(): void;
+/**
+ * Starts the advanced rule screen and loads it
+ * @returns {void} - Nothing
+ */
+declare function AdvancedRuleOpen(RuleType: any): void;
+/**
+ * Draws the advanced rule text and check boxes
+ * @returns {void} - Nothing
+ */
+declare function AdvancedRuleRun(): void;
+/**
+ * Handles the click events. Is called from CommonClick()
+ * @returns {void} - Nothing
+ */
+declare function AdvancedRuleClick(): void;
+/**
+ * Handles exiting from the screen, updates the sub rules
+ * @returns {void} - Nothing
+ */
+declare function AdvancedRuleExit(): void;
+declare var AdvancedRuleBackground: string;
+/** @type {null | Character | NPCCharacter} */
+declare var AdvancedRuleTarget: null | Character | NPCCharacter;
+declare var AdvancedRuleType: string;
+/** @type {string[]} */
+declare var AdvancedRuleOption: string[];
+declare var AdvancedRuleSelection: string;

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

@@ -0,0 +1,59 @@
+/**
+ * Loads the chat Admin screen properties and creates the inputs
+ * @returns {void} - Nothing
+ */
+declare function ChatAdminLoad(): void;
+/**
+ * When the chat Admin screen runs, draws the screen
+ * @returns {void} - Nothing
+ */
+declare function ChatAdminRun(): void;
+/**
+ * Handles the click events on the admin screen. Is called from CommonClick()
+ * @returns {void} - Nothing
+ */
+declare function ChatAdminClick(): void;
+/**
+ * Handles exiting from the admin screen, removes the inputs and resets the state of the variables
+ * @returns {void} - Nothing
+ */
+declare function ChatAdminExit(): void;
+/**
+ * Handles the reception of the server response after attempting to update a chatroom: Leaves the admin screen or shows an error message
+ * @param {string} data - Response from the server ("Updated" or error message)
+ * @returns {void} - Nothing
+ */
+declare function ChatAdminResponse(data: string): void;
+/**
+ * Sends the chat room data packet to the server. The response will be handled by ChatAdminResponse once it is received
+ * @returns {void} - Nothing
+ */
+declare function ChatAdminUpdateRoom(): void;
+declare var ChatAdminBackground: string;
+declare var ChatAdminMessage: string;
+declare var ChatAdminBackgroundIndex: number;
+declare var ChatAdminBackgroundSelect: string;
+declare var ChatAdminPrivate: boolean;
+declare var ChatAdminLocked: boolean;
+/** @type {ChatRoomGame} */
+declare var ChatAdminGame: ChatRoomGame;
+/** @type {ChatRoomGame[]} */
+declare var ChatAdminGameList: ChatRoomGame[];
+/** @type {null | string} */
+declare var ChatAdminBackgroundSelected: null | string;
+/** @type {null | { Name: string, Language: ChatRoomLanguage, Description: string, Limit: string, AdminList: string, BanList: string, Private: boolean, Locked: boolean }} */
+declare var ChatAdminTemporaryData: null | {
+    Name: string;
+    Language: ChatRoomLanguage;
+    Description: string;
+    Limit: string;
+    AdminList: string;
+    BanList: string;
+    Private: boolean;
+    Locked: boolean;
+};
+/** @type {ChatRoomBlockCategory[]} */
+declare var ChatAdminBlockCategory: ChatRoomBlockCategory[];
+declare var ChatAdminInitialLoad: boolean;
+/** @type {ChatRoomLanguage} */
+declare var ChatAdminLanguage: ChatRoomLanguage;

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

@@ -0,0 +1,30 @@
+/**
+ * Loads the chat room item blocking screen
+ * @returns {void} - Nothing
+ */
+declare function ChatBlockItemLoad(): void;
+/**
+ * When the chat room item blocking screen runs, draws the screen
+ * @returns {void} - Nothing
+ */
+declare function ChatBlockItemRun(): void;
+/**
+ * Handles the click events on the chat room item blocking screen. Called from CommonClick()
+ * @returns {void} - Nothing
+ */
+declare function ChatBlockItemClick(): void;
+/**
+ * Handles exiting from the screen
+ * @returns {void} - Nothing
+ */
+declare function ChatBlockItemExit(): void;
+declare var ChatBlockItemBackground: string;
+/** @type {ChatRoomBlockCategory[]} */
+declare var ChatBlockItemList: ChatRoomBlockCategory[];
+/** @type {ChatRoomBlockCategory[]} */
+declare var ChatBlockItemCategory: ChatRoomBlockCategory[];
+declare var ChatBlockItemEditable: boolean;
+/** @type { { Screen?: string; } } */
+declare var ChatBlockItemReturnData: {
+    Screen?: string;
+};

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

@@ -0,0 +1,66 @@
+/**
+ * Loads the chat creation screen properties and creates the inputs
+ * @returns {void} - Nothing
+ */
+declare function ChatCreateLoad(): void;
+/**
+ * When the chat creation screen runs, draws the screen
+ * @returns {void} - Nothing
+ */
+declare function ChatCreateRun(): void;
+/**
+ * Handles the click events on the chat creation screen. Is called from CommonClick()
+ * @returns {void} - Nothing
+ */
+declare function ChatCreateClick(): void;
+/**
+ * Handles the key presses while in the creation screen. When the user presses enter, we create the room.
+ * @returns {void} - Nothing
+ */
+declare function ChatCreateKeyDown(): void;
+/**
+ * Handles exiting from the chat creation screen, removes the inputs and resets the state of the variable
+ * @returns {void} - Nothing
+ */
+declare function ChatCreateExit(): void;
+/**
+ * Handles the reception of the server response after attempting to create a chatroom: shows the error message, if applicable
+ * @param {string} data - Response from the server
+ * @returns {void} - Nothing
+ */
+declare function ChatCreateResponse(data: string): void;
+/**
+ * Sends the chat room data packet to the server and prepares the player to join a room. The response will be handled by ChatCreateResponse once it is received
+ * @returns {void} - Nothing
+ */
+declare function ChatCreateRoom(): void;
+/**
+ * When we need to enter the item blocking screen
+ * @returns {void} - Nothing
+ */
+declare function ChatCreateBlockItems(): void;
+/**
+ * Removes all chatroom creation inputs
+ */
+declare function ChatRoomCreateRemoveInput(): void;
+declare var ChatCreateBackground: string;
+declare var ChatCreateResult: any[];
+declare var ChatCreateMessage: string;
+/** @type {null | boolean} */
+declare var ChatCreatePrivate: null | boolean;
+/** @type {null | boolean} */
+declare var ChatCreateLocked: null | boolean;
+/** @type {ChatRoomGame} */
+declare var ChatCreateGame: ChatRoomGame;
+/** @type {ChatRoomGame[]} */
+declare var ChatCreateGameList: ChatRoomGame[];
+declare var ChatCreateBackgroundIndex: number;
+declare var ChatCreateBackgroundSelect: string;
+/** @type {null | string[]} */
+declare var ChatCreateBackgroundList: null | string[];
+declare var ChatCreateShowBackgroundMode: boolean;
+declare var ChatCreateIsHidden: boolean;
+/** @type {ChatRoomLanguage} */
+declare var ChatCreateLanguage: ChatRoomLanguage;
+/** @type {ChatRoomLanguage[]} */
+declare var ChatCreateLanguageList: ChatRoomLanguage[];