bc-stubs 126.0.0 → 127.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 (127) hide show
  1. package/bc/NativeDeclarations/Female3DCG_Types.d.ts +15 -6
  2. package/bc/NativeDeclarations/FriendList.d.ts +3 -1
  3. package/bc/NativeDeclarations/Messages.d.ts +7 -2
  4. package/bc/NativeDeclarations/Typedef.d.ts +218 -62
  5. package/bc/Screens/Character/Appearance/Appearance.d.ts +5 -5
  6. package/bc/Screens/Character/BackgroundSelection/BackgroundSelection.d.ts +10 -4
  7. package/bc/Screens/Character/Disclaimer/Disclaimer.d.ts +10 -0
  8. package/bc/Screens/Character/FriendList/FriendList.d.ts +3 -3
  9. package/bc/Screens/Character/InformationSheet/InformationSheet.d.ts +6 -1
  10. package/bc/Screens/Character/Login/Login.d.ts +4 -4
  11. package/bc/Screens/Character/OnlineProfile/OnlineProfile.d.ts +2 -2
  12. package/bc/Screens/Character/Preference/Arousal.d.ts +10 -4
  13. package/bc/Screens/Character/Preference/Difficulty.d.ts +37 -0
  14. package/bc/Screens/Character/Preference/Gender.d.ts +15 -19
  15. package/bc/Screens/Character/Preference/Graphics.d.ts +9 -6
  16. package/bc/Screens/Character/Preference/Keybindings.d.ts +1 -1
  17. package/bc/Screens/Character/Preference/Online.d.ts +2 -2
  18. package/bc/Screens/Character/Preference/Preference.d.ts +10 -14
  19. package/bc/Screens/Character/Preference/Scripts.d.ts +38 -3
  20. package/bc/Screens/Character/Preference/Visibility.d.ts +6 -3
  21. package/bc/Screens/Character/Title/Title.d.ts +5 -2
  22. package/bc/Screens/Inventory/BodyMarkings/BodyWritings/BodyWritings.d.ts +1 -1
  23. package/bc/Screens/Inventory/Cloth/CheerleaderTop/CheerleaderTop.d.ts +13 -13
  24. package/bc/Screens/Inventory/ClothAccessory/Bib/Bib.d.ts +1 -1
  25. package/bc/Screens/Inventory/FaceMarkings/FaceWritings/FaceWritings.d.ts +1 -1
  26. package/bc/Screens/Inventory/Futuristic/Futuristic.d.ts +4 -4
  27. package/bc/Screens/Inventory/ItemArms/HempRope/HempRope.d.ts +1 -1
  28. package/bc/Screens/Inventory/ItemArms/NylonRope/NylonRope.d.ts +1 -1
  29. package/bc/Screens/Inventory/ItemArms/TransportJacket/TransportJacket.d.ts +3 -3
  30. package/bc/Screens/Inventory/ItemBreast/ForbiddenChastityBra/ForbiddenChastityBra.d.ts +1 -1
  31. package/bc/Screens/Inventory/ItemButt/AnalBeads2/AnalBeads2.d.ts +1 -1
  32. package/bc/Screens/Inventory/ItemDevices/DollBox/DollBox.d.ts +1 -1
  33. package/bc/Screens/Inventory/ItemDevices/FuckMachine/FuckMachine.d.ts +2 -2
  34. package/bc/Screens/Inventory/ItemDevices/FuturisticCrate/FuturisticCrate.d.ts +1 -1
  35. package/bc/Screens/Inventory/ItemDevices/KabeshiriWall/KabeshiriWall.d.ts +3 -3
  36. package/bc/Screens/Inventory/ItemDevices/LuckyWheel/LuckyWheel.d.ts +1 -1
  37. package/bc/Screens/Inventory/ItemDevices/PetBowl/PetBowl.d.ts +1 -1
  38. package/bc/Screens/Inventory/ItemDevices/WoodenBox/WoodenBox.d.ts +3 -3
  39. package/bc/Screens/Inventory/ItemFeet/HempRope/HempRope.d.ts +1 -1
  40. package/bc/Screens/Inventory/ItemFeet/NylonRope/NylonRope.d.ts +1 -1
  41. package/bc/Screens/Inventory/ItemHandheld/Plushies/Plushies.d.ts +1 -1
  42. package/bc/Screens/Inventory/ItemHead/DroneMask/DroneMask.d.ts +2 -2
  43. package/bc/Screens/Inventory/ItemHood/CanvasHood/CanvasHood.d.ts +1 -1
  44. package/bc/Screens/Inventory/ItemMisc/CombinationPadlock/CombinationPadlock.d.ts +5 -8
  45. package/bc/Screens/Inventory/ItemMisc/HighSecurityPadlock/HighSecurityPadlock.d.ts +1 -1
  46. package/bc/Screens/Inventory/ItemMisc/PasswordPadlock/PasswordPadlock.d.ts +1 -1
  47. package/bc/Screens/Inventory/ItemMisc/WoodenSign/WoodenSign.d.ts +1 -1
  48. package/bc/Screens/Inventory/ItemMouth/FuturisticPanelGag/FuturisticPanelGag.d.ts +3 -3
  49. package/bc/Screens/Inventory/ItemNeck/FuturisticCollar/FuturisticCollar.d.ts +1 -1
  50. package/bc/Screens/Inventory/ItemNeckAccessories/CollarAutoShockUnit/CollarAutoShockUnit.d.ts +2 -2
  51. package/bc/Screens/Inventory/ItemNeckAccessories/CollarNameTag/CollarNameTag.d.ts +1 -1
  52. package/bc/Screens/Inventory/ItemNeckAccessories/CollarShockUnit/CollarShockUnit.d.ts +2 -2
  53. package/bc/Screens/Inventory/ItemNeckAccessories/CustomCollarTag/CustomCollarTag.d.ts +1 -1
  54. package/bc/Screens/Inventory/ItemNeckAccessories/ElectronicTag/ElectronicTag.d.ts +1 -1
  55. package/bc/Screens/Inventory/ItemNeckRestraints/CollarLeash/CollarLeash.d.ts +3 -3
  56. package/bc/Screens/Inventory/ItemNeckRestraints/PetPost/PetPost.d.ts +1 -1
  57. package/bc/Screens/Inventory/ItemNipples/LactationPump/LactationPump.d.ts +2 -2
  58. package/bc/Screens/Inventory/ItemPelvis/FuturisticTrainingBelt/FuturisticTrainingBelt.d.ts +2 -2
  59. package/bc/Screens/Inventory/ItemPelvis/LoveChastityBelt/LoveChastityBelt.d.ts +2 -2
  60. package/bc/Screens/Inventory/ItemPelvis/ModularChastityBelt/ModularChastityBelt.d.ts +3 -3
  61. package/bc/Screens/Inventory/ItemPelvis/ObedienceBelt/ObedienceBelt.d.ts +1 -1
  62. package/bc/Screens/Inventory/ItemPelvis/SciFiPleasurePanties/SciFiPleasurePanties.d.ts +1 -1
  63. package/bc/Screens/Inventory/ItemVulva/ClitAndDildoVibratorbelt/ClitAndDildoVibratorbelt.d.ts +1 -1
  64. package/bc/Screens/Inventory/ItemVulva/FuturisticVibrator/FuturisticVibrator.d.ts +2 -2
  65. package/bc/Screens/Inventory/Suit/LatexCatsuit/LatexCatsuit.d.ts +3 -3
  66. package/bc/Screens/MiniGame/Chess/chess.d.ts +2 -2
  67. package/bc/Screens/MiniGame/ChestLockpick/ChestLockpick.d.ts +2 -2
  68. package/bc/Screens/MiniGame/ClubCard/ClubCard.d.ts +6 -6
  69. package/bc/Screens/MiniGame/ClubCardBuilder/ClubCardBuilder.d.ts +4 -16
  70. package/bc/Screens/MiniGame/WheelFortune/WheelFortune.d.ts +4 -24
  71. package/bc/Screens/Online/ChatRoom/ChatRoom.d.ts +15 -15
  72. package/bc/Screens/Online/ChatRoom/ChatRoomCharacterView.d.ts +2 -9
  73. package/bc/Screens/Online/ChatRoom/ChatRoomMapView.d.ts +1 -1
  74. package/bc/Screens/Online/ChatRoom/Commands.d.ts +8 -8
  75. package/bc/Screens/Online/ChatSearch/ChatSearch.d.ts +14 -11
  76. package/bc/Screens/Online/GameClubCard/GameClubCard.d.ts +2 -2
  77. package/bc/Screens/Online/NicknameManagement/NicknameManagement.d.ts +2 -2
  78. package/bc/Screens/Online/WheelFortuneCustomize/WheelFortuneCustomize.d.ts +3 -10
  79. package/bc/Screens/Room/Arcade/Arcade.d.ts +1 -1
  80. package/bc/Screens/Room/AsylumGGTS/AsylumGGTS.d.ts +2 -3
  81. package/bc/Screens/Room/Crafting/Crafting.d.ts +1 -19
  82. package/bc/Screens/Room/Crafting/CraftingJSON.d.ts +1 -1
  83. package/bc/Screens/Room/Crafting/CraftingSlot.d.ts +109 -0
  84. package/bc/Screens/Room/Empty/Empty.d.ts +1 -1
  85. package/bc/Screens/Room/Gambling/Gambling.d.ts +1 -1
  86. package/bc/Screens/Room/MagicSchoolFindsAround/MagicSchoolFindsAround.d.ts +119 -52
  87. package/bc/Screens/Room/MagicSchoolLaboratory/MagicSchoolLaboratory.d.ts +11 -1
  88. package/bc/Screens/Room/Management/Management.d.ts +1 -1
  89. package/bc/Screens/Room/Nursery/Nursery.d.ts +2 -2
  90. package/bc/Screens/Room/Pandora/Pandora.d.ts +2 -2
  91. package/bc/Screens/Room/Photographic/Photographic.d.ts +1 -1
  92. package/bc/Screens/Room/Platform/Platform.d.ts +9 -19
  93. package/bc/Screens/Room/PlatformDialog/PlatformDialog.d.ts +11 -10
  94. package/bc/Screens/Room/Prison/Prison.d.ts +2 -2
  95. package/bc/Screens/Room/Private/Private.d.ts +2 -2
  96. package/bc/Screens/Room/Shop2/Shop2.d.ts +3 -3
  97. package/bc/Screens/Room/Stable/Stable.d.ts +8 -8
  98. package/bc/Scripts/Activity.d.ts +12 -11
  99. package/bc/Scripts/Animation.d.ts +19 -24
  100. package/bc/Scripts/Audio.d.ts +7 -7
  101. package/bc/Scripts/Character.d.ts +16 -15
  102. package/bc/Scripts/ColorPicker.d.ts +1 -10
  103. package/bc/Scripts/Common.d.ts +65 -15
  104. package/bc/Scripts/CommonDraw.d.ts +3 -3
  105. package/bc/Scripts/ControllerSupport.d.ts +1 -1
  106. package/bc/Scripts/Dialog.d.ts +68 -67
  107. package/bc/Scripts/DictionaryBuilder.d.ts +2 -1
  108. package/bc/Scripts/Drawing.d.ts +38 -15
  109. package/bc/Scripts/DynamicDraw.d.ts +19 -19
  110. package/bc/Scripts/Element.d.ts +56 -40
  111. package/bc/Scripts/ExtendedItem.d.ts +9 -9
  112. package/bc/Scripts/Game.d.ts +20 -24
  113. package/bc/Scripts/GameLog.d.ts +2 -2
  114. package/bc/Scripts/Inventory.d.ts +31 -31
  115. package/bc/Scripts/KeybindingManager.d.ts +2 -2
  116. package/bc/Scripts/Layering.d.ts +1 -1
  117. package/bc/Scripts/ModularItem.d.ts +2 -2
  118. package/bc/Scripts/Notification.d.ts +1 -1
  119. package/bc/Scripts/PortalLink.d.ts +3 -3
  120. package/bc/Scripts/Preference.d.ts +3 -12
  121. package/bc/Scripts/Server.d.ts +82 -33
  122. package/bc/Scripts/Struggle.d.ts +7 -7
  123. package/bc/Scripts/Text.d.ts +13 -0
  124. package/bc/Scripts/TextItem.d.ts +4 -4
  125. package/bc/Scripts/VibratorMode.d.ts +1 -1
  126. package/bc/Scripts/lib/LZString.d.ts +6 -6
  127. package/package.json +3 -2
