bc-stubs 96.0.0

package/bc/Screens/Room/MagicSchoolEscape/MagicSchoolEscape.d.ts

@@ -0,0 +1,36 @@
+/**
+ * Loads the magic school laboratory and the teacher
+ * @returns {void} - Nothing
+ */
+declare function MagicSchoolEscapeLoad(): void;
+/**
+ * Runs the room
+ * @returns {void} - Nothing
+ */
+declare function MagicSchoolEscapeRun(): void;
+/**
+ * Handles the click events.  Called from CommonClick()
+ * @returns {void} - Nothing
+ */
+declare function MagicSchoolEscapeClick(): void;
+/**
+ * When the spell ends, we remove some restraints if the player succeeded
+ * @returns {void} - Nothing
+ */
+declare function MagicSchoolEscapeSpellEnd(): void;
+/**
+ * Sets the difficulty for the escape challenge
+ * @param {number} Seconds - The number of seconds before the challenge ends
+ * @returns {void} - Nothing
+ */
+declare function MagicSchoolEscapeSetTime(Seconds: number): void;
+/**
+ * Starts the escape challenge and sets the clock
+ * @returns {void} - Nothing
+ */
+declare function MagicSchoolEscapeStart(): void;
+declare var MagicSchoolEscapeBackground: string;
+/** @type {null | NPCCharacter} */
+declare var MagicSchoolEscapeInstructor: null | NPCCharacter;
+declare var MagicSchoolEscapeSeconds: number;
+declare var MagicSchoolEscapeTimer: number;

package/bc/Screens/Room/MagicSchoolLaboratory/MagicSchoolLaboratory.d.ts

