bc-stubs 106.0.0 → 107.0.0

package/bc/NativeDeclarations/FriendList.d.ts

@@ -0,0 +1,29 @@
+type FriendListModes = FriendListMode[];
+type FriendListMode = "OnlineFriends" | "Beeps" | "AllFriends";
+type FriendListSortingMode = 'None' | 'MemberName' | 'MemberNickname' | 'MemberNumber' | 'ChatRoomName' | 'RelationType';
+type FriendListSortingDirection = 'Asc' | 'Desc';
+
+type FriendListReturn = { Screen: string, Module: ModuleType, IsInChatRoom?: boolean, hasScrolledChat?: boolean };
+
+type FriendRawData = {
+  memberNumber?: number; /* undefined for NPCs */
+  memberName: string;
+  memberNickname?: string;
+  chatRoom?: FriendRawRoom;
+  beep?: FriendRawBeep;
+  relationType?: string;
+  canDelete?: boolean;
+}
+
+type FriendRawRoom = {
+  name?: string;
+  caption: string;
+  canSearchRoom: boolean;
+};
+
+type FriendRawBeep = {
+  beepIndex?: number;
+  caption: string;
+  hasMessage?: boolean;
+  canBeep?: boolean;
+};

package/bc/{Typedef.d.ts → NativeDeclarations/Typedef.d.ts}

@@ -298,7 +298,8 @@ interface ExpressionNameMap {
 	Emoticon: (
 		null | "Afk" | "Whisper" | "Sleep" | "Hearts" | "Tear" | "Hearing" | "Confusion" | "Exclamation" |
 		"Annoyed" | "Read" | "RaisedHand" | "Spectator" | "ThumbsDown" | "ThumbsUp" | "LoveRope" |
-		"LoveGag" | "LoveLock" | "Wardrobe" | "Gaming" | "Coffee" | "Fork" | "Music"
+		"LoveGag" | "LoveLock" | "Wardrobe" | "Gaming" | "Coffee" | "Fork" | "Music" | "Car" | "Hanger" |
+		"Call" | "Lightbulb" | "Warning" | "BrokenHeart" | "Drawing" | "Coding" | "TV" | "Bathing"
 	),
 }
 
@@ -369,6 +370,7 @@ type AssetAttribute =
 	"Skirt" | "SuitLower" | "UpperLarge" |
 	"ShortHair" | "SmallEars" | "NoEars" | "NoseRing" | "HoodieFix" |
 	"CanAttachMittens" |
+	"IsChestHarness" | "IsHipHarness" |
 	"PenisLayer" | "PussyLayer" | "GenitaliaCover" | "Pussy1" | "Pussy2" | "Pussy3" |
 	"CagePlastic2" | "CageTechno" | "CageFlat" |
 	"FuturisticRecolor" | "FuturisticRecolorDisplay" |
@@ -380,9 +382,11 @@ type PosePrerequisite = `Can${AssetPoseName}`;
 type AssetPrerequisite =
 	PosePrerequisite | "AccessBreast" | "AccessBreastSuitZip" | "AccessButt" | "AccessFullPenis" | "AccessMouth" | "AccessTorso" | "AccessVulva" | "AccessCrotch" |
 	"BlockedMouth" | "ButtEmpty" | "CanBeCeilingTethered" | "CanCoverVulva" | "CanHaveErection" | "CanBeLimp" | "CanKneel" | "CannotBeSuited" | "CannotHaveWand" |
+	"CanAttachMittens" |
 	"ClitEmpty" | "Collared" | "CuffedArms" | "CuffedArmsOrEmpty" | "CuffedFeet" | "CuffedFeetOrEmpty" | "CuffedLegs" | "CuffedLegsOrEmpty" |
 	"DisplayFrame" | "EyesEmpty" | "GagCorset" | "GagFlat" | "GagUnique" | "GasMask" | "HasBreasts" | "HasFlatChest" | "HasPenis" | "HasVagina" |
-	"HoodEmpty" | "NakedFeet" | "NakedHands" | "NeedsHarness" | "NeedsNippleRings" | "NoChastityCage" | "NoErection" | "NoClothLower" | "NoItemArms" |
+	"HoodEmpty" | "NakedFeet" | "NakedHands" | "NeedsChestHarness" | "NeedsHipHarness" | "NeedsNippleRings" |
+	"NoChastityCage" | "NoErection" | "NoClothLower" | "NoItemArms" |
 	"NoItemFeet" | "NoItemHands" | "NoItemLegs" | "NoMaidTray" | "NoOuterClothes" | "NotChained" | "NotChaste" | "NotKneeling" |
 	"NotLifted" | "NotMasked" | "NotMounted" | "NotProtrudingFromMouth" | "NotSuspended" | "OnBed" |
 	"RemotesAllowed" | "VulvaEmpty"
