bc-stubs 96.0.0

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

@@ -0,0 +1,78 @@
+/**
+ * Returns TRUE if the private bed is available.
+ * @returns {boolean} - TRUE if available.
+ */
+declare function PrivateBedActive(): boolean;
+/**
+ * Returns the number of girls in the private bedroom.
+ * @returns {Number} - The number of girls.
+ */
+declare function PrivateBedCount(): number;
+/**
+ * Loads the private bedroom screen.
+ * @returns {void} - Nothing.
+ */
+declare function PrivateBedLoad(): void;
+/**
+ * Draws a private bedroom character.
+ * @param {Character} C - The character to draw.
+ * @returns {void} - Nothing.
+ */
+declare function PrivateBedDrawCharacter(C: Character): void;
+/**
+ * Runs the private bedroom screen.
+ * @returns {void} - Nothing.
+ */
+declare function PrivateBedRun(): void;
+/**
+ * Starts an arousal action on a character.
+ * @param {Character} Source - The source character.
+ * @param {Character} Target - The target character.
+ * @param {AssetItemGroup} Group - The zone / group to target.
+ * @param {ActivityName} Activity - The activity to do.
+ * @returns {boolean} - TRUE if the activity could start.
+ */
+declare function PrivateBedActivityStart(Source: Character, Target: Character, Group: AssetItemGroup, Activity: ActivityName): boolean;
+/**
+ * Checks if the activity if valid for the group/zone on the target character.
+ * @param {Character} Source - The source character.
+ * @param {Character} Target - The target character.
+ * @param {AssetGroup} Group - The zone / group to target.
+ * @param {Activity} Activity - The activity to do.
+ * @returns {Group is AssetItemGroup} - TRUE if the activity is valid for the group
+ */
+declare function PrivateBedGroupActivityIsValid(Source: Character, Target: Character, Group: AssetGroup, Activity: Activity): Group is AssetItemGroup;
+/**
+ * Starts a random activity for a source NPC
+ * @param {Character} Source - The source character.
+ * @returns {void} - Nothing.
+ */
+declare function PrivateBedNPCActivity(Source: Character): void;
+/**
+ * Handles clicks in the private bedroom.
+ * @returns {void|boolean} - Nothing.
+ */
+declare function PrivateBedClick(): void | boolean;
+/**
+ * When the player exits the private bedroom.  The next sex scene will wait from 5 to 20 depending on luck and the frigid/honry trait.
+ * @returns {void} - Nothing.
+ */
+declare function PrivateBedExit(Type: any): void;
+/**
+ * When a character gets an orgasm
+ * @param {Character} C - The character getting the orgasm.
+ * @returns {void} - Nothing.
+ */
+declare function PrivateBedOrgasm(C: Character): void;
+declare var PrivateBedBackground: string;
+/** @type {Character[]} */
+declare var PrivateBedCharacter: Character[];
+/** @type {ActivityName} */
+declare var PrivateBedActivity: ActivityName;
+/** @type {ActivityName[]} */
+declare var PrivateBedActivityList: ActivityName[];
+/** @type {string[]} */
+declare var PrivateBedLog: string[];
+declare var PrivateBedActivityDelay: number;
+declare var PrivateBedActivityMustRefresh: boolean;
+declare var PrivateBedLeaveTime: number;

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

@@ -0,0 +1,28 @@
+/**
+ * Check if we must start a Pandora ransom for one of the girls in the private room
+ * @returns {boolean} - TRUE if a ransom or more was started
+ */
+declare function PrivateRansomStart(): boolean;
+/**
+ * Loads the private ransom note screen
+ * @returns {void} - Nothing.
+ */
+declare function PrivateRansomLoad(): void;
+/**
+ * Draws the character and the ransom note
+ * @returns {void} - Nothing.
+ */
+declare function PrivateRansomRun(): void;
+/**
+ * Handles clicks in the ransom note
+ * @returns {void} - Nothing.
+ */
+declare function PrivateRansomClick(): void;
+/**
+ * When the player leaves the note, we go back to the private room
+ * @returns {void} - Nothing.
+ */
+declare function PrivateRansomExit(): void;
+declare var PrivateRansomBackground: string;
+/** @type {null | NPCCharacter} */
+declare var PrivateRansomCharacter: null | NPCCharacter;

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