@@ -0,0 +1,170 @@
+/**
+ * Dresses a character C as a witch, the colors and clothes can changes based on the house
+ * @param {Character} C - The character that will wear the clothes
+ * @param {"" | "Maiestas" | "Vincula" | "Amplector" | "Corporis"} House - The house name
+ * @returns {void} - Nothing
+ */
+declare function MagicSchoolLaboratoryPrepareNPC(C: Character, House: "" | "Maiestas" | "Vincula" | "Amplector" | "Corporis"): void;
+/**
+ * Loads the magic school laboratory and the teacher
+ * @returns {void} - Nothing
+ */
+declare function MagicSchoolLaboratoryLoad(): void;
+/**
+ * Runs the room
+ * @returns {void} - Nothing
+ */
+declare function MagicSchoolLaboratoryRun(): void;
+/**
+ * Handles the click events.  Called from CommonClick()
+ * @returns {void} - Nothing
+ */
+declare function MagicSchoolLaboratoryClick(): void;
+/**
+ * When the user wants to practice a spell
+ * @param {number} SpellNumber - The spell number (0 to strip, etc.)
+ * @returns {void} - Nothing
+ */
+declare function MagicSchoolLaboratorySpellPractice(SpellNumber: number): void;
+/**
+ * When the magic spell practice puzzle ends
+ * @returns {void} - Nothing
+ */
+declare function MagicSchoolLaboratorySpellPracticeEnd(): void;
+/**
+ * Check if someone is a member of a magic house or not
+ * @param {"" | "Maiestas" | "Vincula" | "Amplector" | "Corporis"} House - The house name
+ * @returns {boolean} - TRUE if a member, FALSE if not
+ */
+declare function MagicSchoolLaboratoryInHouse(House: "" | "Maiestas" | "Vincula" | "Amplector" | "Corporis"): boolean;
+/**
+ * Joins a specific magic house, sets the reputation to 1 and clear all other reputations
+ * @param {"" | MagicSchoolHouse} House - The house name
+ * @returns {void} - Nothing
+ */
+declare function MagicSchoolLaboratoryJoinHouse(House: "" | MagicSchoolHouse): void;
+/**
+ * Dresses the player as it's current magic school house
+ * @returns {void} - Nothing
+ */
+declare function MagicSchoolLaboratoryDressHouse(): void;
+/**
+ * Check if a NPC is a member of a magic house or not
+ * @param {MagicSchoolHouse} House - The house name
+ * @returns {boolean} - TRUE if a member, FALSE if not
+ */
+declare function MagicSchoolLaboratoryFromHouse(House: MagicSchoolHouse): boolean;
+/**
+ * Check if a NPC is a member of the player's house
+ * @param {MagicSchoolHouse} House - The house name
+ * @returns {boolean} - TRUE if from same house, FALSE if not
+ */
+declare function MagicSchoolLaboratoryFromSameHouse(House: MagicSchoolHouse): boolean;
+/**
+ * Check if a NPC is a member of the player's rival house
+ * @param {MagicSchoolHouse} House - The house name
+ * @returns {boolean} - TRUE if a rival, FALSE if not
+ */
+declare function MagicSchoolLaboratoryFromRivalHouse(House: MagicSchoolHouse): boolean;
+/**
+ * Starts a practice battle against the school teacher
+ * @param {number} Difficulty - The difficulty level from 0 to 10 (hardest)
+ * @returns {void} - Nothing
+ */
+declare function MagicSchoolLaboratoryMagicBattleStart(Difficulty: number): void;
+/**
+ * When the magic battle practice ends
+ * @returns {void} - Nothing
+ */
+declare function MagicSchoolLaboratoryMagicBattleEnd(): void;
+/**
+ * Generates a random student from the same house as the player (sister)
+ * @returns {void} - Nothing
+ */
+declare function MagicSchoolLaboratoryBuildSister(): void;
+/**
+ * Generates a random student that will meet the player
+ * @returns {void} - Nothing
+ */
+declare function MagicSchoolLaboratoryFindStudent(): void;
+/**
+ * When a fight begins between the player and a student
+ * @param {"Wage25" | "Honor" | "RainbowWand"} Type - The type of battle to do (Normal, Wage or Honor)
+ * @returns {void} - Nothing
+ */
+declare function MagicSchoolLaboratoryBattleStudentStart(Type: "Wage25" | "Honor" | "RainbowWand"): void;
+/**
+ * When a student battle ends, we release the winner, change reputation or give some money based on the wage
+ * @returns {void} - Nothing
+ */
+declare function MagicSchoolLaboratoryBattleStudentEnd(): void;
+/**
+ * Sets an emote for the student when there's an activity
+ * @param {ExpressionNameMap["Blush"]} Blush
+ * @param {ExpressionNameMap["Eyes"]} Eyes
+ * @returns {void}
+ */
+declare function MagicSchoolLaboratoryStudentEmote(Blush: ExpressionNameMap["Blush"], Eyes: ExpressionNameMap["Eyes"]): void;
+/**
+ * Checks, if the player can bring the student to her private room
+ * @returns {boolean} - Returns true, if the player can
+ */
+declare function MagicSchoolLaboratoryCanTransferToRoom(): boolean;
+/**
+ * Triggered when the player transfers the student to her private room
+ * @returns {void} - Nothing
+ */
+declare function MagicSchoolLaboratoryTransferToRoom(): void;
+/**
+ * Triggered when the player won and ungag the student to talk with her
+ * @returns {void} - Nothing
+ */
+declare function MagicSchoolLaboratoryUngagStudent(): void;
+/**
+ * Triggered when the player lost and get ungagged by the student, can affect reputation
+ * @returns {void} - Nothing
+ */
+declare function MagicSchoolLaboratoryUngagPlayer(RepChange: any): void;
+/**
+ * Triggered when the player lost and get untied by the student, can affect reputation
+ * @returns {void} - Nothing
+ */
+declare function MagicSchoolLaboratoryReleasePlayer(RepChange: any): void;
+/**
+ * When the player lost a battle and the student tests a spell on her
+ * @returns {void} - Nothing
+ */
+declare function MagicSchoolLaboratoryLoserSpell(RepChange: any): void;
+/**
+ * Returns the player in the main hall in her current bondage
+ * @returns {void} - Nothing
+ */
+declare function MagicSchoolLaboratoryPlayerMainHall(): void;
+/**
+ * Starts a max difficulty battle against the master
+ * @returns {void} - Nothing
+ */
+declare function MagicSchoolLaboratoryBattleMasterStart(): void;
+/**
+ * When the magic battle against the master ends
+ * @returns {void} - Nothing
+ */
+declare function MagicSchoolLaboratoryBattleMasterEnd(): void;
+/**
+ * When the player learns the master technique from it's house
+ * @returns {void} - Nothing
+ */
+declare function MagicSchoolLaboratoryLearnMastery(): void;
+/**
+ * Returns TRUE if the rainbow wand can be waged in a magic fight
+ * @returns {boolean} - TRUE if it can be waged
+ */
+declare function MagicSchoolLaboratoryCanWageWand(): boolean;
+declare var MagicSchoolLaboratoryBackground: string;
+/** @type {null | NPCCharacter} */
+declare var MagicSchoolLaboratoryTeacher: null | NPCCharacter;
+/** @type {null | NPCCharacter} */
+declare var MagicSchoolLaboratoryStudent: null | NPCCharacter;
+declare var MagicSchoolLaboratoryBattleWage: string;
+declare var MagicSchoolLaboratoryLastSpell: string;
+declare var MagicSchoolLaboratorySpellCount: number;

