bc-stubs 100.0.0 → 101.0.0-Beta.2

package/bc/Assets/Female3DCG/Female3DCG.d.ts

@@ -16,6 +16,7 @@ declare namespace E {
     let Shackled: "Shackled";
     let Tethered: "Tethered";
     let Enclose: "Enclose";
+    let MapImmobile: "MapImmobile";
     let OneWayEnclose: "OneWayEnclose";
     let OnBed: "OnBed";
     let Lifted: "Lifted";

package/bc/Female3DCG_Types.d.ts

@@ -573,6 +573,13 @@ interface AssetDefinitionBase extends AssetCommonPropertiesGroupAsset, AssetComm
 	/** @deprecated */
 	AllowTypes?: never;
 	CreateLayerTypes?: string[];
+	/**
+	 * Whether an item can be tightened or not.
+	 *
+	 * Defaults to `false` unless one of the following two conditions are met:
+	 * * The item is considered a restraint (see {@link AssetDefinition.IsRestraint})
+	 * * The items difficulty is larger than zero (see {@link AssetDefinition.Difficulty})
+	 */
 	AllowTighten?: boolean;
 	DefaultColor?: ItemColor;
 	Audio?: string;

package/bc/Messages.d.ts

@@ -10,8 +10,8 @@ interface ServerAccountImmutableData {
 	Creation: number;
 	Ownership?: ServerOwnership;
 	Lovership?: ServerLovership[];
-	ActivePose?: readonly string[];
-	Pose?: any;
+	ActivePose?: readonly AssetPoseName[];
+	Pose?: readonly AssetPoseName[];
 }
 
 interface ServerAccountData extends ServerAccountImmutableData {
@@ -21,40 +21,55 @@ interface ServerAccountData extends ServerAccountImmutableData {
 	 */
 	Lover?: string;
 	Money: number;
-	Log?: any;
+	Log?: LogRecord[];
 	GhostList?: MemberNumber[];
 	BlackList: MemberNumber[];
 	FriendList: MemberNumber[];
 	WhiteList: MemberNumber[];
 	ItemPermission: number;
-	Skill?: any;
+	Skill?: Skill[];
 	Reputation?: { Type: string, Value: number }[];
-	Wardrobe?: any;
-	WardrobeCharacterNames?: any;
-	ChatSettings?: any;
-	VisualSettings?: any;
-	AudioSettings?: any;
-	GameplaySettings?: any;
-	ArousalSettings?: any;
-	OnlineSharedSettings?: any;
+	Wardrobe?: string;
+	WardrobeCharacterNames?: string[];
+	ChatSettings?: ChatSettingsType;
+	VisualSettings?: VisualSettingsType;
+	AudioSettings?: AudioSettingsType;
+	GameplaySettings?: GameplaySettingsType;
+	ArousalSettings?: ArousalSettingsType;
+	OnlineSharedSettings?: CharacterOnlineSharedSettings;
 	Game?: CharacterGameParameters;
 	LabelColor?: string;
 	Appearance?: ServerAppearanceBundle;
 	Description?: string;
-	BlockItems?: any[];
-	LimitedItems?: any[];
-	FavoriteItems?: any[];
-	HiddenItems?: any;
-	Title?: string;
+	BlockItems?: ItemPermissionsPacked | ItemPermissions[];
+	LimitedItems?: ItemPermissionsPacked | ItemPermissions[];
+	FavoriteItems?: ItemPermissionsPacked | ItemPermissions[];
+	HiddenItems?: ItemPermissions[];
+	Title?: TitleName;
 	Nickname?: string;
 	Crafting?: string;
-	Inventory?: string;
+	Inventory?: string | Partial<Record<AssetGroupName, string[]>>;
 	AssetFamily?: "Female3DCG";
-	Infiltration?: object; /* PlayerCharacter.Infiltration */
-	SavedColors?: object[]; /* HSVColor[] */
+	Infiltration?: InfiltrationType;
+	SavedColors?: HSVColor[];
 	ChatSearchFilterTerms?: string;
 	Difficulty?: { Level: number; LastChange: number };
 	MapData?: ChatRoomMapData;
+	PrivateCharacter?: ServerPrivateCharacterData[];
+	SavedExpressions?: ({ Group: ExpressionGroupName, CurrentExpression?: ExpressionName }[] | null)[];
+	ConfiscatedItems?: { Group: AssetGroupName, Name: string }[];
+	RoomCreateLanguage?: ServerChatRoomLanguage;
+	RoomSearchLanguage?: "" | ServerChatRoomLanguage;
+	LastMapData?: null | ChatRoomMapData;
+	LastChatRoom?: null | ServerChatRoomSettings;
+	ControllerSettings?: ControllerSettingsType;
+	ImmersionSettings?: ImmersionSettingsType;
+	RestrictionSettings?: RestrictionSettingsType;
+	OnlineSettings?: PlayerOnlineSettings;
+	GraphicsSettings?: GraphicsSettingsType;
+	NotificationSettings?: NotificationSettingsType;
+	GenderSettings?: GenderSettingsType;
+	ExtensionSettings?: ExtensionSettings;
 }
 
 interface ServerMapDataResponse {
@@ -93,6 +108,22 @@ interface ServerItemBundle {
 	Craft?: CraftingItem;
 }
 
+interface ServerPrivateCharacterData {
+	Name: string;
+	Love: number;
+	Title: TitleName;
+	Trait: NPCTrait[];
+	Cage: boolean;
+	Owner: string;
+	Lover: string;
+	AssetFamily: "Female3DCG";
+	Appearance: ServerAppearanceBundle;
+	AppearanceFull: ServerAppearanceBundle;
+	ArousalSettings: ArousalSettingsType;
+	Event: NPCTrait[];
+	FromPandora?: boolean;
+}
+
 /** An AppearanceBundle is whole minified appearance of a character */
 type ServerAppearanceBundle = ServerItemBundle[];
 
@@ -135,6 +166,7 @@ type ServerChatRoomData = {
 
 interface ServerChatRoomMapData {
 	Type: string;
+	Fog?: boolean;
 	Tiles: string;
 	Objects: string;
 }

package/bc/Screens/Inventory/ItemMouth/FuturisticPanelGag/FuturisticPanelGag.d.ts

@@ -12,6 +12,7 @@ declare function InventoryItemMouthFuturisticPanelGagSetOptionHook(data: Modular
 declare function InventoryItemMouthFuturisticPanelGagPublishActionTrigger(C: Character, Item: Item, OptionName: string, Deflate: boolean): void;
 /**
  * Helper function for handling automatic gag inflation and deflation.
+ * @param {ModularItemData} data
  * @param {Character} C - The selected character
  * @param {Item} Item - The item in question
  * @param {ModularItemOption} previousOption
@@ -19,7 +20,7 @@ declare function InventoryItemMouthFuturisticPanelGagPublishActionTrigger(C: Cha
  * @param {boolean} Deflate - Whether this function is triggered by an automatic deflation or not
  * @returns {ModularItemOption}
  */
-declare function InventoryItemMouthFuturisticPanelGagTriggerGetOptions(C: Character, Item: Item, previousOption: ModularItemOption, module: ModularItemModule, Deflate: boolean): ModularItemOption;
+declare function InventoryItemMouthFuturisticPanelGagTriggerGetOptions(data: ModularItemData, C: Character, Item: Item, previousOption: ModularItemOption, module: ModularItemModule, Deflate: boolean): ModularItemOption;
 /**
  * Helper function for handling automatic gag inflation and deflation.
  * @param {ModularItemData} data

package/bc/Screens/MiniGame/ClubCard/ClubCard.d.ts

@@ -72,6 +72,13 @@ declare function ClubCardPlayerAddFame(CCPlayer: ClubCardPlayer, Amount: number)
  * @returns {void} - Nothing
  */
 declare function ClubCardUpgradeLevel(CCPlayer: any): void;
+/**
+ * Returns TRUE if a card (by name) is currently present on a board
+ * @param {ClubCardPlayer} CCPlayer - The club card player
+ * @param {string} CardName - The name of the card
+ * @returns {boolean} - TRUE if at least one card with that name is present
+ */
+declare function ClubCardEventNameIsInEvents(CCPlayer: ClubCardPlayer, CardName: string): boolean;
 /**
  * Returns TRUE if a card (by name) is currently present on a board
  * @param {ClubCardPlayer} CCPlayer - The club card player
@@ -100,6 +107,12 @@ declare function ClubCardGroupOnBoardCount(CCPlayer: ClubCardPlayer, GroupName:
  * @returns {void} - Nothing
  */
 declare function ClubCardRemoveFromBoard(CCPlayer: ClubCardPlayer, Card: ClubCard): void;
+/**
+ * Removes several cards from player time events
+ * @param {ClubCardPlayer} CCPlayer - The club card player
+ * @param {String[]} ListOfCardNames - The names of the cards to remove
+ */
+declare function ClubCardRemoveCardsFromEventByName(CCPlayer: ClubCardPlayer, ListOfCardNames: string[]): void;
 /**
  * Removes a card from a player time events
  * @param {ClubCardPlayer} CCPlayer - The club card player

package/bc/Screens/MiniGame/MaidDrinks/MaidDrinks.d.ts

@@ -53,9 +53,9 @@ declare function MaidDrinksMiss(): void;
 declare function MaidDrinksDoMove(MoveType: number): void;
 /**
  * Handles key presses during the maid drinks mini game. (Both keyboard and mobile)
- * @returns {void} - Nothing
+ * @returns {boolean} - TRUE if the key is handled by the key down event
  */
-declare function MaidDrinksKeyDown(): void;
+declare function MaidDrinksKeyDown(): boolean;
 /**
  * Handles clicks during the maid drinks mini game (only on mobile, to replace the keyboard)
  * @returns {void} - Nothing

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

@@ -1,3 +1,15 @@
+/**
+ * Activates the chat room view with the passed name
+ * @param {string} viewName - The name of the view to activate
+ * @returns {void}
+ */
+declare function ChatRoomActivateView(viewName: string): void;
+/**
+ * Indicates if the chat room view with the passed name is active or not
+ * @param {string} viewName - The name of the view to check
+ * @returns {boolean} - TRUE if the chat room character view is active, false if not
+ */
+declare function ChatRoomIsViewActive(viewName: string): boolean;
 /**
  * Checks if the player can add the current character to her whitelist.
  * @returns {boolean} - TRUE if the current character is not in the player's whitelist nor blacklist.
@@ -230,15 +242,14 @@ declare function ChatRoomCanAssistStand(): boolean;
  */
 declare function ChatRoomCanAssistKneel(): boolean;
 /**
-* Checks if the player character can attempt to stand up. This is different than CurrentCharacter.CanKneel() because it
-* listens for the current active pose, but it forces the player to do a minigame.
+ * Checks if the player character is kneeling and can stand up.
+ * Will return true if there are any available transitions from {@link PoseAllKneeling} to {@link PoseAllStanding}.
  * @returns {boolean} - Whether or not the player character can stand
  */
 declare function ChatRoomCanAttemptStand(): boolean;
 /**
- * Checks if the player character can attempt to get down on her knees. This is different than
- * CurrentCharacter.CanKneel() because it listens for the current active pose, but it forces the player to do a
- * minigame.
+ * Checks if the player character is standing and can kneel down.
+ * Will return true if there are any available transitions from {@link PoseAllStanding} to {@link PoseAllKneeling}.
  * @returns {boolean} - Whether or not the player character can stand
  */
 declare function ChatRoomCanAttemptKneel(): boolean;
@@ -344,29 +355,6 @@ declare function ChatRoomUpdateDisplay(): void;
  * @returns {void} - Nothing.
  */
 declare function DrawStatus(C: Character, X: number, Y: number, Zoom: number): void;
-/**
- * Iterate over a room's characters
- *
- * This function takes a callback it will call for each character in turn after having
- * calculated their respective drawing parameters (location), accounting for the smooth zoom effect
- * @param {(charIdx: number, charX: number, charY: number, space: number, zoom: number) => boolean | void} callback
- */
-declare function ChatRoomLoopCharacters(callback: (charIdx: number, charX: number, charY: number, space: number, zoom: number) => boolean | void): void;
-/**
- * Draws the chatroom characters.
- * @returns {void} - Nothing.
- */
-declare function ChatRoomDrawCharacter(): void;
-/**
- * Draw the background of a chat room
- * @param {string} Background - The name of the background image file
- * @param {number} Y - The starting Y co-ordinate of the image
- * @param {number} Zoom - The zoom factor based on the number of characters
- * @param {number} DarkFactor - The value (0 = fully visible, 1 = black) to tint the background
- * @param {boolean} InvertRoom - Whether the background image should be inverted
- * @returns {void} - Nothing
- */
-declare function ChatRoomDrawBackground(Background: string, Y: number, Zoom: number, DarkFactor: number, InvertRoom: boolean): void;
 /**
  * Draws the status icons of a character
  * @param {Character} C The target character
@@ -375,26 +363,6 @@ declare function ChatRoomDrawBackground(Background: string, Y: number, Zoom: num
  * @param {number} Zoom Room zoom
  */
 declare function ChatRoomDrawCharacterStatusIcons(C: Character, CharX: number, CharY: number, Zoom: number): void;
-/**
- * Draws any overlays on top of character
- * @param {Character} C The target character
- * @param {number} CharX Character's X position on canvas
- * @param {number} CharY Character's Y position on canvas
- * @param {number} Zoom Room zoom
- * @param {number} Pos Index of target character
- */
-declare function ChatRoomDrawCharacterOverlay(C: Character, CharX: number, CharY: number, Zoom: number, Pos: number): void;
-/**
- * Called when character is clicked
- * @param {Character} C The target character
- * @param {number} CharX Character's X position on canvas
- * @param {number} CharY Character's Y position on canvas
- * @param {number} Zoom Room zoom
- * @param {number} ClickX Click X postion relative to character, without zoom
- * @param {number} ClickY Click Y postion relative to character, without zoom
- * @param {number} Pos Index of target character
- */
-declare function ChatRoomClickCharacter(C: Character, CharX: number, CharY: number, Zoom: number, ClickX: number, ClickY: number, Pos: number): void;
 /**
  * Select the character (open dialog) and clear other chatroom displays.
  * @param {Character} C - The character to focus on. Does nothing if null.
@@ -496,6 +464,11 @@ declare function ChatRoomStatusUpdate(Status: string | null): void;
  * @returns {void} - Nothing.
  */
 declare function ChatRoomStatusUpdateTalk(Key: KeyboardEvent): void;
+/**
+ * Handler called when the chat input field changes
+ * @param {Event} event
+ */
+declare function ChatRoomChatInputChangeHandler(event: Event): void;
 /**
  * Checks if status has expired or is otherwise no longer valid and resets status if so
  * @returns {void} - Nothing.
@@ -516,6 +489,11 @@ declare function ChatRoomCustomizationRun(): void;
  * @returns {void} - Nothing.
  */
 declare function ChatRoomRun(): void;
+/**
+ * Runs the arousal overlay.
+ * @returns {boolean} - Returns true if the orgasm overlay is active and false otherwise.
+ */
+declare function ChatRoomDrawArousalOverlay(): boolean;
 /**
  * Draws the chat room menu buttons
  * @returns {void} - Nothing
@@ -543,9 +521,10 @@ declare function ChatRoomMouseMove(event: any): void;
 declare function ChatRoomMouseWheel(event: any): void;
 /**
  * Handles clicks the chatroom screen.
+ * @param {MouseEvent | TouchEvent} event
  * @returns {void} - Nothing.
  */
-declare function ChatRoomClick(): void;
+declare function ChatRoomClick(event: MouseEvent | TouchEvent): void;
 /**
  * Process chat room menu button clicks
  * @returns {void} - Nothing
@@ -1290,8 +1269,6 @@ declare var ChatRoomQuestGiven: number[];
 declare var ChatRoomSpace: ServerChatRoomSpace;
 /** @type {ServerChatRoomGame} */
 declare var ChatRoomGame: ServerChatRoomGame;
-/** @type {null | number} */
-declare var ChatRoomMoveTarget: null | number;
 declare var ChatRoomHelpSeen: boolean;
 declare var ChatRoomAllowCharacterUpdate: boolean;
 declare var ChatRoomStruggleAssistBonus: number;
@@ -1316,8 +1293,12 @@ declare var ChatRoomChatLogRect: RectTuple;
  * @type {RectTuple}
  */
 declare var ChatRoomChatInputRect: RectTuple;
+/**
+ * Default position of the chat input length label
+ * @type {RectTuple}
+ */
+declare var ChatRoomChatLengthLabelRect: RectTuple;
 declare var ChatRoomChatHidden: boolean;
-declare var ChatRoomCharacterCount: number;
 /**
  * The chatroom characters that were drawn in the last frame.
  * Used for limiting the "fov". Characters come from {@link ChatRoomCharacter}
@@ -1351,6 +1332,16 @@ declare var ChatRoomTargetDirty: boolean;
 declare var ChatRoomCustomized: boolean;
 declare var ChatRoomCustomBackground: string;
 declare var ChatRoomCustomFilter: string;
+/**
+ * The list of chat room views
+ * @type {Record<string, ChatRoomView>}
+ */
+declare var ChatRoomViews: Record<string, ChatRoomView>;
+/**
+ * The active chat room view
+ * @type {ChatRoomView}
+ */
+declare var ChatRoomActiveView: ChatRoomView;
 /**
  * Chances of a chat message popping up reminding you of some stimulation.
  *
@@ -1424,11 +1415,6 @@ declare namespace ChatRoomFontSizes {
     let Medium: number;
     let Large: number;
 }
-declare var ChatRoomCharacterX_Upper: number;
-declare var ChatRoomCharacterX_Lower: number;
-declare var ChatRoomCharacterZoom: number;
-declare var ChatRoomSlideWeight: number;
-declare var ChatRoomCharacterInitialize: boolean;
 /** Sets whether an add/remove for one list automatically triggers an add/remove for another list */
 declare function ChatRoomListOperationTriggers(): {
     list: number[];

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

@@ -0,0 +1,94 @@
+/**
+ * Indicates if the chat room character view is active or not
+ * @returns {boolean} - TRUE if the chat room character view is active, false if not
+ */
+declare function ChatRoomCharacterViewIsActive(): boolean;
+declare function ChatRoomCharacterViewRun(): void;
+/**
+ * Alter the received message to what will be displayed in the chat log
+ *
+ * @param {ServerChatRoomMessage} data
+ * @param {string} msg
+ * @param {Character} SenderCharacter
+ * @param {IChatRoomMessageMetadata} metadata
+ * @returns {string|null} - The string to display or null if the message should be hidden
+ */
+declare function ChatRoomCharacterViewDisplayMessage(data: ServerChatRoomMessage, msg: string, SenderCharacter: Character, metadata: IChatRoomMessageMetadata): string | null;
+/**
+ * Handles clicks the chatroom screen view.
+ * @returns {void} - Nothing.
+ */
+declare function ChatRoomCharacterViewClick(event: any): void;
+declare function ChatRoomCharacterViewKeyDown(event: any): boolean;
+/**
+ * Returns TRUE if the player can leave
+ * @returns {boolean} - True if the player can leave
+ */
+declare function ChatRoomCharacterViewCanLeave(): boolean;
+/**
+ * Take a screenshot of all characters in the chatroom
+ * @returns {void} - Nothing
+ */
+declare function ChatRoomCharacterViewScreenshot(): void;
+/**
+ * Returns TRUE if the map button can be used
+ * @returns {boolean} - TRUE if can be used
+ */
+declare function ChatRoomCharacterViewShowMapButton(): boolean;
+/**
+ * Called when character is clicked
+ * @param {Character} C The target character
+ * @param {number} CharX Character's X position on canvas
+ * @param {number} CharY Character's Y position on canvas
+ * @param {number} Zoom Room zoom
+ * @param {number} ClickX Click X postion relative to character, without zoom
+ * @param {number} ClickY Click Y postion relative to character, without zoom
+ * @param {number} Pos Index of target character
+ */
+declare function ChatRoomCharacterViewClickCharacter(C: Character, CharX: number, CharY: number, Zoom: number, ClickX: number, ClickY: number, Pos: number): void;
+/**
+ * Draws the chatroom characters.
+ * @returns {void} - Nothing.
+ */
+declare function ChatRoomCharacterViewDraw(): void;
+declare function ChatRoomCharacterViewDrawUi(): void;
+/**
+ * Draw the background of a chat room
+ * @param {string} Background - The name of the background image file
+ * @param {number} Y - The starting Y co-ordinate of the image
+ * @param {number} Zoom - The zoom factor based on the number of characters
+ * @param {number} DarkFactor - The value (0 = fully visible, 1 = black) to tint the background
+ * @param {boolean} InvertRoom - Whether the background image should be inverted
+ * @returns {void} - Nothing
+ */
+declare function ChatRoomCharacterViewDrawBackground(Background: string, Y: number, Zoom: number, DarkFactor: number, InvertRoom: boolean): void;
+/**
+ * Iterate over a room's characters
+ *
+ * This function takes a callback it will call for each character in turn after having
+ * calculated their respective drawing parameters (location), accounting for the smooth zoom effect
+ * @param {(charIdx: number, charX: number, charY: number, space: number, zoom: number) => boolean | void} callback
+ */
+declare function ChatRoomCharacterViewLoopCharacters(callback: (charIdx: number, charX: number, charY: number, space: number, zoom: number) => boolean | void): void;
+/**
+ * Draws any overlays on top of character
+ * @param {Character} C The target character
+ * @param {number} CharX Character's X position on canvas
+ * @param {number} CharY Character's Y position on canvas
+ * @param {number} Zoom Room zoom
+ * @param {number} Pos Index of target character
+ */
+declare function ChatRoomCharacterViewDrawOverlay(C: Character, CharX: number, CharY: number, Zoom: number, Pos: number): void;
+declare var ChatRoomCharacterViewInitialize: boolean;
+declare var ChatRoomCharacterViewSlideWeight: number;
+declare var ChatRoomCharacterViewX_Upper: number;
+declare var ChatRoomCharacterViewX_Lower: number;
+declare var ChatRoomCharacterViewZoom: number;
+declare var ChatRoomCharacterViewCharacterCount: number;
+/** @type {null | number} */
+declare var ChatRoomCharacterViewMoveTarget: null | number;
+/**
+ * The name of the chat room character view.
+ * @type {string}
+ */
+declare const ChatRoomCharacterViewName: string;