bc-stubs 105.0.3 → 106.0.0

package/bc/Screens/Character/Login/Login.d.ts

@@ -108,8 +108,14 @@ declare function LoginLoadInventoryObject(InventoryObject: object): {};
 /**
  * Handles server response, when login has been queued
  * @param {number} Pos - The position in queue
+ * @returns {void} Nothing
  */
 declare function LoginQueue(Pos: number): void;
+/**
+ * Fixes the Owner property on the player object if it's wrongly set
+ * @returns {void} Nothing
+ */
+declare function LoginFixOwner(): void;
 /**
  * Handles player login response data
  * @param {ServerLoginResponse} C - The Login response data - this will either be the player's character data if the

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

@@ -47,7 +47,7 @@ declare function ChatRoomCharacterViewShowMapButton(): boolean;
  * @param {number} ClickY Click Y postion relative to character, without zoom
  * @param {number} Pos Index of target character
  */
-declare function ChatRoomCharacterViewClickCharacter(C: Character, CharX: number, CharY: number, Zoom: number, ClickX: number, ClickY: number, Pos: number): void;
+declare function ChatRoomCharacterViewClickCharacter(C: Character, CharX: number, CharY: number, Zoom: number, ClickX: number, ClickY: number): void;
 /**
  * Draws the chatroom characters.
  * @returns {void} - Nothing.

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

@@ -223,6 +223,21 @@ declare function KidnapLeagueRandomClubCardStart(): void;
  * @returns {void} - Nothing
  */
 declare function KidnapLeagueRandomClubCardEnd(): void;
+/**
+ * Returns TRUE if the player can get the anime girl costume
+ * @returns {boolean} - TRUE if it's possible
+ */
+declare function KidnapLeagueCanGetAnimeGirl(): boolean;
+/**
+ * Gives the anime girl costume to the player and wear it
+ * @returns {void} - Nothing
+ */
+declare function KidnapLeagueWearAnimeGirl(): void;
+/**
+ * Returns TRUE if the player is wearing the anime girl costume
+ * @returns {boolean} - TRUE if wearing
+ */
+declare function KidnapLeaguePlayerIsAnimeGirl(): boolean;
 declare var KidnapLeagueBackground: string;
 /** @type {null | NPCCharacter} */
 declare var KidnapLeagueTrainer: null | NPCCharacter;
@@ -230,8 +245,8 @@ declare var KidnapLeagueTrainer: null | NPCCharacter;
 declare var KidnapLeagueRandomKidnapper: null | NPCCharacter;
 declare var KidnapLeagueRandomKidnapperScenario: string;
 declare var KidnapLeagueRandomKidnapperDifficulty: number;
-/** @type {null | "" | "Maid" | "Mistress"} */
-declare var KidnapLeagueArchetype: null | "" | "Maid" | "Mistress";
+/** @type {null | "" | "Maid" | "Mistress" | "AnimeGirl"} */
+declare var KidnapLeagueArchetype: null | "" | "Maid" | "Mistress" | "AnimeGirl";
 declare var KidnapLeagueWillPayForFreedom: boolean;
 declare var KidnapLeagueRandomActivityList: string[];
 declare var KidnapLeagueRandomActivity: string;

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

@@ -209,6 +209,16 @@ declare function ManagementCannotBreakUpLoverNPC(L: number): boolean;
  * @returns {boolean} - TRUE if the player is a club slave.
  */
 declare function ManagementIsClubSlave(): boolean;
+/**
+ * Checks if the player can start a regular chat with a club slave.
+ * @returns {boolean} - TRUE if the player can start a regular
+ */
+declare function ManagementCanStartClubSlaveTalk(): boolean;
+/**
+ * Checks if the player can start a chat with a bunny club slave.
+ * @returns {boolean} - TRUE if the player can start a regular
+ */
+declare function ManagementCanStartBunnyTalk(): boolean;
 /**
  * Checks if the player is wearing a slave collar.
  * @returns {boolean} - TRUE if the player is wearing a slave collar.

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

@@ -52,7 +52,7 @@ declare function PrisonSubClothBack(): void;
 declare function PrisonBecomeBadGirl(): void;
 declare function PrisonLeaveBadGirl(): void;
 declare function PrisonWearPoliceEquipment(C: any): void;
-declare function PrisonWantedPlayer(): 1 | 4 | 7 | 9;
+declare function PrisonWantedPlayer(): 1 | 3 | 5 | 7;
 declare function PrisonMeetPoliceIntro(RoomBackground: any): void;
 declare function PrisonPutHandsInTheAir(): void;
 declare function PrisonRaiseHandsHigher(): void;

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

@@ -403,6 +403,22 @@ declare function PrivateCanTryforAction(): boolean;
  * @returns {boolean} - True if Player can not ask and the friend can not interact
  */
 declare function PrivateCannotTryforAction(): boolean;
