bc-stubs 131.0.0 → 132.0.0-Beta.2

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

@@ -541,10 +541,10 @@ declare namespace AssetPoseMapping {
         export { Hogtied_34 as Hogtied };
     }
 }
-/** @type {string[]} */
-declare const AssetMalePantiesList: string[];
-/** @type {string[]} */
-declare const AssetMaleChasityCagesList: string[];
+/** @type {readonly AssetFullName[]} */
+declare const AssetMalePantiesList: readonly AssetFullName[];
+/** @type {readonly AssetFullName[]} */
+declare const AssetMaleChasityCagesList: readonly AssetFullName[];
 /**
  * 3D Custom Girl based assets
  * @type {AssetGroupDefinition[]}

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

@@ -1,6 +1,17 @@
 /** A type representing layer names (yes this is just a `string` alias). */
 type LayerName = string;
 
+// Do not remove, but do deprecate in order to discourage future usage
+/**
+ * A group + asset name.
+ *
+ * @deprecated Usage of {@link AssetFullPath} instead is strongly recommended for any and all future work.
+ */
+type AssetFullName = `${AssetGroupName}${AssetName}`;
+
+/** A group + asset name separated by a dash */
+type AssetFullPath = `${AssetGroupName}/${AssetName}`;
+
 /** A special key for {@link ItemProperties["DrawingTop"]}/{@link ItemProperties["DrawingLeft"]} that overrides the _relative_ position of each and every layer individually */
 type AssetOverride = "ASSET_OVERRIDE";
 
@@ -33,8 +44,10 @@ declare namespace TopLeft {
 	 */
 	type Definition = number | Partial<Record<AssetPoseName | PoseTypeDefault, number>>;
 	/** See {@link ItemProperties["DrawingTop"]} */
+	// eslint-disable-next-line @typescript-eslint/no-redundant-type-constituents
 	type ItemData = Partial<Record<AssetOverride | LayerName, TopLeft.DataMutable>>;
 	/** See {@link ItemPropertiesConfig["DrawingTop"]} */
+	// eslint-disable-next-line @typescript-eslint/no-redundant-type-constituents
 	type ItemDefinition = Partial<Record<AssetOverride | LayerName, TopLeft.Definition>>;
 }
 
@@ -267,7 +280,7 @@ interface AssetGroupDefinitionBase extends AssetCommonPropertiesGroupAsset, Asse
 	/** The internal identifier for the group */
 	Group: AssetGroupName;
 	/** The list of assets defined by the group */
-	Asset: (AssetDefinition | string)[];
+	Asset: (AssetDefinition | AssetName)[];
 
 	/** Inherited from {@link AssetCommonPropertiesGroupAssetLayer} but mandatory here */
 	Priority: number;
@@ -381,7 +394,7 @@ interface AssetGroupDefinitionBase extends AssetCommonPropertiesGroupAsset, Asse
 	 *
 	 * Used for things like auto-removing collar accessories if the collar is removed.
 	 */