@@ -0,0 +1,162 @@
+declare function SarahStatusIs(QueryStatus: any): boolean;
+declare function SarahAmandaStatusIs(QueryStatus: any): boolean;
+declare function SarahCanKissLover(): boolean;
+declare function SarahCanKissNotLover(): boolean;
+declare function SarahCanSpankOwner(): boolean;
+declare function SarahCanSpankNotOwner(): boolean;
+declare function SarahCanReleaseToClub(): boolean;
+declare function SarahCanInviteToRoomFriend(): boolean;
+declare function SarahCanInviteToRoomSlave(): boolean;
+declare function SarahCanInviteAmandaToRoom(): boolean;
+declare function SarahCanInviteAmandaToRoomRefuse(): boolean;
+declare function SarahCanInviteSophieToRoom(): boolean;
+declare function SarahCanInviteSophieToRoomAccept(): boolean;
+declare function SarahCanInviteSophieToRoomRefuse(): boolean;
+declare function SarahCanKickAmandaOut(): boolean;
+declare function SarahCanKickAmandaOutRefuse(): boolean;
+declare function SarahShackled(): boolean;
+declare function SarahAmandaHasStrapon(): boolean;
+declare function SarahAmandaHasNoStrapon(): boolean;
+declare function SarahKnowAmandaInRoom(): boolean;
+declare function SarahAmandaCanKiss(): boolean;
+declare function SarahIsClubSlave(): boolean;
+declare function SarahCanKissSophie(): boolean;
+declare function SarahCanFightSophie(): boolean;
+declare function SarahSophiePunishmentStageIs(Stage: any): boolean;
+declare function SarahSophieLikesPlayer(): boolean;
+declare function SarahCanStrip(): boolean;
+declare function SarahIsInside(): boolean;
+declare function SarahAmandaIsInside(): boolean;
+declare function SarahAndAmandaAreInside(): boolean;
+declare function SarahOrAmandaAreInside(): boolean;
+declare function SarahIsPlayerSlave(): boolean;
+declare function SarahAmandaIsPlayerSlave(): boolean;
+declare function SarahAmandaAndSarahArePlayerSlave(): boolean;
+declare function SarahRoomLabel(): "ExploreClub" | "SearchSarah" | "SarahBedroom";
+declare function SarahSetStatus(): void;
+declare function SarahLoad(): void;
+declare function AmandaLoad(): void;
+declare function SophieLoad(): void;
+declare function SarahLoadNewCharacter(): void;
+declare function SarahLoadBackground(): void;
+declare function SarahRun(): void;
+declare function SarahClick(): void;
+declare function SarahActivityRun(): void;
+declare function SarahCheckShackles(): void;
+declare function SarahStartUnlockQuest(): void;
+declare function SarahUnlock(): void;
+declare function SarahEvasion(): void;
+declare function SarahLeaveRoom(): void;
+declare function SarahTransferToRoom(): void;
+declare function SarahAmandaLeaveRoom(): void;
+declare function SarahSophieLeaveRoom(): void;
+declare function SarahTransferAmandaToRoom(): void;
+declare function SarahUpsetSophie(Offset: any): void;
+declare function SarahRestrainedBySophie(Phase: any, DomRep: any): void;
+declare function SarahFightSophie(): void;
+declare function SarahFightSophieEnd(): void;
+declare function SarahSophiePunishGirls(): void;
+declare function SarahSophieFreeSarahAndLeave(): void;
+declare function SarahSophieFreePlayerAndAmandaTheyLeave(): void;
+declare function SarahKickPlayerOut(): void;
+declare function SarahTransferSophieToRoom(Love: any): void;
+declare function SarahSophieSetPunishmentIntro(DomRep: any): void;
+/**
+ * Strips and restrains a character
+ * @param {Character} C
+ */
+declare function SarahSophiePreparePunishCharacter(C: Character): void;
+/**
+ * When Sophie starts a character vibrator
+ * @param {Character} C
+ * @param {string|number} Intensity
+ */
+declare function SarahSophieStartBuzz(C: Character, Intensity: string | number): void;
+/**
+ * Sets the Sophie punishment for the player
+ * @param {string} EventType
+ * @param {string|number} DomRep
+ */
+declare function SarahSophiePunishEvent(EventType: string, DomRep: string | number): void;
+/**
+ * When the player plays Sophie Orgasm Game
+ * @param {string} Factor
+ */
+declare function SarahSophieOrgasmGame(Factor: string): void;
+declare function SarahSophieReleaseEveryoneButSarah(): void;
+declare function SarahPlayerPunishGirls(): void;
+/**
+ * Returns TRUE if the current slave(s) are naked and without restrains
+ * @param {NPCCharacter} C
+ */
+declare function SarahSlaveNakedWithoutRestrains(C: NPCCharacter): any;
+/**
+ * Returns TRUE if the current slave(s) are wearing clamps, egg and butt plug
+ * @param {NPCCharacter} C
+ */
+declare function SarahSlaveWithClampEggPlug(C: NPCCharacter): any;
+/**
+ * Returns TRUE if the current slave(s) are wearing clamps, egg, butt plug, chastity belt & bra
+ * @param {NPCCharacter} C
+ */
+declare function SarahSlaveChaste(C: NPCCharacter): any;
+/**
+ * Returns TRUE if the current slave(s) are wearing clamps, egg, butt plug, chastity belt, bra & locked cuffs
+ * @param {NPCCharacter} C
+ */
+declare function SarahSlaveLockedCuffs(C: NPCCharacter): any;
+/**
+ * Returns TRUE if the current slave(s) had their orgasms
+ * @returns {boolean}
+ */
+declare function SarahSlaveOrgasm(): boolean;
+/**
+ * Gives the restrains temporarily to Sarah and Amanda so they can be punished
+ * @param {NPCCharacter} C
+ */
+declare function SarahGiveFirstSlaveItem(C: NPCCharacter): void;
+/**
+ * Gives the second set of restrains temporarily to Sarah and Amanda so they can be punished
+ * @param {NPCCharacter} C
+ */
+declare function SarahGiveSecondSlaveItem(C: NPCCharacter): void;
+/**
+ * Gives the third set of restrains temporarily to Sarah and Amanda so they can be punished
+ * @param {NPCCharacter} C
+ */
+declare function SarahGiveThirdSlaveItem(C: NPCCharacter): void;
+/**
+ * Gives the fourth set of restrains temporarily to Sarah and Amanda so they can be punished
+ * @param {NPCCharacter} C
+ */
+declare function SarahGiveFourthSlaveItem(C: NPCCharacter): void;
+/**
+ * Build the orgasm meter for the slaves
+ * @param {string|number} Pleasure
+ * @param {string|number} Bonus
+ * @param {string|number} Intensity
+ */
+declare function SarahSlaveOrgasmBuild(Pleasure: string | number, Bonus: string | number, Intensity: string | number): void;
+declare function SarahSlaveReset(): void;
+declare var SarahRoomAvailable: boolean;
+declare var SarahBackground: string;
+declare var SarahStatus: string;
+declare var AmandaStatus: string;
+declare var SophieStatus: string;
+/** @type {null | NPCCharacter} */
+declare var Sarah: null | NPCCharacter;
+/** @type {null | NPCCharacter} */
+declare var Amanda: null | NPCCharacter;
+/** @type {null | NPCCharacter} */
+declare var Sophie: null | NPCCharacter;
+declare var SarahInside: boolean;
+declare var AmandaInside: boolean;
+declare var SophieInside: boolean;
+declare var SarahUnlockQuest: boolean;
+/** @type {Character[]} */
+declare var SarahCharacter: Character[];
+declare var SophieUpsetCount: number;
+declare var SophieFightDone: boolean;
+declare var SophiePunishmentStage: number;
+declare var SophieOrgasmGameCount: number;
+declare var SophieOrgasmGamePleasure: number;

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