@@ -1481,6 +1485,7 @@ interface Character {
 	IsAssFull: () => boolean;
 	IsFixedHead: () => boolean;
 	GetDeafLevel: () => number;
+	CanPickLocks: () => boolean;
 	IsEdged: () => boolean;
 	IsPlayer: () => this is PlayerCharacter;
 	IsBirthday: () => boolean;
@@ -1574,7 +1579,7 @@ type NPCArchetype =
 	/* Pandora Special */
 	"Victim"|"Target"|"Chest"|
 	// Misc
-	"Dominatrix" | "Nurse" | "Submissive" | "Mistress" | "Patient" | "Maid" | "Mistress" | "Maiestas" | "Vincula" | "Amplector" | "Corporis" | "AnimeGirl" | "Bunny"
+	"Dominatrix" | "Nurse" | "Submissive" | "Mistress" | "Patient" | "Maid" | "Mistress" | "Maiestas" | "Vincula" | "Amplector" | "Corporis" | "AnimeGirl" | "Bunny" | "Succubus"
 	;
 
 /** NPC Character extension */
@@ -1897,6 +1902,7 @@ interface PlayerOnlineSettings {
 	ShowStatus?: boolean;
 	EnableAfkTimer: boolean;
 	ShowRoomCustomization: 0 | 1 | 2 | 3; // 0 - Never, 1 - No by default, 2 - Yes by default, 3 - Always
+	FriendListAutoRefresh: boolean;
 }
 
 /** Pandora Player extension */
@@ -4142,6 +4148,7 @@ type ChatRoomMapObjectType = (
 	| "FloorDecorationThemed"
 	| "FloorDecorationParty"
 	| "FloorDecorationCamping"
+	| "FloorDecorationExpanding"
 	| "FloorItem"
 	| "FloorObstacle"
 	| "WallDecoration"
@@ -4172,6 +4179,8 @@ interface ChatRoomMapObject extends ChatRoomMapDoodad {
 	Left?: number;
 	Width?: number;
 	Height?: number;
+	Transparency?: number;
+	TransparencyCutoutHeight?: number;
 	Exit?: boolean;
 	Unique?: boolean;
 	AssetGroup?: AssetGroupItemName;
@@ -4179,6 +4188,7 @@ interface ChatRoomMapObject extends ChatRoomMapDoodad {
 	BlockVision?: boolean;
 	BlockHearing?: boolean;
 	IsVisible?: () => boolean;
+	BuildImageName?: (X: number, Y: number) => string;
 }
 
 interface ChatRoomMapMovement {

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

@@ -1,14 +1,11 @@
-/**
- * Loads the online friend list from the server. This function is called dynamically, when the player invokes the friendlist dialog.
- * @returns {void} - Nothing
- */
 declare function FriendListLoad(): void;
-/**
- * Run the friend list screen - Draw the controls and print the result of the server query to the screen.
- * This function is called dynamically on a regular basis. So don't do complex loops within
- * @returns {void} - Nothing
- */
-declare function FriendListRun(): void;
+declare function FriendListResize(load: boolean): void;
+declare function FriendListRun(time: number): void;
+declare function FriendListDraw(): void;
+declare function FriendListClick(event: MouseEvent | TouchEvent): void;
+declare function FriendListKeyDown(event: KeyboardEvent): boolean;
+declare function FriendListUnload(): void;
+declare function FriendListExit(): void;
 /**
  * Creates beep message menu
  * @param {number} MemberNumber Member number of target player
@@ -28,17 +25,6 @@ declare function FriendListBeepMenuSend(): void;
  * @param {number} i index of the beep
  */
 declare function FriendListShowBeep(i: number): void;
-/**
- * Handles the click events in the friend list. Clicks are propagated to this function from CommonClick()
- * @returns {void} - Nothing
- */
-declare function FriendListClick(): void;
-/**
- * This function is called, when the user exists the friend list. From here we either get back to the InformationSheet
- * or the ChatRoom search, depending on the value of the global variable 'FriendListReturn'
- * @returns {void} - Nothing
- */
-declare function FriendListExit(): void;
 /**
  * Exits the friendlist
  * @param {string} room The room to search for
@@ -54,10 +40,9 @@ declare function FriendListChatSearch(room: string): void;
  *
  * `data.ChatRoomName` - The name of the ChatRoom
  *
- * `data.ChatRoomSpace` - The space, where this room was created. Currently this can be the Asylum or the LARP arena
+ * `data.ChatRoomSpace` - The space, where this room was created.
  *
  * `data.Type` - The relationship that exists between the player and the friend of the list.
- * Currently, only "submissive" is supported
  * @returns {void} - Nothing
  */
 declare function FriendListLoadFriendList(data: ServerFriendInfo[]): void;
@@ -68,21 +53,77 @@ declare function FriendListLoadFriendList(data: ServerFriendInfo[]): void;
  * @returns {void} - Nothing
  */
 declare function FriendListDelete(MemberNumber: number): void;
+/**
+ * Handles mode changes for friend list
+ * @param {number} modeIndex - mode to change to
+ */
+declare function FriendListChangeMode(modeIndex: number): void;
+/**
+ * Sorts the friend list depending on the sorting mode
+ * and the sorting direction. If the sorting mode is none nothing is done.
+ * @param {FriendListSortingMode} sortingMode
+ * @param {FriendListSortingDirection} sortingDirection
+ */
+declare function FriendListSort(sortingMode: FriendListSortingMode, sortingDirection: FriendListSortingDirection): void;
+/**
+ * Sorts the friend list by properties based on the search input.
+ * Searched properties: Name, Nickname (NYI) and MemberNumber
+ * @param {string} text
+ */
+declare function FriendListSearchByProperties(text: string): void;
+/**
+ * Highlights the searched text in the innerHTML
+ * @param {Element} element
+ * @param {string} text
+ * @returns {string} - The innerHTML with the searched text highlighted
+ */
+declare function FriendListHighlightProperty(element: Element, text: string): string;
+/**
+ * Handles changes of the sorting mode
+ * @param {FriendListSortingMode} sortingMode
+ */
+declare function FriendListChangeSortingMode(sortingMode: FriendListSortingMode): void;
+/**
+ * @this {HTMLButtonElement}
+ */
+declare function FriendListToggleAutoRefresh(this: HTMLButtonElement): void;
 declare var FriendListBackground: string;
-declare var FriendListContent: string;
 /** @type {number[]} */
 declare var FriendListConfirmDelete: number[];
-/** @type {null | { Screen: string, Module: ModuleType, IsInChatRoom?: boolean, hasScrolledChat?: boolean }} */
-declare var FriendListReturn: null | {
-    Screen: string;
-    Module: ModuleType;
-    IsInChatRoom?: boolean;
-    hasScrolledChat?: boolean;
-};
-declare var FriendListMode: string[];
+/** @type {FriendListReturn | null} */
+declare var FriendListReturn: FriendListReturn | null;
+/** @type {FriendListModes} */
+declare var FriendListMode: FriendListModes;
 declare var FriendListModeIndex: number;
 /** @type {IFriendListBeepLogMessage[]} */
 declare var FriendListBeepLog: IFriendListBeepLogMessage[];
-/** @type {number|null} MemberNumber of the player to send beep to */
-declare let FriendListBeepTarget: number | null;
+/** @type {number} MemberNumber of the player to send beep to */
+declare let FriendListBeepTarget: number;
 declare var FriendListBeepShowRoom: boolean;
+/** @type {FriendListSortingMode} */
+declare let FriendListSortingMode: FriendListSortingMode;
+/** @type {FriendListSortingDirection} */
+declare let FriendListSortingDirection: FriendListSortingDirection;
+declare namespace FriendListAutoRefresh {
+    let interval: number;
+    let nextRefresh: number;
+}
+declare const FriendListIDs: Readonly<{
+    root: "friend-list-subscreen";
+    navBar: "friend-list-nav-bar";
+    header: "friend-list-header";
+    friendList: "friend-list";
+    friendListTable: "friend-list-table";
+    navButtons: "friend-list-buttons";
+    modeTitle: "friend-list-mode-title";
+    searchInput: "friend-list-search-input";
+    btnAutoRefresh: "friend-list-button-auto-refresh";
+    btnRefresh: "friend-list-button-refresh";
+    btnPrev: "friend-list-button-prev";
+    btnNext: "friend-list-button-next";
+    btnExit: "friend-list-button-exit";
+    btnResetSorting: "friend-list-reset-sorting";
+    beepList: "friend-list-beep-dialog";
+    beepTextArea: "friend-list-beep-textarea";
+    beepFooter: "friend-list-beep-footer";
+}>;

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

@@ -45,7 +45,6 @@ declare function ChatRoomCharacterViewShowMapButton(): boolean;
  * @param {number} Zoom Room zoom
  * @param {number} ClickX Click X postion relative to character, without zoom
  * @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): void;
 /**

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

@@ -365,6 +365,8 @@ declare var ChatRoomMapViewUpdatePlayerNext: null | number;
 declare var ChatRoomMapViewUpdateLastMapDataNext: null | number;
 /** @type {null | Character} */
 declare var ChatRoomMapViewFocusedCharacter: null | Character;
+declare var ChatRoomMapViewFocusedCharacterX: number;
+declare var ChatRoomMapViewFocusedCharacterY: number;
 declare var ChatRoomMapViewSuperPowersActive: boolean;
 declare var ChatRoomMapViewBaseMovementSpeed: number;
 /** @type {null | ChatRoomMapMovement} */

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

@@ -413,6 +413,11 @@ declare function PrivateIsAnimeGirl(): boolean;
  * @returns {boolean} - TRUE if archetype is Bunny
  */
 declare function PrivateIsBunny(): boolean;
+/**
+ * Returns TRUE if the current character is a succubus
+ * @returns {boolean} - TRUE if archetype is succubus
+ */
+declare function PrivateIsSuccubus(): 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

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

@@ -155,7 +155,7 @@ declare namespace Shop2 {
     function ApplyItemFilters(clearDatalist?: boolean): void;
     function _SetCheckboxFilters(): void;
     function _UpdatePoseButtons(): void;
-    function _ClickDropdown(): void;
+    function _ClickDropdown(id: string): void;
     let DrawPriceRibbon: (label: string, x: number, y: number, w: number, color?: string) => void;
     function ParseAssets(assets: readonly Asset[]): ShopItem[];
     let Elements: Record<string, ShopScreenFunctions>;

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

@@ -18,6 +18,11 @@ declare function SlaveMarketCannotStartAuctionRoom(): boolean;
  * @returns {boolean} - Returns TRUE if the player can be auctioned
  */
 declare function SlaveMarketCanBeAuctioned(): boolean;
+/**
+ * Checks if the character has a specific title
+ * @returns {boolean} - TRUE if the character has the title in the parameter
+ */
+declare function SlaveMarketSlaveTitleIs(Title: any): boolean;
 /**
  * Loads the Slave Market room, generates the Mistress and slave
  * @returns {void} - Nothing

package/bc/Scripts/Asset.d.ts

@@ -208,10 +208,10 @@ declare function AssetInventoryIDUnnecessary(): void;
  * @param {string} GroupName - The group name to compare
  * @param {string} AssetName - The asset name to compare
  * @param {string} BuyGroup - The buying group to compare
- * @param {number} InventoryID - The inventory ID to compare
+ * @param {number | undefined} InventoryID - The inventory ID to compare
  * @returns {void} - Nothing
  */
-declare function AssetInventoryIDBuyGroup(GroupName: string, AssetName: string, BuyGroup: string, InventoryID: number): void;
+declare function AssetInventoryIDBuyGroup(GroupName: string, AssetName: string, BuyGroup: string, InventoryID: number | undefined): void;
 /**
  * Shows a console warning for all Inventory IDs where the BuyGroup is creating a conflict
  * @returns {void} - Nothing

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" | "AnimeGirl" | "Bunny"} Archetype - Archetype to determine the clothes to put on
+ * @param {"Maid" | "Mistress" | "Employee" | "AnimeGirl" | "Bunny" | "Succubus"} 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" | "AnimeGirl" | "Bunny", ForceColor?: string): void;
+declare function CharacterArchetypeClothes(C: Character, Archetype: "Maid" | "Mistress" | "Employee" | "AnimeGirl" | "Bunny" | "Succubus", 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

package/bc/Scripts/Element.d.ts

@@ -179,6 +179,16 @@ declare function ElementGetScrollPercentage(ID: string): (number | null);
  * @returns {boolean} - Returns TRUE if the specified element is scrolled to the very bottom
  */
 declare function ElementIsScrolledToEnd(ID: string): boolean;
+/**
+ * Sets the scroll position of an element to a specified percentage of its scrollable content.
+ * Ideally scroll percentage should be gotten with {@link ElementGetScrollPercentage}
+ *
+ * @param {string} ID
+ * @param {number} scrollPercentage
+ * @param {ScrollBehavior} scrollBehavior
+ * @returns {void}
+ */
+declare function ElementSetScrollPercentage(ID: string, scrollPercentage: number, scrollBehavior?: ScrollBehavior): void;
 /**
  * Gives focus to a specified existing element for non-mobile users.
  * @param {string} ID - The id of the element to give focus to.
@@ -271,14 +281,17 @@ declare namespace ElementButton {
         top: "button-tooltip-top";
         bottom: "button-tooltip-bottom";
     }>;
-    let _TouchStart: (this: HTMLButtonElement, event: Event) => Promise<void>;
-    let _TouchEnd: (this: HTMLButtonElement, event: Event) => Promise<void>;
-    let _MouseDown: (this: HTMLButtonElement, event: MouseEvent) => Promise<void>;
     let _KeyDown: (this: HTMLButtonElement, ev: KeyboardEvent) => Promise<void>;
     let _KeyUp: (this: HTMLButtonElement, ev: KeyboardEvent) => Promise<void>;
+    let _Click: (this: HTMLButtonElement, ev: MouseEvent | TouchEvent) => void;
+    function _QueryDFS(root: Element, query: string, filter: (el: Element) => boolean): Generator<Element, void>;
+    let _ClickRadio: (this: HTMLButtonElement, ev: Event) => void;
+    let _ClickCheckbox: (this: HTMLButtonElement, ev: Event) => void;
     function Create(id: null | string, onClick: (this: HTMLButtonElement, ev: MouseEvent | TouchEvent) => any, options?: {
         tooltip?: null | string | Node;
         tooltipPosition?: "left" | "right" | "top" | "bottom";
+        role?: "radio" | "checkbox" | "menuitemradio" | "menuitemcheckbox";
+        noStyling?: boolean;
     }, htmlOptions?: null | Partial<Record<"button" | "tooltip", Omit<HTMLOptions<any>, "tag">>>): HTMLButtonElement;
 }
 declare namespace ElementMenu {

package/bc/Scripts/Layering.d.ts

@@ -18,6 +18,8 @@ declare namespace Layering {
         buttonGrid: "layering-button-grid";
         resetButton: "layering-reset-button";
         exitButton: "layering-exit-button";
+        hideButton: "layering-hide-button";
+        hideTooltip: "layering-hide-button-tooltip";
         lockButton: "layering-lock-button";
         assetHeader: "layering-asset-header";
         assetGrid: "layering-asset-grid";
@@ -64,6 +66,13 @@ declare namespace Layering {
      * @private
      */
     function _ResetClickListener(this: HTMLButtonElement, ev: Event): void;
+    /**
+     * Event listener for `click` events of the show hidden layers button
+     * @this {HTMLButtonElement}
+     * @param {Event} ev
+     * @private
+     */
+    function _ShowLayersClickListener(this: HTMLButtonElement, ev: Event): void;
     /**
      * Update the background colors of the `number`-based input elements, the color change depending on whether one is changing an asset- or layer-specific priority.
      * @private

package/bc/Scripts/Server.d.ts

@@ -62,10 +62,13 @@ declare function ServerPackItemPermissions(permissionItems: Partial<Record<`${As
 /**
  * Unpack the quartet of blocked, limited, favorited and hidden item permissions into a single object
  * @param {Pick<Partial<ServerAccountDataSynced>, "BlockItems" | "LimitedItems" | "FavoriteItems" | "HiddenItems">} data - The item permission data as received from the server
- * @param {Character} C - The character in question
- * @returns {Partial<Record<`${AssetGroupName}/${string}`, ItemPermissions>>} - The packed item permission data
+ * @param {boolean} onExtreme - If the expected difficulty is Extreme
+ * @returns {{ permissions: Partial<Record<`${AssetGroupName}/${string}`, ItemPermissions>>; shouldSync: boolean }} - The packed item permission data
  */
-declare function ServerUnPackItemPermissions(data: Pick<Partial<ServerAccountDataSynced>, "BlockItems" | "LimitedItems" | "FavoriteItems" | "HiddenItems">, C: Character): Partial<Record<`${AssetGroupName}/${string}`, ItemPermissions>>;
+declare function ServerUnPackItemPermissions(data: Pick<Partial<ServerAccountDataSynced>, "BlockItems" | "LimitedItems" | "FavoriteItems" | "HiddenItems">, onExtreme: boolean): {
+    permissions: Partial<Record<`${AssetGroupName}/${string}`, ItemPermissions>>;
+    shouldSync: boolean;
+};
 /**
  * Syncs player's favorite, blocked, limited and hidden items to the server
  * @returns {void} - Nothing

package/package.json

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