isaacscript-common 2.3.0 → 3.0.0

package/functions/set.d.ts

@@ -0,0 +1,39 @@
+/// <reference types="isaac-typescript-definitions" />
+/**
+ * Helper function to add all of the values in one set to another set. The first set passed will be
+ * modified in place.
+ *
+ * This function is variadic, meaning that you can specify N sets to add to the first set.
+ */
+export declare function addSetsToSet<T>(mainSet: Set<T>, ...setsToAdd: Array<Set<T> | ReadonlySet<T>>): void;
+/**
+ * Helper function to create a new set that is the composition of two or more sets.
+ *
+ * This function is variadic, meaning that you can specify N sets.
+ */
+export declare function combineSets<T>(...sets: Array<Set<T> | ReadonlySet<T>>): Set<T>;
+/** Helper function to copy a set. (You can also use a Set constructor to accomplish this task.) */
+export declare function copySet<T>(oldSet: Set<T> | ReadonlySet<T>): Set<T>;
+/**
+ * Helper function to delete all of the values in one set from another set. The first set passed
+ * will be modified in place.
+ *
+ * This function is variadic, meaning that you can specify N sets to remove from the first set.
+ */
+export declare function deleteSetsFromSet<T>(mainSet: Set<T>, ...setsToRemove: Array<Set<T> | ReadonlySet<T>>): void;
+/**
+ * Helper function to get a random element from the provided set.
+ *
+ * @param set The set to get an element from.
+ * @param seedOrRNG Optional. The `Seed` or `RNG` object to use. If an `RNG` object is provided, the
+ *                  `RNG.Next` method will be called. Default is `getRandomSeed()`.
+ * @param exceptions Optional. An array of elements to skip over if selected.
+ */
+export declare function getRandomSetElement<T>(set: Set<T> | ReadonlySet<T>, seedOrRNG?: Seed | RNG, exceptions?: T[] | readonly T[]): T;
+/**
+ * Helper function to get a sorted array based on the contents of a set.
+ *
+ * Normally, set values are returned in a random order, so use this function when the ordering of
+ * the contents is important.
+ */
+export declare function getSortedSetValues<T>(set: Set<T> | ReadonlySet<T>): T[];

package/functions/set.lua

@@ -0,0 +1,83 @@
+local ____lualib = require("lualib_bundle")
+local Set = ____lualib.Set
+local __TS__Iterator = ____lualib.__TS__Iterator
+local __TS__New = ____lualib.__TS__New
+local __TS__Spread = ____lualib.__TS__Spread
+local __TS__ArraySort = ____lualib.__TS__ArraySort
+local ____exports = {}
+local ____array = require("functions.array")
+local getRandomArrayElement = ____array.getRandomArrayElement
+local ____rng = require("functions.rng")
+local getRandomSeed = ____rng.getRandomSeed
+--- Helper function to get a sorted array based on the contents of a set.
+-- 
+-- Normally, set values are returned in a random order, so use this function when the ordering of
+-- the contents is important.
+function ____exports.getSortedSetValues(self, set)
+    local values = set:values()
+    local array = {__TS__Spread(values)}
+    __TS__ArraySort(array)
+    return array
+end
+--- Helper function to add all of the values in one set to another set. The first set passed will be
+-- modified in place.
+-- 
+-- This function is variadic, meaning that you can specify N sets to add to the first set.
+function ____exports.addSetsToSet(self, mainSet, ...)
+    local setsToAdd = {...}
+    for ____, set in ipairs(setsToAdd) do
+        for ____, value in __TS__Iterator(set:values()) do
+            mainSet:add(value)
+        end
+    end
+end
+--- Helper function to create a new set that is the composition of two or more sets.
+-- 
+-- This function is variadic, meaning that you can specify N sets.
+function ____exports.combineSets(self, ...)
+    local sets = {...}
+    local newSet = __TS__New(Set)
+    for ____, set in ipairs(sets) do
+        for ____, value in __TS__Iterator(set:values()) do
+            newSet:add(value)
+        end
+    end
+    return newSet
+end
+--- Helper function to copy a set. (You can also use a Set constructor to accomplish this task.)
+function ____exports.copySet(self, oldSet)
+    local newSet = __TS__New(Set)
+    for ____, value in __TS__Iterator(oldSet:values()) do
+        newSet:add(value)
+    end
+    return newSet
+end
+--- Helper function to delete all of the values in one set from another set. The first set passed
+-- will be modified in place.
+-- 
+-- This function is variadic, meaning that you can specify N sets to remove from the first set.
+function ____exports.deleteSetsFromSet(self, mainSet, ...)
+    local setsToRemove = {...}
+    for ____, set in ipairs(setsToRemove) do
+        for ____, value in __TS__Iterator(set:values()) do
+            mainSet:delete(value)
+        end
+    end
+end
+--- Helper function to get a random element from the provided set.
+-- 
+-- @param set The set to get an element from.
+-- @param seedOrRNG Optional. The `Seed` or `RNG` object to use. If an `RNG` object is provided, the
+-- `RNG.Next` method will be called. Default is `getRandomSeed()`.
+-- @param exceptions Optional. An array of elements to skip over if selected.
+function ____exports.getRandomSetElement(self, set, seedOrRNG, exceptions)
+    if seedOrRNG == nil then
+        seedOrRNG = getRandomSeed(nil)
+    end
+    if exceptions == nil then
+        exceptions = {}
+    end
+    local array = ____exports.getSortedSetValues(nil, set)
+    return getRandomArrayElement(nil, array, seedOrRNG, exceptions)
+end
+return ____exports