@@ -0,0 +1,162 @@
+/**
+ * Checks if the player can restrain the Shibari dojo teacher.
+ * @returns {boolean} - Returns TRUE if the player is able to restrain the teacher.
+ */
+declare function ShibariAllowTeacherBondage(): boolean;
+/**
+ * Checks if the player can strip the Shibari dojo teacher.
+ * @returns {boolean} - Returns TRUE if the player is able to strip the teacher.
+ */
+declare function ShibariAllowTeacherStrip(): boolean;
+/**
+ * Checks if the player can be restrained by the Shibari dojo teacher.
+ * @returns {boolean} - Returns TRUE if the player can be restrained by the teacher.
+ */
+declare function ShibariAllowPlayerBondage(): boolean;
+/**
+ * Checks if the player can spank the Shibari dojo teacher.
+ * @returns {boolean} - Returns TRUE if the player can spank the teacher.
+ */
+declare function ShibariAllowSpank(): boolean;
+/**
+ * Checks if the given maid rescue scenario name is currently active in the shibari dojo.
+ * @param {string} ScenarioName - Name of the scenario to check for.
+ * @returns {boolean} - Returns TRUE if the given scenario is active.
+ */
+declare function ShibariIsRescueScenario(ScenarioName: string): boolean;
+/**
+ * Checks if the Shibari dojo teacher is restrained.
+ * @returns {boolean} - Returns TRUE if the teacher is restrained.
+ */
+declare function ShibariIsTeacherRestrained(): boolean;
+/**
+ * Checks if the player can be trained in a given skill type.
+ * @param {SkillType} SkillType - Name of the skill to check for.
+ * @returns {boolean} - Returns TRUE if the player can receive a training.
+ */
+declare function ShibariCanTrainSkill(SkillType: SkillType): boolean;
+/**
+ * Checks if the player can pay for a training.
+ * @returns {boolean} - Returns TRUE if the player can pay for the requested training.
+ */
+declare function ShibariCanPayForTraining(): boolean;
+/**
+ * Checks if the player can pay for a training.
+ * @returns {boolean} - Returns TRUE if the player can pay for the requested training.
+ */
+declare function ShibariCanTrain(): boolean;
+/**
+ * Checks if the player can pay for a training.
+ * @returns {boolean} - Returns TRUE if the player can pay for the requested training.
+ */
+declare function ShibariCannotTrainDelay(): 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 ShibariCanPlayClubCard(): boolean;
+/**
+ * Puts a character in a random bondage position.
+ * @param {Character} C - Character to restrain.
+ * @param {number} Level - Level of bondage, higher is more complex bondage
+ * @returns {void} - Nothing
+ */
+declare function ShibariRandomBondage(C: Character, Level: number): void;
+/**
+ * Loads the shibari dojo and its two characters.
+ * @returns {void} - Nothing
+ */
+declare function ShibariLoad(): void;
+/**
+ * Runs and draws the shibari dojo, with its 3 characters
+ * @returns {void} - Nothing
+ */
+declare function ShibariRun(): void;
+/**
+ * Handles clicks in the shibari dojo
+ * @returns {void} - Nothing
+ */
+declare function ShibariClick(): void;
+/**
+ * Triggered when the player is allowed to restrain the teacher.
+ * @returns {void} - Nothing
+ */
+declare function ShibariStartTeacherBondage(): void;
+/**
+ * Triggered when the player gets restrained by the teacher, the teacher will not release the player for a minute after this.
+ * @param {string} Level
+ * @returns {void} - Nothing
+ */
+declare function ShibariRestrainPlayer(Level: string): void;
+/**
+ * Triggered on the first time the player says something submissive, it lowers the dominant score.
+ * @returns {void} - Nothing
+ */
+declare function ShibariSubComment(): void;
+/**
+ * Triggered on the first time the player says something dominant, it raises the dominant score.
+ * @returns {void} - Nothing
+ */
+declare function ShibariDomComment(): void;
+/**
+ * Triggered on the first time the player surrenders to the teacher, it lowers the dominant score.
+ * @returns {void} - Nothing
+ */
+declare function ShibariSurrenderToTeacher(): void;
+/**
+ * Triggered on the first time the player spanks the submissive or the teacher, it raises the dominant score.
+ * @returns {void} - Nothing
+ */
+declare function ShibariSpank(): void;
+/**
+ * Triggered when the teacher gives the suspension hemp rope to the player
+ * @returns {void} - Nothing
+ */
+declare function ShibariGetRope(): void;
+/**
+ * Triggered when the player rescues the teacher and completes the mission for the maid rescue mission.
+ * @returns {void} - Nothing
+ */
+declare function ShibariCompleteRescue(): void;
+/**
+ * Calculates the training price, it is linked to the current skill level of the player
+ * @param {SkillType} SkillType - Name of the skill to calculate the price of
+ * @returns {void} - Nothing
+ */
+declare function ShibariCalculateTrainingPrice(SkillType: SkillType): void;
+/**
+ * Triggered when the player pays to get trained in a given skill.
+ * @param {SkillType} SkillType - Name of the skill being bought
+ * @returns {void} - Nothing
+ */
+declare function ShibariPayForTraining(SkillType: SkillType): void;
+/**
+ * When the player starts a club card game against the shibari student
+ * @returns {void} - Nothing
+ */
+declare function ShibariClubCardStart(): void;
+/**
+ * When the player ends a club card game against the shibari student
+ * @returns {void} - Nothing
+ */
+declare function ShibariClubCardEnd(): void;
+declare var ShibariBackground: string;
+/** @type {null | NPCCharacter} */
+declare var ShibariTeacher: null | NPCCharacter;
+/** @type {null | Item[]} */
+declare var ShibariTeacherAppearance: null | Item[];
+declare var ShibariAllowTeacherItem: boolean;
+/** @type {null | NPCCharacter} */
+declare var ShibariStudent: null | NPCCharacter;
+/** @type {null | Item[]} */
+declare var ShibariPlayerAppearance: null | Item[];
+declare var ShibariSubCommentDone: boolean;
+declare var ShibariDomCommentDone: boolean;
+declare var ShibariSurrenderDone: boolean;
+declare var ShibariSpankDone: boolean;
+/** @type {null | number} */
+declare let ShibariTeacherReleaseTimer: null | number;
+declare var ShibariRescueScenario: string;
+declare var ShibariRescueScenarioList: string[];
+declare var ShibariTrainingPrice: number;
+declare var ShibariTrainingPriceList: number[];

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

