bc-stubs 96.0.0

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

@@ -0,0 +1,265 @@
+/**
+ * Checks, if the player is able to leave the Asylum
+ * @returns {boolean} - Returns true, if the player is able to leave, false otherwise
+ */
+declare function AsylumEntranceCanWander(): boolean;
+/**
+ * Checks, if the player can bring the nurse to her private room
+ * @returns {boolean} - Returns true, if the player can drag the nurse to her private roo, false otherwise
+ */
+declare function AsylumEntranceCanTransferToRoom(): boolean;
+/**
+ * CHecks if the player can kiss the nurse
+ * @returns {boolean} - Returns true, if the player can kiss the nurse, false otherwise
+ */
+declare function AsylumEntranceCanKiss(): boolean;
+/**
+ * Checks if the player can have a nurse uniform of her own
+ * @returns {boolean} - Returns true, if the player can have her own nurse uniform, false otherwise
+ */
+declare function AsylumEntranceCanGetNurseUniform(): boolean;
+/**
+ * Returns TRUE if the nurse is collared by GGTS
+ * @returns {boolean} - Returns TRUE if the nurse is collared by GGTS
+ */
+declare function AsylumEntranceNurseHasGGTSCollar(): boolean;
+/**
+ * Returns TRUE if the player and the current character can play Club Card
+ * @returns {boolean} - Returns TRUE if both aren't restrained
+ */
+declare function AsylumEntranceCanPlayClubCard(): boolean;
+/**
+ * Loads the room and generates the nurse. Is called dynamically
+ * @returns {void} - Nothing
+ */
+declare function AsylumEntranceLoad(): void;
+/**
+ * // Runs the room (shows the nurse, player, icons and committed time).
+ * Is called over and over again, so don't call expensive functions or loops from here.
+ * @returns {void} - Nothing
+ */
+declare function AsylumEntranceRun(): void;
+/**
+ * Handles the click events. Is called from CommonClick()
+ * @returns {void} - Nothing
+ */
+declare function AsylumEntranceClick(): void;
+/**
+ * Enters the online chat room in "Asylum mode"
+ * @returns {void} - Nothing
+ */
+declare function AsylumEntranceStartChat(): void;
+/**
+ * Dresses a given character as a nurse
+ * @param {Character} C - The character to dress
+ * @returns {void} - Nothing
+ */
+declare function AsylumEntranceWearNurseClothes(C: Character): void;
+/**
+ * Dresses the player as a patient. Used in dialogs.
+ */
+declare function AsylumEntrancePlayerWearPatientClothes(): void;
+/**
+ * Dresses a given character as a patient. Removes all clothes and respects cosplay rules
+ * @param {Character} C - The character to dress
+ * @param {boolean} [ExtraEvent] - Should we process extra events for login or GGTS
+ * @returns {void} - Nothing
+ */
+declare function AsylumEntranceWearPatientClothes(C: Character, ExtraEvent?: boolean): void;
+/**
+ * Checks, if the player is dressed as a patient
+ * @returns {boolean} - Returns true, if the player is dressed as a patient, false otherwise
+ */
+declare function AsylumEntranceIsWearingPatientClothes(): boolean;
+/**
+ * Checks, if the player is dressed as a nurse
+ * @returns {boolean} - Returns true, if the player is dressed as a nurse, false otherwise
+ */
+declare function AsylumEntranceIsWearingNurseClothes(): boolean;
+/**
+ * Commits a player to the asylum for a given time and changes the players reputation
+ * @param {string} Duration - The time (in micro seconds) the player gets committed for
+ * @param {string} ReputationChange - The amount the player's reputation is going to change
+ * @returns {void} - Nothing
+ */
+declare function AsylumEntranceCommitPatient(Duration: string, ReputationChange: string): void;
+/**
+ * The player starts working as a nurse for the Asylum. Dresses the player and sets her reputation to 1
+ * @returns {void} - Nothing
+ */
+declare function AsylumEntranceStartNurse(): void;
+/**
+ * Starts the fight for freedom between the player and the nurse
+ * @returns {void} - Nothing
+ */
+declare function AsylumEntranceFightNurse(): void;
+/**
+ * Resolves the result of the fight against the nurse
+ * @returns {void} - Nothing
+ */
+declare function AsylumEntranceFightNurseEnd(): void;
+/**
+ * Restrains the player in a straitjacket with a custom difficulty
+ * @param {string} Pose - The tightness of the straitjacket
+ * @returns {void} - Nothing
+ */
+declare function AsylumEntrancePlayerJacket(Pose: string): void;
+/**
+ * Handles the theft of the nurse's clothes by the player
+ * @param {number} RepChange - The amount of reputation change
+ * @returns {void} - Nothing
+ */
+declare function AsylumEntrancePlayerNurseClothes(RepChange: number): void;
+/**
+ * When the nurse is forced to be a patient (player will be tracked down for a full day after and a title will be forced)
+ * @returns {void} - Nothing
+ */
+declare function AsylumEntranceNurseBecomePatient(): void;
+/**
+ * Handles the restraining of the nurse by the player
+ * @param {number} RepChange - The amount of reputation change for the player
+ * @returns {void} - Nothing
+ */
+declare function AsylumEntranceNurseStrap(RepChange: number): void;
+/**
+ * When the player gets committed again after escaping, she is restraint tightly and has to stay for a full day
+ * @returns {void} - Nothing
+ */
+declare function AsylumEntranceRecommit(): void;
+/**
+ * Handles the player being caught by a nurse, after escaping the Asylum. The player is brought back and the doors locked
+ * @returns {void} - Nothing
+ */
+declare function AsylumEntranceNurseCatchEscapedPlayer(): void;
+/**
+ * Handled the player'S fight against the kidnap nurse
+ * @returns {void} - Nothing
+ */
+declare function AsylumEntranceKidnapNurseFight(): void;
+/**
+ * Resolved the fight against the kidnap nurse
+ * @param {boolean} Surrender - Wether the player surrendered or not
+ * @returns {void} - Nothing
+ */
+declare function AsylumEntranceKidnapNurseFightOutro(Surrender: boolean): void;
+/**
+ * Handles the bribe attempt of the kidnapping nurse
+ * @param {string} BribeAmount - The offered bribe amount
+ * @param {string} BribeOdds - The odds of a succesful bribe attempt
+ * @returns {void} - Nothing
+ */
+declare function AsylumEntranceKidnapNurseBribe(BribeAmount: string, BribeOdds: string): void;
+/**
+ * When the player transfers the kidnap nurse to her room
+ * @returns {void} - Nothing
+ */
+declare function AsylumEntranceKidnapNurseTransferToRoom(): void;
+/**
+ * When the player leaves the kidnap nurse
+ * @returns {void} - Nothing
+ */
+declare function AsylumEntranceKidnapNurseExit(): void;
+/**
+ * When the escaped player walks back to the asylum
+ * @returns {void} - Nothing
+ */
+declare function AsylumEntranceGoToAsylum(): void;
+/**
+ * When the escaped player is dressed back as a patient
+ * @returns {void} - Nothing
+ */
+declare function AsylumEntranceBackAsPatient(): void;
+/**
+ * The player meets  an escaped patient while on nurse duty
+ * @returns {void} - Nothing
+ */
+declare function AsylumEntranceEscapedPatientMeet(): void;
+/**
+ * When the player starts a fight against the escaped patient
+ * @returns {void} - Nothing
+ */
+declare function AsylumEntranceEscapedPatientFight(): void;
+/**
+ * Resolves the fight against an escaped patient
+ * @param {boolean} Surrender - Wether the player surrendered or not
+ * @returns {void} - Nothing
+ */
+declare function AsylumEntranceEscapedPatientFightOutro(Surrender: boolean): void;
+/**
+ * Resolves the bribe attempt towards the player by an escaped patient
+ * @returns {void} - Nothing
+ */
+declare function AsylumEntranceEscapedPatientBribe(): void;
+/**
+ * When the player transfers a patient to her room
+ * @returns {void} - Nothing
+ */
+declare function AsylumEntranceEscapedPatientTransferToRoom(): void;
+/**
+ * Handles the returning of an escaped patient by the player
+ * @returns {void} - Nothing
+ */
+declare function AsylumEntranceEscapedPatientTransferToAsylum(): void;
+/**
+ * When the player leaves the escaped patient
+ * @returns {void} - Nothing
+ */
+declare function AsylumEntranceEscapedPatientLeave(): void;
+/**
+ * The player gets a nurse uniform of her own
+ * @returns {void} - Nothing
+ */
+declare function AsylumEntranceGiveNurseUniform(): void;
+/**
+ * Whether or not a patient has earned a set of Asylum restraints.
+ * @returns {boolean} - TRUE if the the player is a patient but is not eligible for their own set of Asylum restraints,
+ * FALSE otherwise.
+ */
+declare function AsylumEntrancePatientCannotGetRestraints(): boolean;
+/**
+ * Whether or not a patient has earned a set of Asylum restraints.
+ * @returns {boolean} - TRUE if the the player is a patient and is eligible for their own set of Asylum restraints,
+ * FALSE otherwise.
+ */
+declare function AsylumEntrancePatientCanGetRestraints(): boolean;
+/**
+ * Whether or not a nurse has earned a set of Asylum restraints.
+ * @returns {boolean} - TRUE if the the player is a nurse but is not eligible for their own set of Asylum restraints,
+ * FALSE otherwise.
+ */
+declare function AsylumEntranceNurseCannotGetRestraints(): boolean;
+/**
+ * Whether or not a nurse has earned a set of Asylum restraints.
+ * @returns {boolean} - TRUE if the the player is a nurse and is eligible for their own set of Asylum restraints,
+ * FALSE otherwise
+ */
+declare function AsylumEntranceNurseCanGetRestraints(): boolean;
+/**
+ * Called when the player has earned their own set of Asylum restraints.
+ * @returns {void} - Nothing
+ */
+declare function AsylumEntranceGiveRestraints(): void;
+/**
+ * When the user removes 10 GGTS minutes from her bank to leave the asylum
+ * @returns {void} - Nothing
+ */
+declare function AsylumEntrancePayTenMinutes(): void;
+/**
+ * When the player starts a club card game
+ * @returns {void} - Nothing
+ */
+declare function AsylumEntranceClubCardStart(): void;
+/**
+ * When the player ends a club card game
+ * @returns {void} - Nothing
+ */
+declare function AsylumEntranceClubCardEnd(): void;
+declare var AsylumEntranceBackground: string;
+/** @type {null | NPCCharacter} */
+declare var AsylumEntranceNurse: null | NPCCharacter;
+/** @type {null | NPCCharacter} */
+declare var AsylumEntranceKidnapNurse: null | NPCCharacter;
+/** @type {null | NPCCharacter} */
+declare var AsylumEntranceEscapedPatient: null | NPCCharacter;
+declare var AsylumEntranceEscapedPatientWillBribe: boolean;
+declare var AsylumEntranceEscapedPatientWillJoin: boolean;

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

