bc-stubs 115.0.1 → 116.0.0

package/bc/Backgrounds/Backgrounds.d.ts

@@ -6,10 +6,10 @@
 declare function BackgroundsTextGet(msg: string): string;
 /**
  * Builds the selectable background arrays based on the tags supplied
- * @param {readonly BackgroundTag[]} BackgroundTagList - An array of string of all the tags to load
+ * @param {BackgroundTag[]} BackgroundTagList - An array of string of all the tags to load
  * @returns {string[]} - The list of all background names
  */
-declare function BackgroundsGenerateList(BackgroundTagList: readonly BackgroundTag[]): string[];
+declare function BackgroundsGenerateList(BackgroundTagList: BackgroundTag[]): string[];
 declare const BackgroundsStringsPath: "Backgrounds/Backgrounds.csv";
 declare const BackgroundsTagNone: "Filter by tag";
 declare const BackgroundsTagIndoor: "Indoor";
@@ -17,11 +17,13 @@ declare const BackgroundsTagOutdoor: "Outdoor";
 declare const BackgroundsTagAquatic: "Aquatic";
 declare const BackgroundsTagSpecial: "Special Events";
 declare const BackgroundsTagSciFiFantasy: "SciFi & Fantasy";
-declare const BackgroundsTagClub: "Club & College";
+declare const BackgroundsTagClub: "Club";
+declare const BackgroundsTagCollege: "College";
 declare const BackgroundsTagHouse: "Regular house";
 declare const BackgroundsTagDungeon: "Dungeon";
 declare const BackgroundsTagAsylum: "Asylum";
 declare const BackgroundsTagPandora: "Pandora";
+declare const BackgroundsTagClubCards: "Club Cards";
 /**
  * List of all tags to create online chat rooms
  * @constant
@@ -34,6 +36,12 @@ declare const BackgroundsTagList: BackgroundTag[];
  * @type {BackgroundTag[]}
  */
 declare const BackgroundsPrivateRoomTagList: BackgroundTag[];
+/**
+ * List of all tags for the club cards board
+ * @constant
+ * @type {BackgroundTag[]}
+ */
+declare const BackgroundsClubCardsTagList: BackgroundTag[];
 /**
  * List of all the common backgrounds.
  * @constant

package/bc/NativeDeclarations/Element.d.ts

@@ -0,0 +1,6 @@
+declare namespace ElementHelp {
+  type ElementOrId = HTMLElement | string; 
+  type AnchorY = 'top' | 'bottom';
+  type AnchorX = 'left' | 'right';
+  type AnchorXY = `${AnchorY}-${AnchorX}`;
+}

package/bc/NativeDeclarations/FriendList.d.ts

@@ -19,7 +19,7 @@ type FriendRawRoom = {
   name?: string;
   caption: string;
   canSearchRoom: boolean;
-  types: FriendListIcon[];
+  types: (null | FriendListIcon)[];
 };
 
 type FriendRawBeep = {

package/bc/NativeDeclarations/Messages.d.ts

@@ -467,6 +467,7 @@ interface ServerChatRoomSearchData {
 	 * @deprecated Use {@link ServerChatRoomData.Access} instead, this is maintained for backwards compatibility
 	 */
 	Locked?: boolean;
+	CanJoin: boolean;
     MapType: string;
 }
 