@@ -0,0 +1,162 @@
+/**
+ * Checks if the vendor is restrained
+ * @returns {boolean} - Returns TRUE if the vendor is restrained or gagged
+ */
+declare function ShopIsVendorRestrained(): boolean;
+/**
+ * Checks if the current rescue scenario corresponds to the given one
+ * @param {string} ScenarioName - Name of the rescue scenario to check for
+ * @returns {boolean} - Returns TRUE if the current rescue scenario is the given one
+ */
+declare function ShopIsRescueScenario(ScenarioName: string): boolean;
+/**
+ * Activates the mode which allows the player to buy the items that appear in the inventory screen
+ * @returns {void} - Nothing
+ */
+declare function ShopSetBuyMode(): void;
+/**
+ * Activates the mode which allows the player to sell the items that appear in the inventory screen
+ * @returns {void} - Nothing
+ */
+declare function ShopSetSellMode(): void;
+/**
+ * Loads the shop room and its NPC
+ * @returns {void} - Nothing
+ */
+declare function ShopLoad(): void;
+/**
+ * Runs and draws the shop screen.
+ * @returns {void} - Nothing
+ */
+declare function ShopRun(): void;
+/**
+ * Checks if an asset is from the focus group and if it can be bought/sold. An asset can be bought/sold if it has a value greater than
+ * 0. (0 is a default item, -1 is a non-purchasable item)
+ * @param {Asset} Asset - The asset to check for availability
+ * @returns {boolean} - Returns TRUE if the item is purchasable and part of the focus group.
+ */
+declare function ShopAssetFocusGroup(Asset: Asset): boolean;
+/**
+ * Checks if an asset can be bought. An asset is considered missing if it is not owned and has a value greater than 0. (0 is a default
+ * item, -1 is a non-purchasable item)
+ * @param {Asset} Asset - The asset to check for availability
+ * @returns {boolean} - Returns TRUE if the item is purchasable and unowned.
+ */
+declare function ShopAssetMissing(Asset: Asset): boolean;
+/**
+ * Check if the player configured settings to hide items only for a specific gender
+ * @param {Asset} Asset - The asset to check
+ * @returns {boolean} - Returns whether the asset should be hidden
+ */
+declare function ShopHideGenderedAsset(Asset: Asset): boolean;
+/**
+ * Used to display all the items the player does not own
+ * @returns {void} - Nothing
+ */
+declare function ShopSelectAssetMissing(): void;
+/**
+ * Click handler for the shop screen
+ * @returns {void} - Nothing
+ */
+declare function ShopClick(): void;
+/**
+ * Add the item and any other items linked by the buy-group to the player's inventory if able
+ * @param {Asset} asset - The item being bought
+ */
+declare function ShopBuyItem(asset: Asset): void;
+/**
+ * Remove the item and any other items linked by the buy-group from the player's inventory
+ * @param {Asset} asset - The item being sold
+ */
+declare function ShopSellItem(asset: Asset): void;
+/**
+ * Builds the array of items the player can buy in the current category.
+ * @returns {void} - Nothing
+ */
+declare function ShopCartBuild(): void;
+/**
+ * If selling items, checks whether the player owns any items in the specified groups that can be sold
+ * @param {string} groupList - The list of groups to check, with separator "|"
+ * @returns {boolean} - If TRUE the player is either buying items or owns at least one item in one of the groups
+ */
+declare function ShopCanShow(groupList: string): boolean;
+/**
+ * Returns whether the player is able to sell the item back to the shop
+ * @param {Asset} asset - The item to check
+ * @returns {boolean} - If TRUE the item can be sold
+ */
+declare function ShopCanSell(asset: Asset): boolean;
+/**
+ * Sets the current asset group the player is shopping for
+ * @param {AssetGroupItemName} ItemGroup - Name of the asset group to look for
+ * @returns {void} - Nothing
+ */
+declare function ShopStart(ItemGroup: AssetGroupItemName): void;
+/**
+ * Triggered when the player rescues the shop vendor
+ * @returns {void} - Nothing
+ */
+declare function ShopCompleteRescue(): void;
+/**
+ * Checks if the player bought all items that can be bought, including appearance items
+ * @returns {void} - Nothing
+ */
+declare function ShopCheckBoughtEverything(): void;
+/**
+ * Allows the player to tie the shop vendor if the player has bought everything
+ * @returns {void} - Nothing
+ */
+declare function ShopVendorBondage(): void;
+/**
+ * Restrains the player with a random shop item before the shop demo job starts. The customer will have a 50/50 chance of being willing to
+ * release the player
+ * @returns {void} - Nothing
+ */
+declare function ShopJobRestrain(): void;
+/**
+ * Handles starting the shop demo job, the player is sent in an empty room with a customer
+ * @returns {void} - Nothing
+ */
+declare function ShopJobStart(): void;
+/**
+ * Filters the list of shop demo items down to the groups that are currently available on the player
+ * @returns {AssetGroupItemName[]} - The filtered list demo item groups that are both empty and unblocked
+ */
+declare function ShopJobFilterAvailableGroups(): AssetGroupItemName[];
+/**
+ * Checks whether or not the player is able to retry the shop job after completing one
+ * @returns {boolean} - Returns true if the player is able to continue running shop jobs (are able to interact, not all
+ * demo item groups are occupied/blocked)
+ */
+declare function ShopJobCanGoAgain(): boolean;
+declare var ShopBackground: string;
+/** @type {null | NPCCharacter} */
+declare var ShopVendor: null | NPCCharacter;
+/** @type {null | NPCCharacter} */
+declare var ShopCustomer: null | NPCCharacter;
+declare var ShopVendorAllowItem: boolean;
+declare var ShopBoughtEverything: boolean;
+declare var ShopStarted: boolean;
+declare var ShopText: string;
+declare var ShopRescueScenario: string;
+declare var ShopRescueScenarioList: string[];
+declare var ShopItemOffset: number;
+declare var ShopDemoItemPayment: number;
+/** @type {"" | AssetGroupItemName} */
+declare var ShopDemoItemGroup: "" | AssetGroupItemName;
+/** @type {AssetGroupItemName[]} */
+declare var ShopDemoItemGroupList: AssetGroupItemName[];
+/**
+ * Checks if an asset is from the focus group and if it can be bought/sold. An asset can be bought/sold if it has a value greater than
+ * 0. (0 is a default item, -1 is a non-purchasable item)
+ * @param {Asset} Asset - The asset to check for availability
+ * @returns {boolean} - Returns TRUE if the item is purchasable and part of the focus group.
+ */
+declare function ShopSelectAsset(Asset: Asset): boolean;
+/** @type {Asset[]} */
+declare var ShopCart: Asset[];
+declare var ShopBuyMode: boolean;
+declare var ShopSellExceptions: {
+    Name: string;
+    Group: string;
+}[];

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