@@ -0,0 +1,330 @@
+/**
+ * Returns TRUE if the player has three strikes on record
+ * @returns {boolean} - TRUE if three strikes or more
+ */
+declare function AsylumGGTSHasThreeStrikes(): boolean;
+/**
+ * Returns TRUE if the player can quit GGTS
+ * @returns {boolean} - TRUE if three strikes or more or in active punishment
+ */
+declare function AsylumGGTSCanQuit(): boolean;
+/**
+ * Check that GGTS is enabled in the current room.
+ * @returns true if GGTS is running, false otherwise.
+ */
+declare function AsylumGGTSIsEnabled(): boolean;
+/**
+ * Returns TRUE if the player has completed the required time for the current level
+ * @returns {boolean} - TRUE if level is completed with 3 strikes on record
+ */
+declare function AsylumGGTSLevelCompleted(): boolean;
+/**
+ * Returns the character GGTS level
+ * @param {Character} C - The character to evaluate
+ * @returns {number} - Nothing
+ */
+declare function AsylumGGTSGetLevel(C: Character): number;
+/**
+ * Sets the computer image based on the player level
+ * @param {number} Level - The player GGTS level
+ * @returns {void} - Nothing
+ */
+declare function AsylumGGTSComputerImage(Level: number): void;
+/**
+ * Loads the GGTS and computer NPC
+ * @returns {void} - Nothing
+ */
+declare function AsylumGGTSLoad(): void;
+/**
+ * Runs the room
+ * @returns {void} - Nothing
+ */
+declare function AsylumGGTSRun(): void;
+/**
+ * Handles the click events.  Called from CommonClick()
+ * @returns {void} - Nothing
+ */
+declare function AsylumGGTSClick(): void;
+/**
+ * Adds the GGTS items based on the player level
+ * @returns {void} - Nothing
+ */
+declare function AsylumGGTSSAddItems(): void;
+/**
+ * Starts a new GGTS level for the player
+ * @param {number} Level - The new level to set
+ * @returns {void} - Nothing
+ */
+declare function AsylumGGTSStartLevel(Level: number): void;
+/**
+ * Quits GGTS and deletes the player data for the game
+ * @returns {void} - Nothing
+ */
+declare function AsylumGGTSQuit(): void;
+/**
+ * Builds a private room online chat room for single player GGTS experience
+ * @returns {void} - Nothing
+ */
+declare function AsylumGGTSBuildPrivate(): void;
+/**
+ * Gets the new character name based on it's GGTS level
+ * @param {Character} C - The character to rename
+ * @returns {string} - The new name for that character
+ */
+declare function AsylumGGTSCharacterName(C: Character, Name: any): string;
+/**
+ * Sends a chat message from the GGTS.  GGTS slowly replaces the player name by the player number as level rises.
+ * @param {string} Msg - The message to publish
+ * @param {Character} [Target] - The member number of the target character
+ * @returns {void} - Nothing
+ */
+declare function AsylumGGTSMessage(Msg: string, Target?: Character): void;
+/**
+ * Generates a new GGTS Task for the player and publishes it
+ * @returns {void} - Nothing
+ */
+declare function AsylumGGTSSetTimer(): void;
+/**
+ * Returns TRUE if the query was answered by character number M
+ * @param {number} Level - The player GGTS level, at level 4 or more, capital letters and punctuation matters
+ * @param {number} M - The member number to evaluate
+ * @param {string} TextEasy - The text to evaluate
+ * @param {string} TextHard - The text to evaluate
+ * @returns {boolean} - TRUE if the is done
+ */
+declare function AsylumGGTSQueryDone(Level: number, M: number, TextEasy: string, TextHard: string): boolean;
+/**
+ * Returns TRUE if the task T is currently done by character C
+ * @param {Character} C - The character to evaluate
+ * @param {string} T - The task to evaluate
+ * @returns {boolean} - TRUE if the is done
+ */
+declare function AsylumGGTSTaskDone(C: Character, T: string): boolean;
+/**
+ * Returns TRUE if GGTS can remove an item for a body group
+ * @param {Character} C - The character to evaluate
+ * @param {AssetGroupName} Group - The body group on which to remove the item
+ * @returns {boolean} - TRUE if removing the item is possible
+ */
+declare function AsylumGGTSCanRemove(C: Character, Group: AssetGroupName): boolean;
+/**
+ * Returns TRUE if the task T can be done in character C predicament
+ * @param {Character} C - The character to evaluate
+ * @param {string} T - The task to evaluate
+ * @returns {boolean} - TRUE if the task can be done
+ */
+declare function AsylumGGTSTaskCanBeDone(C: Character, T: string): boolean;
+/**
+ * Returns TRUE if the task T was failed by character C
+ * @param {Character} C - The character to evaluate
+ * @param {string} T - The task to evaluate
+ * @returns {boolean} - TRUE if the task was failed
+ */
+declare function AsylumGGTSTaskFail(C: Character, T: string): boolean;
+/**
+ * Checks if there's a futuristic item in the group slot and remove it if it's the case
+ * @param {AssetGroupName} Group - The group name to validate
+ * @returns {void} - Nothing
+ */
+declare function AsylumGGTSTaskRemoveFuturisticItem(Group: AssetGroupName): void;
+/**
+ * Transforms a ballgag to a panelgag for the specified group
+ * @param {AssetGroupName} Group - The group name to transform
+ * @returns {void} - Nothing
+ */
+declare function AsylumGGTSTransformGag(Group: AssetGroupName): void;
+/**
+ * Changes the inflation setting on the ballgag or panelgag
+ * @param {AssetGroupName} Group - The group name to transform
+ * @returns {void} - Nothing
+ */
+declare function AsylumGGTSConfigureGag(Group: AssetGroupName): void;
+/**
+ * Processes the tasks that doesn't need any player input. GGTS does everything and ends the task automatically.
+ * @returns {void} - Nothing
+ */
+declare function AsylumGGTSAutomaticTask(): void;
+/**
+ * In a public room, some GGTS tasks can target another valid player.  Patients will do physical activities, nurses will restraint.
+ * @param {string} T - The task to evaluate
+ * @returns {Character} - The target character
+ */
+declare function AsylumGGTSFindTaskTarget(T: string): Character;
+/**
+ * Generates a new GGTS Task for the player and publishes it
+ * @returns {void} - Nothing
+ */
+declare function AsylumGGTSNewTask(): void;
+/**
+ * Saves the game progress after a task ended
+ * @param {boolean} [Fail=false] - If the task was failed, we don't add bonus time
+ * @returns {void} - Nothing
+ */
+declare function AsylumGGTSEndTaskSave(Fail?: boolean): void;
+/**
+ * Adds a new rule for the player to follow or get strikes, syncs with the chatroom
+ * @param {string} NewRule - The rule name to add
+ * @param {boolean} Publish - TRUE if we must publish to local chat
+ * @returns {void} - Nothing
+ */
+declare function AsylumGGTSAddRule(NewRule: string, Publish: boolean): void;
+/**
+ * Removes a rule for the player to follow, syncs with the chatroom
+ * @param {string} Rule - The rule name to remove
+ * @returns {void} - Nothing
+ */
+declare function AsylumGGTSRemoveRule(Rule: string): void;
+/**
+ * Checks if the current GGTS Task is complete
+ * @returns {void} - Nothing
+ */
+declare function AsylumGGTSEndTask(): void;
+/**
+ * Checks for forbidden words spoken by a character
+ * @param {Character} C - The character to evaluate
+ * @returns {boolean} - TRUE if a forbidden word was said
+ */
+declare function AsylumGGTSForbiddenWord(C: Character): boolean;
+/**
+ * Processes the GGTS AI in the chatroom
+ * @returns {void} - Nothing
+ */
+declare function AsylumGGTSProcess(): void;
+/**
+ * Processes the sexual activity in GGTS
+ * @param {Character} S - The character performing the activity
+ * @param {Character} C - The character on which the activity is performed
+ * @param {string} A - The name of the activity performed
+ * @param {string} Z - The group/zone name where the activity was performed
+ * @param {number} [Count=1] - If the activity is done repeatedly, this defines the number of times, the activity is done.
+ * @return {void} - Nothing
+ */
+declare function AsylumGGTSActivity(S: Character, C: Character, A: string, Z: string, Count?: number): void;
+/**
+ * Sets the punishment time for failing GGTS
+ * @param {number} Minute - The number of minutes for the punishment
+ * @returns {void} - Nothing
+ */
+declare function AsylumGGTSPunishmentTime(Minute: number): void;
+/**
+ * Starts the isolation punishment and go to the player room
+ * @returns {void} - Nothing
+ */
+declare function AsylumGGTSStartPunishment(): void;
+/**
+ * Returns TRUE if the item is controlled by GGTS, so the player should not have control.  The rules changes on level 3 and GGTS takes control throughout the asylum.
+ * @returns {boolean} - TRUE if the item is controlled by GGTS
+ */
+declare function AsylumGGTSControlItem(C: any, Item: any): boolean;
+/**
+ * Checks if the has enough GGTS minutes to spend on different activities, for GGTS level 6 and up
+ * @param {number} Minute - The number of minutes to compare
+ * @returns {boolean} - TRUE if the player has enough minutes
+ */
+declare function AsylumGGTSHasMinutes(Minute: number): boolean;
+/**
+ * At level 6, the player can spend GGTS minutes for various reasons
+ * @returns {void} - Nothing
+ */
+declare function AsylumGGTSSpendMinute(Minute: any): void;
+/**
+ * Adds a strike to the player game info.  At strike 3, we auto-unlock the door to allow players to leave.
+ * @returns {void} - Nothing
+ */
+declare function AsylumGGTSAddStrike(): void;
+/**
+ * Allows the player to start the punishment phase with a futuristic gag on
+ * @returns {boolean} - Returns TRUE if the player is due for a punishment with a future gag
+ */
+declare function AsylumGGTSFuturisticGaggedPunished(): boolean;
+/**
+ * Ungags the player
+ * @returns {void} - Nothing
+ */
+declare function AsylumGGTSUngag(): void;
+/**
+ * When an orgasm starts, we check if it breaks any GGTS rule
+ * @param {Character} C - The character getting the orgasm
+ * @return {void} - Nothing
+ */
+declare function AsylumGGTSTOrgasm(C: Character): void;
+/**
+ * When the player resists an orgasm, there's a 50% chance the no-orgasm rule will be dropped
+ * @return {void} - TRUE if the character can change
+ */
+declare function AsylumGGTSOrgasmResist(): void;
+/**
+ * When the player is sent to do GGTS by her owner
+ * @param {number} LockTime - The number of minutes to do
+ * @param {string} Msg - The nurse intro message
+ * @return {void} - Nothing
+ */
+declare function AsylumGGTSLock(LockTime: number, Msg: string): void;
+/**
+ * Fully dress the character in a drone futuristic gear setup
+ * @param {Character} C - The character to dress, if omitted, we use the player
+ * @return {void} - Nothing
+ */
+declare function AsylumGGTSDroneDress(C: Character): void;
+/**
+ * GGTS will not allow the character to change if she's being punished or she reached level 6
+ * @param {Character} C - The character to evaluate
+ * @return {boolean} - TRUE if the character can change
+ */
+declare function AsylumGGTSAllowChange(C: Character): boolean;
+/**
+ * Called from Dialog.js, triggers a specific action from GGTS game
+ * @param {String} Action - The action to perform
+ * @param {Number} Minute - The number of minutes to remove
+ * @returns {void} - Nothing
+ */
+declare function AsylumGGTSDialogAction(Action: string, Minute: number): void;
+/**
+ * Called from Dialog.js, as nurse, trigger a specific interaction for the current character
+ * @param {String} Interaction - The interaction to perform
+ * @returns {void} - Nothing
+ */
+declare function AsylumGGTSDialogInteraction(Interaction: string): void;
+/**
+ * Called from chat room, processes hidden GGTS messages
+ * @param {Character} SenderCharacter - The character sending the message
+ * @param {String} Interaction - The message sent
+ * @param {IChatRoomMessage} data - The full message recieved
+ * @returns {Object} - Nothing to be used
+ */
+declare function AsylumGGTSHiddenMessage(SenderCharacter: Character, Interaction: string, data: IChatRoomMessage): any;
+/**
+ * GGTS Draws the level, the number of strikes and a progress bar, level 6 shows the time in a gold frame
+ * @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 AsylumGGTSDrawCharacter(C: Character, X: number, Y: number, Zoom: number): void;
+/**
+ * Resets the state of the GGTS game
+ * @returns {void} - Nothing
+ */
+declare function AsylumGGTSReset(): void;
+declare var AsylumGGTSBackground: string;
+/** @type {null | NPCCharacter} */
+declare var AsylumGGTSComputer: null | NPCCharacter;
+declare var AsylumGGTSIntroDone: boolean;
+declare var AsylumGGTSTimer: number;
+/** @type {null | string} */
+declare var AsylumGGTSTask: null | string;
+/** @type {null | Character} */
+declare var AsylumGGTSTaskTarget: null | Character;
+declare var AsylumGGTSLastTask: string;
+declare var AsylumGGTSTaskStart: number;
+declare var AsylumGGTSTaskEnd: number;
+/**
+ * The list of available tasks, partitioned by level.
+ */
+declare var AsylumGGTSTaskList: string[][];
+declare var AsylumGGTSLevelTime: number[];
+/** The last pose the character had. Used to enforce KeepPose rules */
+declare var AsylumGGTSPreviousPose: any[];
+declare var AsylumGGTSWordCheck: number;
+declare var AsylumGGTSSpeed: number;