bc-stubs 96.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 bananarama92
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,2 @@
+# BC-stubs
+Auto-generated .d.ts stub files for the Bondage Club game (https://gitgud.io/BondageProjects/Bondage-College).

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

@@ -0,0 +1,41 @@
+/** @type {[number, number, number, number]} */
+declare const AssetUpperOverflowAlpha: [number, number, number, number];
+/** @type {[number, number, number, number]} */
+declare const AssetLowerOverflowAlpha: [number, number, number, number];
+/**
+ * 3D Custom Girl based assets
+ * @type {AssetGroupDefinition[]}
+ */
+declare var AssetFemale3DCG: AssetGroupDefinition[];
+/** 3D Custom Girl based pose
+ * @type {Pose[]}
+ */
+declare var PoseFemale3DCG: Pose[];
+/**
+ * List of all available pose names in the game
+ * @constant {AssetPoseName[]}
+ */
+declare var PoseFemale3DCGNames: AssetPoseName[];
+/**
+ * 3D Custom Girl based activities
+ *
+ * The ordering is supposed to match what body part they use, in order:
+ * mouth, hand, feet, whole-body, head, then the item-related ones.
+ * Inside that, they get sorted by softest to harshest, when that makes sense.
+ *
+ * @type {Activity[]}
+ */
+declare var ActivityFemale3DCG: Activity[];
+/**
+ * Display order for activities.
+ * @type {ActivityName[]}
+ */
+declare let ActivityFemale3DCGOrdering: ActivityName[];
+/**
+ * 3D Custom Girl based fetishes
+ * @type {{Name: FetishName; GetFactor(C: Character): number; }[]}
+ */
+declare var FetishFemale3DCG: {
+    Name: FetishName;
+    GetFactor(C: Character): number;
+}[];

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

@@ -0,0 +1,29 @@
+/**
+ * Female3DCGExtended.js
+ * ---------------------
+ * This file contains definitions and configuration for extended items. Items which are marked as Extended in
+ * `Female3DCG.js` and which have an extended item definition here will have their load/draw/click functions
+ * _automatically_ created when assets are loaded, saving the need for an individual extended item script.
+ *
+ * Currently, modular and typed items are supported, and this is likely to expand in the future.
+ */
+/**
+ * An enum encapsulating the available extended item archetypes
+ * MODULAR - Indicates that this item is modular, with several independently configurable modules
+ * @type {{MODULAR: "modular", TYPED: "typed", VIBRATING: "vibrating", VARIABLEHEIGHT: "variableheight", TEXT: "text"}}
+ * @see {@link ModularItemConfig}
+ * @see {@link TypedItemConfig}
+ */
+declare const ExtendedArchetype: {
+    MODULAR: "modular";
+    TYPED: "typed";
+    VIBRATING: "vibrating";
+    VARIABLEHEIGHT: "variableheight";
+    TEXT: "text";
+};
+/**
+ * An object containing all extended item configurations.
+ * @type {ExtendedItemMainConfig}
+ * @const
+ */
+declare var AssetFemale3DCGExtended: ExtendedItemMainConfig;

package/bc/Backgrounds/Backgrounds.d.ts

@@ -0,0 +1,37 @@
+/**
+ * Builds the selectable background arrays based on the tags supplied
+ * @param {readonly BackgroundTag[]} BackgroundTagList - An array of string of all the tags to load
+ * @returns {string[]} - The list of all background names
+ */
+declare function BackgroundsGenerateList(BackgroundTagList: readonly BackgroundTag[]): string[];
+declare const BackgroundsTagNone: "Filter by tag";
+declare const BackgroundsTagIndoor: "Indoor";
+declare const BackgroundsTagOutdoor: "Outdoor";
+declare const BackgroundsTagAquatic: "Aquatic";
+declare const BackgroundsTagSpecial: "Special Events";
+declare const BackgroundsTagSciFiFantasy: "SciFi & Fantasy";
+declare const BackgroundsTagClub: "Club & College";
+declare const BackgroundsTagHouse: "Regular house";
+declare const BackgroundsTagDungeon: "Dungeon";
+declare const BackgroundsTagAsylum: "Asylum";
+/**
+ * List of all tags to create online chat rooms
+ * @constant
+ * @type {BackgroundTag[]}
+ */
+declare const BackgroundsTagList: BackgroundTag[];
+/**
+ * List of all tags to setup your main hall or private room
+ * @constant
+ * @type {BackgroundTag[]}
+ */
+declare const BackgroundsPrivateRoomTagList: BackgroundTag[];
+/**
+ * List of all the common backgrounds.
+ * @constant
+ * @type {{ Name: string; Tag: BackgroundTag[]; }[]}
+ */
+declare const BackgroundsList: {
+    Name: string;
+    Tag: BackgroundTag[];
+}[];