bc-stubs 110.0.0 → 110.0.2

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

@@ -174,8 +174,8 @@ declare var LoginErrorMessage: string;
 declare var LoginCharacter: NPCCharacter;
 declare let LoginTextCacheUnsubscribeCallback: any;
 declare namespace LoginEventListeners {
-    let _KeyDownInputName: (this: HTMLInputElement, ev: KeyboardEvent) => void;
-    let _KeyDownInputPassword: (this: HTMLInputElement, ev: KeyboardEvent) => void;
+    function _KeyDownInputName(this: HTMLInputElement, ev: KeyboardEvent): void;
+    function _KeyDownInputPassword(this: HTMLInputElement, ev: KeyboardEvent): void;
 }
 /**
  * The list of item fixups to apply on login.

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

@@ -1500,9 +1500,30 @@ 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>;
+    /**
+     * Return a {@link HTMLElement.InnerHTML} representation of the passed button's room name
+     * @private
+     * @param {HTMLButtonElement} button
+     * @returns {string}
+     */
     function _GetDisplayName(button: HTMLButtonElement): string;
+    /**
+     * Create a dividing element serving as seperator for different chat rooms
+     * @param {boolean} appendChat - Whether to assign {@link ChatRoomSep.ActiveElem} and append the returned `<div>` to the chat log
+     * @returns {HTMLDivElement} - The created `<div>` element
+     */
     function Create(appendChat?: boolean): HTMLDivElement;
+    /**
+     * Return a {@link HTMLElement.innerHTML} representation of the separators room name
+     * @param {HTMLDivElement} roomSep - The chat room separator
+     * @returns {string}
+     */
     function GetDisplayName(roomSep: HTMLDivElement): string;
+    /**
+     * Return whether the passed room separator is collapsed OR NOT
+     * @param {HTMLDivElement} roomSep - The chat room separator
+     * @returns {boolean}
+     */
     function IsCollapsed(roomSep: HTMLDivElement): boolean;
     function Uncollapse(roomSep: HTMLDivElement): Promise<void>;
     function Collapse(roomSep: HTMLDivElement): Promise<void>;

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

