bc-stubs 96.0.0

package/bc/Screens/Room/PlatformIntro/PlatformIntro.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Loads the screen
+ * @returns {void} - Nothing
+ */
+declare function PlatformIntroLoad(): void;
+/**
+ * Runs and draws the screen.
+ * @returns {void} - Nothing
+ */
+declare function PlatformIntroRun(): void;
+/**
+ * Handles clicks in the screen
+ * @returns {void} - Nothing
+ */
+declare function PlatformIntroClick(): void;
+/**
+ * When the screens exits
+ * @returns {void} - Nothing
+ */
+declare function PlatformIntroExit(): void;
+declare var PlatformIntroDrawAsset: number;

package/bc/Screens/Room/PlatformProfile/PlatformProfile.d.ts

@@ -0,0 +1,62 @@
+/**
+ * Returns the number of available perks for the current player character
+ * @returns {number} - The number of perks
+ */
+declare function PlatformProfileGetFreePerk(): number;
+/**
+ * Draws a black arrow that goes down and right
+ * @param {number} SX - The source X position on screen
+ * @param {number} SY - The source Y position on screen
+ * @param {number} TX - The target X position on screen
+ * @param {number} TY - The target Y position on screen
+ * @returns {void} - Nothing
+ */
+declare function PlatformProfileDrawArrow(SX: number, SY: number, TX: number, TY: number): void;
+/**
+ * Loads the screen and removes the key listeners
+ * @returns {void} - Nothing
+ */
+declare function PlatformProfileLoad(): void;
+/**
+ * Draws the perk button on the screen, the color changes based on if the perk is available or paid
+ * @param {number} X - The X position on screen
+ * @param {number} Y - The Y position on screen
+ * @param {number} PerkNum - The perk number for the current character
+ * @param {Object} Prerequisite1 - If there's a first prerequisite to validate
+ * @param {Object} Prerequisite2 - If there's a second prerequisite to validate
+ * @returns {void} - Nothing
+ */
+declare function PlatformProfileDrawPerkButton(X: number, Y: number, PerkNum: number, Prerequisite1: any, Prerequisite2: any): void;
+/**
+ * Returns the text associated to the bonus given by the owner of the current player
+ * @param {Object} PlatformChar - The platform character to evaluate
+ * @returns {string} - The text string linked to the bonus
+ */
+declare function PlatformGetOwnerBonus(PlatformChar: any): string;
+/**
+ * Returns the text associated to the bonus given by the lover of the current player
+ * @param {Object} PlatformChar - The platform character to evaluate
+ * @returns {string} - The text string linked to the bonus
+ */
+declare function PlatformGetLoverBonus(PlatformChar: any): string;
+/**
+ * Runs and draws the screen.
+ * @returns {void} - Nothing
+ */
+declare function PlatformProfileRun(): void;
+/**
+ * Adds the perk as an active perk for the current character
+ * @param {number} PerkNum - The perk number for the current character
+ * @returns {void} - Nothing
+ */
+declare function PlatformProfileBuyPerk(PerkNum: number): void;
+/**
+ * Handles clicks in the screen
+ * @returns {void} - Nothing
+ */
+declare function PlatformProfileClick(): void;
+/**
+ * When the screens exits, we unload the listeners
+ * @returns {void} - Nothing
+ */
+declare function PlatformProfileExit(): void;

package/bc/Screens/Room/Poker/Poker.d.ts