@@ -861,7 +862,8 @@ interface ServerChatRoomGameCardGameData {
     Event: string;
     DiscardPile: string;
     CardsPlayedThisTurn: Record<number, ClubCard[]>;
-    ClubCardTurnCounter: number;
+	ClubCardTurnCounter: number;
+	Sleeve: number;
 }
 
 interface ServerChatRoomGameCardGameQueryRequest {

package/bc/NativeDeclarations/Typedef.d.ts

@@ -130,6 +130,8 @@ type HTMLOptions<T extends keyof HTMLElementTagNameMap> = {
 interface HTMLElementEventMap {
 	/** Custom event fired by {@link ElementButton.Create} buttons whenever a click-event encounters `aria-disabled: "true"`. */
 	bcClickDisabled: MouseEvent;
+	/** Custom event fired by {@link ElementButton.Create} buttons whenever a touch is hold for 300 ms. */
+	bcTouchHold: MouseEvent;
 }
 
 declare namespace ElementButton {
@@ -179,6 +181,11 @@ declare namespace ElementButton {
 		disabled?: boolean;
 		/** A click event listener to-be fired when a button is disabled via `aria-disabled: "true"`. */
 		clickDisabled?: (this: HTMLButtonElement, event: MouseEvent) => any;
+		/**
+		 * Enabled buttons with a `checkbox` or `radio` role can normally not be clicked if the `aria-required: "true"` is set.
+		 * Setting this option to `true` disables that behavior, clicking an already enabled button thus firing its click events once again rather than aborting.
+		 */
+		allowRequiredClick?: boolean;
 	}
 }
 
@@ -495,7 +502,8 @@ interface ExpressionNameMap {
 		null | "Afk" | "Whisper" | "Sleep" | "Hearts" | "Tear" | "Hearing" | "Confusion" | "Exclamation" |
 		"Annoyed" | "Read" | "RaisedHand" | "Spectator" | "ThumbsDown" | "ThumbsUp" | "LoveRope" |
 		"LoveGag" | "LoveLock" | "Wardrobe" | "Gaming" | "Coffee" | "Fork" | "Music" | "Car" | "Hanger" |
-		"Call" | "Lightbulb" | "Warning" | "BrokenHeart" | "Drawing" | "Coding" | "TV" | "Bathing"
+		"Call" | "Lightbulb" | "Warning" | "BrokenHeart" | "Drawing" | "Coding" | "TV" | "Bathing" |
+		"Shopping" |"Brb" | "Work" | "SOS"
 	),
 }
 
@@ -650,7 +658,7 @@ type FetishName =
 
 type BackgroundTag =
 	"Filter by tag" | "Indoor" | "Outdoor" | "Aquatic" | "Special Events" | "SciFi & Fantasy" |
-	"Club & College" | "Regular house" | "Dungeon" | "Asylum" | "Pandora"
+	"Club" | "College" | "Regular house" | "Dungeon" | "Asylum" | "Pandora" | "Club Cards"
 	;
 
 // NOTE: `NPCArchetype` is for NPC's only
@@ -2324,6 +2332,7 @@ interface ChatSettingsType {
 	/** Whether to preserve the chat log when switching rooms */
 	PreserveChat: boolean;
 	OOCAutoClose: boolean;
+	DisableReplies: boolean;
 }
 
 interface GameplaySettingsType {
@@ -2350,8 +2359,16 @@ interface AudioSettingsType {
 interface VisualSettingsType {
 	ForceFullHeight: boolean;
 	UseCharacterInPreviews: boolean;
-	MainHallBackground: string;
-	PrivateRoomBackground: string;
+	/**
+	 * Background to use for the MainHall screen
+	 * "MainHall" is used if undefined
+	 */
+	MainHallBackground?: string;
+	/**
+	 * Background to use for the PrivateRoom screen
+	 * "Private" is used if undefined
+	 */
+	PrivateRoomBackground?: string;
 }
 
 /**
@@ -2369,6 +2386,7 @@ interface PlayerOnlineSettings {
 	EnableAfkTimer: boolean;
 	ShowRoomCustomization: 0 | 1 | 2 | 3; // 0 - Never, 1 - No by default, 2 - Yes by default, 3 - Always
 	FriendListAutoRefresh: boolean;
+	DefaultChatRoomBackground: string;
 }
 
 /** Pandora Player extension */
@@ -3779,6 +3797,9 @@ interface GameClubCardParameters {
 	Reward?: string;
 	Status?: OnlineGameStatus;
 	PlayerSlot?: number;
+	Background?: string;
+	CardBack?: number;
+	IsAnimation?: boolean;
 }
 
 interface GamePrisonParameters {
@@ -4427,6 +4448,15 @@ interface NotificationData {
 	chatRoomName?: string,
 }
 
+interface NotificationBeep {
+	Message: string;
+	Duration: number;
+	ClickHandler?: (event: MouseEvent) => void;
+	Silent?: boolean;
+	/** Internal use; timer that is set when the beep first appears on screen */
+	Timer?: number;
+}
+
 // #end region
 
 // #region preference
@@ -4585,8 +4615,11 @@ interface WheelFortuneOptionType {
 
 // #end region
 
+// #region ClubCard
+
 interface ClubCard {
 	ID: number;
+	UniqueID?: string;
 	Name: string;
 	ArrayIndex?: number;
 	Type?: string;
@@ -4607,6 +4640,16 @@ interface ClubCard {
 	Negated?: boolean;
 	GlowTimer?: number;
 	GlowColor?: string;
+	EffectKey?: number;
+	EffectType?: string;
+	//### Animations
+	AnimationState?: string;
+	DelayedAnimationState?: string;
+	CurrentX?: number;
+	CurrentY?: number;
+	CurrentW?: number;
+	IsVisible?: boolean;
+	//### ### ### ###
 	OnPlay?: (C: ClubCardPlayer) => void;
 	BeforeTurnEnd?: (C: ClubCardPlayer) => void;
 	AfterTurnEnd?: (C: ClubCardPlayer) => void;
@@ -4636,12 +4679,13 @@ interface ClubCardPlayer {
 	Character: Character;
 	Control: string;
 	Index: number;
-	Sleeve: string;
+	Sleeve: number;
 	Deck: ClubCard[];
 	FullDeck: ClubCard[];
 	Hand: ClubCard[];
 	Board: ClubCard[];
 	Event: ClubCard[];
+	RenderFullBoard: ClubCard[];
 	DiscardPile: ClubCard[];
 	Level: number;
 	Money: number;
@@ -4666,6 +4710,39 @@ interface ClubCardMessage {
     OpponentPlayer?: string;
 }
 
+/**
+ * Represents an active card animation in progress.
+ */
+interface ClubCardActiveAnimation {
+    /** The card being animated. */
+    Card: ClubCard;
+    /** The original card (if a copy is animated). */
+    OriginalCard?: ClubCard | null;
+    /** Timestamp when the animation started (in milliseconds). */
+    StartTime: number;
+    /** Total animation duration in milliseconds. */
+    Duration: number;
+    /** Initial position of the card. */
+    StartPosition: { x: number, y: number, w: number };
+    /** Target position of the card. */
+    EndPosition: { x: number, y: number, w: number };
+    /** Whether to hide the original card during animation. */
+    HideOriginal: boolean;
+    /** Whether the original card should stay hidden after animation completes. */
+    KeepOriginalHidden: boolean;
+    /** Timeout ID for fallback handling (used to restore the card state in case of failure). */
+    SafetyTimeout: number;
+    /** Callback function called when the animation completes. */
+    OnComplete?: Function|null;
+    // Processed elsewhere
+    // /** Callback function called when the animation starts. */
+	// OnStart?: Function|null;
+	/** Animation rendering level priority*/
+	Priority: number;
+}
+
+
+// #endregion
 
 // #region drawing
 
@@ -4813,6 +4890,8 @@ interface ShopItem {
 	readonly Asset: Asset,
 	/** The assets sorting priority within the asset list; lower values take priority */
 	readonly SortPriority: number,
+	/** Whether the player is forbidden to buy the item */
+	readonly CannotBuy: boolean,
 	/** Whether an item should never be able to be sold */
 	readonly NeverSell: boolean,
 	/** Whether the asset can be bought; `false` implies that it can be sold */

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

@@ -1,24 +1,18 @@
 /**
  * Change the current screen to the background selection screen
- * @param {string[]} List - The list of possible Background names
- * @param {number} Idx - The index of the current background
- * @param {(selection: string) => void} Callback - The function to call when a new background has been selected
+ * @param {BackgroundTag[]} Tags - The list of possible Background names
+ * @param {string} Name - The name of the current background
+ * @param {(selection: string, setBackground: boolean) => void} Callback - The function to call when a new background has been selected
  * @returns {void} - Nothing
  */
-declare function BackgroundSelectionMake(List: string[], Idx: number, Callback: (selection: string) => void): void;
+declare function BackgroundSelectionMake(Tags: BackgroundTag[], Name: string, Callback: (selection: string, setBackground: boolean) => void): void;
 /**
  * Comapres two backgrounds by their description
- * @param {object} a - The first object to compare
- * @param {string} a.Description - The description of object a. Is used for comparision
- * @param {object} b - The second object to compar
- * @param {string} b.Description - The description of object b. Is used for comparision
+ * @param {string} a - The name of the first background
+ * @param {string} b - The name of the second background
  * @returns {number} - Returns -1 if the description of object a is less then that of b, 1 otherwise
  */
-declare function BackgroundSelectionSort(a: {
-    Description: string;
-}, b: {
-    Description: string;
-}): number;
+declare function BackgroundSelectionSort(a: string, b: string): number;
 /**
  * Initializes the Background selection screen.
  * Function coiuld be called dynamically, so the body has to be there, even if it does nothing.
@@ -34,9 +28,11 @@ declare function BackgroundSelectionUnload(): void;
 declare function BackgroundSelectionInputChanged(): void;
 /**
  * When a new value is selected in the tag selection drop-down, we refresh the displayed background
+ * @this {HTMLSelectElement}
  * @returns {void} - Nothing
  */
-declare function BackgroundSelectionTagChanged(): void;
+declare function BackgroundSelectionTagChanged(this: HTMLSelectElement): void;
+declare function BackgroundSelectionResize(load: boolean): void;
 /**
  * Draws the Background selection screen:
  * - draws all the buttons and the text input field on the topmost rows
@@ -71,22 +67,26 @@ declare var BackgroundSelectionList: string[];
 /** @type {BackgroundTag[]} */
 declare var BackgroundSelectionTagList: BackgroundTag[];
 declare var BackgroundSelectionIndex: number;
-declare var BackgroundSelectionSelect: string;
+/** @type {string | null} */
+declare var BackgroundSelectionSelect: string | null;
 declare var BackgroundSelectionSize: number;
 declare var BackgroundSelectionOffset: number;
-/** @type {null | ((selection: string) => void)} */
-declare var BackgroundSelectionCallback: null | ((selection: string) => void);
-/** @type {ScreenSpecifier | null} */
-declare var BackgroundSelectionReturnScreen: ScreenSpecifier | null;
-/** @type {{ Name: string, Description: string, Low: string }[]} */
-declare var BackgroundSelectionAll: {
-    Name: string;
-    Description: string;
-    Low: string;
-}[];
-/** @type {{ Name: string, Description: string, Low: string }[]} */
-declare var BackgroundSelectionView: {
-    Name: string;
-    Description: string;
-    Low: string;
-}[];
+/** @type {null | ((selection: string, setBackground: boolean) => void)} */
+declare var BackgroundSelectionCallback: null | ((selection: string, setBackground: boolean) => void);
+/** @type {never} */
+declare var BackgroundSelectionReturnScreen: never;
+/** @type {never} */
+declare var BackgroundSelectionAll: never;
+/** @type {string[]} */
+declare var BackgroundSelectionView: string[];
+declare namespace Background {
+    namespace elementID {
+        let root: string;
+        let searchFilter: string;
+        let tagFilter: string;
+        let btnPrev: string;
+        let btnNext: string;
+        let btnCancel: string;
+        let btnAccept: string;
+    }
+}

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

@@ -1,3 +1,4 @@
+declare function PreferenceSubscreenOnlineLoad(): void;
 /**
  * Sets the online preferences for the player. Redirected to from the main Run function if the player is in the online
  * settings subscreen.
@@ -9,3 +10,7 @@ declare function PreferenceSubscreenOnlineRun(): void;
  * @returns {void} - Nothing
  */
 declare function PreferenceSubscreenOnlineClick(): void;
+/** @type {null | string[]} */
+declare var PreferenceOnlineDefaultBackgroundList: null | string[];
+declare var PreferenceOnlineDefaultBackgroundIndex: number;
+declare var PreferenceOnlineDefaultBackground: string;