+/**
+ * Returns TRUE if the current character is an anime girl / superheroine
+ * @returns {boolean} - TRUE if archetype is AnimeGirl
+ */
+declare function PrivateIsAnimeGirl(): boolean;
+/**
+ * Returns TRUE if the current character is a rope bunny
+ * @returns {boolean} - TRUE if archetype is Bunny
+ */
+declare function PrivateIsBunny(): boolean;
+/**
+ * Returns a random item that could be bought from the store as a gift that the player could receive by a NPC
+ * @param {boolean} Restraint - TRUE if we must return an item that's a restraint
+ * @returns {Asset} - The item asset that can be given
+ */
+declare function PrivateGetPossibleGift(Restraint: boolean): Asset;
 /**
  * Loads the private room screen and the vendor NPC.
  * @returns {void} - Nothing.
@@ -698,7 +714,7 @@ declare function PrivateGetBed(Type: "White" | "Black" | "Pink"): void;
  * When the player exits the private room
  * @returns {void} - Nothing.
  */
-declare function PrivateExit(Type: any): void;
+declare function PrivateExit(): void;
 /**
  * When the player joins the NPC in bed
  * @returns {void} - Nothing.
@@ -777,6 +793,72 @@ declare function PrivateClubCardKinkyConsequence(Eyes: ExpressionName, Strip: st
  * Checks if the player owns a private room, there's a spot left and they're not locked out of it.
  */
 declare function PrivateHasEmptySlot(): boolean;
+/**
+ * Resets the possible gifts given by NPCs
+ */
+declare function PrivateGiftReset(): void;
+/**
+ * Gives the NPC gift to the player, a new gift will come between 1 and 6 days
+ * @param {string} GiftType - Regular or Restraint
+ * @returns {void} - Nothing.
+ */
+declare function PrivateGiftGet(GiftType: string): void;
+/**
+ * Uses the NPC gift on the player
+ * @param {string} GiftType - Regular or Restraint
+ * @returns {void} - Nothing.
+ */
+declare function PrivateGiftUse(GiftType: string): void;
+/**
+ * When the player meets her owner randomly in the main hall
+ * @returns {void} - Nothing.
+ */
+declare function PrivateOwnerInMainHall(): void;
+/**
+ * The owner can ungag the player and it can affect the love factor
+ * @param {number} LoveFactor - Amount of love to gain or lose.
+ * @returns {void} - Nothing.
+ */
+declare function PrivatePlayerUngag(LoveFactor: number): void;
+/**
+ * The owner can do some activities with the player from the main hall
+ * @returns {void} - Nothing.
+ */
+declare function PrivateStartOwnerHallActivity(): void;
+/**
+ * Owner in Main Hall - When the player returns to her private room with her owner
+ * @returns {void} - Nothing.
+ */
+declare function PrivateOwnerHallReturnToPrivate(): void;
+/**
+ * Owner in Main Hall - Restrains the player with a factor
+ * @param {"FEW"|"LOT"|"ALL"} BondageType - The type of bondage to apply
+ * @returns {void} - Nothing.
+ */
+declare function PrivateOwnerHallBondage(BondageType: "FEW" | "LOT" | "ALL"): void;
+/**
+ * Owner in Main Hall - Strips the player
+ * @returns {void} - Nothing.
+ */
+declare function PrivateOwnerHallNaked(): void;
+/**
+ * Owner in Main Hall - Change collar and leash the player
+ * @returns {void} - Nothing.
+ */
+declare function PrivateOwnerHallLeash(): void;
+/**
+ * Owner in Main Hall - Changes the background and can bind/gag the player
+ * @param {string} Background - The new background to setup
+ * @param {string} Action - The action to perform
+ * @returns {void} - Nothing.
+ */
+declare function PrivateOwnerHallBackground(Background: string, Action: string): void;
+/**
+ * Owner in Main Hall - Ends the parade and can do an extra action
+ * @param {string} Action - The action to perform
+ * @returns {void} - Nothing.
+ */
+declare function PrivateOwnerHallParadeEnd(Action: string): void;
 declare var PrivateBackground: string;
 /** @type {null | NPCCharacter} */
 declare var PrivateVendor: null | NPCCharacter;
