bc-stubs 114.0.0 → 115.0.0

package/bc/NativeDeclarations/Female3DCG_Types.d.ts

@@ -657,6 +657,7 @@ interface AssetDefinitionBase extends AssetCommonPropertiesGroupAsset, AssetComm
 	AllowHideItem?: string[];
 	/** @deprecated */
 	AllowTypes?: never;
+	/** A list of {@link TypeRecord} keys for which a single layer expects multiple type-specific .png files. */
 	CreateLayerTypes?: string[];
 	/**
 	 * Whether an item can be tightened or not.
@@ -805,6 +806,12 @@ type AssetDefinition = (
 	| AssetDefinition.Script
 );
 
+interface AssetLayerMaskTexureDefinition {
+	/** The groups that will be affected */
+	Groups?: AssetGroupName[];
+	/** If true, the texture mask will apply to all layers in the groups specified, event if their priority is higher than the mask layer */ 
+	ApplyToAbove?: boolean;
+}
 
 interface AssetLayerDefinition extends AssetCommonPropertiesGroupAssetLayer, AssetCommonPropertiesAssetLayer {
 	/** The layer's name */
@@ -819,7 +826,7 @@ interface AssetLayerDefinition extends AssetCommonPropertiesGroupAssetLayer, Ass
 	/** Whether the layer is hidden in the Color Picker UI. Defaults to false. */
 	HideColoring?: boolean;
 
-	/** A record (or a list thereof) with all screen names + option indices that should make the layer visible */
+	/** A record (or a list thereof) with all screen names + option indices, _i.e._ {@link TypeRecord} keys + values, that should make the layer visible */
 	AllowTypes?: AllowTypes.Definition;
 
 	/**
@@ -848,6 +855,15 @@ interface AssetLayerDefinition extends AssetCommonPropertiesGroupAssetLayer, Ass
 	 */
 	BlendingMode?: GlobalCompositeOperation;
 
+
+	/**
+	 * Mark the layer as a mask layer, which will be used to apply alpha masks to other layers.
+	 * Only the alpha channel of the image, and positioning are concerned for a mask layer.
+	 * The color, priority and alpha are ignored for mask layers.
+	 * The blending mode of the mask layer must be set to "destination-in" or "destination-out".
+	 */
+	TextureMask?: AssetLayerMaskTexureDefinition;
+
 	/**
 	 * Specify that this is (one of) the asset's lock layer.
 	 *
@@ -867,6 +883,11 @@ interface AssetLayerDefinition extends AssetCommonPropertiesGroupAssetLayer, Ass
 	 */
 	CopyLayerPoseMapping?: string;
 
+	/**
+	 * A list of {@link TypeRecord} keys for which a single layer expects multiple type-specific .png files.
+	 *
+	 * By default files are expected for _all_ option indices associated with the key(s), unless the valid option set has been narrowed down according to {@link AssetLayerDefinition.AllowTypes}.
+	 */
 	CreateLayerTypes?: string[];
 	/* Specifies that this layer should not be drawn if the character is wearing any item with the given attributes */
 	HideForAttribute?: AssetAttribute[];

package/bc/NativeDeclarations/FriendList.d.ts

@@ -1,6 +1,6 @@
 type FriendListModes = FriendListMode[];
 type FriendListMode = "OnlineFriends" | "Beeps" | "AllFriends";
-type FriendListSortingMode = 'None' | 'MemberName' | 'MemberNickname' | 'MemberNumber' | 'ChatRoomName' | 'RelationType';
+type FriendListSortingMode = 'None' | 'MemberName' | 'MemberNickname' | 'MemberNumber' | 'ChatRoomName' | 'RelationType' | 'ChatRoomType';
 type FriendListSortingDirection = 'Asc' | 'Desc';
 
 type FriendListReturn<T extends ModuleType> = { Screen: ModuleScreens[T], Module: T, IsInChatRoom?: boolean, hasScrolledChat?: boolean };
@@ -19,6 +19,7 @@ type FriendRawRoom = {
   name?: string;
   caption: string;
   canSearchRoom: boolean;
+  types: FriendListIcon[];
 };
 
 type FriendRawBeep = {
@@ -27,3 +28,12 @@ type FriendRawBeep = {
   hasMessage?: boolean;
   canBeep?: boolean;
 };
+
+interface FriendListIcon {
+  /** The {@link HTMLImageElement.src} of the icon */
+  src: string;
+  /** The `Character/FriendList` {@link TextGet} key of the icon's tooltip */
+  tooltipKey: string;
+  /** A string to-be used for sorting the icon-containing column cells */
+  sortKey: string;
+}

package/bc/NativeDeclarations/Messages.d.ts

@@ -750,6 +750,20 @@ interface ActivityNameDictionaryEntry {
 	ActivityName: ActivityName;
 }
 
+/**
+ * A dictionary entry indicating the ID of a message being replied to.
+ */
+interface ReplyIdDictionaryEntry {
+	ReplyId: string;
+	Tag: "ReplyId";
+}
+/**
+ * A dictionary entry indicating the ID of a message.
+ */
+interface MsgIdDictionaryEntry {
+	MsgId: string;
+	Tag: "MsgId";
+}
 /**
  * A dictionary entry with metadata about the chat message transmitted.
  *
@@ -777,7 +791,10 @@ type ChatMessageDictionaryEntry =
 	| ActivityCounterDictionaryEntry
 	| AssetGroupNameDictionaryEntry
 	| ActivityNameDictionaryEntry
-	| MessageEffectEntry;
+	| MessageEffectEntry
+	| MsgIdDictionaryEntry
+	| ReplyIdDictionaryEntry ;
+
 
 type ChatMessageDictionary = ChatMessageDictionaryEntry[];
 

package/bc/NativeDeclarations/Platform.d.ts

@@ -0,0 +1,285 @@
+declare namespace Platform {
+
+	type Perk = string;
+
+	type CharacterStatus = "Maid" | "Oracle" | "Archer" | "Thief"
+
+	type SoundCategory = string;
+	type SoundEffect = string;
+
+	type EffectType = "Teleport" | "Heal";
+
+	type AnimationName = "Petrified" | "Bound" | "HalfBoundWounded" | "Wounded" | "Aim" | "AimReady" | "AimFull" | "Bind" | "Jump" | "HalfBoundJump" | "Crawl" | "Stun" | "HalfBoundStun" | "Walk" | "HalfBoundWalk" | "WalkHit" | "Run" | "HalfBoundRun" | "Crouch" | "Block" | "Idle" | "HalfBoundIdle"
+		| "Uppercut" | "StandAttackFast" | "StandAttackSlow" | "CrouchAttackFast" | "CrouchAttackSlow" | "Scream" | "Backflip" | "FireProjectile" | "Left" | "Right";
+
+	type ItemName = "RedRose" | "PoisonApple" | "LeatherWhip" | "AnimalCollar";
+
+	interface AnimationSpec {
+		Name: AnimationName;
+		Cycle?: number[];
+		Speed?: number;
+		Audio?: SoundEffect[];
+		CycleLeft?: number[];
+		OffsetX?: number;
+		OffsetY?: number;
+		Width?: number;
+		Height?: number;
+		Image?: number;
+		Mirror?: boolean;
+	}
+
+	interface DummyTemplate {
+		Name: string;
+		Status: string;
+		Width: number;
+		Height: number;
+		Animation: AnimationSpec[];
+
+		OnBind?: () => void;
+
+		Loot?: { Name: ItemName, Expire: number; }[];
+	}
+
+	interface CharacterTemplate {
+		Name: string;
+		Status: string;
+
+		Width: number;
+		Height: number;
+
+		HitBox: RectTuple;
+		JumpHitBox?: RectTuple;
+
+		Health: number;
+		HealthPerLevel?: number;
+		ExperienceValue?: number;
+
+		Magic?: number;
+		MagicPerLevel?: number;
+
+		Projectile?: number;
+		ProjectileName?: ProjectileName;
+		ProjectileType?: ProjectileType;
+		ProjectileTime?: number;
+		ProjectileDamage?: number[];
+		ProjectileBothSides?: boolean;
+
+		Perk?: string;
+		PerkName?: PerkName[];
+
+		WalkSpeed: number;
+		RunSpeed?: number;
+		CrawlSpeed: number;
+		JumpForce?: number;
+		CollisionDamage?: number;
+
+		JumpOdds?: number;
+		LootOdds?: number;
+		RunOdds?: number;
+		ProjectileOdds?: number;
+		StandAttackSlowOdds?: number;
+
+		DamageBackOdds?: number;
+		DamageFaceOdds?: number;
+		DamageKnockForce?: number;
+
+		IdleAudio?: SoundEffect[];
+		DamageAudio?: SoundEffect[];
+		DownAudio?: SoundEffect[];
+		BindAudio?: SoundEffect[];
+		ProjectileHitAudio?: SoundEffect[];
+
+		RunHeight?: number;
+		FlyingHeight?: number;
+		IdleTurnToFace?: boolean;
+		PetrifyOnWound?: boolean;
+
+		Animation: AnimationSpec[];
+
+		Attack?: {
+			Name: string;
+			HitBox?: RectTuple;
+			HitAnimation?: number[];
+
+			Magic?: number;
+			Cooldown?: number;
+
+			StartAudio?: string[];
+			HitAudio?: string[];
+
+			Damage?: number[];
+			Speed: number;
+			JumpForce?: number;
+		}[];
+
+
+		OnBind?: () => void;
+
+		Loot?: { Name: ItemName, Expire: number; }[];
+	}
+
+	type ProjectileName = "Barrel" | "Arrow" | "Dagger";
+	type ProjectileType = "Wood" | "Iron";
+
+	interface Projectile {
+		IsProjectile: true;
+		Gravity: number;
+		ProjectileForce: number;
+		HitAudio: SoundEffect[];
+	}
+
+	interface Character extends CharacterTemplate, Projectile {
+		ID: number;
+		Camera: boolean;
+		X: number;
+		Y: number;
+		ForceX: number;
+		ForceY: number;
+		Experience: number;
+		Level: number;
+		BaseHealth: number;
+		BaseMagic?: number;
+		BaseProjectile?: number;
+		BaseProjectileTime?: number;
+		BaseWalkSpeed: number;
+		BaseRunSpeed: number;
+
+		MaxHealth: number;
+		MaxMagic?: number;
+		MaxProjectile?: number;
+
+		Fix: boolean;
+		Combat: boolean;
+		Dialog: string;
+
+		Run: boolean;
+		NextJump: number;
+
+		DamageBackOdds: number;
+		DamageFaceOdds: number;
+
+		FaceLeft: boolean;
+
+		HalfBound: boolean;
+		Bound: boolean;
+		Petrified: boolean;
+
+		OnBind?: () => void;
+
+		Immunity: number;
+		Damage: { Value: number, Expire: number }[];
+		RiseTime: number;
+		ProjectileAim: number;
+
+		Action: { Name: AnimationName, Start: number, Expire: number, Target?: number, Done?: boolean };
+		Effect?: { Name: EffectType, End: number };
+
+		Anim?: AnimationSpec;
+	}
+
+	interface PartyMember {
+		Character: string;
+		Status: Platform.CharacterStatus;
+		Level: number;
+		Experience: number;
+		Perk: string;
+	}
+
+	interface DialogCharacter {
+		Name: string;
+		Color: HexColor;
+
+		NickName?: string;
+
+		Love?: number;
+		LoverName?: string;
+		LoverLevel?: number;
+		OwnerName?: string;
+		OwnerLevel?: number;
+
+		Domination?: number;
+
+		IdlePose?: CharacterStatus[];
+	}
+
+	type RoomType = "Up" | "Down" | "Left" | "Right";
+
+	interface Room {
+		Name: string;
+		Text?: string;
+		Background: string;
+		AlternateBackground?: string;
+		BackgroundFilter?: string;
+		Music: string;
+		Width?: number;
+		Height?: number;
+		LimitLeft?: number | null;
+		LimitRight?: number | null;
+		Heal?: number;
+		Door?: {
+			Name: string;
+			FromX: number;
+			FromY: number;
+			FromW: number;
+			FromH: number;
+			FromType: RoomType;
+			ToX: number;
+			ToFaceLeft?: boolean;
+		}[];
+
+		Character?: {
+			Name: string;
+			Status: string;
+			X: number;
+			Fix?: boolean;
+			Combat?: boolean;
+			Battle?: boolean;
+			Dialog?: string;
+		}[];
+
+		Entry?: () => void;
+	}
+
+	interface Item {
+		Name: ItemName;
+		DisplayName: string;
+		Description: string;
+		OnGive: (Char: Platform.DialogCharacter) => void;
+	}
+
+	type EventType =
+		| "ThiefBossIntro" | "ThiefBossDefeat" | "ThiefBossSecondDefeat" | "ThiefBossRetreat"
+		| "EdlaranKey" | "EdlaranForestKey" | "EdlaranIntro" | "EdlaranCurseIntro" | "EdlaranUnlock" | "EdlaranBedroomIsabella"
+		| "EdlaranCountessBedroomOrgasmDom" | "EdlaranCountessBedroomOrgasmSub" | "EdlaranWineCellar" | "EdlaranJoin"
+		| "EdlaranForestIntro"
+		| "IntroForestBandit" | "ForestBanditCrate"
+		| "ForestCapture" | "ForestCaptureEnd" | "ForestCaptureRescueMelody"
+		| "BarnThiefRescueMelody"
+		| "CamilleEscape" | "CamilleDefeat"
+		| "JealousMaid" | "CursedMaid"
+		| "OliviaCollarKey" | "OliviaUnchain" | "OliviaBath" | "OliviaBathOrgasm"
+		| "OliviaCurseIntro" | "OliviaCurseRelease"
+		| "OliviaTerrace" | "OliviaTerraceKiss"
+		| "OliviaCabin" | "EdlaranCabin" | "LynCabin"
+		| "OliviaTent" | "EdlaranTent" | "LynTent"
+		| "IntroGuard" | "IntroGuardCurse"
+		| "DesertEntrance"
+		| "Curse"
+		| "LynJoin"
+		;
+
+	interface Event {
+		// Doesn't appear to be used for anything, just saved and loaded
+	}
+
+	type PerkName = "Healthy" | "Robust" | "Vigorous" | "Spring" | "Impact" | "Block" | "Deflect" | "Seduction" | "Persuasion" | "Manipulation" | "Apprentice" | "Witch" | "Meditation" | "Scholar" | "Heal" | "Cure" | "Howl" | "Roar" | "Teleport" | "Freedom" | "Fletcher" | "Burglar" | "Athletic" | "Sprint" | "Backflip" | "Acrobat" | "Archery" | "Celerity" | "Capacity" | "Sneak" | "Backstab" | "Kidnapper" | "Rigger" | "Thief" | "Bounce" | "Inventory" | "Duplicate";
+
+	type KeyCode = string;
+
+	type CooldownType = AnimationName | EffectType;
+	interface Cooldown {
+		Type: CooldownType;
+		Time: number;
+		Delay: number;
+	}
+}