bc-stubs 97.0.0-beta.1 → 97.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.
Files changed (157) hide show
  1. package/LICENSE +21 -21
  2. package/README.md +18 -2
  3. package/bc/Assets/Female3DCG/Female3DCG.d.ts +41 -41
  4. package/bc/Assets/Female3DCG/Female3DCGExtended.d.ts +29 -29
  5. package/bc/Backgrounds/Backgrounds.d.ts +37 -37
  6. package/bc/Screens/Character/BackgroundSelection/BackgroundSelection.d.ts +98 -98
  7. package/bc/Screens/Character/Cheat/Cheat.d.ts +54 -54
  8. package/bc/Screens/Character/Disclaimer/Disclaimer.d.ts +21 -21
  9. package/bc/Screens/Character/InformationSheet/InformationSheet.d.ts +46 -46
  10. package/bc/Screens/Character/ItemColor/ItemColor.d.ts +232 -232
  11. package/bc/Screens/Character/OnlineProfile/OnlineProfile.d.ts +27 -27
  12. package/bc/Screens/Character/PasswordReset/PasswordReset.d.ts +28 -28
  13. package/bc/Screens/Character/Preference/Preference.d.ts +1 -0
  14. package/bc/Screens/Character/Relog/Relog.d.ts +36 -36
  15. package/bc/Screens/Character/Title/Title.d.ts +68 -68
  16. package/bc/Screens/Character/Wardrobe/Wardrobe.d.ts +93 -93
  17. package/bc/Screens/Cutscene/NPCCollaring/NPCCollaring.d.ts +26 -26
  18. package/bc/Screens/Cutscene/NPCSlaveAuction/NPCSlaveAuction.d.ts +27 -27
  19. package/bc/Screens/Cutscene/NPCWedding/NPCWedding.d.ts +35 -35
  20. package/bc/Screens/Cutscene/PlayerCollaring/PlayerCollaring.d.ts +26 -26
  21. package/bc/Screens/Cutscene/PlayerMistress/PlayerMistress.d.ts +24 -24
  22. package/bc/Screens/Cutscene/SarahIntro/SarahIntro.d.ts +22 -22
  23. package/bc/Screens/Inventory/Cloth/CheerleaderTop/CheerleaderTop.d.ts +33 -33
  24. package/bc/Screens/Inventory/ClothAccessory/Bib/Bib.d.ts +2 -2
  25. package/bc/Screens/Inventory/ItemArms/FullLatexSuit/FullLatexSuit.d.ts +6 -6
  26. package/bc/Screens/Inventory/ItemArms/HempRope/HempRope.d.ts +2 -2
  27. package/bc/Screens/Inventory/ItemArms/NylonRope/NylonRope.d.ts +2 -2
  28. package/bc/Screens/Inventory/ItemArms/PrisonLockdownSuit/PrisonLockdownSuit.d.ts +4 -4
  29. package/bc/Screens/Inventory/ItemArms/TransportJacket/TransportJacket.d.ts +10 -10
  30. package/bc/Screens/Inventory/ItemBreast/FuturisticBra/FuturisticBra.d.ts +24 -24
  31. package/bc/Screens/Inventory/ItemButt/AnalBeads2/AnalBeads2.d.ts +2 -2
  32. package/bc/Screens/Inventory/ItemButt/InflVibeButtPlug/InflVibeButtPlug.d.ts +2 -2
  33. package/bc/Screens/Inventory/ItemDevices/DollBox/DollBox.d.ts +2 -2
  34. package/bc/Screens/Inventory/ItemDevices/FuturisticCrate/FuturisticCrate.d.ts +8 -8
  35. package/bc/Screens/Inventory/ItemDevices/Kennel/Kennel.d.ts +18 -18
  36. package/bc/Screens/Inventory/ItemDevices/PetBowl/PetBowl.d.ts +6 -6
  37. package/bc/Screens/Inventory/ItemDevices/VacBedDeluxe/VacBedDeluxe.d.ts +2 -2
  38. package/bc/Screens/Inventory/ItemDevices/WoodenBox/WoodenBox.d.ts +13 -13
  39. package/bc/Screens/Inventory/ItemFeet/HempRope/HempRope.d.ts +2 -2
  40. package/bc/Screens/Inventory/ItemFeet/NylonRope/NylonRope.d.ts +2 -2
  41. package/bc/Screens/Inventory/ItemHead/DroneMask/DroneMask.d.ts +2 -2
  42. package/bc/Screens/Inventory/ItemHood/CanvasHood/CanvasHood.d.ts +6 -6
  43. package/bc/Screens/Inventory/ItemMisc/CombinationPadlock/CombinationPadlock.d.ts +16 -16
  44. package/bc/Screens/Inventory/ItemMisc/ExclusivePadlock/ExclusivePadlock.d.ts +6 -6
  45. package/bc/Screens/Inventory/ItemMisc/FamilyPadlock/FamilyPadlock.d.ts +6 -6
  46. package/bc/Screens/Inventory/ItemMisc/HighSecurityPadlock/HighSecurityPadlock.d.ts +15 -15
  47. package/bc/Screens/Inventory/ItemMisc/IntricatePadlock/IntricatePadlock.d.ts +6 -6
  48. package/bc/Screens/Inventory/ItemMisc/LoversPadlock/LoversPadlock.d.ts +6 -6
  49. package/bc/Screens/Inventory/ItemMisc/MetalPadlock/MetalPadlock.d.ts +6 -6
  50. package/bc/Screens/Inventory/ItemMisc/MistressPadlock/MistressPadlock.d.ts +6 -6
  51. package/bc/Screens/Inventory/ItemMisc/MistressTimerPadlock/MistressTimerPadlock.d.ts +13 -13
  52. package/bc/Screens/Inventory/ItemMisc/OwnerPadlock/OwnerPadlock.d.ts +6 -6
  53. package/bc/Screens/Inventory/ItemMisc/PandoraPadlock/PandoraPadlock.d.ts +6 -6
  54. package/bc/Screens/Inventory/ItemMisc/PasswordPadlock/PasswordPadlock.d.ts +17 -17
  55. package/bc/Screens/Inventory/ItemMisc/PortalLinkPadlock/PortalLinkPadlock.d.ts +6 -6
  56. package/bc/Screens/Inventory/ItemMisc/SafewordPadlock/SafewordPadlock.d.ts +12 -12
  57. package/bc/Screens/Inventory/ItemMisc/TimerPadlock/TimerPadlock.d.ts +13 -13
  58. package/bc/Screens/Inventory/ItemMisc/TimerPasswordPadlock/TimerPasswordPadlock.d.ts +13 -13
  59. package/bc/Screens/Inventory/ItemMisc/WoodenSign/WoodenSign.d.ts +2 -2
  60. package/bc/Screens/Inventory/ItemMouth/FuturisticPanelGag/FuturisticPanelGag.d.ts +49 -49
  61. package/bc/Screens/Inventory/ItemNeck/PetSuitShockCollar/PetSuitShockCollar.d.ts +32 -0
  62. package/bc/Screens/Inventory/ItemNeckAccessories/CollarNameTag/CollarNameTag.d.ts +8 -8
  63. package/bc/Screens/Inventory/ItemNeckAccessories/CustomCollarTag/CustomCollarTag.d.ts +2 -2
  64. package/bc/Screens/Inventory/ItemNeckAccessories/ElectronicTag/ElectronicTag.d.ts +2 -2
  65. package/bc/Screens/Inventory/ItemNeckRestraints/CollarLeash/CollarLeash.d.ts +4 -4
  66. package/bc/Screens/Inventory/ItemNeckRestraints/PetPost/PetPost.d.ts +2 -2
  67. package/bc/Screens/Inventory/ItemNipples/LactationPump/LactationPump.d.ts +2 -2
  68. package/bc/Screens/Inventory/ItemPelvis/FuturisticChastityBelt/FuturisticChastityBelt.d.ts +28 -28
  69. package/bc/Screens/Inventory/ItemPelvis/FuturisticTrainingBelt/FuturisticTrainingBelt.d.ts +103 -103
  70. package/bc/Screens/Inventory/ItemPelvis/SciFiPleasurePanties/SciFiPleasurePanties.d.ts +6 -6
  71. package/bc/Screens/Inventory/ItemTorso/FuturisticHarness/FuturisticHarness.d.ts +8 -8
  72. package/bc/Screens/Inventory/ItemVulva/FuturisticVibrator/FuturisticVibrator.d.ts +65 -65
  73. package/bc/Screens/Inventory/ItemVulva/LoversVibrator/LoversVibrator.d.ts +2 -2
  74. package/bc/Screens/Inventory/Wings/SteampunkWings/SteampunkWings.d.ts +16 -16
  75. package/bc/Screens/MiniGame/Chess/BondageChess.d.ts +30 -30
  76. package/bc/Screens/MiniGame/Chess/chess.d.ts +7 -7
  77. package/bc/Screens/MiniGame/ChestLockpick/ChestLockpick.d.ts +27 -27
  78. package/bc/Screens/MiniGame/DojoStruggle/DojoStruggle.d.ts +25 -25
  79. package/bc/Screens/MiniGame/GetUp/GetUp.d.ts +31 -31
  80. package/bc/Screens/MiniGame/HorseWalk/HorseWalk.d.ts +85 -85
  81. package/bc/Screens/MiniGame/MagicBattle/MagicBattle.d.ts +73 -73
  82. package/bc/Screens/MiniGame/MagicPuzzle/MagicPuzzle.d.ts +75 -75
  83. package/bc/Screens/MiniGame/MaidCleaning/MaidCleaning.d.ts +51 -51
  84. package/bc/Screens/MiniGame/MaidDrinks/MaidDrinks.d.ts +82 -82
  85. package/bc/Screens/MiniGame/PlayerAuction/PlayerAuction.d.ts +36 -36
  86. package/bc/Screens/MiniGame/PuppyWalker/PuppyWalker.d.ts +39 -39
  87. package/bc/Screens/MiniGame/RhythmGame/RhythmGame.d.ts +76 -76
  88. package/bc/Screens/MiniGame/SlaveAuction/SlaveAuction.d.ts +39 -39
  89. package/bc/Screens/MiniGame/Tennis/Tennis.d.ts +52 -52
  90. package/bc/Screens/MiniGame/Therapy/Therapy.d.ts +39 -39
  91. package/bc/Screens/MiniGame/WheelFortune/WheelFortune.d.ts +105 -105
  92. package/bc/Screens/Online/AdvancedRule/AdvancedRule.d.ts +32 -32
  93. package/bc/Screens/Online/ChatAdminRoomCustomization/ChatAdminRoomCustomization.d.ts +7 -0
  94. package/bc/Screens/Online/ChatRoom/Commands.d.ts +66 -66
  95. package/bc/Screens/Online/ForbiddenWords/ForbiddenWords.d.ts +33 -33
  96. package/bc/Screens/Online/Game/OnlineGame.d.ts +69 -69
  97. package/bc/Screens/Online/WheelFortuneCustomize/WheelFortuneCustomize.d.ts +24 -24
  98. package/bc/Screens/Room/Arcade/Arcade.d.ts +94 -94
  99. package/bc/Screens/Room/AsylumBedroom/AsylumBedroom.d.ts +16 -16
  100. package/bc/Screens/Room/Cell/Cell.d.ts +32 -32
  101. package/bc/Screens/Room/ClubCardLounge/ClubCardLounge.d.ts +28 -28
  102. package/bc/Screens/Room/CollegeCafeteria/CollegeCafeteria.d.ts +57 -57
  103. package/bc/Screens/Room/CollegeEntrance/CollegeEntrance.d.ts +54 -54
  104. package/bc/Screens/Room/CollegeTennis/CollegeTennis.d.ts +47 -47
  105. package/bc/Screens/Room/DailyJob/DailyJob.d.ts +111 -111
  106. package/bc/Screens/Room/Empty/Empty.d.ts +84 -84
  107. package/bc/Screens/Room/Gambling/Gambling.d.ts +269 -269
  108. package/bc/Screens/Room/InfiltrationPerks/InfiltrationPerks.d.ts +42 -42
  109. package/bc/Screens/Room/Magic/Magic.d.ts +199 -199
  110. package/bc/Screens/Room/MagicSchoolEscape/MagicSchoolEscape.d.ts +36 -36
  111. package/bc/Screens/Room/MagicSchoolLaboratory/MagicSchoolLaboratory.d.ts +170 -170
  112. package/bc/Screens/Room/MaidQuarters/MaidQuarters.d.ts +305 -305
  113. package/bc/Screens/Room/MainHall/MainHall.d.ts +255 -255
  114. package/bc/Screens/Room/Management/Management.d.ts +544 -544
  115. package/bc/Screens/Room/Nursery/Nursery.d.ts +85 -85
  116. package/bc/Screens/Room/PandoraPrison/PandoraPrison.d.ts +180 -180
  117. package/bc/Screens/Room/Photographic/Photographic.d.ts +53 -53
  118. package/bc/Screens/Room/PlatformDialog/PlatformDialog.d.ts +10 -0
  119. package/bc/Screens/Room/PlatformIntro/PlatformIntro.d.ts +21 -21
  120. package/bc/Screens/Room/Poker/Poker.d.ts +141 -141
  121. package/bc/Screens/Room/Poker/PokerHandValue.d.ts +65 -65
  122. package/bc/Screens/Room/Prison/Prison.d.ts +118 -118
  123. package/bc/Screens/Room/PrivateBed/PrivateBed.d.ts +78 -78
  124. package/bc/Screens/Room/PrivateRansom/PrivateRansom.d.ts +28 -28
  125. package/bc/Screens/Room/Sarah/Sarah.d.ts +162 -162
  126. package/bc/Screens/Room/Shop/Shop.d.ts +162 -162
  127. package/bc/Screens/Room/SlaveMarket/SlaveMarket.d.ts +90 -90
  128. package/bc/Scripts/Activity.d.ts +270 -270
  129. package/bc/Scripts/AfkTimer.d.ts +43 -43
  130. package/bc/Scripts/Animation.d.ts +81 -81
  131. package/bc/Scripts/CharacterName.d.ts +1 -1
  132. package/bc/Scripts/ColorPicker.d.ts +155 -155
  133. package/bc/Scripts/Common.d.ts +7 -0
  134. package/bc/Scripts/CommonDraw.d.ts +34 -34
  135. package/bc/Scripts/ControllerSupport.d.ts +107 -107
  136. package/bc/Scripts/Drawing.d.ts +581 -581
  137. package/bc/Scripts/Drawing3D.d.ts +21 -21
  138. package/bc/Scripts/DynamicDraw.d.ts +310 -310
  139. package/bc/Scripts/GLDraw.d.ts +223 -223
  140. package/bc/Scripts/Game.d.ts +61 -61
  141. package/bc/Scripts/GameLog.d.ts +87 -87
  142. package/bc/Scripts/Graph.d.ts +46 -46
  143. package/bc/Scripts/Import.d.ts +7 -7
  144. package/bc/Scripts/Inventory.d.ts +1 -1
  145. package/bc/Scripts/MiniGame.d.ts +30 -30
  146. package/bc/Scripts/Mouse.d.ts +34 -34
  147. package/bc/Scripts/NPC.d.ts +105 -105
  148. package/bc/Scripts/Notification.d.ts +120 -120
  149. package/bc/Scripts/Property.d.ts +14 -0
  150. package/bc/Scripts/Reputation.d.ts +36 -36
  151. package/bc/Scripts/Text.d.ts +92 -92
  152. package/bc/Scripts/TightenLoosenItem.d.ts +31 -31
  153. package/bc/Scripts/Validation.d.ts +324 -324
  154. package/bc/Scripts/lib/LZString.d.ts +12 -12
  155. package/bc/Typedef.d.ts +4 -1
  156. package/bc/patch.d.ts +1 -0
  157. package/package.json +3 -2