@@ -273,36 +273,74 @@ declare namespace CraftingDescription {
     let ExtendedDescriptionMarker: "\0";
     let Pattern: RegExp;
     let PatternASCII: RegExp;
+    /**
+     * Decode and return the passed string if it consists of UTF16-encoded UTF8 characters.
+     *
+     * Encoded strings must be marked with a leading {@link CraftingDescription.ExtendedDescriptionMarker}; unencoded strings are returned unmodified.
+     * @param {string} description - The to-be decoded string
+     * @returns {string} - The decoded string
+     */
     function Decode(description: string): string;
+    /**
+     * Encode the passed crafted item description, extracting all UTF8 characters and encoding up to two of them into a single UTF16 character.
+     *
+     * The first character is marked with {@link CraftingDescription.ExtendedDescriptionMarker}
+     * @param {string} description - The initial length <=398 string of UTF8 characters
+     * @returns {string} - The length <=200 string of UTF16-encoded UTF8 characters
+     */
     function Encode(description: string): string;
 }
 declare namespace CraftingEventListeners {
-    let _ClickPrivate: (this: HTMLInputElement, ev: Event) => void;
-    let _InputLayering: (this: HTMLInputElement, ev: Event) => void;
-    let _ChangeName: (this: HTMLInputElement, ev: Event) => void;
-    let _ChangeDescription: (this: HTMLTextAreaElement, ev: Event) => void;
-    let _InputDescription: (this: HTMLTextAreaElement, ev: Event) => void;
-    let _ChangeColor: (this: HTMLInputElement, ev: Event) => void;
-    let _ClickExtended: (this: HTMLButtonElement, ev: Event) => void;
-    let _ClickTighten: (this: HTMLButtonElement, ev: Event) => void;
-    let _ClickLayering: (this: HTMLButtonElement, ev: Event) => void;
-    let _ClickColors: (this: HTMLButtonElement, ev: Event) => void;
-    let _ClickUndress: (this: HTMLButtonElement, ev: Event) => void;
-    let _ClickAccept: (this: HTMLButtonElement, ev: Event) => void;
-    let _ClickExit: (this: HTMLButtonElement, ev: Event) => void;
-    let _ClickUpload: (this: HTMLButtonElement, ev: Event) => void;
-    let _ClickDownload: (this: HTMLButtonElement, ev: Event) => void;
-    let _ClickExpand: (this: HTMLButtonElement, ev: Event) => void;
-    let _ClickProperty: (this: HTMLButtonElement, ev: Event) => void;
-    let _ClickPadlock: (this: HTMLButtonElement, ev: Event) => void;
-    let _ClickAsset: (this: HTMLButtonElement, ev: Event) => void;
-    let _ClickRadio: (this: HTMLButtonElement, ev: Event) => void;
+    function _ClickPrivate(this: HTMLInputElement, ev: Event): void;
+    function _InputLayering(this: HTMLInputElement, ev: Event): void;
+    function _ChangeName(this: HTMLInputElement, ev: Event): void;
+    function _ChangeDescription(this: HTMLTextAreaElement, ev: Event): void;
+    function _InputDescription(this: HTMLTextAreaElement, ev: Event): void;
+    function _ChangeColor(this: HTMLInputElement, ev: Event): void;
+    function _ClickExtended(this: HTMLButtonElement, ev: Event): void;
+    function _ClickTighten(this: HTMLButtonElement, ev: Event): void;
+    function _ClickLayering(this: HTMLButtonElement, ev: Event): void;
+    function _ClickColors(this: HTMLButtonElement, ev: Event): void;
+    function _ClickUndress(this: HTMLButtonElement, ev: Event): void;
+    function _ClickAccept(this: HTMLButtonElement, ev: Event): void;
+    function _ClickExit(this: HTMLButtonElement, ev: Event): void;
+    function _ClickUpload(this: HTMLButtonElement, ev: Event): void;
+    function _ClickDownload(this: HTMLButtonElement, ev: Event): void;
+    function _ClickExpand(this: HTMLButtonElement, ev: Event): void;
+    function _ClickProperty(this: HTMLButtonElement, ev: Event): void;
+    function _ClickPadlock(this: HTMLButtonElement, ev: Event): void;
+    function _ClickAsset(this: HTMLButtonElement, ev: Event): void;
+    function _ClickRadio(this: HTMLButtonElement, ev: Event): void;
     let _InputSearch: (this: HTMLInputElement, ev: Event) => Promise<void>;
-    let _ClickAsciiDescription: (this: HTMLInputElement, ev: Event) => void;
+    function _ClickAsciiDescription(this: HTMLInputElement, ev: Event): void;
 }
 declare namespace CraftingElements {
+    /**
+     * @private
+     * @param {string} controls
+     * @returns {() => string[]}
+     */
     function _SearchInputGetDataList(controls: string): () => string[];
+    /**
+     * @private
+     * @param {string} id
+     * @param {string} controls
+     * @param {string} placeholder
+     * @returns {HTMLInputElement}
+     */
     function _SearchInput(id: string, controls: string, placeholder: string): HTMLInputElement;
+    /**
+     * @private
+     * @param {string} id
+     * @param {(this: HTMLButtonElement, ev: Event) => any} onClick
+     * @param {null | Asset} assetImage
+     * @param {null | Partial<Record<string, string | number | boolean>>} dataAttributes
+     * @param {null | string} label
+     * @param {null | readonly (string | Node)[]} children
+     * @param {null | Asset} asset
+     * @param {boolean} first
+     * @returns {HTMLButtonElement}
+     */
     function _RadioButton(id: string, onClick: (this: HTMLButtonElement, ev: Event) => any, assetImage?: null | Asset, dataAttributes?: null | Partial<Record<string, string | number | boolean>>, label?: null | string, children?: null | readonly (string | Node)[], asset?: null | Asset, first?: boolean): HTMLButtonElement;
 }
 /**

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

@@ -438,7 +438,7 @@ declare var PlatformInventoryList: {
     Name: string;
     DisplayName: string;
     Description: string;
-    OnGive: (Char: any) => void;
+    OnGive(Char: any): void;
 }[];
 declare var PlatformTemplate: ({
     Name: string;
@@ -724,7 +724,7 @@ declare var PlatformTemplate: ({
         Damage?: undefined;
         JumpForce?: undefined;
     })[];
-    OnBind: () => void;
+    OnBind(): void;
     Magic?: undefined;
     MagicPerLevel?: undefined;
     ProjectileHitAudio?: undefined;
@@ -889,7 +889,7 @@ declare var PlatformTemplate: ({
         Cycle: number[];
         Speed: number;
     }[];
-    OnBind: () => void;
+    OnBind(): void;
     Perk?: undefined;
     PerkName?: undefined;
     HealthPerLevel?: undefined;
@@ -949,7 +949,7 @@ declare var PlatformTemplate: ({
         Cycle: number[];
         Speed: number;
     }[];
-    OnBind: () => void;
+    OnBind(): void;
     Perk?: undefined;
     PerkName?: undefined;
     HealthPerLevel?: undefined;
@@ -997,7 +997,7 @@ declare var PlatformTemplate: ({
         Cycle: number[];
         Speed: number;
     }[];
-    OnBind: () => void;
+    OnBind(): void;
     Perk?: undefined;
     PerkName?: undefined;
     HealthPerLevel?: undefined;
@@ -1044,7 +1044,7 @@ declare var PlatformTemplate: ({
         Cycle: number[];
         Speed: number;
     }[];
-    OnBind: () => void;
+    OnBind(): void;
     Perk?: undefined;
     PerkName?: undefined;
     HealthPerLevel?: undefined;
@@ -1123,7 +1123,7 @@ declare var PlatformTemplate: ({
         Damage: number[];
         Speed: number;
     }[];
-    OnBind: () => void;
+    OnBind(): void;
     Perk?: undefined;
     PerkName?: undefined;
     HealthPerLevel?: undefined;
@@ -1175,7 +1175,7 @@ declare var PlatformTemplate: ({
         Name: string;
         Speed: number;
     }[];
-    OnBind: () => void;
+    OnBind(): void;
     Perk?: undefined;
     PerkName?: undefined;
     HealthPerLevel?: undefined;
@@ -1318,7 +1318,7 @@ declare var PlatformRoomList: ({
     BackgroundFilter?: undefined;
 } | {
     Name: string;
-    Entry: () => void;
+    Entry(): void;
     Text: string;
     Background: string;
     Music: string;
@@ -1346,7 +1346,7 @@ declare var PlatformRoomList: ({
     BackgroundFilter?: undefined;
 } | {
     Name: string;
-    Entry: () => void;
+    Entry(): void;
     Text: string;
     Background: string;
     AlternateBackground: string;
@@ -1402,7 +1402,7 @@ declare var PlatformRoomList: ({
     BackgroundFilter?: undefined;
 } | {
     Name: string;
-    Entry: () => void;
+    Entry(): void;
     Text: string;
     Background: string;
     Music: string;
@@ -1426,7 +1426,7 @@ declare var PlatformRoomList: ({
     BackgroundFilter?: undefined;
 } | {
     Name: string;
-    Entry: () => void;
+    Entry(): void;
     Text: string;
     Background: string;
     Music: string;
@@ -1450,7 +1450,7 @@ declare var PlatformRoomList: ({
     BackgroundFilter?: undefined;
 } | {
     Name: string;
-    Entry: () => void;
+    Entry(): void;
     Text: string;
     Background: string;
     AlternateBackground: string;
@@ -1474,7 +1474,7 @@ declare var PlatformRoomList: ({
     BackgroundFilter?: undefined;
 } | {
     Name: string;
-    Entry: () => void;
+    Entry(): void;
     Text: string;
     Background: string;
     Music: string;
@@ -1498,7 +1498,7 @@ declare var PlatformRoomList: ({
     BackgroundFilter?: undefined;
 } | {
     Name: string;
-    Entry: () => void;
+    Entry(): void;
     Text: string;
     Background: string;
     Music: string;
@@ -1526,7 +1526,7 @@ declare var PlatformRoomList: ({
     BackgroundFilter?: undefined;
 } | {
     Name: string;
-    Entry: () => void;
+    Entry(): void;
     Text: string;
     Background: string;
     BackgroundFilter: string;
@@ -1554,7 +1554,7 @@ declare var PlatformRoomList: ({
     AlternateBackground?: undefined;
 } | {
     Name: string;
-    Entry: () => void;
+    Entry(): void;
     Text: string;
     Background: string;
     BackgroundFilter: string;
@@ -1606,7 +1606,7 @@ declare var PlatformRoomList: ({
     AlternateBackground?: undefined;
 } | {
     Name: string;
-    Entry: () => void;
+    Entry(): void;
     Text: string;
     Background: string;
     BackgroundFilter: string;
@@ -1630,7 +1630,7 @@ declare var PlatformRoomList: ({
     AlternateBackground?: undefined;
 } | {
     Name: string;
-    Entry: () => void;
+    Entry(): void;
     Text: string;
     Background: string;
     BackgroundFilter: string;
@@ -1743,7 +1743,7 @@ declare var PlatformRoomList: ({
     Name: string;
     Background: string;
     Music: string;
-    Entry: () => void;
+    Entry(): void;
     Text?: undefined;
     Width?: undefined;
     Height?: undefined;
@@ -1775,7 +1775,7 @@ declare var PlatformRoomList: ({
     Background: string;
     AlternateBackground: string;
     Music: string;
-    Entry: () => void;
+    Entry(): void;
     Width: number;
     Height: number;
     LimitLeft: number;
@@ -1795,7 +1795,7 @@ declare var PlatformRoomList: ({
     BackgroundFilter?: undefined;
 } | {
     Name: string;
-    Entry: () => void;
+    Entry(): void;
     Text: string;
     Background: string;
     Music: string;
@@ -1837,7 +1837,7 @@ declare var PlatformRoomList: ({
     Background: string;
     AlternateBackground: string;
     Music: string;
-    Entry: () => void;
+    Entry(): void;
     Width: number;
     Height: number;
     LimitLeft: number;
@@ -1865,7 +1865,7 @@ declare var PlatformRoomList: ({
     Background: string;
     AlternateBackground: string;
     Music: string;
-    Entry: () => void;
+    Entry(): void;
     Width: number;
     Height: number;
     LimitLeft: number;
@@ -1892,7 +1892,7 @@ declare var PlatformRoomList: ({
     Height: number;
     LimitRight: number;
     Heal: number;
-    Entry: () => void;
+    Entry(): void;
     Door: {
         Name: string;
         FromX: number;
@@ -1933,7 +1933,7 @@ declare var PlatformRoomList: ({
         ToX: number;
         ToFaceLeft?: undefined;
     })[];
-    Entry: () => void;
+    Entry(): void;
     Character: {
         Name: string;
         Status: string;
@@ -2007,7 +2007,7 @@ declare var PlatformRoomList: ({
         ToX: number;
         ToFaceLeft?: undefined;
     })[];
-    Entry: () => void;
+    Entry(): void;
     LimitLeft?: undefined;
     LimitRight?: undefined;
     Heal?: undefined;