package/functions/sound.d.ts

@@ -0,0 +1 @@
+export declare function stopAllSoundEffects(): void;

package/functions/sound.lua

@@ -0,0 +1,13 @@
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local SoundEffect = ____isaac_2Dtypescript_2Ddefinitions.SoundEffect
+local ____cachedClasses = require("cachedClasses")
+local sfxManager = ____cachedClasses.sfxManager
+local ____enums = require("functions.enums")
+local getEnumValues = ____enums.getEnumValues
+function ____exports.stopAllSoundEffects(self)
+    for ____, soundEffect in ipairs(getEnumValues(nil, SoundEffect)) do
+        sfxManager:Stop(soundEffect)
+    end
+end
+return ____exports

package/functions/spawnCollectible.d.ts

@@ -0,0 +1,31 @@
+import { CollectibleType } from "isaac-typescript-definitions";
+/**
+ * Helper function to spawn a collectible. Use this instead of the `Game.Spawn` method because it
+ * handles the cases of Tainted Keeper collectibles costing coins and preventing quest items from
+ * being rotated by Tainted Isaac's rotation mechanic. (Rotation prevention will only occur in
+ * upgraded mods.)
+ *
+ * @param collectibleType The collectible type to spawn.
+ * @param position The position to spawn the collectible at.
+ * @param seedOrRNG Optional. The `Seed` or `RNG` object to use. If an `RNG` object is provided, the
+ *                  `RNG.Next` method will be called. Default is `getRandomSeed()`.
+ * @param options Optional. Set to true to make the collectible a "There's Options" style
+ *                collectible. Default is false.
+ * @param forceFreeItem Optional. Set to true to disable the logic that gives the item a price for
+ *                      Tainted Keeper. Default is false.
+ * @param spawner Optional.
+ */
+export declare function spawnCollectible(collectibleType: CollectibleType, position: Vector, seedOrRNG?: Seed | RNG, options?: boolean, forceFreeItem?: boolean, spawner?: Entity): EntityPickupCollectible;
+/**
+ * Helper function to spawn an empty collectible. Doing this is tricky since spawning a collectible
+ * with `CollectibleType.NULL` will result in spawning a collectible with a random type from the
+ * current room's item pool.
+ *
+ * Instead, this function arbitrarily spawns a collectible with `CollectibleType.SAD_ONION`, and
+ * then converts it to an empty pedestal afterward.
+ *
+ * @param position The position to spawn the empty collectible at.
+ * @param seedOrRNG The `Seed` or `RNG` object to use. If an `RNG` object is provided, the
+ *                  `RNG.Next` method will be called. Default is `getRandomSeed()`.
+ */
+export declare function spawnEmptyCollectible(position: Vector, seedOrRNG?: Seed | RNG): EntityPickup;

package/functions/spawnCollectible.lua