@@ -11,6 +11,8 @@ interface Fetish {
11
11
  GetFactor(C: Character): number;
12
12
  }
13
13
 
14
+ type BodyStyle = "EchoV1" | "EchoV2" | AssetGroupName;
15
+
14
16
  /** Types for representing the left/top coordinate of a target draw rect. */
15
17
  declare namespace TopLeft {
16
18
  /**
@@ -405,7 +407,7 @@ interface AssetGroupDefinitionBase extends AssetCommonPropertiesGroupAsset, Asse
405
407
  MirrorActivitiesFrom?: AssetGroupItemName;
406
408
 
407
409
  /**
408
- * The group actually recieving arousal events
410
+ * The group actually receiving arousal events
409
411
  *
410
412
  * Used to proxy around a group that does not have activities
411
413
  * enabled (and thus arousal settings.
@@ -522,7 +524,7 @@ interface AssetDefinitionBase extends AssetCommonPropertiesGroupAsset, AssetComm
522
524
  NotVisibleOnScreen?: string[];
523
525
 
524
526
  /** Specify body type overrides that live in the asset override folder */
525
- StyleOverride?: string[];
527
+ StyleOverride?: BodyStyle[];
526
528
  CreateLayerTypesOverride?: number[];
527
529
 
528
530
  DrawOffset?: {
@@ -631,6 +633,12 @@ interface AssetDefinitionBase extends AssetCommonPropertiesGroupAsset, AssetComm
631
633
  MaxTimer?: number;
632
634
 
633
635
  Height?: number;
636
+ /**
637
+ * The height of the character as set in the special `Height` appearance group.
638
+ *
639
+ * Is represented by a number in the `[0.9, 1.0]` interval.
640
+ * @default 1.0
641
+ */
634
642
  Zoom?: number;
635
643
  Prerequisite?: AssetPrerequisite | AssetPrerequisite[];
636
644
  Extended?: boolean;
@@ -766,6 +774,7 @@ declare namespace AssetDefinition {
766
774
  /** An {@link AssetDefinition} subtype for assets whose group is of the `Item` category. */
767
775
  interface Item extends AssetDefinitionBase {
768
776
  BodyCosplay?: false;
777
+ Zoom?: never;
769
778
  }
770
779
  /** An {@link AssetDefinition} subtype for assets whose group is of the `Appearance` category. */
771
780
  interface Appearance extends AssetDefinitionBase {
@@ -880,7 +889,7 @@ interface AssetLayerDefinition extends AssetCommonPropertiesGroupAssetLayer, Ass
880
889
  /**
881
890
  * Specify body type overrides that live in the asset override folder
882
891
  */
883
- StyleOverride?: string[];
892
+ StyleOverride?: BodyStyle[];
884
893
  CreateLayerTypesOverride?: number[];
885
894
 
886
895
  MirrorExpression?: AssetGroupName;
@@ -937,7 +946,7 @@ interface ExtendedItemConfig<OptionType extends ExtendedItemOption> {
937
946
  /** A record containing various dialog keys used by the extended item screen */
938
947
  DialogPrefix?: ExtendedItemCapsDialog<any, OptionType>;
939
948
  /**
940
- * A recond containing functions that are run on load, click, draw, exit, and validate, with the original archetype function
949
+ * A record containing functions that are run on load, click, draw, exit, and validate, with the original archetype function
941
950
  * and parameters passed on to them. If undefined, these are ignored.
942
951
  * Note that scripthook functions must be loaded before `Female3DCGExtended.js` in `index.html`.
943
952
  */
@@ -1138,7 +1147,7 @@ interface TypedItemConfig extends ExtendedItemConfig<TypedItemOption> {
1138
1147
  */
1139
1148
  ChangeWhenLocked?: boolean;
1140
1149
  /**
1141
- * A recond containing functions that are run on load, click, draw, exit, validate and publishaction,
1150
+ * A record containing functions that are run on load, click, draw, exit, validate and publishaction,
1142
1151
  * with the original archetype function and parameters passed on to them. If undefined, these are ignored.
1143
1152
  * Note that scripthook functions must be loaded before `Female3DCGExtended.js` in `index.html`.
1144
1153
  */
@@ -1193,7 +1202,7 @@ interface ModularItemConfig extends ExtendedItemConfig<ModularItemOption> {
1193
1202
  Chat?: string | ExtendedItemChatCallback<ModularItemOption>;
1194
1203
  };
1195
1204
  /**
1196
- * A recond containing functions that are run on load, click, draw, exit, and validate, with the original archetype function
1205
+ * A record containing functions that are run on load, click, draw, exit, and validate, with the original archetype function
1197
1206
  * and parameters passed on to them. If undefined, these are ignored.
1198
1207
  * Note that scripthook functions must be loaded before `Female3DCGExtended.js` in `index.html`.
1199
1208
  */
@@ -5,13 +5,15 @@ type FriendListSortingDirection = 'Asc' | 'Desc';
5
5
 
6
6
  type FriendListReturn<T extends ModuleType> = { Screen: ModuleScreens[T], Module: T, IsInChatRoom?: boolean, hasScrolledChat?: boolean };
7
7
 
8
+ type FriendRelationType = "Friend" | "Owner" | "Lover" | "Submissive";
9
+
8
10
  type FriendRawData = {
9
11
  memberNumber?: number; /* undefined for NPCs */
10
12
  memberName: string;
11
13
  memberNickname?: string;
12
14
  chatRoom?: FriendRawRoom;
13
15
  beep?: FriendRawBeep;
14
- relationType?: string;
16
+ relationType?: FriendRelationType;
15
17
  canDelete?: boolean;
16
18
  }
17
19
 
@@ -497,7 +497,12 @@ interface ServerChatRoomAdminSwapRequest {
497
497
 
498
498
  type ServerChatRoomAdminRequest = ServerChatRoomAdminUpdateRequest | ServerChatRoomAdminMoveRequest | ServerChatRoomAdminSwapRequest;
499
499
 
500
- type ServerChatRoomSearchResponse = "JoinedRoom" | "AlreadyInRoom" | "RoomLocked" | "RoomBanned" | "RoomKicked" | "RoomFull" | "CannotFindRoom" | "AccountError" | "InvalidRoomData";
500
+ type ServerChatRoomJoinResponse = "JoinedRoom" | "RoomKicked" | ServerChatRoomJoinFailedResponse;
501
+ type ServerChatRoomJoinFailedResponse = "AlreadyInRoom" | "RoomLocked" | "RoomBanned" | "RoomFull" | "CannotFindRoom" | "AccountError" | "InvalidRoomData";
502
+ /**
503
+ * @deprecated Use {@link ServerChatRoomJoinResponse}
504
+ */
505
+ type ServerChatRoomSearchResponse = ServerChatRoomJoinResponse;
501
506
 
502
507
  /** Base interface for a chat message */
503
508
  interface ServerChatRoomMessageBase {
@@ -1047,7 +1052,7 @@ interface ServerToClientEvents {
1047
1052
 
1048
1053
  ChatRoomSearchResult: (data: ServerChatRoomSearchResultResponse) => void;
1049
1054
  ChatRoomCreateResponse: (data: ServerChatRoomCreateResponse) => void;
1050
- ChatRoomSearchResponse: (data: ServerChatRoomSearchResponse) => void;
1055
+ ChatRoomSearchResponse: (data: ServerChatRoomJoinResponse) => void;
1051
1056
 
1052
1057
  ChatRoomMessage: (data: ServerChatRoomMessage) => void;
1053
1058
  ChatRoomGameResponse: (data: ServerChatRoomGameResponse) => void;