package/bc/Screens/Room/MaidQuarters/MaidQuarters.d.ts

@@ -0,0 +1,305 @@
+/**
+ * Checks if the player is helpless (maids disabled) or not.
+ * @returns {boolean} - Returns true if the player still has time remaining after asking the maids to stop helping
+ */
+declare function MaidQuartersIsMaidsDisabled(): boolean;
+/**
+ * Checks if the player is helpless (maids disabled) or not and also if they have reputation to do work
+ * @returns {boolean} - Returns true if the player has maids enabled and also has rep
+ */
+declare function MaidQuartersCanDoWorkForMaids(): boolean;
+/**
+ * Checks if the player is helpless (maids disabled) or not and also if they have reputation to do work
+ * @returns {boolean} - Returns true if the player has maids enabled and also has rep
+ */
+declare function MaidQuartersCanDoWorkButMaidsDisabled(): boolean;
+/**
+ * CHecks for appropriate dressing
+ * @returns {boolean} - Returns true if the player wears a maid dress and a maid hair band, false otherwise
+ */
+declare function MaidQuartersPlayerInMaidUniform(): boolean;
+/**
+ * Checks, if the player is fully dressed for the 'serve drinks' job
+ * @returns {boolean} - Retruns true, if the player is wearing a maid uniform, has her legs and arms restrained, is gagged and wearing a serving tray
+ */
+declare function MaidQuartersPlayerInDrinksUniform(): boolean;
+/**
+ * Checks, if the player can leave the maid to wear her uniform for the 'serve drink job'
+ * @returns {boolean} - Returns true, if the player is a maid, not wearing her uniform and was not forced to do the job
+ */
+declare function MaidQuartersPlayerCanChangeForDrinks(): boolean;
+/**
+ * Checks, if the player is fully dressed for the 'clean room job'
+ * @returns {boolean} - Returns true, if the player is wearing a maid uniform, has her feet, legs and arms restrained and is wearing a duster gag
+ */
+declare function MaidQuartersPlayerInCleaningUniform(): boolean;
+/**
+ * Checks, if the player can leave the maid to wear her uniform for the 'clean room job'
+ * @returns {boolean} - Returns true, if the player is a maid and not wearing her uniform
+ */
+declare function MaidQuartersPlayerCanChangeForCleaning(): boolean;
+/**
+ * Checks, if the player can leave the maid to wear her uniform for the 'rescue job'
+ * @returns {boolean} - Returns true, if the player is a maid and not wearing her uniform
+ */
+declare function MaidQuartersPlayerCanChangeForRescue(): boolean;
+/**
+ * Update the maid current dialog to give an advice about why the player's current outfit isn't a maid outfit
+ */
+declare function MaidQuartersAdviceMaidUniform(): void;
+/**
+ * Checks, if the player is able to do the 'serve drinks' job
+ * @returns {boolean} - Returns true, if the player can do the job, false otherwise
+ */
+declare function MaidQuartersAllowMaidDrinks(): boolean;
+/**
+ * Checks, if the player is ready for the 'serve drinks' job and is allowed to do it
+ * @returns {boolean} - Returns true, if the player is ready for the job, false otherwise
+ */
+declare function MaidQuartersAllowSelfBondageMaidDrinks(): boolean;
+/**
+ * Accept to start the 'serve drinks' job when self prepared for it
+ * @returns {void} - Nothing
+ */
+declare function MaidQuartersAcceptSelfBondageMaidDrinks(): void;
+/**
+ * Checks, if the player can do the 'clean room job'
+ * @returns {boolean} - Returns true, if the player can do the job, false otherwise
+ */
+declare function MaidQuartersAllowMaidCleaning(): boolean;
+/**
+ * Checks, if the player is ready for the 'clean room job' and is allowed to do it
+ * @returns {boolean} - Returns true, if the player is ready for the job, false otherwise
+ */
+declare function MaidQuartersAllowSelfBondageMaidCleaning(): boolean;
+/**
+ * Accept to start the 'clean room job' when self prepared for it
+ * @returns {void} - Nothing
+ */
+declare function MaidQuartersAcceptSelfBondageMaidCleaning(): void;
+/**
+ * Checks, if the player can do the 'play music' job
+ * @returns {boolean} - Returns true, if the player can do the job, false otherwise
+ */
+declare function MaidQuartersAllowMaidPlayMusic(): boolean;
+/**
+ * Checks, if the player can do a rescue mission
+ * @returns {boolean} - Returns true, if the player can do the job, false otherwise
+ */
+declare function MaidQuartersAllowRescue(): boolean;
+/**
+ * Checks, if the player is on a running rescue mission
+ * @returns {boolean} - Returns true, if the player has a running but unfinished rescue mission, false otherwise
+ */
+declare function MaidQuartersAllowCancelRescue(): boolean;
+/**
+ * Checks, if the 'Unlock Sarah' quest is available
+ * @returns {boolean} - Returns true, if the quest is available, false otherwise
+ */
+declare function MaidQuartersCanFreeSarah(): boolean;
+/**
+ * Checks, if the maid can release the player from her restraint
+ * @returns {boolean} - Returns true, if the player can be released, false otherwise
+ */
+declare function MaidQuartersCanReleasePlayer(): boolean;
+/**
+ * Checks, if the maid is unable to free the player
+ * @returns {boolean} - Returns true, if the maid is unable to free the player, false otherwise
+ */
+declare function MaidQuartersCannotReleasePlayer(): boolean;
+/**
+ * Checks, if the player can get the duster gag
+ * @returns {boolean} - Returns true, if the player can get the duster gag, false otherwise
+ */
+declare function MaidQuartersCanGetDusterGag(): boolean;
+/**
+ * Checks, if the player has finished the 'serve drinks' job
+ * @returns {boolean} - Returns true, if the job is finished, false otherwise
+ */
+declare function MaidQuartersOnlineDrinkCompleted(): boolean;
+/**
+ * Checks if the player can talk after being rewarded for the online drinks mini-game
+ * @returns {boolean} - Returns true, if the player is gagged or restrained.
+ */
+declare function MaidQuartersOnlineDrinkIsRestrained(): boolean;
+/**
+ * Checks if the player can get ungagged by the maids
+ * @returns {boolean} - Returns true, if the maids can remove the gag, false otherwise
+ */
+declare function MaidQuartersCanUngag(): boolean;
+declare function MaidQuartersCanUngagAndMaidsDisabled(): boolean;
+/**
+ * Checks, if the maids are unable to remove the gag (if there is one)
+ * @returns {boolean} - Returns true, if the player cannot be ungagged by the maids, false otherwise
+ */
+declare function MaidQuartersCannotUngag(): boolean;
+declare function MaidQuartersCannotUngagAndMaidsNotDisabled(): boolean;
+/**
+ * Loads the maid quarters. This function is called dynamically, as soon, as the player enters the maid quarters
+ * @returns {void} - Nothing
+ */
+declare function MaidQuartersLoad(): void;
+/**
+ * Runs the maid quarters dialog
+ * This function is called periodically so don't use it for extensive use or the call of other complex functions
+ * @returns {void} - Nothing
+ */
+declare function MaidQuartersRun(): void;
+/**
+ * Handles the click events of the maid quarters. Clicks are propageted from 'CommonClick()'
+ * @returns {void} - Nothing
+ */
+declare function MaidQuartersClick(): void;
+/**
+ * The maid ungags the player
+ * @returns {void} - Nothing
+ */
+declare function MaidQuartersMaidUngagPlayer(): void;
+/**
+ * Dresses the player as a maid
+ * @returns {void} - Nothing
+ */
+declare function MaidQuartersWearMaidUniform(): void;
+/**
+ * Removes the maid uniform and dresses the character back
+ * @returns {void} - Nothing
+ */
+declare function MaidQuartersRemoveMaidUniform(): void;
+/**
+ * Starts a mini game or maid chore
+ * @param {string} GameType - Name of the mini-game to launch
+ * @param {number} Difficulty - Difficulty Ration for the mini-game
+ * @returns {void} - Nothing
+ */
+declare function MaidQuartersMiniGameStart(GameType: string, Difficulty: number): void;
+/**
+ * Is called when the mini game ends and sends the player back to the maid quarters.
+ * Depending on the choosen game, the next dialog option is selected
+ * @returns {void} - Nothing
+ */
+declare function MaidQuartersMiniGameEnd(): void;
+/**
+ * When an ordinary  mini game / maid chore is successful, the player gets paid and the maid reputation increases
+ * @returns {void} - Nothing
+ */
+declare function MaidQuartersMiniGamePay(): void;
+/**
+ * When the music mini game is successful, the player gets paid
+ * @returns {void} - Nothing
+ */
+declare function MaidQuartersMiniGamePayAdvanced(): void;
+/**
+ * Handles the payment after a successful rescue mission
+ * @returns {void} - Nothing
+ */
+declare function MaidQuartersRescuePay(): void;
+/**
+ * The maid releases the player, reduces her dominant score and assures that this option is only used once
+ * @returns {void} - Nothing
+ */
+declare function MaidQuartersMaidReleasePlayer(): void;
+/**
+ * Collects the dominant reputation change of a player during the course of the various dialog options.
+ * When the player becomes a maid, the change is applied
+ * @param {string} Value - The value by which the reputation is changed
+ * @returns {void} - Nothing
+ */
+declare function MaidQuartersDominantRepChange(Value: string): void;
+/**
+ * Switches from one maid to another in the initiation
+ * @param {string} MaidType - Name of the current maid type
+ */
+declare function MaidQuartersInitiationTransition(MaidType: string): void;
+/**
+ * Change the initiation maid appearance on the spot to simulate a new character
+ * @returns {void} - Nothing
+ */
+declare function MaidQuartersChangeInitiationMaid(): void;
+/**
+ * The player joins the maid sorority
+ * @returns {void} - Nothing
+ */
+declare function MaidQuartersBecomMaid(): void;
+/**
+ * The player is promoted to head maid
+ * @returns {void} - Nothing
+ */
+declare function MaidQuartersBecomHeadMaid(): void;
+/**
+ * Starts a maid rescue mission in a random room. The same room is never selected twice and
+ * the player is not sent to the introduction room when doing the daily quest
+ * @returns {void} - Nothing
+ */
+declare function MaidQuartersStartRescue(): void;
+/**
+ * Cancels the current rescue mission
+ * @returns {void} - Nothing
+ */
+declare function MaidQuartersCancelRescue(): void;
+/**
+ * The player as head maid can trick the maids into freeing Sarah
+ * @returns {void} - Nothing
+ */
+declare function MaidQuartersFreeSarah(): void;
+/**
+ * The maid gives a duster gag to the player if she's in the sorority
+ * @returns {void} - Nothing
+ */
+declare function MaidQuartersGetDusterGag(): void;
+/**
+ * Starts the online drink serving game
+ * @returns {void} - Nothing
+ */
+declare function MaidQuartersOnlineDrinkStart(): void;
+/**
+ * On online player picks a drink from the plyers tray. She only gets credited, if it was a new customer
+ * @param {number} MemberNumber - The member ID of the customer
+ * @param {number|string} DrinkValue - The value of the picked drink
+ */
+declare function MaidQuartersOnlineDrinkPick(MemberNumber: number, DrinkValue: number | string): void;
+/**
+ * Calculates the player's earnings from the online drink serving.
+ * When the maid tray is empty, the player can get paid (40% of drink value + 10$)
+ * @returns {void} - Nothing
+ */
+declare function MaidQuartersOnlineDrinkPay(): void;
+/**
+ * Flags the online drink serving as not initiated by the player's owner
+ * @returns {void} - Nothing
+ */
+declare function MaidQuartersNotFromOwner(): void;
+declare function MaidQuartersSetMaidsDisabled(minutes: any): void;
+declare var MaidQuartersBackground: string;
+/** @type {null | NPCCharacter} */
+declare var MaidQuartersMaid: null | NPCCharacter;
+/** @type {null | NPCCharacter} */
+declare var MaidQuartersMaidInitiation: null | NPCCharacter;
+/** @type {{ Cloth?: Item, Hat?: Item, ItemArms?: Item, ItemLegs?: Item, ItemFeet?: Item }} */
+declare var MaidQuartersItemClothPrev: {
+    Cloth?: Item;
+    Hat?: Item;
+    ItemArms?: Item;
+    ItemLegs?: Item;
+    ItemFeet?: Item;
+};
+declare var MaidQuartersMaidReleasedPlayer: boolean;
+declare var MaidQuartersCanBecomeMaid: boolean;
+declare var MaidQuartersCannotBecomeMaidYet: boolean;
+declare var MaidQuartersCanBecomeHeadMaid: boolean;
+declare var MaidQuartersCannotBecomeHeadMaidYet: boolean;
+declare var MaidQuartersIsMaid: boolean;
+declare var MaidQuartersIsHeadMaid: boolean;
+declare var MaidQuartersSelfBondageMaidDrinksAccepted: boolean;
+declare var MaidQuartersSelfBondageMaidCleaningAccepted: boolean;
+declare var MaidQuartersDominantRep: number;
+declare var MaidQuartersCurrentRescue: string;
+declare var MaidQuartersRescueList: string[];
+declare var MaidQuartersRescueStage: string[];
+declare var MaidQuartersCurrentRescueStarted: boolean;
+declare var MaidQuartersCurrentRescueCompleted: boolean;
+declare var MaidQuartersOnlineDrinkStarted: boolean;
+declare var MaidQuartersOnlineDrinkCount: number;
+declare var MaidQuartersOnlineDrinkValue: number;
+/** @type {number[]} */
+declare var MaidQuartersOnlineDrinkCustomer: number[];
+declare var MaidQuartersOnlineDrinkFromOwner: boolean;