@@ -0,0 +1,141 @@
+/**
+ * Loads the Bondage Poker room
+ * @returns {void} - Nothing
+ */
+declare function PokerLoad(): void;
+/**
+ * Draws a poker player behind the table
+ * @param {PokerPlayer} P
+ * @param {number} X
+ * @param {number} Y
+ * @returns {void} - Nothing
+ */
+declare function PokerDrawPlayer(P: PokerPlayer, X: number, Y: number): void;
+/**
+ * Gets the chip progress of the current player P
+ * @param {PokerPlayer} P
+ * @returns {number} - The progress as a %
+ */
+declare function PokerGetProgress(P: PokerPlayer): number;
+/**
+ * Gets a possible text for a poker player P
+ * @param {PokerPlayer} P
+ * @param {string} [Tag]
+ * @returns {void} - Nothing
+ */
+declare function PokerGetText(P: PokerPlayer, Tag?: string): void;
+/**
+ * Gets a possible image for a poker player P
+ * @param {PokerPlayer} P
+ * @returns {void} - Nothing
+ */
+declare function PokerGetImage(P: PokerPlayer): void;
+/**
+ * Runs & Draws the Bondage Poker room
+ * @returns {void} - Nothing
+ */
+declare function PokerRun(): void;
+/**
+ * Clears the player data for player P
+ * @param {PokerPlayer} P
+ * @returns {void} - Nothing
+ */
+declare function PokerClearData(P: PokerPlayer): void;
+/**
+ * Returns TRUE if the opponent has been unlocked and can be faced
+ * @param {string} Opponent
+ * @returns {boolean}
+ */
+declare function PokerChallengeUnlocked(Opponent: string): boolean;
+/**
+ * Picks the next/previous opponent family for a player P
+ * @param {PokerPlayer} P - The player to change
+ * @param {boolean} Next - Whether to pick the next or previous opponent
+ * @returns {void} - Nothing
+ */
+declare function PokerChangeOpponentFamily(P: PokerPlayer, Next: boolean): void;
+/**
+ * Picks the next/previous opponent for a player P
+ * @param {PokerPlayer} P
+ * @param {boolean} Next - true for next, false for previous
+ * @returns {void} - Nothing
+ */
+declare function PokerChangeOpponent(P: PokerPlayer, Next: boolean): void;
+/**
+ * Picks the next challenge in the list
+ * @returns {PokerPlayer} - Nothing
+ */
+declare function PokerNextChallenge(): PokerPlayer;
+/**
+ * Handles the click events.  Called from CommonClick()
+ * @returns {void} - Nothing
+ */
+declare function PokerClick(): void;
+/**
+ * Handles key presses during the bondage poker game
+ * @returns {void} - Nothing
+ */
+declare function PokerKeyDown(): void;
+/**
+ * When the player exits from Bondage Poker
+ * @returns {void} - Nothing
+ */
+declare function PokerExit(): void;
+/**
+ * Draws a card for a poker player PP
+ * @param {PokerPlayer} PP
+ * @returns {void} - Nothing
+ */
+declare function PokerDrawCard(PP: PokerPlayer): void;
+/**
+ * Returns the file name associated with the card
+ * @param {number} Card
+ * @returns {string} - The file name of the card image
+ */
+declare function PokerCardFileName(Card: number): string;
+/**
+ * Draw one card on the poker table, only used in Texas Hold'em
+ * @returns {void} - Nothing
+ */
+declare function PokerTableDraw(): void;
+/**
+ * When all players chip in the pot
+ * @returns {void} - Nothing
+ */
+declare function PokerAddPot(Multiplier: any, StartPos: any): void;
+/**
+ * When the player wins, she can unlock new opponents and win money
+ * @returns {void}
+ */
+declare function PokerChallengeDone(): void;
+/**
+ * Process an action to advance the poker game
+ * @param {string} Action - Bet, Raise, Fold or Watch
+ * @returns {string} - The file name of the card image
+ */
+declare function PokerProcess(Action: string): string;
+/**
+ * Deals a fresh new hand for all poker players
+ * @returns {void} - Nothing
+ */
+declare function PokerDealHands(): void;
+declare var PokerBackground: string;
+/** @type {PokerPlayer[]} */
+declare var PokerPlayer: PokerPlayer[];
+/** @type {PokerMode} */
+declare var PokerMode: PokerMode;
+/** @type {PokerGameType} */
+declare var PokerGame: PokerGameType;
+declare var PokerShowPlayer: boolean;
+/** @type {PokerAsset[]} */
+declare var PokerAsset: PokerAsset[];
+declare var PokerPlayerCount: number;
+/** @type {number[]} */
+declare var PokerTableCards: number[];
+declare var PokerMessage: string;
+declare var PokerResultMessage: string;
+declare var PokerAnte: number;
+declare var PokerAnteCount: number;
+declare var PokerPot: number;
+declare var PokerChallenge: string[];
+declare var PokerOpponentList: string[];

package/bc/Screens/Room/Poker/PokerHandValue.d.ts