@@ -804,3 +886,6 @@ declare var PrivateBeltList: string[];
 declare var PrivateEntryEvent: boolean;
 declare var PrivateClubCardVictoryMode: boolean;
 declare var PrivateClubCardDefeatConsequence: string[];
+declare var PrivateGiftRegular: any;
+declare var PrivateGiftRestraint: any;
+declare var PrivateBaseDecay: number;

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

@@ -57,7 +57,7 @@ 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;
+declare function PrivateBedExit(): void;
 /**
  * When a character gets an orgasm
  * @param {Character} C - The character getting the orgasm.

package/bc/Scripts/Character.d.ts

@@ -35,11 +35,11 @@ declare function CharacterLoadCSVDialog(C: Character, info?: DialogInfo): void;
 /**
  * Sets the clothes based on a character archetype
  * @param {Character} C - Character to set the clothes for
- * @param {"Maid" | "Mistress" | "Employee"} Archetype - Archetype to determine the clothes to put on
+ * @param {"Maid" | "Mistress" | "Employee" | "AnimeGirl" | "Bunny"} Archetype - Archetype to determine the clothes to put on
  * @param {string} [ForceColor] - Color to use for the added clothes
  * @returns {void} - Nothing
  */
-declare function CharacterArchetypeClothes(C: Character, Archetype: "Maid" | "Mistress" | "Employee", ForceColor?: string): void;
+declare function CharacterArchetypeClothes(C: Character, Archetype: "Maid" | "Mistress" | "Employee" | "AnimeGirl" | "Bunny", ForceColor?: string): void;
 /**
  * Loads an NPC into the character array. The appearance is randomized, and a type can be provided to dress them in a given style.
  * @param {string} CharacterID - The unique identifier for the NPC
@@ -170,9 +170,10 @@ declare function CharacterIsInUnderwear(C: Character): boolean;
 /**
  * Removes all appearance items from the character
  * @param {Character} C - Character to undress
+ * @param {boolean} refresh - Whether to refresh the character afterwards and push changes to the server database
  * @returns {void} - Nothing
  */
-declare function CharacterNaked(C: Character): void;
+declare function CharacterNaked(C: Character, refresh?: boolean): void;
 /**
  * Dresses the given character in random underwear
  * @param {Character} C - Character to randomly dress
@@ -216,9 +217,10 @@ declare function CharacterReleaseNoLock(C: Character): void;
 /**
  * Removes all items except for clothing and slave collars from the character
  * @param {Character} C - Character to release
+ * @param {boolean} refresh - Whether to refresh the character afterwards and push changes to the server database
  * @returns {void} - Nothing
  */
-declare function CharacterReleaseTotal(C: Character): void;
+declare function CharacterReleaseTotal(C: Character, refresh?: boolean): void;
 /**
  * Gets the bonus amount of a given type for a given character (Kidnap league)
  * @param {Character} C - Character for which we want to get the bonus amount

package/bc/Scripts/Dialog.d.ts

@@ -1010,7 +1010,7 @@ declare namespace DialogLeaveFocusItemHandlers {
 declare namespace DialogEffectIcons {
     let Table: Partial<Record<InventoryIcon, readonly EffectName[]>>;
     function GetIcons(item: Item): InventoryIcon[];
-    let GetEffectIcons: (effects: EffectName[], prop?: CraftingPropertyType) => null | InventoryIcon[];
+    let GetEffectIcons: (effects: Iterable<EffectName>, prop?: CraftingPropertyType) => null | InventoryIcon[];
     function _GetGagIcon(effect: EffectName, prop?: CraftingPropertyType): null | InventoryIcon;
     function _GetBlindIcon(effect: EffectName, prop?: CraftingPropertyType): null | InventoryIcon;
     function _GetDeafIcon(effect: EffectName): undefined | InventoryIcon;

package/bc/Scripts/Element.d.ts

@@ -14,10 +14,10 @@ declare function ElementValue(ID: string, Value?: string): string;
 declare function ElementContent(ID: string, Content?: string): string;
 /**
  * @template {keyof HTMLElementScalarTagNameMap} T
- * @param {null | HTMLOptions<T>} options - Options for customizing the element
+ * @param {HTMLOptions<T>} options - Options for customizing the element
  * @returns {HTMLElementTagNameMap[T]} - The created element
  */