@@ -0,0 +1,90 @@
+/**
+ * Checks if an auction can be started.
+ * @returns {boolean} - Returns TRUE if the player has room in her private room and is dominant enough to participate in an auction
+ */
+declare function SlaveMarketCanStartAuction(): boolean;
+/**
+ * Checks if an auction cannot be started due to being too submissive.
+ * @returns {boolean} - Returns TRUE if the player is not dominant enough to participate in an auction
+ */
+declare function SlaveMarketCannotStartAuctionSubmissive(): boolean;
+/**
+ * Checks if an auction cannot be started due to lack of space in the player's private room
+ * @returns {boolean} - Returns TRUE if the player is dominant enough to participate in an auction, but does not have space in her private room
+ */
+declare function SlaveMarketCannotStartAuctionRoom(): boolean;
+/**
+ * Checks if the player can be auctioned.  Must not be owned, must be submissive, must not be restrained, must have space in room and must not have been auctioned in the last seven days
+ * @returns {boolean} - Returns TRUE if the player can be auctioned
+ */
+declare function SlaveMarketCanBeAuctioned(): boolean;
+/**
+ * Loads the Slave Market room, generates the Mistress and slave
+ * @returns {void} - Nothing
+ */
+declare function SlaveMarketLoad(): void;
+/**
+ * Runs and draws the slave market, the screen can be used to search for a daily job.
+ * @returns {void} - Nothing
+ */
+declare function SlaveMarketRun(): void;
+/**
+ * Handles clicks in the slave market.
+ * @returns {void} - Nothing
+ */
+declare function SlaveMarketClick(): void;
+/**
+ * Triggered when the auction starts, the mini game is launched
+ * @returns {void} - Nothing
+ */
+declare function SlaveMarketAuctionStart(): void;
+/**
+ * Triggered when the auction ends. If the player was the last bidder, she buys the slave and gets in a dialog with her, otherwise she returns to the main area of the slave market
+ * @returns {void} - Nothing
+ */
+declare function SlaveMarketAuctionEnd(): void;
+/**
+ * Generates a new slave for the slave market
+ * @returns {void} - Nothing
+ */
+declare function SlaveMarketNewSlave(): void;
+/**
+ * Triggered when the player brings the slave to her room, the player is sent to her private room with the NPC.
+ * @returns {void} - Nothing
+ */
+declare function SlaveMarketVisitRoom(): void;
+/**
+ * Triggered when the slave training start. Sets the NPC and dialog before sending the player to an empty room with the trainee.
+ * @returns {void} - Nothing
+ */
+declare function SlaveMarketTrainingStart(): void;
+/**
+ * Triggered when the auctioned player gets stripped and chained
+ * @returns {void} - Nothing
+ */
+declare function SlaveMarketAuctionPlayerStrip(): void;
+/**
+ * Triggered when the player auction starts
+ * @returns {void} - Nothing
+ */
+declare function SlaveMarketAuctionPlayerStart(): void;
+/**
+ * Triggered when the player auction ends, we create the buyer and activate her
+ * @returns {void} - Nothing
+ */
+declare function SlaveMarketPlayerAuctionEnd(): void;
+/**
+ * Triggered when the player auction has ended and both characters are transferred to the player room
+ * @returns {void} - Nothing
+ */
+declare function SlaveMarketPlayerAuctionTransfer(): void;
+declare var SlaveMarketBackground: string;
+/** @type {null | NPCCharacter} */
+declare var SlaveMarketMistress: null | NPCCharacter;
+/** @type {null | NPCCharacter} */
+declare var SlaveMarketSlave: null | NPCCharacter;
+/** @type {null | NPCCharacter} */
+declare var SlaveMarketSlaveToTrain: null | NPCCharacter;
+declare var SlaveMarketTrainingBackgroundList: string[];
+/** @type {null | NPCCharacter} */
+declare var SlaveMarketBuyer: null | NPCCharacter;