@@ -0,0 +1,65 @@
+/**
+ * Sort the current hand from highest to lowest
+ * @param {PokerHand} Hand
+ */
+declare function PokerHandValueSortHand(Hand: PokerHand): void;
+/**
+ * Validate if the current hand is a straight flush (value 9)
+ * @param {PokerHand} Hand
+ */
+declare function PokerHandValueStraightFlush(Hand: PokerHand): number;
+/**
+ * Validate if the current hand is a four of a kind (value 8)
+ * @param {PokerHand} Hand
+ */
+declare function PokerHandValueFourOfAKind(Hand: PokerHand): number;
+/**
+ * Validate if the current hand is a full house (value 7)
+ * @param {PokerHand} Hand
+ */
+declare function PokerHandValueFullHouse(Hand: PokerHand): number;
+/**
+ * Validate if the current hand is a flush (value 6)
+ * @param {PokerHand} Hand
+ */
+declare function PokerHandValueFlush(Hand: PokerHand): number;
+/**
+ * Validate if the current hand is a straight (value 5)
+ * @param {PokerHand} Hand
+ */
+declare function PokerHandValueStraight(Hand: PokerHand): number;
+/**
+ * Validate if the current hand is a three of a kind (value 4)
+ * @param {PokerHand} Hand
+ */
+declare function PokerHandValueThreeOfAKind(Hand: PokerHand): number;
+/**
+ * Validate if the current hand is a two pairs (value 3)
+ * @param {PokerHand} Hand
+ */
+declare function PokerHandValueTwoPairs(Hand: PokerHand): number;
+/**
+ * Validate if the current hand is a one pair (value 2)
+ * @param {PokerHand} Hand
+ */
+declare function PokerHandValueOnePair(Hand: PokerHand): number;
+/**
+ * Allocate the highest card value for the leading 5 cards (value 1)
+ * @param {PokerHand} Hand
+ */
+declare function PokerHandValueHighestCards(Hand: PokerHand): number;
+/**
+ * Return a decimal to express the hand value
+ * @param {number} C1
+ * @param {number} C2
+ * @param {PokerGameType} GameType
+ * @param {PokerMode} CurrentMode
+ * @param {number[]} TableCards
+ */
+declare function PokerHandValueCalcHandValue(C1: number, C2: number, GameType: PokerGameType, CurrentMode: PokerMode, TableCards: number[]): number;
+/**
+ * Return a text version of a decimal hand value
+ * @param {number} Value
+ * @returns {string}
+ */
+declare function PokerHandValueTextHandValue(Value: number): string;

package/bc/Screens/Room/Prison/Prison.d.ts