@@ -0,0 +1,94 @@
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local CollectibleType = ____isaac_2Dtypescript_2Ddefinitions.CollectibleType
+local PickupVariant = ____isaac_2Dtypescript_2Ddefinitions.PickupVariant
+local PlayerType = ____isaac_2Dtypescript_2Ddefinitions.PlayerType
+local ____constants = require("constants")
+local VectorZero = ____constants.VectorZero
+local ____preventCollectibleRotation = require("features.preventCollectibleRotation")
+local preventCollectibleRotation = ____preventCollectibleRotation.preventCollectibleRotation
+local ____featuresInitialized = require("featuresInitialized")
+local areFeaturesInitialized = ____featuresInitialized.areFeaturesInitialized
+local ____collectibles = require("functions.collectibles")
+local setCollectibleEmpty = ____collectibles.setCollectibleEmpty
+local ____collectibleTag = require("functions.collectibleTag")
+local isQuestCollectible = ____collectibleTag.isQuestCollectible
+local ____entitySpecific = require("functions.entitySpecific")
+local spawnPickupWithSeed = ____entitySpecific.spawnPickupWithSeed
+local ____player = require("functions.player")
+local anyPlayerIs = ____player.anyPlayerIs
+local ____rng = require("functions.rng")
+local getRandomSeed = ____rng.getRandomSeed
+local isRNG = ____rng.isRNG
+--- Helper function to spawn a collectible. Use this instead of the `Game.Spawn` method because it
+-- handles the cases of Tainted Keeper collectibles costing coins and preventing quest items from
+-- being rotated by Tainted Isaac's rotation mechanic. (Rotation prevention will only occur in
+-- upgraded mods.)
+-- 
+-- @param collectibleType The collectible type to spawn.
+-- @param position The position to spawn the collectible at.
+-- @param seedOrRNG Optional. The `Seed` or `RNG` object to use. If an `RNG` object is provided, the
+-- `RNG.Next` method will be called. Default is `getRandomSeed()`.
+-- @param options Optional. Set to true to make the collectible a "There's Options" style
+-- collectible. Default is false.
+-- @param forceFreeItem Optional. Set to true to disable the logic that gives the item a price for
+-- Tainted Keeper. Default is false.
+-- @param spawner Optional.
+function ____exports.spawnCollectible(self, collectibleType, position, seedOrRNG, options, forceFreeItem, spawner)
+    if seedOrRNG == nil then
+        seedOrRNG = getRandomSeed(nil)
+    end
+    if options == nil then
+        options = false
+    end
+    if forceFreeItem == nil then
+        forceFreeItem = false
+    end
+    local seed = isRNG(nil, seedOrRNG) and seedOrRNG:Next() or seedOrRNG
+    local collectible = spawnPickupWithSeed(
+        nil,
+        PickupVariant.COLLECTIBLE,
+        collectibleType,
+        position,
+        seed,
+        VectorZero,
+        spawner
+    )
+    if options then
+        collectible.OptionsPickupIndex = 1
+    end
+    if anyPlayerIs(nil, PlayerType.KEEPER_B) and not isQuestCollectible(nil, collectibleType) and not forceFreeItem then
+        collectible.ShopItemId = -1
+        collectible.Price = 15
+    end
+    if isQuestCollectible(nil, collectibleType) and areFeaturesInitialized(nil) then
+        preventCollectibleRotation(nil, collectible, collectibleType)
+    end
+    return collectible
+end
+--- Helper function to spawn an empty collectible. Doing this is tricky since spawning a collectible
+-- with `CollectibleType.NULL` will result in spawning a collectible with a random type from the
+-- current room's item pool.
+-- 
+-- Instead, this function arbitrarily spawns a collectible with `CollectibleType.SAD_ONION`, and
+-- then converts it to an empty pedestal afterward.
+-- 
+-- @param position The position to spawn the empty collectible at.
+-- @param seedOrRNG The `Seed` or `RNG` object to use. If an `RNG` object is provided, the
+-- `RNG.Next` method will be called. Default is `getRandomSeed()`.
+function ____exports.spawnEmptyCollectible(self, position, seedOrRNG)
+    if seedOrRNG == nil then
+        seedOrRNG = getRandomSeed(nil)
+    end
+    local collectible = ____exports.spawnCollectible(
+        nil,
+        CollectibleType.SAD_ONION,
+        position,
+        seedOrRNG,
+        false,
+        true
+    )
+    setCollectibleEmpty(nil, collectible)
+    return collectible
+end
+return ____exports

