bc-stubs 96.0.0

package/bc/Scripts/Asset.d.ts

@@ -0,0 +1,216 @@
+/**
+ * Adds a new asset group to the main list
+ * @param {IAssetFamily} Family
+ * @param {AssetGroupDefinition} GroupDef
+ * @returns {AssetGroup}
+ */
+declare function AssetGroupAdd(Family: IAssetFamily, GroupDef: AssetGroupDefinition): AssetGroup;
+/**
+ * Collects the group equivalence classes defined by the MirrorActivitiesFrom property into a map for easy access to
+ * mirror group sets (i.e. all groups that are mirror activities from, or are mirrored by, each other).
+ * @param {AssetGroup} group - The group to register
+ */
+declare function AssetActivityMirrorGroupSet(group: AssetGroup): void;
+/**
+ * Adds a new asset to the main list
+ * @param {AssetGroup} Group
+ * @param {AssetDefinition} AssetDef
+ * @param {ExtendedItemMainConfig} ExtendedConfig
+ * @returns {void} - Nothing
+ */
+declare function AssetAdd(Group: AssetGroup, AssetDef: AssetDefinition, ExtendedConfig: ExtendedItemMainConfig): void;
+/**
+ * Construct the items extended item config, merging via {@link AssetArchetypeConfig.CopyConfig} if required.
+ * Potentially updates the passed {@link AssetArchetypeConfig} object inplace.
+ * @param {Asset} A - The asset to configure
+ * @param {AssetArchetypeConfig} config - The extended item configuration of the base item
+ * @param {ExtendedItemMainConfig} extendedConfig - The extended item configuration object for the asset's family
+ * @returns {null | AssetArchetypeConfig} - The oiginally passed base item configuration, potentially updated inplace.
+ * Returns `null` insstead if an error was encountered.
+ */
+declare function AssetBuildConfig(A: Asset, config: AssetArchetypeConfig, extendedConfig: ExtendedItemMainConfig): null | AssetArchetypeConfig;
+/**
+ * Constructs extended item functions for an asset, if extended item configuration exists for the asset.
+ * Updates the passed config inplace if {@link ExtendedItem.CopyConfig} is present.
+ * @param {Asset} A - The asset to configure
+ * @param {AssetArchetypeConfig} baseConfig - The extended item configuration of the base item
+ * @param {ExtendedItemMainConfig} extendedConfig - The extended item configuration object for the asset's family
+ * @param {null | ExtendedItemOption} parentOption
+ * @param {boolean} createCallbacks
+ * @returns {null | AssetArchetypeData} - The extended itemdata or `null` if an error was encoutered
+ */
+declare function AssetBuildExtended(A: Asset, baseConfig: AssetArchetypeConfig, extendedConfig: ExtendedItemMainConfig, parentOption?: null | ExtendedItemOption, createCallbacks?: boolean): null | AssetArchetypeData;
+/**
+ * Finds the extended item configuration for the provided group and asset name, if any exists
+ * @param {ExtendedItemMainConfig} ExtendedConfig - The full extended item configuration object
+ * @param {AssetGroupName} GroupName - The name of the asset group to find extended configuration for
+ * @param {string} AssetName - The name of the asset to find extended configuration fo
+ * @returns {AssetArchetypeConfig | undefined} - The extended asset configuration object for the specified asset, if
+ * any exists, or undefined otherwise
+ */
+declare function AssetFindExtendedConfig(ExtendedConfig: ExtendedItemMainConfig, GroupName: AssetGroupName, AssetName: string): AssetArchetypeConfig | undefined;
+/**
+ * Builds the layer array for an asset based on the asset definition. One layer is created for each drawable part of
+ * the asset (excluding the lock). If the asset definition contains no layer definitions, a default layer definition
+ * will be created.
+ * @param {AssetDefinition} AssetDefinition - The raw asset definition
+ * @param {Asset} A - The built asset
+ * @return {AssetLayer[]} - An array of layer objects representing the drawable layers of the asset
+ */
+declare function AssetBuildLayer(AssetDefinition: AssetDefinition, A: Asset): AssetLayer[];
+/**
+ * Maps a layer definition to a drawable layer object
+ * @param {AssetLayerDefinition} Layer - The raw layer definition
+ * @param {AssetDefinition} AssetDefinition - The raw asset definition
+ * @param {Asset} A - The built asset
+ * @param {number} I - The index of the layer within the asset
+ * @return {AssetLayer} - A Layer object representing the drawable properties of the given layer
+ */
+declare function AssetMapLayer(Layer: AssetLayerDefinition, AssetDefinition: AssetDefinition, A: Asset, I: number): AssetLayer;
+/**
+ * Resolves the AllowPose and HideForPose properties on a layer or an asset
+ * @param {Asset | AssetLayerDefinition} obj - The asset or layer object
+ * @param {AssetPoseName[]} defaultAllowPose - A fallback value for the AllowPose property if it's not defined on the
+ * object
+ * @return {{AllowPose: AssetPoseName[], HideForPose: (AssetPoseName | "")[]}} - A partial object containing AllowPose and HideForPose
+ * properties
+ */
+declare function AssetParsePoseProperties(obj: Asset | AssetLayerDefinition, defaultAllowPose?: AssetPoseName[]): {
+    AllowPose: AssetPoseName[];
+    HideForPose: (AssetPoseName | "")[];
+};
+/**
+ * Parses and validates asset's opacity
+ * @param {number|undefined} opacity
+ * @returns {number}
+ */
+declare function AssetParseOpacity(opacity: number | undefined): number;
+/**
+ * Determines whether a layer can be colorized, based on the layer definition and its parent asset/group definitions
+ * @param {AssetLayerDefinition} Layer - The raw layer definition
+ * @param {AssetDefinition} NewAsset - The raw asset definition
+ * @param {AssetGroup} Group - The group being processed
+ * @return {boolean} - Whether or not the layer should be permit colors
+ */
+declare function AssetLayerAllowColorize(Layer: AssetLayerDefinition, NewAsset: AssetDefinition, Group: AssetGroup): boolean;
+/**
+ * Builds the alpha mask definitions for a layer, based on the
+ * @param {AssetLayerDefinition} Layer - The raw layer definition
+ * @param {AssetDefinition} NewAsset - The raw asset definition
+ * @param {number} I - The index of the layer within its asset
+ * @return {AlphaDefinition[]} - a list of alpha mask definitions for the layer
+ */
+declare function AssetLayerAlpha(Layer: AssetLayerDefinition, NewAsset: AssetDefinition, I: number): AlphaDefinition[];
+/**
+ * Assigns color indices to the layers of an asset. These determine which colors get applied to the layer. Also adds
+ * a count of colorable layers to the asset definition.
+ * @param {Asset} A - The built asset
+ * @returns {void} - Nothing
+ */
+declare function AssetAssignColorIndices(A: Asset): void;
+/**
+ * Builds the asset description from the CSV file
+ * @param {IAssetFamily} Family
+ * @param {string[][]} CSV
+ */
+declare function AssetBuildDescription(Family: IAssetFamily, CSV: string[][]): void;
+/**
+ * Loads the description of the assets in a specific language
+ * @param {IAssetFamily} Family The asset family to load the description for
+ */
+declare function AssetLoadDescription(Family: IAssetFamily): void;
+/**
+ * Loads a specific asset file
+ * @param {readonly AssetGroupDefinition[]} Groups
+ * @param {IAssetFamily} Family
+ * @param {ExtendedItemMainConfig} ExtendedConfig
+ */
+declare function AssetLoad(Groups: readonly AssetGroupDefinition[], Family: IAssetFamily, ExtendedConfig: ExtendedItemMainConfig): void;
+/** Reset and load all the assets */
+declare function AssetLoadAll(): void;
+/**
+ * Gets a specific asset by family/group/name
+ * @param {IAssetFamily} Family - The family to search in (Ignored until other family is added)
+ * @param {AssetGroupName} Group - Name of the group of the searched asset
+ * @param {string} Name - Name of the searched asset
+ * @returns {Asset|null}
+ */
+declare function AssetGet(Family: IAssetFamily, Group: AssetGroupName, Name: string): Asset | null;
+/**
+ * Gets all activities on a family and name
+ * @param {IAssetFamily} family - The family to search in
+ * @returns {Activity[]}
+ */
+declare function AssetAllActivities(family: IAssetFamily): Activity[];
+/**
+ * Gets an activity asset by family and name
+ * @param {IAssetFamily} family - The family to search in
+ * @param {ActivityName} name - Name of activity to search for
+ * @returns {Activity|undefined}
+ */
+declare function AssetGetActivity(family: IAssetFamily, name: ActivityName): Activity | undefined;
+/**
+ * Get the list of all activities on a group for a given family.
+ *
+ * @description Note that this just returns activities as defined, no checks are
+ * actually done on whether the activity makes sense.
+ *
+ * @param {IAssetFamily} family
+ * @param {AssetGroupName} groupname
+ * @param {"self" | "other" | "any"} onSelf
+ * @returns {Activity[]}
+ */
+declare function AssetActivitiesForGroup(family: IAssetFamily, groupname: AssetGroupName, onSelf?: "self" | "other" | "any"): Activity[];
+/**
+ * Cleans the given array of assets of any items that no longer exists
+ * @param {readonly ItemPermissions[]} AssetArray - The arrays of items to clean
+ * @returns {ItemPermissions[]} - The cleaned up array
+ */
+declare function AssetCleanArray(AssetArray: readonly ItemPermissions[]): ItemPermissions[];
+/**
+ * Gets an asset group by the asset family name and group name
+ * @template {AssetGroupName} T
+ * @param {IAssetFamily} Family - The asset family that the group belongs to (Ignored until other family is added)
+ * @param {T} Group - The name of the asset group to find
+ * @returns {AssetGroupMap[T] | null} - The asset group matching the provided family and group name
+ */
+declare function AssetGroupGet<T extends AssetGroupName>(Family: IAssetFamily, Group: T): AssetGroupMap[T];
+/**
+ * Utility function for retrieving the preview image directory path for an asset
+ * @param {Asset} A - The asset whose preview path to retrieve
+ * @returns {string} - The path to the asset's preview image directory
+ */
+declare function AssetGetPreviewPath(A: Asset): string;
+/**
+ * Utility function for retrieving the base path of an asset's inventory directory, where extended item scripts are
+ * held
+ * @param {Asset} A - The asset whose inventory path to retrieve
+ * @returns {string} - The path to the asset's inventory directory
+ */
+declare function AssetGetInventoryPath(A: Asset): string;
+/**
+ * Sort a list of asset layers for the {@link Character.AppearanceLayers } property.
+ * Performs an inplace update of the passed array and then returns it.
+ * @param {AssetLayer[]} layers - The to-be sorted asset layers
+ * @returns {AssetLayer[]} - The newly sorted asset layers
+ */
+declare function AssetLayerSort(layers: AssetLayer[]): AssetLayer[];
+/**
+ * Convert {@link AssetDefinition} default color into a {@link Asset} default color list
+ * @param {number} colorableLayerCount The number of colorable layers
+ * @param {string | readonly string[]} [color] See {@link AssetDefinition.DefaultColor}
+ * @returns {string[]} See {@link Asset.DefaultColor}
+ */
+declare function AssetParseDefaultColor(colorableLayerCount: number, color?: string | readonly string[]): string[];
+/** @type {Asset[]} */
+declare var Asset: Asset[];
+/** @type {AssetGroup[]} */
+declare var AssetGroup: AssetGroup[];
+/** @type {Map<string, Asset>} */
+declare var AssetMap: Map<string, Asset>;
+/** @type {Map<AssetGroupName, AssetGroup>} */
+declare var AssetGroupMap: Map<AssetGroupName, AssetGroup>;
+/** @type {Pose[]} */
+declare var Pose: Pose[];
+/** @type {Map<AssetGroupName, AssetGroup[]>} */
+declare var AssetActivityMirrorGroups: Map<AssetGroupName, AssetGroup[]>;