-declare function ElementCreate<T extends keyof HTMLElementScalarTagNameMap>(options: null | HTMLOptions<T>): HTMLElementTagNameMap[T];
+declare function ElementCreate<T extends keyof HTMLElementScalarTagNameMap>(options: HTMLOptions<T>): HTMLElementTagNameMap[T];
 /**
  * Creates a new from element in the main document.
  *
@@ -186,7 +186,7 @@ declare function ElementIsScrolledToEnd(ID: string): boolean;
  */
 declare function ElementFocus(ID: string): void;
 /**
- * Toggles HTML elements that were created by a given screen. When toggled off, they are hidden (not removed)
+ * Toggles (non-nested) HTML elements that were created by a given screen. When toggled off, they are hidden (not removed)
  * @param {string} Screen - Screen for which to hide the elements generated
  * @param {boolean} ShouldDisplay - TRUE if we are toggling on the elements, FALSE if we are hiding them.
  */

package/bc/Scripts/NPC.d.ts

@@ -86,7 +86,7 @@ declare function NPCLongEventDelay(C: NPCCharacter): number;
  */
 declare function NPCLongLoverEventDelay(C: NPCCharacter): number;
 /**
- * Changes the love factor for a specified NPC, will stay within the -100 to 100 range
+ * Changes the love factor for a specified NPC, will stay within the -100 to 100 range, 60 is max out of a relationship
  * @param {NPCCharacter} C - NPC to change the love factor of
  * @param {number} LoveFactor - Amount to add to the current love factor (can be negative).
  * @returns {void} - Nothing

package/bc/Typedef.d.ts

@@ -102,9 +102,9 @@ type HTMLOptions<T extends keyof HTMLElementTagNameMap> = {
 	/** The elements parent (if any) to which it will be attached (see {@link HTMLElement.parentElement}). */
 	parent?: Node;
 	/** A list of CSS classes to-be assigned to the element (see {@link HTMLElement.classList}). */
-	classList?: readonly string[];
+	classList?: readonly (null | undefined | string)[];
 	/** Any to-be added child elements. */
-	children?: (string | Node | HTMLOptions<keyof HTMLElementTagNameMap>)[];
+	children?: (null | undefined | string | Node | HTMLOptions<keyof HTMLElementTagNameMap>)[];
 	/** The {@link HTMLElement.innerHTML} of the element; will be assigned before appending children */
 	innerHTML?: string;
 };
@@ -453,7 +453,7 @@ type BackgroundTag =
 // NOTE: `NPCArchetype` is for NPC's only
 type TitleName =
 	NPCArchetype | "None" | "Mistress" | "Master" | "Mistree" | "ClubSlave" | "Maid" | "HeadMaid" | "BondageMaid" | "Kidnapper" |
-	"MasterKidnapper" | "Patient" | "PermanentPatient" | "EscapedPatient" | "Nurse" | "Doctor" |
+	"MasterKidnapper" | "Patient" | "PermanentPatient" | "EscapedPatient" | "Nurse" | "Doctor" | "AnimeBoy" |
 	"LadyLuck" | "LordFortune" | "Patron" | "CollegeStudent" |"Nawashi" | "Houdini" | "PonyAlicorn" |
 	"PonyPegasus" | "PonyUnicorn" | "PonyWild" | "PonyHot" | "PonyWarm" | "PonyCold" | "PonyFarm" |
 	"PonyFoal" | "InfilrationMole" | "InfilrationInfiltrator" | "InfilrationAgent" |
@@ -1574,7 +1574,7 @@ type NPCArchetype =
 	/* Pandora Special */
 	"Victim"|"Target"|"Chest"|
 	// Misc
-	"Dominatrix" | "Nurse" | "Submissive" | "Mistress" | "Patient" | "Maid" | "Mistress" | "Maiestas" | "Vincula" | "Amplector" | "Corporis"
+	"Dominatrix" | "Nurse" | "Submissive" | "Mistress" | "Patient" | "Maid" | "Mistress" | "Maiestas" | "Vincula" | "Amplector" | "Corporis" | "AnimeGirl" | "Bunny"
 	;
 
 /** NPC Character extension */
@@ -3620,6 +3620,11 @@ interface CraftingItem {
 	 * @see {@link ItemProperties.TypeRecord}
 	 */
 	TypeRecord?: null | TypeRecord;
+	/**
+	 * Whether the crafting item is elligble for use.
+	 * Only relevant if the player is the craft's owner but do they not own the underlying item (_e.g._ due to an inventory wipe).
+	 */
+	Disabled?: boolean;
 }
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bc-stubs",
-  "version": "105.0.3",
+  "version": "106.0.0",
   "repository": {
     "type": "git",
     "url": "git+ssh://git@github.com/bananarama92/BC-stubs.git"