-	RemoveItemOnRemove?: { Group: AssetGroupItemName, Name: string, TypeRecord?: TypeRecord }[];
+	RemoveItemOnRemove?: { Group: AssetGroupItemName, Name: AssetName, TypeRecord?: TypeRecord }[];
 
 	/**
 	 * Whether the group has a blinking variant
@@ -427,7 +440,7 @@ declare namespace AssetGroupDefinition {
 	/** An {@link AssetGroupDefinition} subtype for groups of the `Item` category. */
 	interface Item extends AssetGroupDefinitionBase {
 		Group: AssetGroupItemName;
-		Asset: (AssetDefinition.Item | string)[];
+		Asset: (AssetDefinition.Item | AssetName)[];
 		Category: "Item";
 		Clothing?: false;
 		Underwear?: false;
@@ -442,7 +455,7 @@ declare namespace AssetGroupDefinition {
 	/** An {@link AssetGroupDefinition} subtype for groups of the `Appearance` category. */
 	interface Appearance extends AssetGroupDefinitionBase {
 		Group: AssetGroupBodyName;
-		Asset: (AssetDefinition.Appearance | string)[];
+		Asset: (AssetDefinition.Appearance | AssetName)[];
 		Category?: "Appearance";
 		IsRestraint?: false;
 		Zone?: never;
@@ -451,7 +464,7 @@ declare namespace AssetGroupDefinition {
 	/** An {@link AssetGroupDefinition} subtype for groups of the `Script` category. */
 	interface Script extends AssetGroupDefinitionBase {
 		Group: AssetGroupScriptName;
-		Asset: (AssetDefinition.Script | string)[];
+		Asset: (AssetDefinition.Script | AssetName)[];
 		Category: "Script";
 	}
 }
@@ -484,7 +497,7 @@ interface AssetCommonPropertiesAssetLayer {
 interface AssetDefinitionBase extends AssetCommonPropertiesGroupAsset, AssetCommonPropertiesAssetLayer, AssetCommonPropertiesGroupAssetLayer {
 
 	/** The asset's internal name. */
-	Name: string,
+	Name: AssetName,
 
 	/** The asset's InventoryID to be synced with the server and other players */
 	InventoryID?: number,
@@ -497,7 +510,7 @@ interface AssetDefinitionBase extends AssetCommonPropertiesGroupAsset, AssetComm
 		/** The name of the group */
 		GroupName: AssetGroupName,
 		/** The name of the asset */
-		AssetName: string,
+		AssetName: AssetName,
 		/** Whether to automatically assign a {@link AssetDefinition.BuyGroup} to the config and, if required, to set it for all `CopyConfig`-referenced super configs */
 		BuyGroup?: boolean,
 	};
@@ -508,7 +521,7 @@ interface AssetDefinitionBase extends AssetCommonPropertiesGroupAsset, AssetComm
 	 * Used for the random appearance generator, to ensure combined assets match.
 	 * Eyes, as well as the student tops and bottoms make use of it.
 	 */
-	ParentItem?: string;
+	ParentItem?: AssetName;
 
 	/**
 	 * Whether the asset is enabled or not.
@@ -524,7 +537,7 @@ interface AssetDefinitionBase extends AssetCommonPropertiesGroupAsset, AssetComm
 	Visible?: boolean;
 
 	/** A list of screens where current asset won't be shown. */
-	NotVisibleOnScreen?: string[];
+	NotVisibleOnScreen?: RoomName[];
 
 	/** Specify body type overrides that live in the asset override folder */
 	StyleOverride?: BodyStyle[];
@@ -533,8 +546,8 @@ interface AssetDefinitionBase extends AssetCommonPropertiesGroupAsset, AssetComm
 	// Only on BodyStyles
 	DrawOffset?: {
 		Group?: AssetGroupName;
-		Asset?: string;
-		Layer?: string[]
+		Asset?: AssetName;
+		Layer?: LayerName[]
 		X?: number;
 		Y?: number;
 	}[];
@@ -576,10 +589,10 @@ interface AssetDefinitionBase extends AssetCommonPropertiesGroupAsset, AssetComm
 	Expose?: AssetGroupItemName[];
 
 	/** A list of asset names that get hidden when the asset is worn. */
-	HideItem?: string[];
+	HideItem?: AssetFullName[];
 
 	/** A list of asset names that get shown when the asset is worn. Only useful when combined with Hide */
-	HideItemExclude?: string[];
+	HideItemExclude?: AssetFullName[];
 
 	/**
 	 * A list of body group that becomes required when this asset is worn.
@@ -670,12 +683,12 @@ interface AssetDefinitionBase extends AssetCommonPropertiesGroupAsset, AssetComm
 	ExpressionTrigger?: ExpressionTrigger[];
 
 	/** A list of assets to also remove when the asset is taken off. */
-	RemoveItemOnRemove?: { Name: string, Group: AssetGroupItemName, TypeRecord?: TypeRecord }[];
+	RemoveItemOnRemove?: { Name: AssetName, Group: AssetGroupItemName, TypeRecord?: TypeRecord }[];
 
 	AllowEffect?: EffectName[];
 	AllowBlock?: AssetGroupItemName[];
 	AllowHide?: AssetGroupItemName[];
-	AllowHideItem?: string[];
+	AllowHideItem?: AssetFullName[];
 	/** A list of {@link TypeRecord} keys for which a single layer expects multiple type-specific .png files. */
 	CreateLayerTypes?: string[];
 	/**
@@ -700,7 +713,7 @@ interface AssetDefinitionBase extends AssetCommonPropertiesGroupAsset, AssetComm
 	DynamicDescription?: (C: Character) => string;
 	DynamicPreviewImage?: (C: Character) => string;
 	DynamicAllowInventoryAdd?: (C: Character) => boolean;
-	DynamicName?: (C: Character) => string;
+	DynamicName?: (C: Character) => AssetName;
 
 	/** The real group name used when building the file paths for the asset's layers */
 	DynamicGroupName?: AssetGroupName;
@@ -719,7 +732,7 @@ interface AssetDefinitionBase extends AssetCommonPropertiesGroupAsset, AssetComm
 	AllowColorizeAll?: never;
 
 	/** A list of online spaces (eg. Asylum) where the asset is automatically available */
-	AvailableLocations?: string[];
+	AvailableLocations?: (RoomName | ServerChatRoomSpace)[];
 
 	OverrideHeight?: AssetOverrideHeight;
 
@@ -737,6 +750,7 @@ interface AssetDefinitionBase extends AssetCommonPropertiesGroupAsset, AssetComm
 
 	MirrorExpression?: AssetGroupBodyName;
 
+	/** See {@link BackgroundsList} */
 	CustomBlindBackground?: string;
 
 	/** The list of layers for the asset. */
@@ -867,7 +881,7 @@ interface AssetLayerDefinition extends AssetCommonPropertiesGroupAssetLayer, Ass
 	 */
 	Visibility?: "Player" | "AllExceptPlayerDialog" | "Others" | "OthersExceptDialog" | "Owner" | "Lovers" | "Mistresses";
 
-	HideAs?: { Group: AssetGroupName, Asset?: string };
+	HideAs?: { Group: AssetGroupName, Asset?: AssetName };
 
 	/** Whether the layer uses an image. Defaults to true. */
 	HasImage?: boolean;
@@ -911,7 +925,7 @@ interface AssetLayerDefinition extends AssetCommonPropertiesGroupAssetLayer, Ass
 	 *
 	 * Serves as the pose mapping equivalent of {@link AssetLayerDefinition.CopyLayerColor}.
 	 */
-	CopyLayerPoseMapping?: string;
+	CopyLayerPoseMapping?: LayerName;
 
 	/**
 	 * A list of {@link TypeRecord} keys for which a single layer expects multiple type-specific .png files.
@@ -953,7 +967,7 @@ type ExtendedItemMainConfig = Partial<Record<AssetGroupName, ExtendedItemGroupCo
  * An object containing extended item definitions for a group.
  * Maps asset names within the group to their extended item configuration
  */
-type ExtendedItemGroupConfig = Record<string, AssetArchetypeConfig>;
+type ExtendedItemGroupConfig = Partial<Record<AssetName, AssetArchetypeConfig>>;
 
 /** Get the archetype config type */
 type AssetArchetypeGetConfig<T extends keyof ExtendedArchetypes> = ExtendedArchetypes[T][0];
@@ -994,9 +1008,9 @@ interface ExtendedItemConfig<OptionType extends ExtendedItemOption> {
 	/** A boolean indicating whether or not images should be drawn for the option and/or module selection screen. */
 	DrawImages?: boolean;
 	/** The group name and asset name of a configuration to copy - useful if multiple items share the same config */
-	CopyConfig?: { GroupName?: AssetGroupName, AssetName: string };
+	CopyConfig?: { GroupName?: AssetGroupName, AssetName: AssetName };
 	/** An interface with element-specific drawing data for a given screen. */
-	DrawData?: ExtendedItemConfigDrawData<{}>;
+	DrawData?: ExtendedItemConfigDrawData<object>;
 	/**
 	 * A list with extra to-be allowed effect names.
 	 * Should only defined when there are effects that are exclusively managed by script hooks and thus cannot be extracted from the normal extended item options.
@@ -1466,7 +1480,7 @@ interface TestingStruct<T> {
 	/** The asset's group */
 	readonly Group: AssetGroupName;
 	/** The asset's name */
-	readonly Name: string;
+	readonly Name: AssetName;
 	/** A representation of the asset's missing or invalid data */
 	readonly Invalid: T;
 }

package/bc/NativeDeclarations/Screens/Character/Preference/Preference.d.ts

@@ -52,6 +52,7 @@ type GraphicsFontName =
 	"Arial" | "TimesNewRoman" | "Papyrus" | "ComicSans" | "Impact" | "HelveticaNeue" | "Verdana" |
 	"CenturyGothic" | "Georgia" | "CourierNew" | "Copperplate"
 	;
+type GraphicsShowFullscreenButton = "on" | "off" | "on_when_mobile";
 
 // #endregion
 

package/bc/NativeDeclarations/Screens/Character/Wardrobe/Wardrobe.d.ts

@@ -0,0 +1,12 @@
+type WardrobeReorderType = "None" | "Select" | "Place";
+type WardrobeActionPreview = "Load" | "Save";
+type WardrobeFastLoadOptions = {
+	/** Keep body from {@link WardrobeFastLoadOptions.BodyCharacter} and apply only clothes from the slot. Honored only when {@link Wardrobe.excludeBodyparts} is set. */
+	ExcludeBodyparts?: boolean;
+	/** Body source when excluding body parts; defaults to {@link Wardrobe.selectedCharacter}. */
+	BodyCharacter?: Character;
+	/** Restore facial expressions from this character after loading. Defaults to the player when `C` is the player. */
+	ExpressionSource?: Character;
+	/** Load this bundle instead of `Player.Wardrobe[W]`. */
+	Appearance?: ItemBundle[];
+};

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

@@ -0,0 +1,260 @@
+type ClubCardTag =
+	| "All Cards"
+	| "Selected Cards"
+	| "Event Cards"
+	| "Ungrouped"
+	| "Liability"
+	| "Staff"
+	| "Police"
+	| "Criminal"
+	| "Fetishist"
+	| "Porn"
+	| "Maid"
+	| "Asylum"
+	| "Dominant / Mistress"
+	| "ABDL"
+	| "College"
+	| "Shibari"
+	| "Pet / Owner"
+	| "Kemonomimi"
+	| "Submissive / Slave"
+	| "Exhibitionist"
+	| "Latex"
+	| "Online Player"
+	| "Reward Cards"
+;
+
+type ClubCardType = "Member" | "Event";
+
+type ClubCardGroup =
+    | "Fetishist"
+    | "Exhibitionist"
+    | "Shibari"
+    | "Submissive"
+    | "Sensei"
+    | "Staff"
+    | "Police"
+    | "Criminal"
+    | "Liability"
+    | "ABDLBaby"
+    | "ABDLMommy"
+    | "Maid"
+    | "Slave"
+    | "PornActress"
+    | "Porn"
+    | "Kemonomimi"
+    | "AsylumPatient"
+    | "AsylumNurse"
+    | "Dominant"
+    | "Mistress"
+    | "CollegeStudent"
+    | "CollegeTeacher"
+    | "Player"
+    | "Pet"
+    | "Knot"
+    | "Owner"
+    | "Latex"
+    | "Auction"
+    | "TimedEvent"
+    | "Video"
+    | "ContinuousEvent"
+;
+
+interface ClubCard {
+	ID: number;
+	UniqueID?: string;
+	Name: string;
+	ArrayIndex?: number;
+	Type?: ClubCardType;
+	Title?: string;
+	Text?: string;
+	Prerequisite?: string;
+	Reward?: string;
+	RewardMemberNumber?: number;
+	MoneyPerTurn?: number;
+	FamePerTurn?: number;
+	RequiredLevel?: 1 | 2 | 3 | 4 | 5;
+	Time?: number;
+	ExtraTime?: number;
+	ExtraPlay?: number;
+	Group?: ClubCardGroup[];
+	Location?: string;
+	Negated?: boolean; // if the card's effect should not work
+	Negating?: string; // the card that its effect is stopped by this card
+	GlowTimer?: number;
+	GlowColor?: string;
+	EffectKey?: number;
+	EffectType?: string;
+	Revealed?: boolean;
+	CanActive?: boolean;
+	//### Animations
+	AnimationState?: string;
+	DelayedAnimationState?: string;
+	CurrentX?: number;
+	CurrentY?: number;
+	CurrentW?: number;
+	IsVisible?: boolean;
+	//### ### ### ###
+	OnPlay?: (C: ClubCardPlayer) => void;
+	BeforeTurnEnd?: (C: ClubCardPlayer) => void;
+	AfterTurnEnd?: (C: ClubCardPlayer) => void;
+	BeforeOpponentTurnEnd?: (C: ClubCardPlayer) => void;
+	AfterOpponentTurnEnd?: (C: ClubCardPlayer) => void;
+	CanPlay?: (C: ClubCardPlayer) => boolean;
+	/**
+	 * @param C Player that owns the card and played a card
+	 * @param Card that was played
+	 */
+	onPlayedCard?: (C: ClubCardPlayer, Card: ClubCard) => void;
+	/**
+	 * @param C player that owns the card (not the one who played it in this case)
+	 * @param Card the card that was played
+	 */
+	onOpponentPlayedCard?: (C: ClubCardPlayer, Card: ClubCard) => void;
+	/**
+	 * Hook to run when card is removed from the board.
+	 * @param C Player that owns the card
+	 */
+	onLeaveClub?: (C: ClubCardPlayer) => void;
+	onMemberLeaveClub?: (C: ClubCardPlayer, Card: ClubCard, DidntDiscard: boolean) => void;
+	onRender?: (C: ClubCardPlayer, X: number, Y: number, W: number) => void;
+	turnStart?: (C: ClubCardPlayer) => void;
+	onLevelUp?: (C: ClubCardPlayer) => void;
+	onOpponentLevelUp?: (C: ClubCardPlayer) => void;
+	onDrawCard?: (C: ClubCardPlayer) => void;
+	onOpponentDrawCard?: (C: ClubCardPlayer) => void;
+	onDrawAction?: (C: ClubCardPlayer) => void;
+	onOpponentDrawAction?: (C: ClubCardPlayer) => void;
+	onSteal?: (C: ClubCardPlayer) => void;
+	StreetsTurnEnd?: (C: ClubCardPlayer) => void;
+	onDiscardCard?: (C: ClubCardPlayer, Card: ClubCard) => void;
+	onCancelNegation?: (C: ClubCardPlayer) => void;
+	WhenDrawn?: (C: ClubCardPlayer) => void;
+	OnActive?: (C: ClubCardPlayer) => void;
+	OnGameStart?: (C: ClubCardPlayer) => void;
+}
+
+type ClubCardDefaultDecks =
+	| "Default"
+	| "Princess Treatment"
+	| "Permanent Stay"
+	| "Pound Town"
+;
+
+interface ClubCardPlayer {
+	Character: Character;
+	Control: "AI" | "Player" | "Online";
+	Index: number;
+	Sleeve: number;
+	Deck: ClubCard[];
+	FullDeck: ClubCard[];
+	Hand: ClubCard[];
+	Board: ClubCard[];
+	Event: ClubCard[];
+	RenderFullBoard: ClubCard[];
+	DiscardPile: ClubCard[];
+	Level: number;
+	Money: number;
+	Fame: number;
+	LastFamePerTurn?: number;
+	LastMoneyPerTurn?: number;
+	ClubCardTurnCounter: number;
+	CardsPlayedThisTurn: Record<number, ClubCard[]>
+}
+
+interface ClubCardPopupType {
+    Mode:
+        | "DISCARDPILE"
+        | "YESNO"
+        | "TEXT"
+        | "SEARCH"
+        | "INFO"
+        | "TIERSELECTION"
+        | "DECK"
+        | "TifaActive";
+    Text?: string;
+    Button1?: string;
+    Button2?: string;
+    Function1?: string;
+    Function2?: string;
+    CardsPool?: ClubCard[];
+}
+
+type ClubCardMessageType =
+	| "Prerequisite"
+	| "StartTurnInfo"
+	| "SystemMessage"
+	| "PlayersMessage"
+	| "PlayersDisconnected"
+	| "CardsEffect"
+	| "TurnEndEffect"
+	| "KnotEvent"
+	| "Actions"
+	| "ActionSeparator"
+	| "FameMoneyInfo"
+	| "StartTurnEvent"
+	| "VictoryInfo"
+;
+
+type ClubCardPlaceholderKeysType =
+	| "MONEYLABEL"
+	| "FAMELABEL"
+	| "AMOUNT"
+	| "CARDNAME"
+	| "MONEYAMOUNT"
+	| "FAMEAMOUNT"
+	| "TURNNUMBER"
+	| "PLAYERNAME"
+;
+
+interface ClubCardMessage {
+	/** Localization key */
+	TextGetKey: string;
+	/** Type of message (e.g., ACTION, SYSTEM, IMMEDIATE) */
+	MessageType: ClubCardMessageType;
+	/** ID of the player who triggered the message */
+	PlayerId: string;
+	/** Turn number when the message was created */
+	TurnCounter: number;
+	/** Dynamic data for text replacement */
+	Placeholders: {
+		[key in ClubCardPlaceholderKeysType]?: string;
+	};
+}
+
+interface ClubCardPosition {
+    x: number;
+    y: number;
+    w: number;
+}
+
+/**
+ * Represents an active card animation in progress.
+ */
+interface ClubCardActiveAnimation {
+	/** The card being animated. */
+	Card: ClubCard;
+	/** The original card (if a copy is animated). */
+	OriginalCard?: ClubCard | null;
+	/** Timestamp when the animation started (in milliseconds). */
+	StartTime: number;
+	/** Total animation duration in milliseconds. */
+	Duration: number;
+	/** Initial position of the card. */
+	StartPosition: { x: number, y: number, w: number };
+	/** Target position of the card. */
+	EndPosition: { x: number, y: number, w: number };
+	/** Whether to hide the original card during animation. */
+	HideOriginal: boolean;
+	/** Whether the original card should stay hidden after animation completes. */
+	KeepOriginalHidden: boolean;
+	/** Timeout ID for fallback handling (used to restore the card state in case of failure). */
+	SafetyTimeout: number;
+	/** Callback function called when the animation completes. */
+	OnComplete?: AnyFunction|null;
+	// Processed elsewhere
+	// /** Callback function called when the animation starts. */
+	// OnStart?: Function|null;
+	/** Animation rendering level priority*/
+	Priority: number;
+}

package/bc/NativeDeclarations/Scripts/DeclarationsStatic.d.ts

@@ -1,3 +1,6 @@
 // Statically defined types that can be swapped out for more precise, dynamically computed alternatives during the `files:csvtypescript` CI
 
 type TextKeysInterface = string;
+
+/** A type representing asset names (yes this is just a `string` alias). */
+type AssetName = string;

package/bc/NativeDeclarations/Scripts/Element.d.ts

@@ -62,7 +62,7 @@ declare namespace ElementSearchableDropdown {
 	/** Imperative helpers attached to the root element returned from {@link ElementCreateSearchableDropdown}. */
 	interface SearchableDropdownInstance {
 		bcSetOptions(optionsList: readonly OptionItem[], newValue?: string): void;
-		bcSetValue(newValue: string): void;
+		bcSetNewValue(newValue: string): void;
 		bcSetDisabled(disabled: boolean): void;
 	}