package/functions/sprite.d.ts

@@ -0,0 +1,36 @@
+/// <reference types="isaac-typescript-definitions" />
+/**
+ * Helper function to clear a specific layer from a sprite.
+ *
+ * This function is variadic, so pass as many layer IDs as you want to clear. If no specific layers
+ * are passed, it will clear every layer.
+ *
+ * Since there is no official API method to "clear" a sprite, we can work around it by setting the
+ * spritesheet to a non-existent or completely transparent file. If the path to the spritesheet does
+ * not exist, then this function might cause spurious errors to appear in the "log.txt file". To
+ * silence these errors, create a transparent 1 pixel PNG file in your mod's resources folder at the
+ * path corresponding to the "EMPTY_PNG_PATH" constant.
+ */
+export declare function clearSprite(sprite: Sprite, ...layerIDs: int[]): void;
+/**
+ * Helper function that returns the number of the final frame in a particular animation for a
+ * sprite. By default, it will use the currently playing animation, but you can also specify a
+ * specific animation to check.
+ *
+ * Note that this function is bugged with the Stop Watch or the Broken Watch, since using the
+ * `Sprite.SetFrame` method will reset the internal accumulator used to slow down the playback speed
+ * of the animation. (The `PlaybackSpeed` property of the sprite is not used.) Thus, it is only safe
+ * to use this function on animations that are not slowed down by Stop Watch or Broken Watch, such
+ * as player animations.
+ */
+export declare function getLastFrameOfAnimation(sprite: Sprite, animation?: string): int;
+/**
+ * Helper function to check if two sprite layers have the same sprite sheet by using the
+ * `Sprite.GetTexel` method.
+ *
+ * Since checking every single texel in the entire sprite is very expensive, this function requires
+ * that you provide a range of specific texels to check.
+ */
+export declare function spriteEquals(sprite1: Sprite, sprite2: Sprite, layerID: int, xStart: int, xFinish: int, xIncrement: int, yStart: int, yFinish: int, yIncrement: int): boolean;
+/** Helper function to check if two texels on a sprite are equivalent to each other. */
+export declare function texelEquals(sprite1: Sprite, sprite2: Sprite, position: Vector, layerID: int): boolean;

package/functions/sprite.lua

@@ -0,0 +1,89 @@
+local ____exports = {}
+local ____constants = require("constants")
+local EMPTY_PNG_PATH = ____constants.EMPTY_PNG_PATH
+local VectorZero = ____constants.VectorZero
+local ____kColor = require("functions.kColor")
+local kColorEquals = ____kColor.kColorEquals
+local ____utils = require("functions.utils")
+local erange = ____utils.erange
+--- Helper function to check if two texels on a sprite are equivalent to each other.
+function ____exports.texelEquals(self, sprite1, sprite2, position, layerID)
+    local kColor1 = sprite1:GetTexel(position, VectorZero, 1, layerID)
+    local kColor2 = sprite2:GetTexel(position, VectorZero, 1, layerID)
+    return kColorEquals(nil, kColor1, kColor2)
+end
+--- Helper function to clear a specific layer from a sprite.
+-- 
+-- This function is variadic, so pass as many layer IDs as you want to clear. If no specific layers
+-- are passed, it will clear every layer.
+-- 
+-- Since there is no official API method to "clear" a sprite, we can work around it by setting the
+-- spritesheet to a non-existent or completely transparent file. If the path to the spritesheet does
+-- not exist, then this function might cause spurious errors to appear in the "log.txt file". To
+-- silence these errors, create a transparent 1 pixel PNG file in your mod's resources folder at the
+-- path corresponding to the "EMPTY_PNG_PATH" constant.
+function ____exports.clearSprite(self, sprite, ...)
+    local layerIDs = {...}
+    if #layerIDs == 0 then
+        local numLayers = sprite:GetLayerCount()
+        layerIDs = erange(nil, numLayers)
+    end
+    for ____, layerID in ipairs(layerIDs) do
+        sprite:ReplaceSpritesheet(layerID, EMPTY_PNG_PATH)
+    end
+    sprite:LoadGraphics()
+end
+--- Helper function that returns the number of the final frame in a particular animation for a
+-- sprite. By default, it will use the currently playing animation, but you can also specify a
+-- specific animation to check.
+-- 
+-- Note that this function is bugged with the Stop Watch or the Broken Watch, since using the
+-- `Sprite.SetFrame` method will reset the internal accumulator used to slow down the playback speed
+-- of the animation. (The `PlaybackSpeed` property of the sprite is not used.) Thus, it is only safe
+-- to use this function on animations that are not slowed down by Stop Watch or Broken Watch, such
+-- as player animations.
+function ____exports.getLastFrameOfAnimation(self, sprite, animation)
+    local currentAnimation = sprite:GetAnimation()
+    local currentFrame = sprite:GetFrame()
+    if animation ~= nil and animation ~= currentAnimation then
+        sprite:SetAnimation(animation)
+    end
+    sprite:SetLastFrame()
+    local finalFrame = sprite:GetFrame()
+    if animation ~= nil and animation ~= currentAnimation then
+        sprite:Play(currentAnimation, true)
+    end
+    sprite:SetFrame(currentFrame)
+    return finalFrame
+end
+--- Helper function to check if two sprite layers have the same sprite sheet by using the
+-- `Sprite.GetTexel` method.
+-- 
+-- Since checking every single texel in the entire sprite is very expensive, this function requires
+-- that you provide a range of specific texels to check.
+function ____exports.spriteEquals(self, sprite1, sprite2, layerID, xStart, xFinish, xIncrement, yStart, yFinish, yIncrement)
+    do
+        local x = xStart
+        while x <= xFinish do
+            do
+                local y = yStart
+                while y <= yFinish do
+                    local position = Vector(x, y)
+                    if not ____exports.texelEquals(
+                        nil,
+                        sprite1,
+                        sprite2,
+                        position,
+                        layerID
+                    ) then
+                        return false
+                    end
+                    y = y + yIncrement
+                end
+            end
+            x = x + xIncrement
+        end
+    end
+    return true
+end
+return ____exports