package/bc/Scripts/Audio.d.ts

@@ -0,0 +1,105 @@
+/**
+ * Plays a sound at a given volume
+ * @param {string} src - Source of the audio file to play
+ * @param {number} [volume] - Volume of the audio in percentage (ranges from 0 to 1)
+ * @returns {void} - Nothing
+ */
+declare function AudioPlayInstantSound(src: string, volume?: number): void;
+/**
+ * Begins to play a sound when applying/removing an item
+ * @param {string} SourceFile - Source of the audio file to play
+ * @returns {void} - Nothing
+ */
+declare function AudioDialogStart(SourceFile: string): void;
+/**
+ * Stops playing the sound when done applying/removing an item
+ * @returns {void} - Nothing
+ */
+declare function AudioDialogStop(): void;
+/**
+ * Returns the actual volume given a volume modifier.
+ *
+ * @param {number} modifier - The volume modifier to use, from -4 to 4
+ * @returns {number} The volume level, from 0.0 to 1.0
+ */
+declare function AudioVolumeFromModifier(modifier: number): number;
+/**
+ * Is sound allowed to play.
+ *
+ * @param {boolean} IsPlayerInvolved - Whether the player was involved in what caused the sound to play.
+ * @returns {boolean} True if the player has item sound enabled, and a non-muted volume, false otherwise.
+ */
+declare function AudioShouldSilenceSound(IsPlayerInvolved?: boolean): boolean;
+/**
+ * Takes the received data dictionary content and identifies the audio to be played
+ * @param {IChatRoomMessage} data - Data received
+ * @param {Character} sender
+ * @param {string} msg
+ * @param {IChatRoomMessageMetadata} metadata
+ * @returns {boolean}
+ */
+declare function AudioPlaySoundForChatMessage(data: IChatRoomMessage, sender: Character, msg: string, metadata: IChatRoomMessageMetadata): boolean;
+/**
+ * Low-level function to play a sound effect.
+ * @param {AudioSoundEffect|string} soundEffect
+ * @param {number} [volumeModifier]
+ * @returns {boolean} if a sound was played or not.
+ */
+declare function AudioPlaySoundEffect(soundEffect: AudioSoundEffect | string, volumeModifier?: number): boolean;
+/**
+ * Plays a given asset sound effect.
+ * @param {Character} character
+ * @param {Asset} asset
+ * @returns {boolean} Whether a sound was played.
+ */
+declare function AudioPlaySoundForAsset(character: Character, asset: Asset): boolean;
+/**
+ * Get the sound effect for a given asset.
+ *
+ * @param {Character} character
+ * @param {AssetGroupName} groupName
+ * @param {string} assetName
+ * @returns {AudioSoundEffect?}
+ */
+declare function AudioGetSoundFromAsset(character: Character, groupName: AssetGroupName, assetName: string): AudioSoundEffect | null;
+/**
+ * Get a file name for a given sound effect.
+ * @param {string} sound - The sound effect to load a file from.
+ * @returns {string?}
+ */
+declare function AudioGetFileName(sound: string): string | null;
+/**
+ * Processes which sound should be played for items
+ * @param {IChatRoomMessage} data - Data content triggering the potential sound
+ * @param {IChatRoomMessageMetadata} metadata - The chat message metadata
+ * @returns {AudioSoundEffect | undefined} - The name of the sound to play, followed by the noise modifier
+ */
+declare function AudioGetSoundFromChatMessage(data: IChatRoomMessage, metadata: IChatRoomMessageMetadata): AudioSoundEffect | undefined;
+/**
+ * Processes the sound for vibrators
+ * @param {IChatRoomMessage} data - Represents the chat message received
+ * @param {IChatRoomMessageMetadata} metadata - The metadata from the recieved message
+ * @returns {[string, number]} - The name of the sound to play, followed by the noise modifier
+ */
+declare function AudioVibratorSounds(data: IChatRoomMessage, metadata: IChatRoomMessageMetadata): [string, number];
+/**
+ * Processes the sound for shocks
+ * @param {IChatRoomMessage} data - Represents the chat message received
+ * @returns {[string, number]} - The name of the sound to play, followed by the noise modifier
+ */
+declare function AudioShockSounds(data: IChatRoomMessage): [string, number];
+declare var AudioDialog: HTMLAudioElement;
+/** @type AudioEffect[] */
+declare var AudioList: AudioEffect[];
+/**
+ * A list of chat message audio effect "detectors".
+ *
+ * They get checked in the order they're defined, so be careful where you insert new entries.
+ *
+ * @type AudioChatAction[]
+ */
+declare var AudioActions: AudioChatAction[];
+/** The "normal" volume for a game sound, a.k.a a sound with modifier 0 */
+declare let AudioVolumeNormalLevel: number;
+/** Number of available modifier steps */
+declare let AudioVolumeModifierSteps: number;