bc-stubs 124.0.0-Beta.2 → 124.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.
- package/bc/NativeDeclarations/Typedef.d.ts +35 -30
- package/bc/Screens/Character/Appearance/Appearance.d.ts +2 -2
- package/bc/Screens/MiniGame/ClubCard/ClubCard.d.ts +4 -4
- package/bc/Screens/Online/ChatAdminRoomCustomization/ChatAdminRoomCustomization.d.ts +5 -0
- package/bc/Screens/Online/ChatSearch/ChatSearch.d.ts +2 -2
- package/bc/Screens/Room/MagicSchoolFindsAround/MagicSchoolFindsAround.d.ts +131 -0
- package/bc/Screens/Room/Pandora/Pandora.d.ts +4 -3
- package/bc/Scripts/Dialog.d.ts +10 -10
- package/package.json +1 -1
|
@@ -108,13 +108,13 @@ type HTMLOptions<T extends keyof HTMLElementTagNameMap> = {
|
|
|
108
108
|
/**
|
|
109
109
|
* Scalar-valued attributes that will be set on the HTML element.
|
|
110
110
|
*
|
|
111
|
-
* Note that booleans are
|
|
111
|
+
* Note that booleans are interpreted as [boolean attributes](https://developer.mozilla.org/en-US/docs/Glossary/Boolean/HTML).
|
|
112
112
|
*/
|
|
113
113
|
attributes?: Partial<Record<string, number | boolean | string>>;
|
|
114
114
|
/**
|
|
115
115
|
* Data attributes that will be set on the HTML element (see {@link HTMLElement.dataset}).
|
|
116
116
|
*
|
|
117
|
-
* Note that booleans are
|
|
117
|
+
* Note that booleans are interpreted as [boolean attributes](https://developer.mozilla.org/en-US/docs/Glossary/Boolean/HTML).
|
|
118
118
|
*/
|
|
119
119
|
dataAttributes?: Partial<Record<string, number | string | boolean>>;
|
|
120
120
|
/** CSS style declarations that will be set on the HTML element (see {@link HTMLElement.style}). */
|
|
@@ -801,7 +801,7 @@ interface ModuleScreens {
|
|
|
801
801
|
| "Introduction"
|
|
802
802
|
| "KidnapLeague"
|
|
803
803
|
| "LARP"
|
|
804
|
-
| "Magic" | "MagicSchoolEscape" | "MagicSchoolLaboratory"
|
|
804
|
+
| "Magic" | "MagicSchoolEscape" | "MagicSchoolLaboratory" | "MagicSchoolFindsAround"
|
|
805
805
|
| "MaidQuarters" | "MainHall" | "Management" | "MovieStudio" | "Nursery"
|
|
806
806
|
| "Pandora" | "PandoraPrison"
|
|
807
807
|
| "Photographic"
|
|
@@ -896,7 +896,7 @@ interface StimulationEventItem {
|
|
|
896
896
|
event: StimulationEventType;
|
|
897
897
|
/** The chance of the event occurring */
|
|
898
898
|
chance: number;
|
|
899
|
-
/** Arousal
|
|
899
|
+
/** Arousal boost from the event */
|
|
900
900
|
arousal: number;
|
|
901
901
|
}
|
|
902
902
|
|
|
@@ -912,7 +912,7 @@ interface ChatRoomChatLogEntry {
|
|
|
912
912
|
interface IChatRoomMessageMetadata {
|
|
913
913
|
/** The name of the sender character, appropriately garbled if deafened */
|
|
914
914
|
senderName?: string;
|
|
915
|
-
/** The character
|
|
915
|
+
/** The character targeted by the message */
|
|
916
916
|
TargetCharacter?: Character;
|
|
917
917
|
AdditionalTargets?: Record<number, Character>;
|
|
918
918
|
/** The character sending the message */
|
|
@@ -967,7 +967,7 @@ type ChatRoomMessageExtractor =
|
|
|
967
967
|
* A chat message handler.
|
|
968
968
|
*
|
|
969
969
|
* This is used in ChatRoomMessage to perform filtering and actions on
|
|
970
|
-
* the
|
|
970
|
+
* the received message. You can register one of those with
|
|
971
971
|
* ChatRoomRegisterMessageHandler if you need to peek at incoming messages.
|
|
972
972
|
*
|
|
973
973
|
* Message processing is done in three phases:
|
|
@@ -1841,7 +1841,7 @@ interface Character {
|
|
|
1841
1841
|
/**
|
|
1842
1842
|
* Get a copy or set the array of the last set of manually activated poses.
|
|
1843
1843
|
*
|
|
1844
|
-
* Note that these poses are by no means
|
|
1844
|
+
* Note that these poses are by no means guaranteed to be enabled, as they do not reflect any item-specific automatic pose changes (see {@link Pose}).
|
|
1845
1845
|
* @see {@link ActivePoseMapping} - The underlying record of this property, usage of which is recommended
|
|
1846
1846
|
*/
|
|
1847
1847
|
get ActivePose(): readonly AssetPoseName[];
|
|
@@ -1869,7 +1869,7 @@ interface Character {
|
|
|
1869
1869
|
/**
|
|
1870
1870
|
* A record mapping pose categories to the last manually enabled pose belonging to it.
|
|
1871
1871
|
*
|
|
1872
|
-
* Note that these poses are by no means
|
|
1872
|
+
* Note that these poses are by no means guaranteed to be enabled, as they do not reflect any item-specific automatic pose changes (see {@link PoseMapping}).
|
|
1873
1873
|
*/
|
|
1874
1874
|
ActivePoseMapping: Partial<Record<AssetPoseCategory, AssetPoseName>>;
|
|
1875
1875
|
/**
|
|
@@ -2107,6 +2107,7 @@ interface CharacterGameParameters {
|
|
|
2107
2107
|
GGTS?: GameGGTSParameters,
|
|
2108
2108
|
Poker?: GamePokerParameters,
|
|
2109
2109
|
ClubCard?: GameClubCardParameters,
|
|
2110
|
+
MagicSchoolFindsAround?: GameMagicSchoolFindsAroundParameters;
|
|
2110
2111
|
Prison? : GamePrisonParameters;
|
|
2111
2112
|
}
|
|
2112
2113
|
|
|
@@ -2776,10 +2777,10 @@ declare namespace ExtendedItemCallbacks {
|
|
|
2776
2777
|
/**
|
|
2777
2778
|
* Callback for extended item `Validate` functions.
|
|
2778
2779
|
* `Validate` functions are responsible for validating any change in an item's properties.
|
|
2779
|
-
* @param C The character that has the item
|
|
2780
|
+
* @param C The character that has the item equipped
|
|
2780
2781
|
* @param item The item in question
|
|
2781
2782
|
* @param newOption The newly selected extended item option
|
|
2782
|
-
* @param previousOption The
|
|
2783
|
+
* @param previousOption The previously selected extended item option
|
|
2783
2784
|
* @param permitExisting - Determines whether the validation should allow the new option and previous option
|
|
2784
2785
|
* to be identical. Defaults to false.
|
|
2785
2786
|
* @returns A non-empty message string if the item failed validation, or an empty string otherwise
|
|
@@ -2790,10 +2791,10 @@ declare namespace ExtendedItemCallbacks {
|
|
|
2790
2791
|
/**
|
|
2791
2792
|
* Callback for extended item `PublishAction` functions.
|
|
2792
2793
|
* `PublishAction` functions are responsible for reporting any changes to an item's properties via a chat message.
|
|
2793
|
-
* @param C The character that has the item
|
|
2794
|
+
* @param C The character that has the item equipped
|
|
2794
2795
|
* @param item The item in question
|
|
2795
2796
|
* @param newOption The newly selected extended item option
|
|
2796
|
-
* @param previousOption The
|
|
2797
|
+
* @param previousOption The previously selected extended item option
|
|
2797
2798
|
*/
|
|
2798
2799
|
type PublishAction<
|
|
2799
2800
|
OptionType extends ExtendedItemOption
|
|
@@ -2801,7 +2802,7 @@ declare namespace ExtendedItemCallbacks {
|
|
|
2801
2802
|
/**
|
|
2802
2803
|
* Callback for extended item `Init` functions.
|
|
2803
2804
|
* `Init` functions are responsible for setting the initial properties of an extended item.
|
|
2804
|
-
* @param C The character that has the item
|
|
2805
|
+
* @param C The character that has the item equipped
|
|
2805
2806
|
* @param item The item in question
|
|
2806
2807
|
* @param push Whether to push to changes to the server
|
|
2807
2808
|
* @param refresh Whether to refresh the character. This should generally be `true`, with custom script hooks being a potential exception.
|
|
@@ -2810,10 +2811,10 @@ declare namespace ExtendedItemCallbacks {
|
|
|
2810
2811
|
type Init = ExtendedItemCallback<[C: Character, item: Item, push: boolean, refresh: boolean], boolean>;
|
|
2811
2812
|
/**
|
|
2812
2813
|
* Callback for extended item `SetOption` functions.
|
|
2813
|
-
* @param C The character that has the item
|
|
2814
|
+
* @param C The character that has the item equipped
|
|
2814
2815
|
* @param item The item in question
|
|
2815
2816
|
* @param newOption The newly selected extended item option
|
|
2816
|
-
* @param previousOption The
|
|
2817
|
+
* @param previousOption The previously selected extended item option
|
|
2817
2818
|
* @param push Whether to push to changes to the server
|
|
2818
2819
|
* @param refresh Whether to refresh the character. This should generally be `true`, with custom script hooks being a potential exception.
|
|
2819
2820
|
*/
|
|
@@ -2893,10 +2894,10 @@ declare namespace ExtendedItemScriptHookCallbacks {
|
|
|
2893
2894
|
* `Validate` functions are responsible for validating any change in an item's properties.
|
|
2894
2895
|
* @param data The items extended item data
|
|
2895
2896
|
* @param originalFunction The function (if any) that is normally called when an archetypical item reaches this point
|
|
2896
|
-
* @param C The character that has the item
|
|
2897
|
+
* @param C The character that has the item equipped
|
|
2897
2898
|
* @param item The item in question
|
|
2898
2899
|
* @param newOption The newly selected extended item option
|
|
2899
|
-
* @param previousOption The
|
|
2900
|
+
* @param previousOption The previously selected extended item option
|
|
2900
2901
|
* @param permitExisting - Determines whether the validation should allow the new option and previous option
|
|
2901
2902
|
* to be identical. Defaults to false.
|
|
2902
2903
|
* @returns A non-empty message string if the item failed validation, or an empty string otherwise
|
|
@@ -2910,10 +2911,10 @@ declare namespace ExtendedItemScriptHookCallbacks {
|
|
|
2910
2911
|
* `PublishAction` functions are responsible for reporting any changes to an item's properties via a chat message.
|
|
2911
2912
|
* @param data The items extended item data
|
|
2912
2913
|
* @param originalFunction The function (if any) that is normally called when an archetypical item reaches this point
|
|
2913
|
-
* @param C The character that has the item
|
|
2914
|
+
* @param C The character that has the item equipped
|
|
2914
2915
|
* @param item The item in question
|
|
2915
2916
|
* @param newOption The newly selected extended item option
|
|
2916
|
-
* @param previousOption The
|
|
2917
|
+
* @param previousOption The previously selected extended item option
|
|
2917
2918
|
*/
|
|
2918
2919
|
type PublishAction<
|
|
2919
2920
|
DataType extends ExtendedItemData<any>,
|
|
@@ -2924,7 +2925,7 @@ declare namespace ExtendedItemScriptHookCallbacks {
|
|
|
2924
2925
|
* `Init` functions are responsible for setting the initial properties of an extended item.
|
|
2925
2926
|
* @param data The items extended item data
|
|
2926
2927
|
* @param originalFunction The function (if any) that is normally called when an archetypical item reaches this point
|
|
2927
|
-
* @param C The character that has the item
|
|
2928
|
+
* @param C The character that has the item equipped
|
|
2928
2929
|
* @param item The item in question
|
|
2929
2930
|
* @param push Whether to push to changes to the server
|
|
2930
2931
|
* @param refresh Whether to refresh the character. This should generally be `true`, with custom script hooks being a potential exception.
|
|
@@ -2937,10 +2938,10 @@ declare namespace ExtendedItemScriptHookCallbacks {
|
|
|
2937
2938
|
* Callback for extended item `SetOption` functions.
|
|
2938
2939
|
* @param data The items extended item data
|
|
2939
2940
|
* @param originalFunction The function that is normally called when an archetypical item reaches this point
|
|
2940
|
-
* @param C The character that has the item
|
|
2941
|
+
* @param C The character that has the item equipped
|
|
2941
2942
|
* @param item The item in question
|
|
2942
2943
|
* @param newOption The newly selected extended item option
|
|
2943
|
-
* @param previousOption The
|
|
2944
|
+
* @param previousOption The previously selected extended item option
|
|
2944
2945
|
* @param push Whether to push to changes to the server
|
|
2945
2946
|
* @param refresh Whether to refresh the character. This should generally be `true`, with custom script hooks being a potential exception.
|
|
2946
2947
|
* @returns
|
|
@@ -3004,7 +3005,7 @@ interface ExtendedItemData<OptionType extends ExtendedItemOption> {
|
|
|
3004
3005
|
/** A record containing various dialog keys used by the extended item screen */
|
|
3005
3006
|
dialogPrefix: ExtendedItemDialog<any, OptionType>;
|
|
3006
3007
|
/**
|
|
3007
|
-
* A
|
|
3008
|
+
* A record containing functions that are run on load, click, draw, exit, and validate, with the original archetype function
|
|
3008
3009
|
* and parameters passed on to them. If undefined, these are ignored.
|
|
3009
3010
|
* Note that scripthook functions must be loaded before `Female3DCGExtended.js` in `index.html`.
|
|
3010
3011
|
*/
|
|
@@ -3525,7 +3526,7 @@ interface ModularItemData extends ExtendedItemData<ModularItemOption> {
|
|
|
3525
3526
|
/** A lookup for the click functions for each of the item's modules */
|
|
3526
3527
|
clickFunctions: Record<string, () => void>;
|
|
3527
3528
|
/**
|
|
3528
|
-
* A
|
|
3529
|
+
* A record containing functions that are run on load, click, draw, exit, and validate, with the original archetype function
|
|
3529
3530
|
* and parameters passed on to them. If undefined, these are ignored.
|
|
3530
3531
|
* Note that scripthook functions must be loaded before `Female3DCGExtended.js` in `index.html`.
|
|
3531
3532
|
*/
|
|
@@ -3578,7 +3579,7 @@ interface TypedItemData extends ExtendedItemData<TypedItemOption> {
|
|
|
3578
3579
|
*/
|
|
3579
3580
|
chatSetting: TypedItemChatSetting;
|
|
3580
3581
|
/**
|
|
3581
|
-
* A
|
|
3582
|
+
* A record containing functions that are run on load, click, draw, exit, validate and publishaction,
|
|
3582
3583
|
* with the original archetype function and parameters passed on to them. If undefined, these are ignored.
|
|
3583
3584
|
* Note that scripthook functions must be loaded before `Female3DCGExtended.js` in `index.html`.
|
|
3584
3585
|
*/
|
|
@@ -3925,6 +3926,10 @@ interface GamePrisonParameters {
|
|
|
3925
3926
|
Role?: string;
|
|
3926
3927
|
}
|
|
3927
3928
|
|
|
3929
|
+
interface GameMagicSchoolFindsAroundParameters {
|
|
3930
|
+
KitsuneQuestProgress?: number;
|
|
3931
|
+
}
|
|
3932
|
+
|
|
3928
3933
|
//#endregion
|
|
3929
3934
|
|
|
3930
3935
|
// #region Online Games
|
|
@@ -4260,7 +4265,7 @@ interface CraftingItem {
|
|
|
4260
4265
|
MemberNumber?: number;
|
|
4261
4266
|
/** The custom item description. */
|
|
4262
4267
|
Description: string;
|
|
4263
|
-
/** The crafted item
|
|
4268
|
+
/** The crafted item property. */
|
|
4264
4269
|
Property: CraftingPropertyType;
|
|
4265
4270
|
/** The comma-separated color(s) of the item. */
|
|
4266
4271
|
Color: string;
|
|
@@ -4293,7 +4298,7 @@ interface CraftingItem {
|
|
|
4293
4298
|
*/
|
|
4294
4299
|
TypeRecord?: null | TypeRecord;
|
|
4295
4300
|
/**
|
|
4296
|
-
* Whether the crafting item is
|
|
4301
|
+
* Whether the crafting item is eligible for use.
|
|
4297
4302
|
* Only relevant if the player is the craft's owner but do they not own the underlying item (_e.g._ due to an inventory wipe).
|
|
4298
4303
|
*/
|
|
4299
4304
|
Disabled?: boolean;
|
|
@@ -4330,9 +4335,9 @@ interface CraftingItemSelected {
|
|
|
4330
4335
|
* The asset is guaranteed to satisfy `Asset.Group.Name === Asset.DynamicGroupName` _if_ any of the list members satisfy this condition.
|
|
4331
4336
|
*/
|
|
4332
4337
|
get Asset(): Asset | undefined;
|
|
4333
|
-
/** The crafted item
|
|
4338
|
+
/** The crafted item property. */
|
|
4334
4339
|
Property: CraftingPropertyType;
|
|
4335
|
-
/** The lock as
|
|
4340
|
+
/** The lock as equipped on the item or, if absent, `null`. */
|
|
4336
4341
|
Lock: Asset | null;
|
|
4337
4342
|
/** Whether the crafted item should be private or not. */
|
|
4338
4343
|
Private: boolean;
|
|
@@ -4417,7 +4422,7 @@ interface ColorGroup {
|
|
|
4417
4422
|
colorIndex: number;
|
|
4418
4423
|
}
|
|
4419
4424
|
|
|
4420
|
-
/** A fully
|
|
4425
|
+
/** A fully mutable subset of {@link ItemColorStateType} */
|
|
4421
4426
|
interface ItemColorExitState extends Pick<ItemColorStateType, "colors" | "initialColors" | "defaultColors" | "opacity" | "initialOpacity" | "defaultOpacity" | "editOpacity" > {
|
|
4422
4427
|
initialColors: string[];
|
|
4423
4428
|
initialOpacity: number[];
|
|
@@ -301,10 +301,10 @@ declare function AppearanceItemStringify(Item: readonly Item[] | Item | any): st
|
|
|
301
301
|
/**
|
|
302
302
|
* Restores a character's appearance from a serialised string generated by CharacterAppearanceStringify
|
|
303
303
|
* @param {Character} C - The character whose appearance should be restored
|
|
304
|
-
* @param {string} backup - The serialised appearance to restore
|
|
304
|
+
* @param {string | null} backup - The serialised appearance to restore
|
|
305
305
|
* @returns {void} - Nothing
|
|
306
306
|
*/
|
|
307
|
-
declare function CharacterAppearanceRestore(C: Character, backup: string): void;
|
|
307
|
+
declare function CharacterAppearanceRestore(C: Character, backup: string | null): void;
|
|
308
308
|
/**
|
|
309
309
|
* @param {string} stringified
|
|
310
310
|
* @returns {any}
|
|
@@ -80,7 +80,7 @@ declare function ClubCardMessagesMergeSteal(stealMoneyMessages: Array<{
|
|
|
80
80
|
declare function ClubCardMessageGetText(ClubCardMessage: ClubCardMessage): string;
|
|
81
81
|
/**
|
|
82
82
|
* Updated the text by mask, for InnerHTML
|
|
83
|
-
* The function finds the necessary words from the arrays and adds
|
|
83
|
+
* The function finds the necessary words from the arrays and adds color labels to them.
|
|
84
84
|
* @param {String} text -Normal Card Text
|
|
85
85
|
* @returns {String} - Updated for InnerHTML Card Text
|
|
86
86
|
*/
|
|
@@ -108,7 +108,7 @@ declare function ClubCardGetCopyCardByID(cardId: number): ClubCard;
|
|
|
108
108
|
*/
|
|
109
109
|
declare function ClubCardGenerateUniqueID(cardID: number): string;
|
|
110
110
|
/**
|
|
111
|
-
* Creates a
|
|
111
|
+
* Creates a popup in the middle of the board that pauses the game
|
|
112
112
|
* @param {string} Mode - The popup mode "DECK", "TEXT" or "YESNO"
|
|
113
113
|
* @param {string|null} Text - The text to display
|
|
114
114
|
* @param {string|null} Button1 - The label of the first button
|
|
@@ -159,7 +159,7 @@ declare function ClubCardPlayerAddMoney(CCPlayer: ClubCardPlayer, Amount: number
|
|
|
159
159
|
*/
|
|
160
160
|
declare function ClubCardPlayerAddFame(CCPlayer: ClubCardPlayer, Amount: number, CardName?: null | string): void;
|
|
161
161
|
/**
|
|
162
|
-
* Add fame from a player and remove from the
|
|
162
|
+
* Add fame from a player and remove from the other player
|
|
163
163
|
* @param {ClubCardPlayer} CCPlayer - The club card player
|
|
164
164
|
* @param {Number} moneyAmount - The money amount to steal
|
|
165
165
|
* @param {Number} fameAmount - The fame amount to steal
|
|
@@ -475,7 +475,7 @@ declare function ClubCardGetReward(): void;
|
|
|
475
475
|
declare function ClubCardRunTurnEndHandlers(CCPlayer: ClubCardPlayer, Opponent: ClubCardPlayer, Before: boolean): void;
|
|
476
476
|
/**
|
|
477
477
|
* @param {string} StartType
|
|
478
|
-
* StartType = ClubCardStartTurnType.
|
|
478
|
+
* StartType = ClubCardStartTurnType.BANKRUPT because otherwise the bankruptcy function won't work.
|
|
479
479
|
*/
|
|
480
480
|
declare function ClubCardStartTurn(StartType?: string): void;
|
|
481
481
|
/**
|
|
@@ -1,3 +1,8 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Checks whether the player is allowed to change customization settings
|
|
3
|
+
* @returns {boolean} - true if the player is allowed to change customization settings, false otherwise
|
|
4
|
+
*/
|
|
5
|
+
declare function ChatAdminRoomCustomizationCanEdit(): boolean;
|
|
1
6
|
/**
|
|
2
7
|
* Changes a customiation value from a chat room command
|
|
3
8
|
* @param {"Image" | "Filter" | "Music"} Property - The custom property to change (Image, Filter or Music)
|
|
@@ -3,9 +3,9 @@
|
|
|
3
3
|
* @param {ServerChatRoomSpace} space - Name of the chatroom space
|
|
4
4
|
* @param {ScreenSpecifier | undefined} returnScreen - Screen to go back to when exiting leaving the lobby.
|
|
5
5
|
* @param {ChatSearchLobbyOptions} [options]
|
|
6
|
-
* @returns {void} - Nothing.
|
|
6
|
+
* @returns {Promise<void>} - Nothing.
|
|
7
7
|
*/
|
|
8
|
-
declare function ChatSearchStart(space: ServerChatRoomSpace, returnScreen: ScreenSpecifier | undefined, options?: ChatSearchLobbyOptions): void
|
|
8
|
+
declare function ChatSearchStart(space: ServerChatRoomSpace, returnScreen: ScreenSpecifier | undefined, options?: ChatSearchLobbyOptions): Promise<void>;
|
|
9
9
|
declare function ChatSearchLoad(): Promise<void>;
|
|
10
10
|
declare function ChatSearchResize(load: boolean): void;
|
|
11
11
|
declare function ChatSearchUnload(): void;
|
|
@@ -0,0 +1,131 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Uncompress a string containing an appearance, then applies that appearance data to the NPC
|
|
3
|
+
* @param {NPCCharacter} C - The NPC character that loads its new appearance
|
|
4
|
+
* @returns {void} - Nothing
|
|
5
|
+
*/
|
|
6
|
+
declare function MagicSchoolFindsAroundPrepareFoundNPC(C: NPCCharacter): void;
|
|
7
|
+
declare function MagicSchoolFindsAroundLoad(): Promise<void>;
|
|
8
|
+
/**
|
|
9
|
+
* Runs the room
|
|
10
|
+
* @returns {void} - Nothing
|
|
11
|
+
*/
|
|
12
|
+
declare function MagicSchoolFindsAroundRun(): void;
|
|
13
|
+
/**
|
|
14
|
+
* Handles the click events. Called from CommonClick()
|
|
15
|
+
* @returns {void} - Nothing
|
|
16
|
+
*/
|
|
17
|
+
declare function MagicSchoolFindsAroundClick(): void;
|
|
18
|
+
/**
|
|
19
|
+
* Sets a boolean flag on the player to indicate they have learned about the prizes
|
|
20
|
+
* @returns {void} - Nothing
|
|
21
|
+
*/
|
|
22
|
+
declare function MagicSchoolFindsAroundLearnAboutPrizes(): void;
|
|
23
|
+
/**
|
|
24
|
+
* Starts a magic battle with the Kitsune NPC
|
|
25
|
+
* @returns {void} - Nothing
|
|
26
|
+
*/
|
|
27
|
+
declare function MagicSchoolFindsAroundMagicBattleStart(): void;
|
|
28
|
+
/**
|
|
29
|
+
* When the magic battle practice ends
|
|
30
|
+
* @returns {Promise<void>} - Nothing
|
|
31
|
+
*/
|
|
32
|
+
declare function MagicSchoolFindsAroundKitsuneMagicBattleEnd(): Promise<void>;
|
|
33
|
+
/**
|
|
34
|
+
* When the player starts a club card game
|
|
35
|
+
* @returns {void} - Nothing
|
|
36
|
+
*/
|
|
37
|
+
declare function MagicSchoolFindsAroundClubCardStart(): void;
|
|
38
|
+
/**
|
|
39
|
+
* When the player ends a club card game
|
|
40
|
+
* @returns {void} - Nothing
|
|
41
|
+
*/
|
|
42
|
+
declare function MagicSchoolFindsAroundClubCardEnd(): void;
|
|
43
|
+
/**
|
|
44
|
+
* Run out of the Findings room
|
|
45
|
+
* @returns {void} - Nothing
|
|
46
|
+
*/
|
|
47
|
+
declare function MagicSchoolFindsAroundRunAway(): void;
|
|
48
|
+
/**
|
|
49
|
+
* Run out of the Findings room and reset NPC
|
|
50
|
+
* @returns {void} - Nothing
|
|
51
|
+
*/
|
|
52
|
+
declare function MagicSchoolFindsAroundRunAwayEnd(): void;
|
|
53
|
+
/**
|
|
54
|
+
* Starts the quest to gather essences
|
|
55
|
+
* @returns {void} - Nothing
|
|
56
|
+
*/
|
|
57
|
+
declare function MagicSchoolFindsAroundStartQuest(): void;
|
|
58
|
+
/**
|
|
59
|
+
* Return the current progress of the quest
|
|
60
|
+
* @returns {number}
|
|
61
|
+
*/
|
|
62
|
+
declare function MagicSchoolFindsAroundKitsuneGetQuestProgress(): number;
|
|
63
|
+
/**
|
|
64
|
+
* Quest in-progress?
|
|
65
|
+
* @returns {boolean} - True if in progress
|
|
66
|
+
*/
|
|
67
|
+
declare function MagicSchoolFindsAroundQuestStarted(): boolean;
|
|
68
|
+
/**
|
|
69
|
+
* Quest completed?
|
|
70
|
+
* @returns {boolean} - True if completed
|
|
71
|
+
*/
|
|
72
|
+
declare function MagicSchoolFindsAroundQuestCompleted(): boolean;
|
|
73
|
+
/**
|
|
74
|
+
* Returns the fully initialized and validated parameters for the FindsAround game
|
|
75
|
+
* @returns {Required<GameMagicSchoolFindsAroundParameters>} - Nothing
|
|
76
|
+
*/
|
|
77
|
+
declare function MagicSchoolFindsAroundGetData(): Required<GameMagicSchoolFindsAroundParameters>;
|
|
78
|
+
/**
|
|
79
|
+
* Gives the player the reward tails
|
|
80
|
+
* @returns {void} - Nothing
|
|
81
|
+
*/
|
|
82
|
+
declare function MagicSchoolFindsAroundGiveTails(): void;
|
|
83
|
+
/** Hide the NPC
|
|
84
|
+
* @returns {void} - Nothing
|
|
85
|
+
*/
|
|
86
|
+
declare function MagicSchoolFindsAroundHideNPC(): void;
|
|
87
|
+
/**
|
|
88
|
+
* Triggered when the player lost and get ungagged by the Kitsune, can affect reputation
|
|
89
|
+
* @param {string} RepChange
|
|
90
|
+
* @returns {void} - Nothing
|
|
91
|
+
*/
|
|
92
|
+
declare function MagicSchoolFindsAroundUngagPlayer(RepChange: string): void;
|
|
93
|
+
/**
|
|
94
|
+
* When the player lost a battle and the Kitsune tests a spell on her
|
|
95
|
+
* @param {string} RepChange
|
|
96
|
+
* @returns {void} - Nothing
|
|
97
|
+
*/
|
|
98
|
+
declare function MagicSchoolFindsAroundLoserSpell(RepChange: string): void;
|
|
99
|
+
/**
|
|
100
|
+
* Triggered when the player lost and get untied by the Kitsune, can affect reputation
|
|
101
|
+
* @param {string} RepChange
|
|
102
|
+
* @returns {void} - Nothing
|
|
103
|
+
*/
|
|
104
|
+
declare function MagicSchoolFindsAroundReleasePlayer(RepChange: string): void;
|
|
105
|
+
/**
|
|
106
|
+
* Returns the player in the main hall in her current bondage
|
|
107
|
+
* @returns {void} - Nothing
|
|
108
|
+
*/
|
|
109
|
+
declare function MagicSchoolFindsAroundPlayerMainHall(): void;
|
|
110
|
+
/**
|
|
111
|
+
* Magic School Finds Around Kitsune Quest in progress?
|
|
112
|
+
* True if started but not completed (0–8)
|
|
113
|
+
* @returns {boolean}
|
|
114
|
+
*/
|
|
115
|
+
declare function DialogKitsuneQuestInProgress(): boolean;
|
|
116
|
+
/**
|
|
117
|
+
* Update the Kitsune NPC's quest status as it progresses
|
|
118
|
+
* @returns {void} - Nothing
|
|
119
|
+
*/
|
|
120
|
+
declare function MagicSchoolLaboratoryKitsuneQuestUpdate(): void;
|
|
121
|
+
/**
|
|
122
|
+
* Give player essence from defeated student
|
|
123
|
+
* @param {string} Amount - The amount of essence to give
|
|
124
|
+
* @returns {void} - Nothing
|
|
125
|
+
*/
|
|
126
|
+
declare function DialogKitsuneGiveEssence(Amount: string): void;
|
|
127
|
+
declare var MagicSchoolFindsAroundBackground: string;
|
|
128
|
+
/** @type {NPCCharacter} */
|
|
129
|
+
declare var MagicSchoolFindsAroundKitsune: NPCCharacter;
|
|
130
|
+
declare var MagicSchoolFindsAroundSpellCount: number;
|
|
131
|
+
declare var MagicSchoolFindsAroundLastSpell: string;
|
|
@@ -296,11 +296,12 @@ declare function PandoraPenitentiaryIsGuard(C: Character): boolean;
|
|
|
296
296
|
*/
|
|
297
297
|
declare function PandoraPenitentiaryCreate(): void;
|
|
298
298
|
/**
|
|
299
|
-
*
|
|
300
|
-
*
|
|
299
|
+
* Intercept chat results and auto-join Pandora room if currently in the Penitentiary
|
|
300
|
+
* This function expects to only be called with the ChatSearch screen running
|
|
301
|
+
* @param {ServerChatRoomSearchResultResponse} Result - The result of the search
|
|
301
302
|
* @returns {void} - Nothing
|
|
302
303
|
*/
|
|
303
|
-
declare function PandoraPenitentiaryResult(Result:
|
|
304
|
+
declare function PandoraPenitentiaryResult(Result: ServerChatRoomSearchResultResponse): void;
|
|
304
305
|
/**
|
|
305
306
|
* Returns TRUE if the group is available for an Onlin Pandora Prison activity
|
|
306
307
|
* @param {Character} C - The character to evaluate
|
package/bc/Scripts/Dialog.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Returns character based on argument
|
|
3
|
-
* @param {Character | string} C - The
|
|
3
|
+
* @param {Character | string} C - The character to get; can be `"Player"` to get player or empty to get current
|
|
4
4
|
* @returns {Character} - The actual character
|
|
5
5
|
*/
|
|
6
6
|
declare function DialogGetCharacter(C: Character | string): Character;
|
|
@@ -190,7 +190,7 @@ declare function DialogSkillGreater(SkillType: SkillType, Value: string): boolea
|
|
|
190
190
|
declare function DialogInventoryAvailable(InventoryName: string, InventoryGroup: AssetGroupName): boolean;
|
|
191
191
|
/**
|
|
192
192
|
* Checks, if the player is the administrator of the current chat room
|
|
193
|
-
* @returns {boolean} - Returns true, if the player
|
|
193
|
+
* @returns {boolean} - Returns true, if the player belongs to the group of administrators for the current char room false otherwise
|
|
194
194
|
*/
|
|
195
195
|
declare function DialogChatRoomPlayerIsAdmin(): boolean;
|
|
196
196
|
/**
|
|
@@ -324,7 +324,7 @@ declare function DialogAllowItemScreenException(): boolean;
|
|
|
324
324
|
*/
|
|
325
325
|
declare function DialogIntro(C: Character): string;
|
|
326
326
|
/**
|
|
327
|
-
* Generic dialog function to leave conversation. De-
|
|
327
|
+
* Generic dialog function to leave conversation. De-initializes global variables and reverts the
|
|
328
328
|
* FocusGroup of the player and the current character to null
|
|
329
329
|
* @param {null | DialogLeave.Options} options - Further customization options
|
|
330
330
|
* @returns {void} - Nothing
|
|
@@ -517,7 +517,7 @@ declare function DialogMenuButtonClick(): boolean;
|
|
|
517
517
|
declare function DialogPublishAction(C: Character, Action: string, ClickItem: Item): void;
|
|
518
518
|
/**
|
|
519
519
|
* Returns TRUE if the clicked item can be processed, make sure it's not the same item as the one already used
|
|
520
|
-
* @param {Item} CurrentItem - The item currently
|
|
520
|
+
* @param {Item} CurrentItem - The item currently equipped
|
|
521
521
|
* @param {Item} ClickItem - The clicked item
|
|
522
522
|
* @returns {boolean} - TRUE when we can process
|
|
523
523
|
*/
|
|
@@ -641,7 +641,7 @@ declare function DialogStatusClear(): void;
|
|
|
641
641
|
*/
|
|
642
642
|
declare function DialogExtendItem(Item: Item, SourceItem?: Item): void;
|
|
643
643
|
/**
|
|
644
|
-
* Shows the
|
|
644
|
+
* Shows the tighten/loosen item menu for a given item, if possible.
|
|
645
645
|
* @param {Item} Item - The item to open the menu for
|
|
646
646
|
* @returns {void} - Nothing
|
|
647
647
|
*/
|
|
@@ -680,7 +680,7 @@ declare function DialogIsMenuButtonDisabled(ButtonName: DialogMenuButton): boole
|
|
|
680
680
|
declare function DialogFindPlayer(KeyWord: string): string;
|
|
681
681
|
/**
|
|
682
682
|
* Searches in the dialog for a specific stage keyword and returns that dialog option if we find it
|
|
683
|
-
* @param {Character} C - The character whose dialog
|
|
683
|
+
* @param {Character} C - The character whose dialog option*
|
|
684
684
|
* @param {string} KeyWord1 - The key word to search for
|
|
685
685
|
* @param {string} [KeyWord2] - An optionally given second key word. is only looked for, if specified and the first
|
|
686
686
|
* keyword was not found.
|
|
@@ -938,7 +938,7 @@ declare class DialogMenu<ModeType extends string = string, ClickedObj = any, Pro
|
|
|
938
938
|
*/
|
|
939
939
|
constructor(mode: ModeType);
|
|
940
940
|
/**
|
|
941
|
-
* An object
|
|
941
|
+
* An object containing all DOM element IDs referenced in the {@link DialogMenu} subclass.
|
|
942
942
|
* @abstract
|
|
943
943
|
* @readonly
|
|
944
944
|
* @type {Readonly<Record<string, string> & { root: string, status?: string, grid?: string, paginate?: string, icon?: string, menubar?: string }>}
|
|
@@ -967,7 +967,7 @@ declare class DialogMenu<ModeType extends string = string, ClickedObj = any, Pro
|
|
|
967
967
|
*/
|
|
968
968
|
_initProperties: null | PropType;
|
|
969
969
|
/**
|
|
970
|
-
* An object
|
|
970
|
+
* An object containing all event listeners referenced in the {@link DialogMenu} subclass.
|
|
971
971
|
* @readonly
|
|
972
972
|
* @satisfies {Record<string, (this: HTMLElement, ev: Event) => any>}
|
|
973
973
|
*/
|
|
@@ -1046,7 +1046,7 @@ declare class DialogMenu<ModeType extends string = string, ClickedObj = any, Pro
|
|
|
1046
1046
|
*/
|
|
1047
1047
|
private _reloadHighestID;
|
|
1048
1048
|
/**
|
|
1049
|
-
* Promise object for queuing reloads, ensuring that they are run consecutively rather than concurrently if multiple calls are invoked (near)
|
|
1049
|
+
* Promise object for queuing reloads, ensuring that they are run consecutively rather than concurrently if multiple calls are invoked (near) simultaneously.
|
|
1050
1050
|
* See {@link DialogMenu.Reload}
|
|
1051
1051
|
* @private
|
|
1052
1052
|
* @type {Promise<boolean>}
|
|
@@ -1157,7 +1157,7 @@ declare class DialogMenu<ModeType extends string = string, ClickedObj = any, Pro
|
|
|
1157
1157
|
*/
|
|
1158
1158
|
_GetClickedObject(button: HTMLButtonElement): ClickedObj | undefined;
|
|
1159
1159
|
/**
|
|
1160
|
-
* Helper function for handling the clicks of
|
|
1160
|
+
* Helper function for handling the clicks of successfully validated grid button clicks.
|
|
1161
1161
|
* @abstract
|
|
1162
1162
|
* @param {HTMLButtonElement} button - The clicked button
|
|
1163
1163
|
* @param {Character} C - The target character
|