package/LICENSE CHANGED
@@ -1,21 +1,21 @@
1
- MIT License
2
-
3
- Copyright (c) 2023 bananarama92
4
-
5
- Permission is hereby granted, free of charge, to any person obtaining a copy
6
- of this software and associated documentation files (the "Software"), to deal
7
- in the Software without restriction, including without limitation the rights
8
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
- copies of the Software, and to permit persons to whom the Software is
10
- furnished to do so, subject to the following conditions:
11
-
12
- The above copyright notice and this permission notice shall be included in all
13
- copies or substantial portions of the Software.
14
-
15
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
- SOFTWARE.
1
+ MIT License
2
+
3
+ Copyright (c) 2023 bananarama92
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -1,2 +1,18 @@
1
- # BC-stubs
2
- Auto-generated .d.ts stub files for the Bondage Club game (https://gitgud.io/BondageProjects/Bondage-College).
1
+ [![npm version](https://badge.fury.io/js/bc-stubs.svg)](https://badge.fury.io/js/bc-stubs)
2
+
3
+ # BC-stubs
4
+ Auto-generated .d.ts stub files for the Bondage Club game (https://gitgud.io/BondageProjects/Bondage-College).
5
+
6
+ # Installation
7
+ To install the package one must:
8
+
9
+ 1. Install BC-Stubs either from npmjs (`npm install bc-stubs`) or directly from github (`npm install bananarama92/BC-stubs`)
10
+ 2. Ensure that the package is specified in the `include` field of tsconfig.json:
11
+
12
+ ```json
13
+ {
14
+ "include": [
15
+ "node_modules/bc-stubs/bc/**/*.d.ts"
16
+ ]
17
+ }
18
+ ```
@@ -1,41 +1,41 @@
1
- /** @type {[number, number, number, number]} */
2
- declare const AssetUpperOverflowAlpha: [number, number, number, number];
3
- /** @type {[number, number, number, number]} */
4
- declare const AssetLowerOverflowAlpha: [number, number, number, number];
5
- /**
6
- * 3D Custom Girl based assets
7
- * @type {AssetGroupDefinition[]}
8
- */
9
- declare var AssetFemale3DCG: AssetGroupDefinition[];
10
- /** 3D Custom Girl based pose
11
- * @type {Pose[]}
12
- */
13
- declare var PoseFemale3DCG: Pose[];
14
- /**
15
- * List of all available pose names in the game
16
- * @constant {AssetPoseName[]}
17
- */
18
- declare var PoseFemale3DCGNames: AssetPoseName[];
19
- /**
20
- * 3D Custom Girl based activities
21
- *
22
- * The ordering is supposed to match what body part they use, in order:
23
- * mouth, hand, feet, whole-body, head, then the item-related ones.
24
- * Inside that, they get sorted by softest to harshest, when that makes sense.
25
- *
26
- * @type {Activity[]}
27
- */
28
- declare var ActivityFemale3DCG: Activity[];
29
- /**
30
- * Display order for activities.
31
- * @type {ActivityName[]}
32
- */
33
- declare let ActivityFemale3DCGOrdering: ActivityName[];
34
- /**
35
- * 3D Custom Girl based fetishes
36
- * @type {{Name: FetishName; GetFactor(C: Character): number; }[]}
37
- */
38
- declare var FetishFemale3DCG: {
39
- Name: FetishName;
40
- GetFactor(C: Character): number;
41
- }[];
1
+ /** @type {[number, number, number, number]} */
2
+ declare const AssetUpperOverflowAlpha: [number, number, number, number];
3
+ /** @type {[number, number, number, number]} */
4
+ declare const AssetLowerOverflowAlpha: [number, number, number, number];
5
+ /**
6
+ * 3D Custom Girl based assets
7
+ * @type {AssetGroupDefinition[]}
8
+ */
9
+ declare var AssetFemale3DCG: AssetGroupDefinition[];
10
+ /** 3D Custom Girl based pose
11
+ * @type {Pose[]}
12
+ */
13
+ declare var PoseFemale3DCG: Pose[];
14
+ /**
15
+ * List of all available pose names in the game
16
+ * @constant {AssetPoseName[]}
17
+ */
18
+ declare var PoseFemale3DCGNames: AssetPoseName[];
19
+ /**
20
+ * 3D Custom Girl based activities
21
+ *
22
+ * The ordering is supposed to match what body part they use, in order:
23
+ * mouth, hand, feet, whole-body, head, then the item-related ones.
24
+ * Inside that, they get sorted by softest to harshest, when that makes sense.
25
+ *
26
+ * @type {Activity[]}
27
+ */
28
+ declare var ActivityFemale3DCG: Activity[];
29
+ /**
30
+ * Display order for activities.
31
+ * @type {ActivityName[]}
32
+ */
33
+ declare let ActivityFemale3DCGOrdering: ActivityName[];
34
+ /**
35
+ * 3D Custom Girl based fetishes
36
+ * @type {{Name: FetishName; GetFactor(C: Character): number; }[]}
37
+ */
38
+ declare var FetishFemale3DCG: {
39
+ Name: FetishName;
40
+ GetFactor(C: Character): number;
41
+ }[];
@@ -1,29 +1,29 @@
1
- /**
2
- * Female3DCGExtended.js
3
- * ---------------------
4
- * This file contains definitions and configuration for extended items. Items which are marked as Extended in
5
- * `Female3DCG.js` and which have an extended item definition here will have their load/draw/click functions
6
- * _automatically_ created when assets are loaded, saving the need for an individual extended item script.
7
- *
8
- * Currently, modular and typed items are supported, and this is likely to expand in the future.
9
- */
10
- /**
11
- * An enum encapsulating the available extended item archetypes
12
- * MODULAR - Indicates that this item is modular, with several independently configurable modules
13
- * @type {{MODULAR: "modular", TYPED: "typed", VIBRATING: "vibrating", VARIABLEHEIGHT: "variableheight", TEXT: "text"}}
14
- * @see {@link ModularItemConfig}
15
- * @see {@link TypedItemConfig}
16
- */
17
- declare const ExtendedArchetype: {
18
- MODULAR: "modular";
19
- TYPED: "typed";
20
- VIBRATING: "vibrating";
21
- VARIABLEHEIGHT: "variableheight";
22
- TEXT: "text";
23
- };
24
- /**
25
- * An object containing all extended item configurations.
26
- * @type {ExtendedItemMainConfig}
27
- * @const
28
- */
29
- declare var AssetFemale3DCGExtended: ExtendedItemMainConfig;
1
+ /**
2
+ * Female3DCGExtended.js
3
+ * ---------------------
4
+ * This file contains definitions and configuration for extended items. Items which are marked as Extended in
5
+ * `Female3DCG.js` and which have an extended item definition here will have their load/draw/click functions
6
+ * _automatically_ created when assets are loaded, saving the need for an individual extended item script.
7
+ *
8
+ * Currently, modular and typed items are supported, and this is likely to expand in the future.
9
+ */
10
+ /**
11
+ * An enum encapsulating the available extended item archetypes
12
+ * MODULAR - Indicates that this item is modular, with several independently configurable modules
13
+ * @type {{MODULAR: "modular", TYPED: "typed", VIBRATING: "vibrating", VARIABLEHEIGHT: "variableheight", TEXT: "text"}}
14
+ * @see {@link ModularItemConfig}
15
+ * @see {@link TypedItemConfig}
16
+ */
17
+ declare const ExtendedArchetype: {
18
+ MODULAR: "modular";
19
+ TYPED: "typed";
20
+ VIBRATING: "vibrating";
21
+ VARIABLEHEIGHT: "variableheight";
22
+ TEXT: "text";
23
+ };
24
+ /**
25
+ * An object containing all extended item configurations.
26
+ * @type {ExtendedItemMainConfig}
27
+ * @const
28
+ */
29
+ declare var AssetFemale3DCGExtended: ExtendedItemMainConfig;
@@ -1,37 +1,37 @@
1
- /**
2
- * Builds the selectable background arrays based on the tags supplied
3
- * @param {readonly BackgroundTag[]} BackgroundTagList - An array of string of all the tags to load
4
- * @returns {string[]} - The list of all background names
5
- */
6
- declare function BackgroundsGenerateList(BackgroundTagList: readonly BackgroundTag[]): string[];
7
- declare const BackgroundsTagNone: "Filter by tag";
8
- declare const BackgroundsTagIndoor: "Indoor";
9
- declare const BackgroundsTagOutdoor: "Outdoor";
10
- declare const BackgroundsTagAquatic: "Aquatic";
11
- declare const BackgroundsTagSpecial: "Special Events";
12
- declare const BackgroundsTagSciFiFantasy: "SciFi & Fantasy";
13
- declare const BackgroundsTagClub: "Club & College";
14
- declare const BackgroundsTagHouse: "Regular house";
15
- declare const BackgroundsTagDungeon: "Dungeon";
16
- declare const BackgroundsTagAsylum: "Asylum";
17
- /**
18
- * List of all tags to create online chat rooms
19
- * @constant
20
- * @type {BackgroundTag[]}
21
- */
22
- declare const BackgroundsTagList: BackgroundTag[];
23
- /**
24
- * List of all tags to setup your main hall or private room
25
- * @constant
26
- * @type {BackgroundTag[]}
27
- */
28
- declare const BackgroundsPrivateRoomTagList: BackgroundTag[];
29
- /**
30
- * List of all the common backgrounds.
31
- * @constant
32
- * @type {{ Name: string; Tag: BackgroundTag[]; }[]}
33
- */
34
- declare const BackgroundsList: {
35
- Name: string;
36
- Tag: BackgroundTag[];
37
- }[];
1
+ /**
2
+ * Builds the selectable background arrays based on the tags supplied
3
+ * @param {readonly BackgroundTag[]} BackgroundTagList - An array of string of all the tags to load
4
+ * @returns {string[]} - The list of all background names
5
+ */
6
+ declare function BackgroundsGenerateList(BackgroundTagList: readonly BackgroundTag[]): string[];
7
+ declare const BackgroundsTagNone: "Filter by tag";
8
+ declare const BackgroundsTagIndoor: "Indoor";
9
+ declare const BackgroundsTagOutdoor: "Outdoor";
10
+ declare const BackgroundsTagAquatic: "Aquatic";
11
+ declare const BackgroundsTagSpecial: "Special Events";
12
+ declare const BackgroundsTagSciFiFantasy: "SciFi & Fantasy";
13
+ declare const BackgroundsTagClub: "Club & College";
14
+ declare const BackgroundsTagHouse: "Regular house";
15
+ declare const BackgroundsTagDungeon: "Dungeon";
16
+ declare const BackgroundsTagAsylum: "Asylum";
17
+ /**
18
+ * List of all tags to create online chat rooms
19
+ * @constant
20
+ * @type {BackgroundTag[]}
21
+ */
22
+ declare const BackgroundsTagList: BackgroundTag[];
23
+ /**
24
+ * List of all tags to setup your main hall or private room
25
+ * @constant
26
+ * @type {BackgroundTag[]}
27
+ */
28
+ declare const BackgroundsPrivateRoomTagList: BackgroundTag[];
29
+ /**
30
+ * List of all the common backgrounds.
31
+ * @constant
32
+ * @type {{ Name: string; Tag: BackgroundTag[]; }[]}
33
+ */
34
+ declare const BackgroundsList: {
35
+ Name: string;
36
+ Tag: BackgroundTag[];
37
+ }[];
@@ -1,98 +1,98 @@
1
- /**
2
- * Change the current screen to the background selection screen
3
- * @param {string[]} List - The list of possible Background names
4
- * @param {number} Idx - The index of the current background
5
- * @param {(selection: string) => void} Callback - The function to call when a new background has been selected
6
- * @returns {void} - Nothing
7
- */
8
- declare function BackgroundSelectionMake(List: string[], Idx: number, Callback: (selection: string) => void): void;
9
- /**
10
- * Comapres two backgrounds by their description
11
- * @param {object} a - The first object to compare
12
- * @param {string} a.Description - The description of object a. Is used for comparision
13
- * @param {object} b - The second object to compar
14
- * @param {string} b.Description - The description of object b. Is used for comparision
15
- * @returns {number} - Returns -1 if the description of object a is less then that of b, 1 otherwise
16
- */
17
- declare function BackGroundSelectionSort(a: {
18
- Description: string;
19
- }, b: {
20
- Description: string;
21
- }): number;
22
- /**
23
- * Initializes the Background selection screen.
24
- * Function coiuld be called dynamically, so the body has to be there, even if it does nothing.
25
- * @returns {void} - Nothing
26
- */
27
- declare function BackgroundSelectionLoad(): void;
28
- /**
29
- * Handles input in the text box in the topmost row of the selection screen
30
- * and changes the offset of the background selection appropriately
31
- * @returns {void} - Nothing
32
- */
33
- declare function BackgroundSelectionInputChanged(): void;
34
- /**
35
- * When a new value is selected in the tag selection drop-down, we refresh the displayed background
36
- * @returns {void} - Nothing
37
- */
38
- declare function BackgroundSelectionTagChanged(): void;
39
- /**
40
- * Draws the Background selection screen:
41
- * - draws all the buttons and the text input field on the topmost rows
42
- * - paints the first (max) 12 possible backgrounds in the lower part of the screen
43
- * The function is called dynamically
44
- * @returns {void} - Nothing
45
- */
46
- declare function BackgroundSelectionRun(): void;
47
- /**
48
- * Handles clicks in the background selection screen:
49
- * - Exit: Exit the screen without changes
50
- * - Accept: Exit the screen with a new background
51
- * - Prev: Paints the previous 12 backgrounds
52
- * - Next: Paints the nextt 12 backgrounds
53
- * - Click on any background: Sets this background for selection
54
- * This function is called dynamically
55
- *
56
- * @returns {void} - Nothing
57
- */
58
- declare function BackgroundSelectionClick(): void;
59
- /**
60
- * Handles key events in the background selection screen:
61
- * - When the user presses "enter", we exit
62
- * @returns {void} - Nothing
63
- */
64
- declare function BackgroundSelectionKeyDown(): void;
65
- /**
66
- * Handles the exit of the selection screen. Sets the new background, if necessary, and
67
- * calls the previously defined callback function. Then exits the screen to the screen, the player was before
68
- * @param {boolean} SetBackground - Defines, wether the background must be changed (true) or not (false)
69
- * @returns {void} - Nothing
70
- */
71
- declare function BackgroundSelectionExit(SetBackground: boolean): void;
72
- declare var BackgroundSelectionBackground: string;
73
- /** @type {string[]} */
74
- declare var BackgroundSelectionList: string[];
75
- /** @type {BackgroundTag[]} */
76
- declare var BackgroundSelectionTagList: BackgroundTag[];
77
- declare var BackgroundSelectionIndex: number;
78
- declare var BackgroundSelectionSelect: string;
79
- declare var BackgroundSelectionSelectName: string;
80
- declare var BackgroundSelectionSize: number;
81
- declare var BackgroundSelectionOffset: number;
82
- /** @type {null | ((selection: string) => void)} */
83
- declare var BackgroundSelectionCallback: (selection: string) => void;
84
- /** @type {"" | ModuleType} */
85
- declare var BackgroundSelectionPreviousModule: "" | ModuleType;
86
- declare var BackgroundSelectionPreviousScreen: string;
87
- /** @type {{ Name: string, Description: string, Low: string }[]} */
88
- declare var BackgroundSelectionAll: {
89
- Name: string;
90
- Description: string;
91
- Low: string;
92
- }[];
93
- /** @type {{ Name: string, Description: string, Low: string }[]} */
94
- declare var BackgroundSelectionView: {
95
- Name: string;
96
- Description: string;
97
- Low: string;
98
- }[];
1
+ /**
2
+ * Change the current screen to the background selection screen
3
+ * @param {string[]} List - The list of possible Background names
4
+ * @param {number} Idx - The index of the current background
5
+ * @param {(selection: string) => void} Callback - The function to call when a new background has been selected
6
+ * @returns {void} - Nothing
7
+ */
8
+ declare function BackgroundSelectionMake(List: string[], Idx: number, Callback: (selection: string) => void): void;
9
+ /**
10
+ * Comapres two backgrounds by their description
11
+ * @param {object} a - The first object to compare
12
+ * @param {string} a.Description - The description of object a. Is used for comparision
13
+ * @param {object} b - The second object to compar
14
+ * @param {string} b.Description - The description of object b. Is used for comparision
15
+ * @returns {number} - Returns -1 if the description of object a is less then that of b, 1 otherwise
16
+ */
17
+ declare function BackGroundSelectionSort(a: {
18
+ Description: string;
19
+ }, b: {
20
+ Description: string;
21
+ }): number;
22
+ /**
23
+ * Initializes the Background selection screen.
24
+ * Function coiuld be called dynamically, so the body has to be there, even if it does nothing.
25
+ * @returns {void} - Nothing
26
+ */
27
+ declare function BackgroundSelectionLoad(): void;
28
+ /**
29
+ * Handles input in the text box in the topmost row of the selection screen
30
+ * and changes the offset of the background selection appropriately
31
+ * @returns {void} - Nothing
32
+ */
33
+ declare function BackgroundSelectionInputChanged(): void;
34
+ /**
35
+ * When a new value is selected in the tag selection drop-down, we refresh the displayed background
36
+ * @returns {void} - Nothing
37
+ */
38
+ declare function BackgroundSelectionTagChanged(): void;
39
+ /**
40
+ * Draws the Background selection screen:
41
+ * - draws all the buttons and the text input field on the topmost rows
42
+ * - paints the first (max) 12 possible backgrounds in the lower part of the screen
43
+ * The function is called dynamically
44
+ * @returns {void} - Nothing
45
+ */
46
+ declare function BackgroundSelectionRun(): void;
47
+ /**
48
+ * Handles clicks in the background selection screen:
49
+ * - Exit: Exit the screen without changes
50
+ * - Accept: Exit the screen with a new background
51
+ * - Prev: Paints the previous 12 backgrounds
52
+ * - Next: Paints the nextt 12 backgrounds
53
+ * - Click on any background: Sets this background for selection
54
+ * This function is called dynamically
55
+ *
56
+ * @returns {void} - Nothing
57
+ */
58
+ declare function BackgroundSelectionClick(): void;
59
+ /**
60
+ * Handles key events in the background selection screen:
61
+ * - When the user presses "enter", we exit
62
+ * @returns {void} - Nothing
63
+ */
64
+ declare function BackgroundSelectionKeyDown(): void;
65
+ /**
66
+ * Handles the exit of the selection screen. Sets the new background, if necessary, and
67
+ * calls the previously defined callback function. Then exits the screen to the screen, the player was before
68
+ * @param {boolean} SetBackground - Defines, wether the background must be changed (true) or not (false)
69
+ * @returns {void} - Nothing
70
+ */
71
+ declare function BackgroundSelectionExit(SetBackground: boolean): void;
72
+ declare var BackgroundSelectionBackground: string;
73
+ /** @type {string[]} */
74
+ declare var BackgroundSelectionList: string[];
75
+ /** @type {BackgroundTag[]} */
76
+ declare var BackgroundSelectionTagList: BackgroundTag[];
77
+ declare var BackgroundSelectionIndex: number;
78
+ declare var BackgroundSelectionSelect: string;
79
+ declare var BackgroundSelectionSelectName: string;
80
+ declare var BackgroundSelectionSize: number;
81
+ declare var BackgroundSelectionOffset: number;
82
+ /** @type {null | ((selection: string) => void)} */
83
+ declare var BackgroundSelectionCallback: (selection: string) => void;
84
+ /** @type {"" | ModuleType} */
85
+ declare var BackgroundSelectionPreviousModule: "" | ModuleType;
86
+ declare var BackgroundSelectionPreviousScreen: string;
87
+ /** @type {{ Name: string, Description: string, Low: string }[]} */
88
+ declare var BackgroundSelectionAll: {
89
+ Name: string;
90
+ Description: string;
91
+ Low: string;
92
+ }[];
93
+ /** @type {{ Name: string, Description: string, Low: string }[]} */
94
+ declare var BackgroundSelectionView: {
95
+ Name: string;
96
+ Description: string;
97
+ Low: string;
98
+ }[];
@@ -1,54 +1,54 @@
1
- /**
2
- * Checks if the cheats are valid
3
- * @returns {void} - Nothing
4
- */
5
- declare function CheatValidate(): void;
6
- /**
7
- * Checks if the cheat is currently active
8
- * @param {string} CheatName - Name of the cheat to check for
9
- * @returns {boolean} - Returns TRUE if the cheat is currently active
10
- */
11
- declare function CheatActive(CheatName: string): boolean;
12
- /**
13
- * Gets the factor for a given cheat. The bonus factor is added if active.
14
- * @param {string} CheatName - Name of the cheat to check for
15
- * @param {number} Factor - Bonus factor on top of the cheat
16
- * @returns {number} - The total factor for the given cheat
17
- */
18
- declare function CheatFactor(CheatName: string, Factor: number): number;
19
- /**
20
- * Imports the cheats from local storage (only works before the game is loaded)
21
- * @returns {void} - Nothing
22
- */
23
- declare function CheatImport(): void;
24
- /**
25
- * Exports the cheats to local storage. Each one is its own item.
26
- * @returns {void} - Nothing
27
- */
28
- declare function CheatExport(): void;
29
- /**
30
- * Runs and draws the cheat screen
31
- * @returns {void} - Nothing
32
- */
33
- declare function CheatRun(): void;
34
- /**
35
- * Handles clicks in the cheat screen.
36
- * @returns {void} - Nothing
37
- */
38
- declare function CheatClick(): void;
39
- /**
40
- * Handles exiting the cheat screen by saving the cheats and going back to the login screen.
41
- * @returns {void} - Nothing
42
- */
43
- declare function CheatExit(): void;
44
- declare var CheatBackground: string;
45
- declare var CheatAllow: boolean;
46
- declare var CheatList: string[];
47
- declare var CheatBonusList: string[];
48
- declare var CheatBonusFactor: number;
49
- declare var CheatBonusTime: number;
50
- /** @type {string[]} */
51
- declare var CheatActivated: string[];
52
- declare var CheatBrowserName: string;
53
- declare var CheatBrowserVersion: string;
54
- declare var CheatBrowserTime: number;
1
+ /**
2
+ * Checks if the cheats are valid
3
+ * @returns {void} - Nothing
4
+ */
5
+ declare function CheatValidate(): void;
6
+ /**
7
+ * Checks if the cheat is currently active
8
+ * @param {string} CheatName - Name of the cheat to check for
9
+ * @returns {boolean} - Returns TRUE if the cheat is currently active
10
+ */
11
+ declare function CheatActive(CheatName: string): boolean;
12
+ /**
13
+ * Gets the factor for a given cheat. The bonus factor is added if active.
14
+ * @param {string} CheatName - Name of the cheat to check for
15
+ * @param {number} Factor - Bonus factor on top of the cheat
16
+ * @returns {number} - The total factor for the given cheat
17
+ */
18
+ declare function CheatFactor(CheatName: string, Factor: number): number;
19
+ /**
20
+ * Imports the cheats from local storage (only works before the game is loaded)
21
+ * @returns {void} - Nothing
22
+ */
23
+ declare function CheatImport(): void;
24
+ /**
25
+ * Exports the cheats to local storage. Each one is its own item.
26
+ * @returns {void} - Nothing
27
+ */
28
+ declare function CheatExport(): void;
29
+ /**
30
+ * Runs and draws the cheat screen
31
+ * @returns {void} - Nothing
32
+ */
33
+ declare function CheatRun(): void;
34
+ /**
35
+ * Handles clicks in the cheat screen.
36
+ * @returns {void} - Nothing
37
+ */
38
+ declare function CheatClick(): void;
39
+ /**
40
+ * Handles exiting the cheat screen by saving the cheats and going back to the login screen.
41
+ * @returns {void} - Nothing
42
+ */
43
+ declare function CheatExit(): void;
44
+ declare var CheatBackground: string;
45
+ declare var CheatAllow: boolean;
46
+ declare var CheatList: string[];
47
+ declare var CheatBonusList: string[];
48
+ declare var CheatBonusFactor: number;
49
+ declare var CheatBonusTime: number;
50
+ /** @type {string[]} */
51
+ declare var CheatActivated: string[];
52
+ declare var CheatBrowserName: string;
53
+ declare var CheatBrowserVersion: string;
54
+ declare var CheatBrowserTime: number;
@@ -1,21 +1,21 @@
1
- /**
2
- * Loads the disclaimer screen
3
- * @returns {void} - Nothing
4
- */
5
- declare function DisclaimerLoad(): void;
6
- /**
7
- * Runs & draws the disclaimer screen
8
- * @returns {void} - Nothing
9
- */
10
- declare function DisclaimerRun(): void;
11
- /**
12
- * Handles click events in the disclaimer screen
13
- * @returns {void} - Nothing
14
- */
15
- declare function DisclaimerClick(): void;
16
- /**
17
- * Does the cleanup, if the user exits the screen
18
- * @returns {void} - Nothing
19
- */
20
- declare function DisclaimerExit(): void;
21
- declare var DisclaimerBackground: string;
1
+ /**
2
+ * Loads the disclaimer screen
3
+ * @returns {void} - Nothing
4
+ */
5
+ declare function DisclaimerLoad(): void;
6
+ /**
7
+ * Runs & draws the disclaimer screen
8
+ * @returns {void} - Nothing
9
+ */
10
+ declare function DisclaimerRun(): void;
11
+ /**
12
+ * Handles click events in the disclaimer screen
13
+ * @returns {void} - Nothing
14
+ */
15
+ declare function DisclaimerClick(): void;
16
+ /**
17
+ * Does the cleanup, if the user exits the screen
18
+ * @returns {void} - Nothing
19
+ */
20
+ declare function DisclaimerExit(): void;
21
+ declare var DisclaimerBackground: string;