bc-stubs 108.0.0 → 109.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -255,6 +255,15 @@ interface AssetGroupDefinitionBase extends AssetCommonPropertiesGroupAsset, Asse
255
255
  */
256
256
  Clothing?: boolean;
257
257
 
258
+ // Set to TRUE if all assets in that group should allow editing opacity, set value on asset level to override
259
+ EditOpacity?: boolean;
260
+
261
+ // The default minimum opacity for that group, set value on asset level to override
262
+ MinOpacity?: number;
263
+
264
+ // The default maximum opacity for that group, set value on asset level to override
265
+ MaxOpacity?: number;
266
+
258
267
  /** Whether the group is considered underwear
259
268
  *
260
269
  * This is used when stripping a character.
@@ -431,6 +440,7 @@ interface AssetCommonPropertiesAssetLayer {
431
440
  Opacity?: number;
432
441
  MinOpacity?: number;
433
442
  MaxOpacity?: number;
443
+ EditOpacity?: boolean; // True if we can edit the opacity in the color picker
434
444
  }
435
445
 
436
446
  /** Input interface for constructing {@link Asset} objects. */
@@ -734,6 +734,9 @@ interface AssetGroup {
734
734
  readonly Effect: readonly EffectName[];
735
735
  readonly MirrorGroup: AssetGroupName | "";
736
736
  readonly RemoveItemOnRemove: readonly Readonly<{ Group: AssetGroupItemName; Name: string; TypeRecord?: TypeRecord }>[];
737
+ readonly EditOpacity: boolean;
738
+ readonly MinOpacity: number;
739
+ readonly MaxOpacity: number;
737
740
  readonly DrawingPriority: number;
738
741
  readonly DrawingLeft: TopLeft.Data;
739
742
  readonly DrawingTop: TopLeft.Data;
@@ -970,6 +973,7 @@ interface Asset {
970
973
  readonly Opacity: number;
971
974
  readonly MinOpacity: number;
972
975
  readonly MaxOpacity: number;
976
+ readonly EditOpacity: boolean;
973
977
  readonly Audio?: string;
974
978
  readonly Category?: readonly AssetCategory[];
975
979
  readonly Fetish?: readonly FetishName[];
@@ -2605,7 +2609,7 @@ interface AssetDefinitionProperties {
2605
2609
  * The asset's draw opacity
2606
2610
  * @see {@link Asset.Opacity}
2607
2611
  */
2608
- Opacity?: number;
2612
+ Opacity?: number | number[];
2609
2613
 
2610
2614
  /**
2611
2615
  * A custom background for this option that overrides the default
@@ -3766,6 +3770,7 @@ interface ItemColorStateType {
3766
3770
  colorInputWidth: number;
3767
3771
  colorInputX: number;
3768
3772
  colorInputY: number;
3773
+ editOpacity: boolean;
3769
3774
  exportButtonX: number;
3770
3775
  importButtonX: number;
3771
3776
  resetButtonX: number;
@@ -4085,6 +4090,7 @@ interface WheelFortuneOptionType {
4085
4090
  interface ClubCard {
4086
4091
  ID: number;
4087
4092
  Name: string;
4093
+ ArrayIndex?: number;
4088
4094
  Type?: string;
4089
4095
  Title?: string;
4090
4096
  Text?: string;
@@ -4108,6 +4114,22 @@ interface ClubCard {
4108
4114
  BeforeOpponentTurnEnd?: (C: ClubCardPlayer) => void;
4109
4115
  AfterOpponentTurnEnd?: (C: ClubCardPlayer) => void;
4110
4116
  CanPlay?: (C: ClubCardPlayer) => boolean;
4117
+ /**
4118
+ * @param C Player that owns the card and played a card
4119
+ * @param Card that was played
4120
+ */
4121
+ onPlayedCard?: (C: ClubCardPlayer, Card: ClubCard) => void;
4122
+ /**
4123
+ * @param C player that owns the card (not the one who played it in this case)
4124
+ * @param Card the card that was played
4125
+ */
4126
+ onOpponentPlayedCard?: (C: ClubCardPlayer, Card: ClubCard) => void;
4127
+ /**
4128
+ * Hook to run when card is removed from the board.
4129
+ * @param C Player that owns the card
4130
+ */
4131
+ onLeaveClub?: (C: ClubCardPlayer) => void;
4132
+ turnStart?: (C: ClubCardPlayer) => void;
4111
4133
  }
4112
4134
 
4113
4135
  interface ClubCardPlayer {
@@ -4120,6 +4142,7 @@ interface ClubCardPlayer {
4120
4142
  Hand: ClubCard[];
4121
4143
  Board: ClubCard[];
4122
4144
  Event: ClubCard[];
4145
+ DiscardPile: ClubCard[];
4123
4146
  Level: number;
4124
4147
  Money: number;
4125
4148
  Fame: number;
@@ -177,6 +177,10 @@ declare var LoginErrorMessage: string;
177
177
  /** @type {NPCCharacter} */
178
178
  declare var LoginCharacter: NPCCharacter;
179
179
  declare let LoginTextCacheUnsubscribeCallback: any;
180
+ declare namespace LoginEventListeners {
181
+ let _KeyDownInputName: (this: HTMLInputElement, ev: KeyboardEvent) => void;
182
+ let _KeyDownInputPassword: (this: HTMLInputElement, ev: KeyboardEvent) => void;
183
+ }
180
184
  /**
181
185
  * The list of item fixups to apply on login.
182
186
  *
@@ -116,6 +116,7 @@ declare const PreferenceSubscreens: PreferenceSubscreen[];
116
116
  declare var PreferencePageCurrent: number;
117
117
  /** @type {Record<string,PreferenceExtensionsSettingItem>} */
118
118
  declare let PreferenceExtensionsSettings: Record<string, PreferenceExtensionsSettingItem>;
119
+ declare let PreferenceDidAddOldStyleScreens: boolean;
119
120
  declare namespace PreferenceActivityEnjoymentDefault {
120
121
  let Name: ActivityName | undefined;
121
122
  let Self: ArousalFactor;
@@ -1 +1,2 @@
1
+ declare function ItemHeadDroneMaskValidateHook(data: ModularItemData, originalFunction: (C: Character, item: Item, newOption: ModularItemOption, previousOption: ModularItemOption, permitExisting?: boolean) => string, C: Character, item: Item, newOption: ModularItemOption, previousOption: ModularItemOption, permitExisting?: boolean): string;
1
2
  declare function AssetsItemHeadDroneMaskAfterDrawHook(data: TextItemData, originalFunction: (drawData: DynamicDrawingData<Record<string, unknown>>) => void, drawData: DynamicDrawingData<Record<string, unknown>>): void;
@@ -117,9 +117,16 @@ declare function ClubCardGroupOnBoardCount(CCPlayer: ClubCardPlayer, GroupName:
117
117
  * Removes a card from a player board
118
118
  * @param {ClubCardPlayer} CCPlayer - The club card player
119
119
  * @param {ClubCard} Card - The card object to remove
120
+ * @param {boolean|null} DontDiscard - If the card dont need to go to the discard pile
120
121
  * @returns {void} - Nothing
121
122
  */
122
- declare function ClubCardRemoveFromBoard(CCPlayer: ClubCardPlayer, Card: ClubCard): void;
123
+ declare function ClubCardRemoveFromBoard(CCPlayer: ClubCardPlayer, Card: ClubCard, DontDiscard?: boolean | null): void;
124
+ /**
125
+ * Gets the updated cost for a player to level up
126
+ * @param {ClubCardPlayer} CCPlayer - The club card player
127
+ * @returns {number} The cost to level up
128
+ */
129
+ declare function ClubCardCalculateLevelCost(CCPlayer: ClubCardPlayer): number;
123
130
  /**
124
131
  * Gets the max effect a card should have depending on its "tier"/required level to play
125
132
  * @param {ClubCard} Card
@@ -177,10 +184,34 @@ declare function ClubCardPlayerDrawCard(CCPlayer: ClubCardPlayer, Amount?: numbe
177
184
  /**
178
185
  * Draw cards from the player deck into it's hand
179
186
  * @param {ClubCardPlayer} CCPlayer - The club card player that draws the cards
180
- * @param {string} group - The group to draw from
187
+ * @param {string[]} groups - The group to draw from
188
+ * @param {number | undefined} level - The level
181
189
  * @returns {boolean} - if cards were drawn or not
182
190
  */
183
- declare function ClubCardPlayerDrawGroupCard(CCPlayer: ClubCardPlayer, group: string): boolean;
191
+ declare function ClubCardPlayerDrawGroupCard(CCPlayer: ClubCardPlayer, groups: string[], level: number | undefined): boolean;
192
+ /**
193
+ * Summon cards from the player deck into it's board
194
+ * @param {ClubCardPlayer} CCPlayer - The club card player that summons the cards
195
+ * @param {string[]} groups - The group to summon from
196
+ * @param {number} amount - The amount of cards to summon
197
+ * @param {number | undefined} level - The level of the cards if needed
198
+ * @returns {boolean} - if cards were summoned or not
199
+ */
200
+ declare function ClubCardPlayerSummonGroupCardFromDeck(CCPlayer: ClubCardPlayer, groups: string[], amount: number, level: number | undefined): boolean;
201
+ /**
202
+ * Play a card from an effect
203
+ * @param {ClubCardPlayer} CCPlayer - The club card player
204
+ * @param {ClubCard} card - The card to play
205
+ * @returns {void} - Nothing
206
+ */
207
+ declare function ClubCardSummonCard(CCPlayer: ClubCardPlayer, card: ClubCard): void;
208
+ /**
209
+ * Returns TRUE if a specific card can be summoned by the player
210
+ * @param {ClubCardPlayer} CCPlayer - The club card player
211
+ * @param {ClubCard} Card - The card to play
212
+ * @returns {boolean} - TRUE if the card can be summoned
213
+ */
214
+ declare function ClubCardCanSummonCard(CCPlayer: ClubCardPlayer, Card: ClubCard): boolean;
184
215
  /**
185
216
  *
186
217
  * @param {ClubCardPlayer} CCPlayer - The club card player that draws the cards
@@ -297,6 +328,19 @@ declare function ClubCardCanSelectCard(CCPlayer: ClubCardPlayer, Card: ClubCard)
297
328
  * @returns {void} - Nothing
298
329
  */
299
330
  declare function ClubCardPlayCard(CCPlayer: ClubCardPlayer, Card: ClubCard): void;
331
+ /**
332
+ * When it adds a card to a player's board, check if there is an effect on board that needs to be triggered.
333
+ * @param {ClubCardPlayer} CCPlayer - The target player
334
+ * @param {ClubCard} Card - The card that was played
335
+ * @returns {void} - Nothing
336
+ */
337
+ declare function ClubCardOnCardPlayedHandler(CCPlayer: ClubCardPlayer, Card: ClubCard): void;
338
+ /**
339
+ * When it adds a card to a player's board, it updates for all index cards.
340
+ * @param {ClubCardPlayer} Target - The target player
341
+ * @returns {void} - Nothing
342
+ */
343
+ declare function ClubCardUpdateBoardCardsIndex(Target: ClubCardPlayer): void;
300
344
  /**
301
345
  * When a player selects a card that's a prerequisite for another card
302
346
  * @param {ClubCard} Card - The card to play
@@ -361,6 +405,12 @@ declare function ClubCardRenderBubble(Value: number, X: number, Y: number, W: nu
361
405
  * @returns {string} - The
362
406
  */
363
407
  declare function ClubCardGetGroupText(Group: any[]): string;
408
+ /**
409
+ * Updated the text by mask, for InnerHTML
410
+ * @param {String} text -Normal Card Text
411
+ * @returns {String} - Updated for InnerHTML Card Text
412
+ */
413
+ declare function ClubCardGetFormatTextForInnerHTML(text: string): string;
364
414
  /**
365
415
  * Draw the club card player hand on screen, show only sleeves if not controlled by player
366
416
  * @param {ClubCard|Number} Card - The card to draw
@@ -393,6 +443,16 @@ declare function ClubCardRenderBoard(CCPlayer: any, X: number, Y: number, W: num
393
443
  * @returns {void} - Nothing
394
444
  */
395
445
  declare function ClubCardRenderHand(CCPlayer: ClubCardPlayer, X: number, Y: number, W: number, H: number): void;
446
+ /**
447
+ * Draw the discard pile on screen
448
+ * @param {ClubCardPlayer} CCPlayer - The club card player that draws it's discard pile
449
+ * @param {number} X - The X on screen position
450
+ * @param {number} Y - The Y on screen position
451
+ * @param {number} W - The width of the discard pile window
452
+ * @param {number} H - The height of the discard pile window
453
+ * @returns {void} - Nothing
454
+ */
455
+ declare function ClubCardRenderDiscardPile(CCPlayer: ClubCardPlayer, X: number, Y: number, W: number, H: number): void;
396
456
  /**
397
457
  * Shows the status text on the bottom right
398
458
  * @param {string} Text - The status text to show
@@ -423,8 +483,12 @@ declare function ClubCardKeyDown(event: KeyboardEvent): boolean;
423
483
  declare var ClubCardBackground: string;
424
484
  declare var ClubCardLog: any[];
425
485
  declare var ClubCardLogText: string;
486
+ declare var ClubCardOldLogText: string;
426
487
  declare var ClubCardLogScroll: boolean;
427
488
  declare var ClubCardColor: string[];
489
+ declare var ClubCardFameTextColor: string;
490
+ declare var ClubCardMoneyTextColor: string;
491
+ declare var ClubCardIsStartTurnAddedLog: boolean;
428
492
  declare var ClubCardOpponent: any;
429
493
  declare var ClubCardOpponentDeck: any[];
430
494
  declare var ClubCardReward: any;
@@ -1316,6 +1316,7 @@ declare var ChatRoomTargetMemberNumber: number;
1316
1316
  declare var ChatRoomOwnershipOption: ChatRoomOwnershipOption;
1317
1317
  /** @type {ChatRoomLovershipOption} */
1318
1318
  declare var ChatRoomLovershipOption: ChatRoomLovershipOption;
1319
+ /** @deprecated Check whether ChatRoomData is set or not instead */
1319
1320
  declare var ChatRoomPlayerCanJoin: boolean;
1320
1321
  declare var ChatRoomMoneyForOwner: number;
1321
1322
  /** @type {number[]} */
@@ -80,6 +80,12 @@ declare function GameClubCardLoadStatus(): void;
80
80
  * @returns {string} - A string with all the cards
81
81
  */
82
82
  declare function GameClubCardDoBundle(Cards: ClubCard[], IncludeTime?: boolean): string;
83
+ /**
84
+ * Creates a bundle of cards in a string to push to the server.
85
+ * @param {ClubCard[]} Cards - An array of ClubCard objects
86
+ * @returns {string} - A string with all the cards
87
+ */
88
+ declare function GameClubCardBoardDoBundle(Cards: ClubCard[]): string;
83
89
  /**
84
90
  * Processes the club card game data received from the server
85
91
  * @param {string} Bundle - An array of c
@@ -88,6 +94,13 @@ declare function GameClubCardDoBundle(Cards: ClubCard[], IncludeTime?: boolean):
88
94
  * @returns {ClubCard[]} - A string with all the cards
89
95
  */
90
96
  declare function GameClubCardUndoBundle(Bundle: string, IncludeTime?: boolean, Location?: string): ClubCard[];
97
+ /**
98
+ * Parses a string to return an updated array of ClubCard objects.
99
+ * @param {string} bundle - A string containing all the cards
100
+ * @param {string} Location - The location of the card
101
+ * @returns {ClubCard[]} - An array of updated ClubCard objects
102
+ */
103
+ declare function GameClubCardBoardUndoBundle(bundle: string, Location: string): ClubCard[];
91
104
  /**
92
105
  * Loads the full server bundle for a player
93
106
  * @param {ClubCardPlayer} CCPlayer - The club card player
@@ -264,12 +264,22 @@ declare namespace CraftingID {
264
264
  let privateLabel: "crafting-private-label";
265
265
  let extendedButton: "crafting-extended-button";
266
266
  let extendedLabel: "crafting-extended-label";
267
+ let asciiDescriptionCheckbox: "crafting-ascii-description-checkbox";
268
+ let asciidescriptionLabel: "crafting-ascii-description-label";
269
+ }
270
+ declare namespace CraftingDescription {
271
+ let ExtendedDescriptionMarker: "\0";
272
+ let Pattern: RegExp;
273
+ let PatternASCII: RegExp;
274
+ function Decode(description: string): string;
275
+ function Encode(description: string): string;
267
276
  }
268
277
  declare namespace CraftingEventListeners {
269
278
  let _ClickPrivate: (this: HTMLInputElement, ev: Event) => void;
270
279
  let _InputLayering: (this: HTMLInputElement, ev: Event) => void;
271
280
  let _ChangeName: (this: HTMLInputElement, ev: Event) => void;
272
281
  let _ChangeDescription: (this: HTMLTextAreaElement, ev: Event) => void;
282
+ let _InputDescription: (this: HTMLTextAreaElement, ev: Event) => void;
273
283
  let _ChangeColor: (this: HTMLInputElement, ev: Event) => void;
274
284
  let _ClickExtended: (this: HTMLButtonElement, ev: Event) => void;
275
285
  let _ClickLayering: (this: HTMLButtonElement, ev: Event) => void;
@@ -285,6 +295,7 @@ declare namespace CraftingEventListeners {
285
295
  let _ClickAsset: (this: HTMLButtonElement, ev: Event) => void;
286
296
  let _ClickRadio: (this: HTMLButtonElement, ev: Event) => void;
287
297
  let _InputSearch: (this: HTMLInputElement, ev: Event) => Promise<void>;
298
+ let _ClickAsciiDescription: (this: HTMLInputElement, ev: Event) => void;
288
299
  }
289
300
  declare namespace CraftingElements {
290
301
  function _SearchInputGetDataList(controls: string): () => string[];
@@ -1129,7 +1129,7 @@ declare var PlatformDialogData: ({
1129
1129
  Answer?: undefined;
1130
1130
  } | {
1131
1131
  TextScript: () => "Is it you Melody? Are you a zombie?" | "Hey! I'm Edlaran, a wood elf, are you a zombie?";
1132
- AudioScript: () => "12" | "11";
1132
+ AudioScript: () => "11" | "12";
1133
1133
  Background?: undefined;
1134
1134
  Character?: undefined;
1135
1135
  Text?: undefined;
@@ -5,6 +5,14 @@
5
5
  * @returns {string} - The value of the element (When no value parameter was passed to the function)
6
6
  */
7
7
  declare function ElementValue(ID: string, Value?: string): string;
8
+ /**
9
+ * Disable all clickable elements within `root` for the given duration.
10
+ * @param {Element} root - The root element
11
+ * @param {null | string} [query] - The query for identifying all clickable elements within `root`
12
+ * @param {number} [timeout] - The timeout in ms
13
+ * @returns {number} - The timeout ID as returned by {@link setTimeout}
14
+ */
15
+ declare function ElementClickTimeout(root: Element, query?: null | string, timeout?: number): number;
8
16
  /**
9
17
  * Handles the content of a HTML element. It sets the content of the element when the Content parameter is provided or it returns the value when the parameter is omitted
10
18
  * @param {string} ID - The id of the element for which we want to get/set the value.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "bc-stubs",
3
- "version": "108.0.0",
3
+ "version": "109.0.0",
4
4
  "repository": {
5
5
  "type": "git",
6
6
  "url": "git+ssh://git@github.com/bananarama92/BC-stubs.git"