package/functions/stage.d.ts

@@ -0,0 +1,35 @@
+import { LevelStage, StageType } from "isaac-typescript-definitions";
+/**
+ * Helper function to account for Repentance floors being offset by 1. For example, Downpour 2 is
+ * the third level of the run, but the game considers it to have a stage of 2. This function will
+ * consider Downpour 2 to have a stage of 3.
+ */
+export declare function getEffectiveStage(): int;
+/** Alias for the `Level.GetStage` method. */
+export declare function getStage(): LevelStage;
+/** Alias for the `Level.GetStageType` method. */
+export declare function getStageType(): StageType;
+/** Helper function to directly warp to a specific stage using the "stage" console command. */
+export declare function goToStage(stage: LevelStage, stageType: StageType): void;
+export declare function isRepentanceStage(stageType: StageType): boolean;
+export declare function onCathedral(): boolean;
+export declare function onChest(): boolean;
+export declare function onDarkRoom(): boolean;
+/**
+ * Returns whether or not the player is on the "final floor" of the particular run. The final floor
+ * is defined as one that prevents the player from entering the I AM ERROR room on.
+ *
+ * For example, when using Undefined on The Chest, it has a 50% chance of teleporting the player to
+ * the Secret Room and a 50% chance of teleporting the player to the Super Secret Room, because the
+ * I AM ERROR room is never entered into the list of possibilities.
+ */
+export declare function onFinalFloor(): boolean;
+export declare function onRepentanceStage(): boolean;
+export declare function onSheol(): boolean;
+/**
+ * Helper function to convert a numerical `StageType` into the letter suffix supplied to the "stage"
+ * console command. For example, `StageType.REPENTANCE` is the stage type for Downpour, and the
+ * console command to go to Downpour is "stage 1c", so this function converts `StageType.REPENTANCE`
+ * to "c".
+ */
+export declare function stageTypeToLetter(stageType: StageType): string;

package/functions/stage.lua