@@ -0,0 +1,118 @@
+declare function PrisonPlayerIsHandcuffed(): boolean;
+declare function PrisonPlayerIsPanelGag(): boolean;
+declare function PrisonPlayerIsLegTied(): boolean;
+declare function PrisonPlayerIsFeetTied(): boolean;
+declare function PrisonPlayerIsOTMGag(): boolean;
+declare function PrisonPlayerIsStriped(): boolean;
+declare function PrisonPlayerIsBadGirl(): boolean;
+declare function PrisonPlayerIsBadGirlThief(): boolean;
+declare function PrisonPlayerHasSleepingPills(): boolean;
+declare function PrisonPlayerHasSpankingToys(): boolean;
+declare function PrisonPlayerHasKeys(): boolean;
+declare function PrisonSubIsHandcuffedOut(): boolean;
+declare function PrisonSubIsBehindBars(): boolean;
+declare function PrisonSubIsFree(): boolean;
+declare function PrisonSubAskForCuff(): boolean;
+declare function PrisonSubCanStripSearch(): boolean;
+declare function PrisonSubCanClothBack(): boolean;
+declare function PrisonLoad(): void;
+declare function PrisonRun(): void;
+declare function PrisonClick(): void;
+declare function PrisonCharacterAppearanceAvailable(C: any, AppearanceName: any, AppearanceGroup: any): boolean;
+declare function PrisonCharacterAppearanceGroupAvailable(C: any, AppearanceGroup: any): boolean;
+declare function PrisonCellPlayerIn(): void;
+declare function PrisonCellPlayerOut(): void;
+/**
+ * @param {InventoryItem[]} items
+ */
+declare function PrisonSaveConfiscatedItems(items: InventoryItem[]): void;
+/** */
+declare function PrisonRestoreConfiscatedItems(): void;
+declare function PrisonMaidLeave(): void;
+declare function PrisonCellRelease(C: any): void;
+declare function PrisonHavySearch(C: any): void;
+declare function PrisonLightSearch(C: any): void;
+declare function PrisonerClothBack(C: any): void;
+declare function PrisonCuffsRelief(): void;
+declare function PrisonMaidLightTorture(): void;
+declare function PrisonMaidHevyTorture(): void;
+declare function PrisonDisableKey(C: any): void;
+declare function PrisonCellPlayerAsk(): void;
+declare function PrisonCellPlayerShake(): void;
+declare function PrisonCellPlayerTry(): void;
+declare function PrisonCellPlayerWimper(): void;
+declare function PrisonCellPlayerWait(): void;
+declare function PrisonSubSendAway(): void;
+declare function PrisonSubHandcuffing(): void;
+declare function PrisonCellSubIn(): void;
+declare function PrisonSubHavySearch(): void;
+declare function PrisonCellSubOut(): void;
+declare function PrisonLeaveCell(): void;
+declare function PrisonSubClothBack(): void;
+declare function PrisonBecomeBadGirl(): void;
+declare function PrisonLeaveBadGirl(): void;
+declare function PrisonWearPoliceEquipment(C: any): void;
+declare function PrisonWantedPlayer(): 1 | 4 | 7 | 9;
+declare function PrisonMeetPoliceIntro(RoomBackground: any): void;
+declare function PrisonPutHandsInTheAir(): void;
+declare function PrisonRaiseHandsHigher(): void;
+declare function PrisonCatchKneel(): void;
+declare function PrisonCatchHandcuffed(): void;
+declare function PrisonCatchKneelingEscape(): void;
+declare function PrisonCatchComplain(): void;
+declare function PrisonCatchAdmitDefeat(): void;
+declare function PrisonFightPolice(): void;
+declare function PrisonFightPoliceEnd(): void;
+declare function PrisonFightPoliceOutro(): void;
+declare function PrisonCatchByPolice(): void;
+declare function PrisonSetBehavior(Behavior: any): void;
+declare function PrisonArrestHandoverDices(): void;
+declare function PrisonArrestHandoverKeys(): void;
+declare function PrisonArrestHandoverSleepingPills(): void;
+declare function PrisonArrestHandoverSpankingToys(): void;
+declare function PrisonArrestStripOuterCloth(): void;
+declare function PrisonCharacterIsInUnderwear(): boolean;
+declare function PrisonArrestStripUnderware(): void;
+declare function PrisonArrestSuit(): void;
+declare function PrisonArrestShackle(): void;
+declare function PrisonArrestEquipmentSearch(): void;
+declare function PrisonArrestConfiscatDices(): void;
+declare function PrisonArrestConfiscatKeys(): void;
+declare function PrisonArrestConfiscatSleepingPills(): void;
+declare function PrisonArrestConfiscatSpankingToys(): void;
+declare function PrisonArrestLeave(): void;
+declare function PrisonDiceBack(): void;
+declare var PrisonBackground: string;
+/** @type {null | number} */
+declare var PrisonNextEventTimer: null | number;
+declare var PrisonNextEvent: boolean;
+declare var PrisonBehavior: number;
+/** @type {null | NPCCharacter} */
+declare var PrisonMaid: null | NPCCharacter;
+/** @type {null | Item[]} */
+declare var PrisonMaidAppearance: null | Item[];
+declare var PrisonMaidIsPresent: boolean;
+declare var PrisonMaidIsAngry: boolean;
+/** @type {null | string} */
+declare var PrisonMaidCharacter: null | string;
+declare var PrisonMaidCharacterList: string[];
+/** @type {null | number} */
+declare var PrisonMaidChaotic: null | number;
+/** @type {null | NPCCharacter} */
+declare var PrisonSub: null | NPCCharacter;
+/** @type {null | Item[]} */
+declare var PrisonSubAppearance: null | Item[];
+declare var PrisonSubBehindBars: boolean;
+declare var PrisonSubSelfCuffed: boolean;
+declare var PrisonSubIsPresent: boolean;
+declare var PrisonSubAskedCuff: boolean;
+declare var PrisonSubIsLeaveOut: boolean;
+declare var PrisonSubIsStripSearch: boolean;
+/** @type {null | NPCCharacter} */
+declare var PrisonPolice: null | NPCCharacter;
+declare var PrisonPoliceIsPresent: boolean;
+declare var PrisonPlayerCatchedBadGirl: boolean;
+/** @type {null | Item[]} */
+declare var PrisonPlayerAppearance: null | Item[];
+declare var PrisonPlayerBehindBars: boolean;
+declare var PrisonPlayerForIllegalChange: boolean;