bc-stubs 104.0.2 → 105.0.0

package/bc/Female3DCG_Types.d.ts

@@ -435,9 +435,13 @@ interface AssetCommonPropertiesAssetLayer {
 
 /** Input interface for constructing {@link Asset} objects. */
 interface AssetDefinitionBase extends AssetCommonPropertiesGroupAsset, AssetCommonPropertiesAssetLayer, AssetCommonPropertiesGroupAssetLayer {
+
 	/** The asset's internal name. */
 	Name: string,
 
+	/** The asset's InventoryID to be synced with the server and other players */
+	InventoryID?: number,
+
 	/**
 	 * The group name and asset name of a configuration to copy.
 	 * Useful if multiple items share the same config.
@@ -543,7 +547,7 @@ interface AssetDefinitionBase extends AssetCommonPropertiesGroupAsset, AssetComm
 	 * A value of -1 makes the asset unavailable, a value of 0 makes it always available.
 	 */
 	Value?: number;
-
+	
 	/**
 	 * Whether an item should never be able to be sold.
 	 *

package/bc/Messages.d.ts

@@ -42,15 +42,16 @@ interface ServerAccountData extends ServerAccountImmutableData {
 	LabelColor?: string;
 	Appearance?: ServerAppearanceBundle;
 	Description?: string;
-	BlockItems?: ItemPermissionsPacked | ItemPermissions[];
-	LimitedItems?: ItemPermissionsPacked | ItemPermissions[];
-	FavoriteItems?: ItemPermissionsPacked | ItemPermissions[];
-	HiddenItems?: ItemPermissions[];
+	BlockItems?: ServerItemPermissionsPacked | ServerItemPermissions[];
+	LimitedItems?: ServerItemPermissionsPacked | ServerItemPermissions[];
+	FavoriteItems?: ServerItemPermissionsPacked | ServerItemPermissions[];
+	HiddenItems?: ServerItemPermissions[];
 	Title?: TitleName;
 	Nickname?: string;
 	Crafting?: string;
 	/** String-based values have been deprecated as of BondageProjects/Bondage-College#2138 */
 	Inventory?: string | Partial<Record<AssetGroupName, string[]>>;
+	InventoryData?: string;
 	AssetFamily?: "Female3DCG";
 	Infiltration?: InfiltrationType;
 	SavedColors?: HSVColor[];
@@ -128,12 +129,31 @@ type ServerAccountDataNoDeprecated = ServerAccountData & { [k in ServerAccountDa
 	Inventory?: Partial<Record<AssetGroupName, string[]>>;
 };
 
+/**
+ * A struct for representing an item with special permissions (limited, favorited, etc) in the server.
+ * @see {@link ServerItemPermissionsPacked}
+ */
+interface ServerItemPermissions {
+	/** The {@link Asset.Name} of the item */
+	Name: string;
+	/** The {@link AssetGroup.Name} of the item */
+	Group: AssetGroupName;
+	/**
+	 * Either the item's {@link ItemProperties.Type} or, in the case of modular items,
+	 * a substring thereof denoting the type of a single module
+	 */
+	Type?: string | null;
+}
+
+/** A packed record-based version of {@link ServerItemPermissions}. */
+type ServerItemPermissionsPacked = Partial<Record<AssetGroupName, Record<string, (undefined | null | string)[]>>>;
+
 interface ServerMapDataResponse {
 	MemberNumber: number;
 	MapData: ChatRoomMapPos;
 }
 
-type ServerAccountDataSynced = Omit<ServerAccountData, "Money" | "FriendList">;
+type ServerAccountDataSynced = Omit<ServerAccountData, "Money" | "FriendList" | "AccountName">;
 
 interface ServerOwnership {
 	MemberNumber?: number;

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

@@ -87,11 +87,6 @@ declare function LoginCheatItems(): void;
  * @returns {void} Nothing
  */
 declare function LoginValideBuyGroups(): void;
-/**
- * Checks if the player arrays contains any item that does not exists and saves them.
- * @returns {void} Nothing
- */
-declare function LoginValidateArrays(): void;
 /**
  * Makes sure the difficulty restrictions are applied to the player
  * @param {boolean} applyDefaults - If changing to the difficulty, set this to True to set LimitedItems to the default settings
@@ -105,9 +100,14 @@ declare function LoginDifficulty(applyDefaults: boolean): void;
  * @returns {void} Nothing
  */
 declare function LoginExtremeItemSettings(applyDefaults: boolean): void;
+/**
+ * Since InventoryData wasn't found (R104 and before), we load the inventory object directly
+ * @param {object} InventoryObject - The inventory object from the server
+ */
+declare function LoginLoadInventoryObject(InventoryObject: object): {};
 /**
  * Handles server response, when login has been queued
- * @param {number} Pos The position in queue
+ * @param {number} Pos - The position in queue
  */
 declare function LoginQueue(Pos: number): void;
 /**

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

@@ -380,10 +380,11 @@ declare function PreferenceVisibilityHideChange(): void;
 declare function PreferenceVisibilityBlockChange(): void;
 /**
  * Adds or removes the current item to/from the list based on the new state of the corresponding checkbox
- * @param {ItemBundle[]} List - The list to add or remove the item from
+ * @param {Partial<Record<`${AssetGroupName}/${string}`, ItemPermissions>>} permissionRecord - The record to add or remove the item from
  * @param {boolean} CheckSetting - The new true/false setting of the checkbox
+ * @param {"Hidden" | "Block"} Type
  */
-declare function PreferenceVisibilityCheckboxChanged(List: ItemBundle[], CheckSetting: boolean): void;
+declare function PreferenceVisibilityCheckboxChanged(permissionRecord: Partial<Record<`${AssetGroupName}/${string}`, ItemPermissions>>, CheckSetting: boolean, Type: "Hidden" | "Block"): void;
 /**
  * Saves changes to the settings, disposes of large lists & exits the visibility preference screen.
  * @param {boolean} SaveChanges - If TRUE, update HiddenItems and BlockItems for the account
@@ -573,6 +574,11 @@ declare function PreferenceSubscreenExtensionsClear(): void;
  * @returns {void} - Nothing
  */
 declare function PreferenceValidateArousalData(C: Character): void;
+/**
+ * Return a new object with default item permissions
+ * @returns {ItemPermissions} - The item permissions
+ */
+declare function PreferencePermissionGetDefault(): ItemPermissions;
 declare var PreferenceBackground: string;
 declare var PreferenceMessage: string;
 declare var PreferenceSafewordConfirm: boolean;
@@ -640,7 +646,16 @@ declare var PreferenceArousalFetishList: null | FetishName[];
 declare var PreferenceArousalFetishIndex: number;
 /** @type {ArousalFactor} */
 declare var PreferenceArousalFetishFactor: ArousalFactor;
-declare var PreferenceVisibilityGroupList: any[];
+/** @type {{ Group: AssetGroup, Assets: { Asset: Asset, Hidden: boolean, Blocked: boolean, Limited: boolean }[] }[]} */
+declare var PreferenceVisibilityGroupList: {
+    Group: AssetGroup;
+    Assets: {
+        Asset: Asset;
+        Hidden: boolean;
+        Blocked: boolean;
+        Limited: boolean;
+    }[];
+}[];
 declare var PreferenceVisibilityGroupIndex: number;
 declare var PreferenceVisibilityAssetIndex: number;
 declare var PreferenceVisibilityHideChecked: boolean;
@@ -648,10 +663,8 @@ declare var PreferenceVisibilityBlockChecked: boolean;
 declare var PreferenceVisibilityCanBlock: boolean;
 /** @type {null | Asset} */
 declare var PreferenceVisibilityPreviewAsset: null | Asset;
-/** @type {ItemPermissions[]} */
-declare var PreferenceVisibilityHiddenList: ItemPermissions[];
-/** @type {ItemPermissions[]} */
-declare var PreferenceVisibilityBlockList: ItemPermissions[];
+/** @type {Partial<Record<`${AssetGroupName}/${string}`, ItemPermissions>>} */
+declare var PreferenceVisibilityRecord: Partial<Record<`${AssetGroupName}/${string}`, ItemPermissions>>;
 declare var PreferenceVisibilityResetClicked: boolean;
 /** @type {null | number} */
 declare var PreferenceDifficultyLevel: null | number;

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

@@ -52,6 +52,13 @@ declare function ClubCardIsLiability(Card: ClubCard): boolean;
  * @returns {ClubCardPlayer} - The opponent
  */
 declare function ClubCardGetOpponent(CCPlayer?: ClubCardPlayer | null): ClubCardPlayer;
+/**
+ * Gets the opponent of the parameter player or the player that's not on it's turn if null
+ * @param {ClubCardPlayer} CCPlayer - The club card player or null
+ * @param {Number} turnCounter
+ * @returns {ClubCard[]} - The opponent
+ */
+declare function ClubCardGetCardsPlayedOnTurn(CCPlayer: ClubCardPlayer, turnCounter: number): ClubCard[];
 /**
  * Adds money to the club card player stats
  * @param {ClubCardPlayer} CCPlayer - The club card player
@@ -68,10 +75,10 @@ declare function ClubCardPlayerAddMoney(CCPlayer: ClubCardPlayer, Amount: number
 declare function ClubCardPlayerAddFame(CCPlayer: ClubCardPlayer, Amount: number): void;
 /**
  * Raises the level of player
- * @param {Object} CCPlayer - The club card player
+ * @param {ClubCardPlayer} CCPlayer - The club card player
  * @returns {void} - Nothing
  */
-declare function ClubCardUpgradeLevel(CCPlayer: any): void;
+declare function ClubCardUpgradeLevel(CCPlayer: ClubCardPlayer): void;
 /**
  * Returns TRUE if a card (by name) is currently present on a board
  * @param {ClubCardPlayer} CCPlayer - The club card player
@@ -93,6 +100,12 @@ declare function ClubCardNameIsOnBoard(CCPlayer: ClubCardPlayer, CardName: strin
  * @returns {boolean} - TRUE if at least one card from that group is present
  */
 declare function ClubCardGroupIsOnBoard(CCPlayer: ClubCardPlayer, GroupName: string): boolean;
+/**
+ * @param {ClubCard} card to evaluate group
+ * @param {string} GroupName group name to find
+ * @returns {boolean} - True if the card has the group
+ */
+declare function ClubCardCardHasGroup(card: ClubCard, GroupName: string): boolean;
 /**
  * Returns the number of cards of a specific group found on a board
  * @param {ClubCardPlayer} CCPlayer - The club card player
@@ -107,6 +120,20 @@ declare function ClubCardGroupOnBoardCount(CCPlayer: ClubCardPlayer, GroupName:
  * @returns {void} - Nothing
  */
 declare function ClubCardRemoveFromBoard(CCPlayer: ClubCardPlayer, Card: ClubCard): void;
+/**
+ * Gets the max effect a card should have depending on its "tier"/required level to play
+ * @param {ClubCard} Card
+ * @param {number} fame
+ * @returns {number} max effect card should have
+ */
+declare function ClubCardGetMaxEffectFromCard(Card: ClubCard, fame: number): number;
+/**
+ * Adds a card to a players hand
+ * @param {ClubCardPlayer} CCPlayer - The club card player
+ * @param {ClubCard} Card - The card object to add
+ * @returns {void} - Nothing
+ */
+declare function ClubCardAddToHand(CCPlayer: ClubCardPlayer, Card: ClubCard): void;
 /**
  * Removes several cards from player time events
  * @param {ClubCardPlayer} CCPlayer - The club card player
@@ -147,6 +174,27 @@ declare function ClubCardSetGlow(Card: ClubCard, Color: string): void;
  * @returns {void} - Nothing
  */
 declare function ClubCardPlayerDrawCard(CCPlayer: ClubCardPlayer, Amount?: number | null): void;
+/**
+ * Draw cards from the player deck into it's hand
+ * @param {ClubCardPlayer} CCPlayer - The club card player that draws the cards
+ * @param {string} group - The group to draw from
+ * @returns {boolean} - if cards were drawn or not
+ */
+declare function ClubCardPlayerDrawGroupCard(CCPlayer: ClubCardPlayer, group: string): boolean;
+/**
+ *
+ * @param {ClubCardPlayer} CCPlayer - The club card player that draws the cards
+ * @returns {void} - Nothing
+ *
+ */
+declare function ClubCardCheckDetectiveDraw(CCPlayer: ClubCardPlayer): void;
+/**
+ * Common place to handle Alvins effect on kidnapping and Restrain
+ * @param {ClubCardPlayer} CCPlayer
+ * @returns {void} - Nothing
+ *
+ */
+declare function ClubCardAlvinCondition(CCPlayer: ClubCardPlayer): void;
 /**
  * Removes cards from a player hand
  * @param {ClubCardPlayer} CCPlayer - The club card player that discards
@@ -388,7 +436,8 @@ declare var ClubCardTurnCardPlayed: number;
 declare var ClubCardTurnEndDraw: boolean;
 declare var ClubCardFameGoal: number;
 declare var ClubCardPopup: any;
-declare var ClubCardSelection: any;
+/** @type {ClubCard} */
+declare var ClubCardSelection: ClubCard;
 declare var ClubCardPending: any;
 declare var ClubCardLevelLimit: number[];
 declare var ClubCardLevelCost: number[];

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

@@ -303,9 +303,9 @@ declare function DialogCanCallMaidsPunishmentOn(): boolean;
 declare function DialogCanCallMaidsPunishmentOff(): boolean;
 /**
  * Creates the chat room input elements.
- * @returns {void} - Nothing.
+ * @returns {HTMLDivElement}
  */
-declare function ChatRoomCreateElement(): void;
+declare function ChatRoomCreateElement(): HTMLDivElement;
 /** Hide the UI elements of the chatroom screen */
 declare function ChatRoomShowElements(): void;
 /** Show the UI elements of the chatroom screen */
@@ -414,10 +414,6 @@ declare function ChatRoomSetLastChatRoom(room: ChatRoom | null): void;
  * @returns {void} - Nothing.
  */
 declare function ChatRoomStimulationMessage(Action: StimulationAction): void;
-/**
- * Called when screen size or position changes or after screen load
- * @param {boolean} load - If the reason for call was load (`true`) or window resize (`false`)
- */
 declare function ChatRoomResize(load: boolean): void;
 /**
  * Draws arousal screen filter
@@ -473,9 +469,10 @@ declare function ChatRoomStatusUpdate(Status: string | null): void;
 declare function ChatRoomStatusUpdateTalk(Key: KeyboardEvent): void;
 /**
  * Handler called when the chat input field changes
+ * @this {HTMLTextAreaElement}
  * @param {Event} event
  */
-declare function ChatRoomChatInputChangeHandler(event: Event): void;
+declare function ChatRoomChatInputChangeHandler(this: HTMLTextAreaElement, event: Event): void;
 /**
  * Checks if status has expired or is otherwise no longer valid and resets status if so
  * @returns {void} - Nothing.
@@ -491,11 +488,7 @@ declare function ChatRoomCustomizationClear(): void;
  * @returns {void} - Nothing.
  */
 declare function ChatRoomCustomizationRun(): void;
-/**
- * Runs the chatroom screen.
- * @returns {void} - Nothing.
- */
-declare function ChatRoomRun(): void;
+declare function ChatRoomRun(time: number): void;
 /**
  * Runs the arousal overlay.
  * @returns {boolean} - Returns true if the orgasm overlay is active and false otherwise.
@@ -529,17 +522,7 @@ declare function ChatRoomMouseUp(event: MouseEvent | TouchEvent): void;
  * @returns {void} - Nothing
  */
 declare function ChatRoomMouseMove(event: MouseEvent | TouchEvent): void;
-/**
- * Redirects the Mouse Wheel event to the map if needed
- * @param {MouseEvent | TouchEvent} event
- * @returns {void} - Nothing
- */
-declare function ChatRoomMouseWheel(event: MouseEvent | TouchEvent): void;
-/**
- * Handles clicks the chatroom screen.
- * @param {MouseEvent | TouchEvent} event
- * @returns {void} - Nothing.
- */
+declare function ChatRoomMouseWheel(event: WheelEvent): void;
 declare function ChatRoomClick(event: MouseEvent | TouchEvent): void;
 /**
  * The handler for the "Kneel" top menu button
@@ -557,11 +540,7 @@ declare function ChatRoomOpenInformationScreen(): void;
  * The handler for the "Admin" button
  */
 declare function ChatRoomOpenAdminScreen(): void;
-/**
- * Process chat room menu button clicks
- * @returns {void} - Nothing
- */
-declare function ChatRoomMenuClick(): void;
+declare function ChatRoomMenuClick(event: MouseEvent | TouchEvent): void;
 declare function ChatRoomAttemptStandMinigameEnd(): void;
 /**
  * Checks if the player can leave the chatroom.
@@ -837,6 +816,10 @@ declare function ChatRoomMessageRunHandlers(type: "pre" | "post", data: ServerCh
  * @returns {void} - Nothing.
  */
 declare function ChatRoomMessage(data: ServerChatRoomMessage): void;
+/**
+ * @this {HTMLButtonElement}
+ */
+declare function ChatRoomMessageNameClick(this: HTMLButtonElement): void;
 /**
  * Update the Chat log with the recieved message
  *
@@ -844,9 +827,9 @@ declare function ChatRoomMessage(data: ServerChatRoomMessage): void;
  * @param {string} msg
  * @param {Character} SenderCharacter
  * @param {IChatRoomMessageMetadata} metadata
- * @returns {void}
+ * @returns {HTMLDivElement}
  */
-declare function ChatRoomMessageDisplay(data: ServerChatRoomMessage, msg: string, SenderCharacter: Character, metadata: IChatRoomMessageMetadata): void;
+declare function ChatRoomMessageDisplay(data: ServerChatRoomMessage, msg: string, SenderCharacter: Character, metadata: IChatRoomMessageMetadata): HTMLDivElement;
 /**
  * Whether to replace message details which reveal information about an unseen/unheard character
  * @param {Character} C - The character whose identity should remain unknown
@@ -1028,12 +1011,6 @@ declare function ChatRoomAdminChatAction(ActionType: "Ban" | "Unban" | "Kick" |
  * @returns {string} - The player's current local time as a string.
  */
 declare function ChatRoomCurrentTime(): string;
-/**
- * Gets a transparent version of the specified hex color.
- * @param {HexColor} Color - Hex color code.
- * @returns {string} - A transparent version of the specified hex color in the rgba format.
- */
-declare function ChatRoomGetTransparentColor(Color: HexColor): string;
 /**
  * Adds or removes an online member to/from a specific list. (From the dialog menu)
  * @param {"Add" | "Remove"} Operation - Operation to perform.
@@ -1364,19 +1341,24 @@ declare var ChatRoomSlowtimer: number;
 declare var ChatRoomSlowStop: boolean;
 /**
  * Default position of the chat log field
- * @type {RectTuple}
+ * @deprecated - superseded by and incorporated into {@link ChatRoomDivRect}
  */
-declare var ChatRoomChatLogRect: RectTuple;
+declare var ChatRoomChatLogRect: never;
 /**
  * Default position of the chat input field
- * @type {RectTuple}
+ * @deprecated - superseded by and incorporated into {@link ChatRoomDivRect}
  */
-declare var ChatRoomChatInputRect: RectTuple;
+declare var ChatRoomChatInputRect: never;
 /**
  * Default position of the chat input length label
+ * @deprecated - superseded by and incorporated into {@link ChatRoomDivRect}
+ */
+declare var ChatRoomChatLengthLabelRect: never;
+/**
+ * Default position of the entire chat panel
  * @type {RectTuple}
  */
-declare var ChatRoomChatLengthLabelRect: RectTuple;
+declare var ChatRoomDivRect: RectTuple;
 declare var ChatRoomChatHidden: boolean;
 /**
  * The chatroom characters that were drawn in the last frame.
@@ -1512,7 +1494,19 @@ declare namespace ChatRoomResizeManager {
     function ChatRoomResizeEvent(): void;
     function ChatRoomResizeEventsEnd(): void;
 }
-declare const ChatRoomUIElementNames: string[];
+declare namespace ChatRoomSep {
+    let ActiveElem: null | HTMLDivElement;
+    let _ClickCollapse: (this: HTMLButtonElement, event: MouseEvent | TouchEvent) => Promise<void>;
+    let _ClickScrollUp: (this: HTMLButtonElement, event: MouseEvent | TouchEvent) => Promise<void>;
+    function _GetDisplayName(button: HTMLButtonElement): string;
+    function Create(appendChat?: boolean): HTMLDivElement;
+    function GetDisplayName(roomSep: HTMLDivElement): string;
+    function IsCollapsed(roomSep: HTMLDivElement): boolean;
+    function Uncollapse(roomSep: HTMLDivElement): Promise<void>;
+    function Collapse(roomSep: HTMLDivElement): Promise<void>;
+    function SetRoomData(roomSep: HTMLDivElement, data: Pick<ServerChatRoomData, "Name" | "Private" | "Space">): Promise<void>;
+    function UpdateDisplayNames(): Promise<void>;
+}
 declare let ChatRoomStatusDeadKeys: string[];
 /** When slowed, we can't leave quicker than this */
 declare const ChatRoomSlowLeaveMinTime: 5000;

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

@@ -41,7 +41,7 @@ declare function ChatRoomMapViewDeactivate(): void;
  * @returns {boolean} - TRUE if the chat room character view is active, false if not
  */
 declare function ChatRoomMapViewIsActive(): boolean;
-declare function ChatRoomMapViewRun(): void;
+declare function ChatRoomMapViewRun(time: number): void;
 /**
  * Alter the received message to what will be displayed in the chat log
  *
@@ -319,11 +319,7 @@ declare function ChatRoomMapViewMouseMove(): void;
  * @returns {void} - Nothing
  */
 declare function ChatRoomMapViewMouseUp(): void;
-/**
- * Mouse wheel event is used to zoom the map
- * @returns {void} - Nothing
- */
-declare function ChatRoomMapViewMouseWheel(Event: any): void;
+declare function ChatRoomMapViewMouseWheel(event: WheelEvent): void;
 /**
  * Copies the current map in the clipboard.  Called from the chat field command "mapcopy"
  * @returns {void} - Nothing

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

@@ -28,8 +28,8 @@ declare function CommandCombine(add: ICommand | ICommand[]): void;
 /**
  * Parse the input chat message
  * @param {string} msg - Input string, cannot be empty
- * @returns {string|boolean} a de-escaped string if msg looks like an escaped
- *   command, true if a command successfully executed, false otherwise.
+ * @returns {string | boolean} a (de-escaped) string if msg looks like an normal message,
+ * true if a command successfully executed, false otherwise.
  */
 declare function CommandParse(msg: string): string | boolean;
 /**

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

@@ -218,7 +218,14 @@ declare var ChatSearchResult: (ServerChatRoomSearchData & {
 })[];
 /** @type {typeof ChatSearchResult} */
 declare var ChatSearchHiddenResult: typeof ChatSearchResult;
-declare var ChatSearchLastSearchDataJSON: string;
+/** @type {null | { Query: string, Language: "" | ServerChatRoomLanguage, Space: ServerChatRoomSpace, Game: ServerChatRoomGame, FullRooms: boolean }} */
+declare var ChatSearchLastSearchDataJSON: null | {
+    Query: string;
+    Language: "" | ServerChatRoomLanguage;
+    Space: ServerChatRoomSpace;
+    Game: ServerChatRoomGame;
+    FullRooms: boolean;
+};
 declare var ChatSearchLastQuerySearchTime: number;
 declare var ChatSearchLastQueryJoin: string;
 declare var ChatSearchLastQueryJoinTime: number;

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

@@ -40,6 +40,11 @@ declare function CraftingResize(load: boolean): void;
  * @returns {void}
  */
 declare function CraftingUpdateFromItem(item: Item): void;
+/**
+ * Return a list of all searchable asset names.
+ * @returns {string[]}
+ */
+declare function CraftingGetAllAssetNames(): string[];
 /**
  * Sets the new mode and creates or removes the inputs
  * @param {CraftingMode} NewMode - The new mode to set