@@ -0,0 +1,86 @@
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local LevelStage = ____isaac_2Dtypescript_2Ddefinitions.LevelStage
+local StageType = ____isaac_2Dtypescript_2Ddefinitions.StageType
+local ____cachedClasses = require("cachedClasses")
+local game = ____cachedClasses.game
+local ____stageTypeToLetter = require("objects.stageTypeToLetter")
+local STAGE_TYPE_TO_LETTER = ____stageTypeToLetter.STAGE_TYPE_TO_LETTER
+function ____exports.isRepentanceStage(self, stageType)
+    return stageType == StageType.REPENTANCE or stageType == StageType.REPENTANCE_B
+end
+function ____exports.onRepentanceStage(self)
+    local level = game:GetLevel()
+    local stageType = level:GetStageType()
+    return ____exports.isRepentanceStage(nil, stageType)
+end
+--- Helper function to convert a numerical `StageType` into the letter suffix supplied to the "stage"
+-- console command. For example, `StageType.REPENTANCE` is the stage type for Downpour, and the
+-- console command to go to Downpour is "stage 1c", so this function converts `StageType.REPENTANCE`
+-- to "c".
+function ____exports.stageTypeToLetter(self, stageType)
+    return STAGE_TYPE_TO_LETTER[stageType]
+end
+--- Helper function to account for Repentance floors being offset by 1. For example, Downpour 2 is
+-- the third level of the run, but the game considers it to have a stage of 2. This function will
+-- consider Downpour 2 to have a stage of 3.
+function ____exports.getEffectiveStage(self)
+    local level = game:GetLevel()
+    local stage = level:GetStage()
+    if ____exports.onRepentanceStage(nil) then
+        return stage + 1
+    end
+    return stage
+end
+--- Alias for the `Level.GetStage` method.
+function ____exports.getStage(self)
+    local level = game:GetLevel()
+    return level:GetStage()
+end
+--- Alias for the `Level.GetStageType` method.
+function ____exports.getStageType(self)
+    local level = game:GetLevel()
+    return level:GetStageType()
+end
+--- Helper function to directly warp to a specific stage using the "stage" console command.
+function ____exports.goToStage(self, stage, stageType)
+    local stageTypeLetterSuffix = ____exports.stageTypeToLetter(nil, stageType)
+    local command = ("stage " .. tostring(stage)) .. stageTypeLetterSuffix
+    Isaac.ExecuteCommand(command)
+end
+function ____exports.onCathedral(self)
+    local level = game:GetLevel()
+    local stage = level:GetStage()
+    local stageType = level:GetStageType()
+    return stage == LevelStage.SHEOL_CATHEDRAL and stageType == StageType.WRATH_OF_THE_LAMB
+end
+function ____exports.onChest(self)
+    local level = game:GetLevel()
+    local stage = level:GetStage()
+    local stageType = level:GetStageType()
+    return stage == LevelStage.DARK_ROOM_CHEST and stageType == StageType.WRATH_OF_THE_LAMB
+end
+function ____exports.onDarkRoom(self)
+    local level = game:GetLevel()
+    local stage = level:GetStage()
+    local stageType = level:GetStageType()
+    return stage == LevelStage.DARK_ROOM_CHEST and stageType == StageType.ORIGINAL
+end
+--- Returns whether or not the player is on the "final floor" of the particular run. The final floor
+-- is defined as one that prevents the player from entering the I AM ERROR room on.
+-- 
+-- For example, when using Undefined on The Chest, it has a 50% chance of teleporting the player to
+-- the Secret Room and a 50% chance of teleporting the player to the Super Secret Room, because the
+-- I AM ERROR room is never entered into the list of possibilities.
+function ____exports.onFinalFloor(self)
+    local level = game:GetLevel()
+    local stage = level:GetStage()
+    return stage == LevelStage.DARK_ROOM_CHEST or stage == LevelStage.THE_VOID or stage == LevelStage.HOME or stage == LevelStage.WOMB_2 and ____exports.onRepentanceStage(nil)
+end
+function ____exports.onSheol(self)
+    local level = game:GetLevel()
+    local stage = level:GetStage()
+    local stageType = level:GetStageType()
+    return stage == LevelStage.SHEOL_CATHEDRAL and stageType == StageType.ORIGINAL
+end
+return ____exports

package/functions/string.d.ts

@@ -0,0 +1,13 @@
+export declare function capitalizeFirstLetter(string: string): string;
+export declare function removeAllCharacters(string: string, character: string): string;
+/**
+ * Helper function to remove one or more substrings from a string, if they exist. Returns the
+ * modified string.
+ *
+ * This function is variadic, meaning that you can pass as many substrings as you want to remove.
+ */
+export declare function removeSubstring(string: string, ...substrings: string[]): string;
+/** Helper function to trim a prefix from a string, if it exists. Returns the trimmed string. */
+export declare function trimPrefix(string: string, prefix: string): string;
+/** Helper function to trim a suffix from a string, if it exists. Returns the trimmed string. */
+export declare function trimSuffix(string: string, prefix: string): string;

package/functions/string.lua

@@ -0,0 +1,42 @@
+local ____lualib = require("lualib_bundle")
+local __TS__StringReplaceAll = ____lualib.__TS__StringReplaceAll
+local __TS__StringStartsWith = ____lualib.__TS__StringStartsWith
+local __TS__StringSlice = ____lualib.__TS__StringSlice
+local __TS__StringEndsWith = ____lualib.__TS__StringEndsWith
+local ____exports = {}
+function ____exports.capitalizeFirstLetter(self, ____string)
+    local firstCharacter = string.sub(____string, 1, 1)
+    local capitalizedFirstLetter = string.upper(firstCharacter)
+    local restOfString = string.sub(____string, 2)
+    return capitalizedFirstLetter .. restOfString
+end
+function ____exports.removeAllCharacters(self, ____string, character)
+    return __TS__StringReplaceAll(____string, character, "")
+end
+--- Helper function to remove one or more substrings from a string, if they exist. Returns the
+-- modified string.
+-- 
+-- This function is variadic, meaning that you can pass as many substrings as you want to remove.
+function ____exports.removeSubstring(self, ____string, ...)
+    local substrings = {...}
+    for ____, substring in ipairs(substrings) do
+        ____string = __TS__StringReplaceAll(____string, substring, "")
+    end
+    return ____string
+end
+--- Helper function to trim a prefix from a string, if it exists. Returns the trimmed string.
+function ____exports.trimPrefix(self, ____string, prefix)
+    if not __TS__StringStartsWith(____string, prefix) then
+        return ____string
+    end
+    return __TS__StringSlice(____string, #prefix)
+end
+--- Helper function to trim a suffix from a string, if it exists. Returns the trimmed string.
+function ____exports.trimSuffix(self, ____string, prefix)
+    if not __TS__StringEndsWith(____string, prefix) then
+        return ____string
+    end
+    local endCharacter = #____string - #prefix
+    return __TS__StringSlice(____string, 0, endCharacter)
+end
+return ____exports

package/functions/table.d.ts

@@ -0,0 +1,36 @@
+/// <reference types="typescript-to-lua/language-extensions" />
+/**
+ * In a Map, you can use the `clear` method to delete every element. However, in a LuaTable, the
+ * `clear` method does not exist. Use this helper function as a drop-in replacement for this.
+ */
+export declare function clearTable(table: LuaTable): void;
+/** Helper function to copy specific values from a object to a table. */
+export declare function copyValuesToTable(object: unknown, keys: string[], table: LuaTable<string, unknown>): void;
+/**
+ * Helper function to safely get boolean values from a Lua table. Will throw an error if the
+ * specific value does not exist on the table.
+ *
+ * This function is variadic, meaning that you can specify N arguments to get N values.
+ */
+export declare function getBooleansFromTable(table: LuaTable<string, unknown>, objectName: string, ...keys: string[]): boolean[];
+/**
+ * Helper function to safely get number values from a Lua table. Will throw an error if the specific
+ * value does not exist on the table or if it cannot be converted to a number.
+ *
+ * This function is variadic, meaning that you can specify N arguments to get N values.
+ */
+export declare function getNumbersFromTable(table: LuaTable<string, unknown>, objectName: string, ...keys: string[]): number[];
+/**
+ * Helper function to safely get string values from a Lua table. Will throw an error if the specific
+ * value does not exist on the table.
+ *
+ * This function is variadic, meaning that you can specify N arguments to get N values.
+ */
+export declare function getStringsFromTable(table: LuaTable<string, unknown>, objectName: string, ...keys: string[]): string[];
+/**
+ * Helper function to check if a Lua table has all of the provided keys.
+ *
+ * This function is variadic, meaning that you can specify as many arguments as you want to check
+ * for.
+ */
+export declare function tableHasKeys(table: LuaTable<AnyNotNil, unknown>, ...keys: string[]): boolean;