isaacscript-common 76.2.0 → 77.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/classes/features/callbackLogic/CustomGridEntities.d.ts +8 -0
- package/dist/classes/features/callbackLogic/CustomGridEntities.d.ts.map +1 -1
- package/dist/classes/features/callbackLogic/GameReorderedCallbacks.d.ts +6 -0
- package/dist/classes/features/callbackLogic/GameReorderedCallbacks.d.ts.map +1 -1
- package/dist/classes/features/other/CharacterHealthConversion.d.ts +2 -0
- package/dist/classes/features/other/CharacterHealthConversion.d.ts.map +1 -1
- package/dist/classes/features/other/CharacterStats.d.ts +2 -0
- package/dist/classes/features/other/CharacterStats.d.ts.map +1 -1
- package/dist/classes/features/other/CollectibleItemPoolType.d.ts +2 -0
- package/dist/classes/features/other/CollectibleItemPoolType.d.ts.map +1 -1
- package/dist/classes/features/other/CustomHotkeys.d.ts +4 -0
- package/dist/classes/features/other/CustomHotkeys.d.ts.map +1 -1
- package/dist/classes/features/other/CustomItemPools.d.ts +2 -0
- package/dist/classes/features/other/CustomItemPools.d.ts.map +1 -1
- package/dist/classes/features/other/CustomPickups.d.ts +1 -0
- package/dist/classes/features/other/CustomPickups.d.ts.map +1 -1
- package/dist/classes/features/other/CustomStages.d.ts +3 -0
- package/dist/classes/features/other/CustomStages.d.ts.map +1 -1
- package/dist/classes/features/other/DebugDisplay.d.ts +54 -0
- package/dist/classes/features/other/DebugDisplay.d.ts.map +1 -1
- package/dist/classes/features/other/DeployJSONRoom.d.ts +1 -0
- package/dist/classes/features/other/DeployJSONRoom.d.ts.map +1 -1
- package/dist/classes/features/other/DisableInputs.d.ts +9 -0
- package/dist/classes/features/other/DisableInputs.d.ts.map +1 -1
- package/dist/classes/features/other/EdenStartingStatsHealth.d.ts +6 -0
- package/dist/classes/features/other/EdenStartingStatsHealth.d.ts.map +1 -1
- package/dist/classes/features/other/ExtraConsoleCommands.d.ts +6 -0
- package/dist/classes/features/other/ExtraConsoleCommands.d.ts.map +1 -1
- package/dist/classes/features/other/FadeInRemover.d.ts +4 -0
- package/dist/classes/features/other/FadeInRemover.d.ts.map +1 -1
- package/dist/classes/features/other/FastReset.d.ts +4 -0
- package/dist/classes/features/other/FastReset.d.ts.map +1 -1
- package/dist/classes/features/other/FlyingDetection.d.ts +2 -0
- package/dist/classes/features/other/FlyingDetection.d.ts.map +1 -1
- package/dist/classes/features/other/FlyingDetection.lua +2 -3
- package/dist/classes/features/other/ForgottenSwitch.d.ts +2 -0
- package/dist/classes/features/other/ForgottenSwitch.d.ts.map +1 -1
- package/dist/classes/features/other/ItemPoolDetection.d.ts +7 -1
- package/dist/classes/features/other/ItemPoolDetection.d.ts.map +1 -1
- package/dist/classes/features/other/ModdedElementDetection.d.ts +32 -0
- package/dist/classes/features/other/ModdedElementDetection.d.ts.map +1 -1
- package/dist/classes/features/other/ModdedElementSets.d.ts +88 -20
- package/dist/classes/features/other/ModdedElementSets.d.ts.map +1 -1
- package/dist/classes/features/other/ModdedElementSets.lua +75 -86
- package/dist/classes/features/other/NoSirenSteal.d.ts +1 -0
- package/dist/classes/features/other/NoSirenSteal.d.ts.map +1 -1
- package/dist/classes/features/other/Pause.d.ts +10 -0
- package/dist/classes/features/other/Pause.d.ts.map +1 -1
- package/dist/classes/features/other/PersistentEntities.d.ts +2 -0
- package/dist/classes/features/other/PersistentEntities.d.ts.map +1 -1
- package/dist/classes/features/other/PlayerCollectibleTracking.d.ts +3 -0
- package/dist/classes/features/other/PlayerCollectibleTracking.d.ts.map +1 -1
- package/dist/classes/features/other/PonyDetection.d.ts +4 -0
- package/dist/classes/features/other/PonyDetection.d.ts.map +1 -1
- package/dist/classes/features/other/PreventChildEntities.d.ts +2 -0
- package/dist/classes/features/other/PreventChildEntities.d.ts.map +1 -1
- package/dist/classes/features/other/RoomClearFrame.d.ts +19 -0
- package/dist/classes/features/other/RoomClearFrame.d.ts.map +1 -1
- package/dist/classes/features/other/RoomClearFrame.lua +8 -2
- package/dist/classes/features/other/RoomHistory.d.ts +17 -1
- package/dist/classes/features/other/RoomHistory.d.ts.map +1 -1
- package/dist/classes/features/other/RunInNFrames.d.ts +9 -2
- package/dist/classes/features/other/RunInNFrames.d.ts.map +1 -1
- package/dist/classes/features/other/RunNextRun.d.ts +2 -0
- package/dist/classes/features/other/RunNextRun.d.ts.map +1 -1
- package/dist/classes/features/other/SaveDataManager.d.ts +21 -0
- package/dist/classes/features/other/SaveDataManager.d.ts.map +1 -1
- package/dist/classes/features/other/SpawnRockAltRewards.d.ts +1 -0
- package/dist/classes/features/other/SpawnRockAltRewards.d.ts.map +1 -1
- package/dist/classes/features/other/StageHistory.d.ts +3 -0
- package/dist/classes/features/other/StageHistory.d.ts.map +1 -1
- package/dist/classes/features/other/StartAmbush.d.ts +2 -0
- package/dist/classes/features/other/StartAmbush.d.ts.map +1 -1
- package/dist/classes/features/other/TaintedLazarusPlayers.d.ts +2 -0
- package/dist/classes/features/other/TaintedLazarusPlayers.d.ts.map +1 -1
- package/dist/classes/features/other/UnlockAchievementsDetection.d.ts +2 -0
- package/dist/classes/features/other/UnlockAchievementsDetection.d.ts.map +1 -1
- package/dist/classes/private/CustomCallback.d.ts +0 -1
- package/dist/classes/private/CustomCallback.d.ts.map +1 -1
- package/dist/classes/private/CustomCallback.lua +0 -19
- package/dist/functions/array.d.ts +3 -3
- package/dist/functions/array.d.ts.map +1 -1
- package/dist/functions/array.lua +34 -28
- package/dist/functions/cards.lua +3 -3
- package/dist/functions/collectibles.d.ts +2 -2
- package/dist/functions/collectibles.d.ts.map +1 -1
- package/dist/functions/collectibles.lua +4 -5
- package/dist/functions/pills.d.ts +3 -3
- package/dist/functions/pills.d.ts.map +1 -1
- package/dist/functions/playerTrinkets.d.ts +1 -1
- package/dist/functions/playerTrinkets.d.ts.map +1 -1
- package/dist/functions/players.d.ts.map +1 -1
- package/dist/functions/players.lua +7 -7
- package/dist/index.rollup.d.ts +354 -34
- package/dist/isaacscript-common.lua +490 -510
- package/dist/sets/{itemConfigCardTypesForCardsSet.d.ts → itemConfigCardTypesForCards.d.ts} +2 -2
- package/dist/sets/itemConfigCardTypesForCards.d.ts.map +1 -0
- package/dist/sets/{itemConfigCardTypesForCardsSet.lua → itemConfigCardTypesForCards.lua} +1 -1
- package/package.json +1 -1
- package/src/classes/features/callbackLogic/CustomGridEntities.ts +8 -0
- package/src/classes/features/callbackLogic/GameReorderedCallbacks.ts +6 -0
- package/src/classes/features/other/CharacterHealthConversion.ts +2 -0
- package/src/classes/features/other/CharacterStats.ts +2 -0
- package/src/classes/features/other/CollectibleItemPoolType.ts +2 -0
- package/src/classes/features/other/CustomHotkeys.ts +4 -0
- package/src/classes/features/other/CustomItemPools.ts +2 -0
- package/src/classes/features/other/CustomPickups.ts +1 -0
- package/src/classes/features/other/CustomStages.ts +3 -0
- package/src/classes/features/other/DebugDisplay.ts +54 -0
- package/src/classes/features/other/DeployJSONRoom.ts +1 -0
- package/src/classes/features/other/DisableInputs.ts +9 -0
- package/src/classes/features/other/EdenStartingStatsHealth.ts +6 -0
- package/src/classes/features/other/ExtraConsoleCommands.ts +6 -0
- package/src/classes/features/other/FadeInRemover.ts +4 -0
- package/src/classes/features/other/FastReset.ts +4 -0
- package/src/classes/features/other/FlyingDetection.ts +2 -0
- package/src/classes/features/other/ForgottenSwitch.ts +2 -0
- package/src/classes/features/other/ItemPoolDetection.ts +7 -1
- package/src/classes/features/other/ModdedElementDetection.ts +32 -0
- package/src/classes/features/other/ModdedElementSets.ts +174 -121
- package/src/classes/features/other/NoSirenSteal.ts +1 -0
- package/src/classes/features/other/Pause.ts +10 -0
- package/src/classes/features/other/PersistentEntities.ts +2 -0
- package/src/classes/features/other/PlayerCollectibleTracking.ts +3 -0
- package/src/classes/features/other/PonyDetection.ts +4 -0
- package/src/classes/features/other/PreventChildEntities.ts +2 -0
- package/src/classes/features/other/RoomClearFrame.ts +27 -1
- package/src/classes/features/other/RoomHistory.ts +17 -1
- package/src/classes/features/other/RunInNFrames.ts +9 -2
- package/src/classes/features/other/RunNextRun.ts +2 -0
- package/src/classes/features/other/SaveDataManager.ts +21 -0
- package/src/classes/features/other/SpawnRockAltRewards.ts +1 -0
- package/src/classes/features/other/StageHistory.ts +3 -0
- package/src/classes/features/other/StartAmbush.ts +2 -0
- package/src/classes/features/other/TaintedLazarusPlayers.ts +2 -0
- package/src/classes/features/other/UnlockAchievementsDetection.ts +2 -0
- package/src/classes/private/CustomCallback.ts +0 -15
- package/src/functions/array.ts +12 -5
- package/src/functions/cards.ts +2 -2
- package/src/functions/collectibles.ts +7 -7
- package/src/functions/pills.ts +3 -3
- package/src/functions/playerTrinkets.ts +3 -1
- package/src/sets/{itemConfigCardTypesForCardsSet.ts → itemConfigCardTypesForCards.ts} +3 -1
- package/dist/sets/itemConfigCardTypesForCardsSet.d.ts.map +0 -1
package/dist/index.rollup.d.ts
CHANGED
|
@@ -1073,9 +1073,9 @@ declare type Arr_2<N extends number, T extends unknown[] = []> = T["length"] ext
|
|
|
1073
1073
|
export declare function arrayEquals<T>(array1: T[] | readonly T[], array2: T[] | readonly T[]): boolean;
|
|
1074
1074
|
|
|
1075
1075
|
/**
|
|
1076
|
-
*
|
|
1077
|
-
* the specified element(s) are not found in the array, it will simply return a shallow
|
|
1078
|
-
* array.
|
|
1076
|
+
* Builds a new array based on the original array without the specified element(s). Returns the new
|
|
1077
|
+
* array. If the specified element(s) are not found in the array, it will simply return a shallow
|
|
1078
|
+
* copy of the array.
|
|
1079
1079
|
*
|
|
1080
1080
|
* This function is variadic, meaning that you can specify N arguments to remove N elements.
|
|
1081
1081
|
*
|
|
@@ -1428,6 +1428,8 @@ declare class CharacterHealthConversion extends Feature {
|
|
|
1428
1428
|
*
|
|
1429
1429
|
* In order to use this function, you must upgrade your mod with
|
|
1430
1430
|
* `ISCFeature.CHARACTER_HEALTH_CONVERSION`.
|
|
1431
|
+
*
|
|
1432
|
+
* @public
|
|
1431
1433
|
*/
|
|
1432
1434
|
registerCharacterHealthConversion(playerType: PlayerType, conversionHeartSubType: ConversionHeartSubType): void;
|
|
1433
1435
|
}
|
|
@@ -1462,6 +1464,8 @@ declare class CharacterStats extends Feature {
|
|
|
1462
1464
|
* not the `MaxFireDelay` format.
|
|
1463
1465
|
*
|
|
1464
1466
|
* In order to use this function, you must upgrade your mod with `ISCFeature.CHARACTER_STATS`.
|
|
1467
|
+
*
|
|
1468
|
+
* @public
|
|
1465
1469
|
*/
|
|
1466
1470
|
registerCharacterStats(playerType: PlayerType, statMap: Map<CacheFlag, number> | ReadonlyMap<CacheFlag, number>): void;
|
|
1467
1471
|
}
|
|
@@ -1649,6 +1653,8 @@ declare class CollectibleItemPoolType extends Feature {
|
|
|
1649
1653
|
*
|
|
1650
1654
|
* In order to use this function, you must upgrade your mod with
|
|
1651
1655
|
* `ISCFeature.COLLECTIBLE_ITEM_POOL_TYPE`.
|
|
1656
|
+
*
|
|
1657
|
+
* @public
|
|
1652
1658
|
*/
|
|
1653
1659
|
getCollectibleItemPoolType(collectible: EntityPickup): ItemPoolType;
|
|
1654
1660
|
}
|
|
@@ -1886,7 +1892,6 @@ declare abstract class CustomCallback<T extends ModCallbackCustom> extends Featu
|
|
|
1886
1892
|
* See "shouldFire.ts" for methods tailored to specific kinds of callbacks.
|
|
1887
1893
|
*/
|
|
1888
1894
|
protected shouldFire: (fireArgs: FireArgs<T>, optionalArgs: OptionalArgs<T>) => boolean;
|
|
1889
|
-
logSubscriptions(): void;
|
|
1890
1895
|
}
|
|
1891
1896
|
|
|
1892
1897
|
declare class CustomGridEntities extends Feature {
|
|
@@ -1972,6 +1977,7 @@ declare class CustomGridEntities extends Feature {
|
|
|
1972
1977
|
* custom grid entity. Default is `GridEntityType.DECORATION`.
|
|
1973
1978
|
* @param baseGridEntityVariant Optional. The variant of the grid entity to use as a "base" for
|
|
1974
1979
|
* this custom grid entity. Default is 0.
|
|
1980
|
+
* @public
|
|
1975
1981
|
*/
|
|
1976
1982
|
spawnCustomGridEntity(gridEntityTypeCustom: GridEntityType, gridIndexOrPosition: int | Vector, gridCollisionClass?: GridCollisionClass, anm2Path?: string, defaultAnimation?: string, baseGridEntityType?: GridEntityType, baseGridEntityVariant?: number): GridEntity;
|
|
1977
1983
|
/**
|
|
@@ -1991,6 +1997,7 @@ declare class CustomGridEntities extends Feature {
|
|
|
1991
1997
|
* function multiple times.
|
|
1992
1998
|
* @returns The grid entity that was removed. Returns undefined if no grid entity was found at the
|
|
1993
1999
|
* given location or if the given grid entity was not a custom grid entity.
|
|
2000
|
+
* @public
|
|
1994
2001
|
*/
|
|
1995
2002
|
removeCustomGridEntity(gridIndexOrPositionOrGridEntity: int | Vector | GridEntity, updateRoom?: boolean): GridEntity | undefined;
|
|
1996
2003
|
/**
|
|
@@ -1999,6 +2006,8 @@ declare class CustomGridEntities extends Feature {
|
|
|
1999
2006
|
*
|
|
2000
2007
|
* In order to use this function, you must upgrade your mod with
|
|
2001
2008
|
* `ISCFeature.CUSTOM_GRID_ENTITIES`.
|
|
2009
|
+
*
|
|
2010
|
+
* @public
|
|
2002
2011
|
*/
|
|
2003
2012
|
getCustomGridEntities(): Array<{
|
|
2004
2013
|
gridEntity: GridEntity;
|
|
@@ -2011,6 +2020,8 @@ declare class CustomGridEntities extends Feature {
|
|
|
2011
2020
|
*
|
|
2012
2021
|
* In order to use this function, you must upgrade your mod with
|
|
2013
2022
|
* `ISCFeature.CUSTOM_GRID_ENTITIES`.
|
|
2023
|
+
*
|
|
2024
|
+
* @public
|
|
2014
2025
|
*/
|
|
2015
2026
|
getCustomGridEntityType(gridEntityOrGridIndex: GridEntity | int): GridEntityType | undefined;
|
|
2016
2027
|
/**
|
|
@@ -2019,6 +2030,8 @@ declare class CustomGridEntities extends Feature {
|
|
|
2019
2030
|
*
|
|
2020
2031
|
* In order to use this function, you must upgrade your mod with
|
|
2021
2032
|
* `ISCFeature.CUSTOM_GRID_ENTITIES`.
|
|
2033
|
+
*
|
|
2034
|
+
* @public
|
|
2022
2035
|
*/
|
|
2023
2036
|
isCustomGridEntity(gridEntityOrGridIndex: GridEntity | int): boolean;
|
|
2024
2037
|
}
|
|
@@ -2054,6 +2067,7 @@ declare class CustomHotkeys extends Feature {
|
|
|
2054
2067
|
* @param getKeyFunc The function that returns the key that will trigger the hotkey.
|
|
2055
2068
|
* @param triggerFunc A function containing the arbitrary code that you want to execute when the
|
|
2056
2069
|
* hotkey is triggered.
|
|
2070
|
+
* @public
|
|
2057
2071
|
*/
|
|
2058
2072
|
setConditionalHotkey(getKeyFunc: () => Keyboard | undefined, triggerFunc: () => void): void;
|
|
2059
2073
|
/**
|
|
@@ -2069,6 +2083,7 @@ declare class CustomHotkeys extends Feature {
|
|
|
2069
2083
|
* @param keyboard The key that you want to trigger the hotkey.
|
|
2070
2084
|
* @param triggerFunc A function containing the arbitrary code that you want to execute when the
|
|
2071
2085
|
* hotkey is triggered.
|
|
2086
|
+
* @public
|
|
2072
2087
|
*/
|
|
2073
2088
|
setHotkey(keyboard: Keyboard, triggerFunc: () => void): void;
|
|
2074
2089
|
/**
|
|
@@ -2078,6 +2093,7 @@ declare class CustomHotkeys extends Feature {
|
|
|
2078
2093
|
*
|
|
2079
2094
|
* @param getKeyFunc Equal to the `getKeyFunc` that you passed when initially registering the
|
|
2080
2095
|
* hotkey.
|
|
2096
|
+
* @public
|
|
2081
2097
|
*/
|
|
2082
2098
|
unsetConditionalHotkey(getKeyFunc: () => Keyboard | undefined): void;
|
|
2083
2099
|
/**
|
|
@@ -2087,6 +2103,7 @@ declare class CustomHotkeys extends Feature {
|
|
|
2087
2103
|
*
|
|
2088
2104
|
* @param keyboard Equal to the keyboard value that you passed when initially registering the
|
|
2089
2105
|
* hotkey.
|
|
2106
|
+
* @public
|
|
2090
2107
|
*/
|
|
2091
2108
|
unsetHotkey(keyboard: Keyboard): void;
|
|
2092
2109
|
}
|
|
@@ -2125,6 +2142,7 @@ declare class CustomItemPools extends Feature {
|
|
|
2125
2142
|
* you are creating. The first element in he tuple is the `CollectibleType`,
|
|
2126
2143
|
* and the second element in the tuple is the float that represents the weight
|
|
2127
2144
|
* of the collectible.
|
|
2145
|
+
* @public
|
|
2128
2146
|
*/
|
|
2129
2147
|
registerCustomItemPool(itemPoolTypeCustom: ItemPoolType, collectibles: WeightedArray<CollectibleType>): void;
|
|
2130
2148
|
/**
|
|
@@ -2148,6 +2166,7 @@ declare class CustomItemPools extends Feature {
|
|
|
2148
2166
|
* Default is true.
|
|
2149
2167
|
* @param defaultItem Optional. The collectible to return if the item pool is depleted. Default is
|
|
2150
2168
|
* `CollectibleType.NULL`.
|
|
2169
|
+
* @public
|
|
2151
2170
|
*/
|
|
2152
2171
|
getCustomItemPoolCollectible(itemPoolTypeCustom: ItemPoolType, seedOrRNG: Seed | RNG | undefined, decrease?: boolean, defaultItem?: CollectibleType): CollectibleType;
|
|
2153
2172
|
}
|
|
@@ -2182,6 +2201,7 @@ declare class CustomPickups extends Feature {
|
|
|
2182
2201
|
* will always immediately collect the pickup when they collide with it.
|
|
2183
2202
|
* Specify this function if your pickup should only be able to be collected
|
|
2184
2203
|
* under certain conditions.
|
|
2204
|
+
* @public
|
|
2185
2205
|
*/
|
|
2186
2206
|
registerCustomPickup(pickupVariantCustom: PickupVariant, subType: int, collectFunc: (this: void, player: EntityPlayer) => void, collisionFunc?: (this: void, player: EntityPlayer) => boolean): void;
|
|
2187
2207
|
}
|
|
@@ -2357,6 +2377,7 @@ declare class CustomStages extends Feature {
|
|
|
2357
2377
|
* announces the name of the level. Default is true.
|
|
2358
2378
|
* @param verbose Optional. Whether to log additional information about the rooms that are chosen.
|
|
2359
2379
|
* Default is false.
|
|
2380
|
+
* @public
|
|
2360
2381
|
*/
|
|
2361
2382
|
setCustomStage(name: string, firstFloor?: boolean, streakText?: boolean, verbose?: boolean): void;
|
|
2362
2383
|
/**
|
|
@@ -2364,6 +2385,8 @@ declare class CustomStages extends Feature {
|
|
|
2364
2385
|
* to a vanilla floor.
|
|
2365
2386
|
*
|
|
2366
2387
|
* In order to use this function, you must upgrade your mod with `ISCFeature.CUSTOM_STAGES`.
|
|
2388
|
+
*
|
|
2389
|
+
* @public
|
|
2367
2390
|
*/
|
|
2368
2391
|
disableCustomStage(): void;
|
|
2369
2392
|
}
|
|
@@ -2964,6 +2987,8 @@ declare class DebugDisplay extends Feature {
|
|
|
2964
2987
|
* ```
|
|
2965
2988
|
*
|
|
2966
2989
|
* In order to use this function, you must upgrade your mod with `ISCFeature.DEBUG_DISPLAY`.
|
|
2990
|
+
*
|
|
2991
|
+
* @public
|
|
2967
2992
|
*/
|
|
2968
2993
|
setPlayerDisplay(textCallback: (player: EntityPlayer) => string): void;
|
|
2969
2994
|
/**
|
|
@@ -2975,6 +3000,8 @@ declare class DebugDisplay extends Feature {
|
|
|
2975
3000
|
* reason, you typically only need to set the function once at the beginning of your mod.
|
|
2976
3001
|
*
|
|
2977
3002
|
* In order to use this function, you must upgrade your mod with `ISCFeature.DEBUG_DISPLAY`.
|
|
3003
|
+
*
|
|
3004
|
+
* @public
|
|
2978
3005
|
*/
|
|
2979
3006
|
setTearDisplay(textCallback: (tear: EntityTear) => string): void;
|
|
2980
3007
|
/**
|
|
@@ -2986,6 +3013,8 @@ declare class DebugDisplay extends Feature {
|
|
|
2986
3013
|
* reason, you typically only need to set the function once at the beginning of your mod.
|
|
2987
3014
|
*
|
|
2988
3015
|
* In order to use this function, you must upgrade your mod with `ISCFeature.DEBUG_DISPLAY`.
|
|
3016
|
+
*
|
|
3017
|
+
* @public
|
|
2989
3018
|
*/
|
|
2990
3019
|
setFamiliarDisplay(textCallback: (familiar: EntityFamiliar) => string): void;
|
|
2991
3020
|
/**
|
|
@@ -2997,6 +3026,8 @@ declare class DebugDisplay extends Feature {
|
|
|
2997
3026
|
* reason, you typically only need to set the function once at the beginning of your mod.
|
|
2998
3027
|
*
|
|
2999
3028
|
* In order to use this function, you must upgrade your mod with `ISCFeature.DEBUG_DISPLAY`.
|
|
3029
|
+
*
|
|
3030
|
+
* @public
|
|
3000
3031
|
*/
|
|
3001
3032
|
setBombDisplay(textCallback: (bomb: EntityBomb) => string): void;
|
|
3002
3033
|
/**
|
|
@@ -3008,6 +3039,8 @@ declare class DebugDisplay extends Feature {
|
|
|
3008
3039
|
* reason, you typically only need to set the function once at the beginning of your mod.
|
|
3009
3040
|
*
|
|
3010
3041
|
* In order to use this function, you must upgrade your mod with `ISCFeature.DEBUG_DISPLAY`.
|
|
3042
|
+
*
|
|
3043
|
+
* @public
|
|
3011
3044
|
*/
|
|
3012
3045
|
setPickupDisplay(textCallback: (pickup: EntityPickup) => string): void;
|
|
3013
3046
|
/**
|
|
@@ -3019,6 +3052,8 @@ declare class DebugDisplay extends Feature {
|
|
|
3019
3052
|
* reason, you typically only need to set the function once at the beginning of your mod.
|
|
3020
3053
|
*
|
|
3021
3054
|
* In order to use this function, you must upgrade your mod with `ISCFeature.DEBUG_DISPLAY`.
|
|
3055
|
+
*
|
|
3056
|
+
* @public
|
|
3022
3057
|
*/
|
|
3023
3058
|
setSlotDisplay(textCallback: (slot: Entity) => string): void;
|
|
3024
3059
|
/**
|
|
@@ -3030,6 +3065,8 @@ declare class DebugDisplay extends Feature {
|
|
|
3030
3065
|
* reason, you typically only need to set the function once at the beginning of your mod.
|
|
3031
3066
|
*
|
|
3032
3067
|
* In order to use this function, you must upgrade your mod with `ISCFeature.DEBUG_DISPLAY`.
|
|
3068
|
+
*
|
|
3069
|
+
* @public
|
|
3033
3070
|
*/
|
|
3034
3071
|
setLaserDisplay(textCallback: (laser: EntityLaser) => string): void;
|
|
3035
3072
|
/**
|
|
@@ -3041,6 +3078,8 @@ declare class DebugDisplay extends Feature {
|
|
|
3041
3078
|
* reason, you typically only need to set the function once at the beginning of your mod.
|
|
3042
3079
|
*
|
|
3043
3080
|
* In order to use this function, you must upgrade your mod with `ISCFeature.DEBUG_DISPLAY`.
|
|
3081
|
+
*
|
|
3082
|
+
* @public
|
|
3044
3083
|
*/
|
|
3045
3084
|
setKnifeDisplay(textCallback: (knife: EntityKnife) => string): void;
|
|
3046
3085
|
/**
|
|
@@ -3052,6 +3091,8 @@ declare class DebugDisplay extends Feature {
|
|
|
3052
3091
|
* reason, you typically only need to set the function once at the beginning of your mod.
|
|
3053
3092
|
*
|
|
3054
3093
|
* In order to use this function, you must upgrade your mod with `ISCFeature.DEBUG_DISPLAY`.
|
|
3094
|
+
*
|
|
3095
|
+
* @public
|
|
3055
3096
|
*/
|
|
3056
3097
|
setProjectileDisplay(textCallback: (projectile: EntityProjectile) => string): void;
|
|
3057
3098
|
/**
|
|
@@ -3063,6 +3104,8 @@ declare class DebugDisplay extends Feature {
|
|
|
3063
3104
|
* reason, you typically only need to set the function once at the beginning of your mod.
|
|
3064
3105
|
*
|
|
3065
3106
|
* In order to use this function, you must upgrade your mod with `ISCFeature.DEBUG_DISPLAY`.
|
|
3107
|
+
*
|
|
3108
|
+
* @public
|
|
3066
3109
|
*/
|
|
3067
3110
|
setEffectDisplay(textCallback: (effect: EntityEffect) => string): void;
|
|
3068
3111
|
/**
|
|
@@ -3074,6 +3117,8 @@ declare class DebugDisplay extends Feature {
|
|
|
3074
3117
|
* reason, you typically only need to set the function once at the beginning of your mod.
|
|
3075
3118
|
*
|
|
3076
3119
|
* In order to use this function, you must upgrade your mod with `ISCFeature.DEBUG_DISPLAY`.
|
|
3120
|
+
*
|
|
3121
|
+
* @public
|
|
3077
3122
|
*/
|
|
3078
3123
|
setNPCDisplay(textCallback: (npc: EntityNPC) => string): void;
|
|
3079
3124
|
/**
|
|
@@ -3085,6 +3130,8 @@ declare class DebugDisplay extends Feature {
|
|
|
3085
3130
|
* reason, you typically only need to set the function once at the beginning of your mod.
|
|
3086
3131
|
*
|
|
3087
3132
|
* In order to use this function, you must upgrade your mod with `ISCFeature.DEBUG_DISPLAY`.
|
|
3133
|
+
*
|
|
3134
|
+
* @public
|
|
3088
3135
|
*/
|
|
3089
3136
|
setRockDisplay(textCallback: (rock: GridEntityRock) => string): void;
|
|
3090
3137
|
/**
|
|
@@ -3096,6 +3143,8 @@ declare class DebugDisplay extends Feature {
|
|
|
3096
3143
|
* reason, you typically only need to set the function once at the beginning of your mod.
|
|
3097
3144
|
*
|
|
3098
3145
|
* In order to use this function, you must upgrade your mod with `ISCFeature.DEBUG_DISPLAY`.
|
|
3146
|
+
*
|
|
3147
|
+
* @public
|
|
3099
3148
|
*/
|
|
3100
3149
|
setPitDisplay(textCallback: (pit: GridEntityPit) => string): void;
|
|
3101
3150
|
/**
|
|
@@ -3107,6 +3156,8 @@ declare class DebugDisplay extends Feature {
|
|
|
3107
3156
|
* reason, you typically only need to set the function once at the beginning of your mod.
|
|
3108
3157
|
*
|
|
3109
3158
|
* In order to use this function, you must upgrade your mod with `ISCFeature.DEBUG_DISPLAY`.
|
|
3159
|
+
*
|
|
3160
|
+
* @public
|
|
3110
3161
|
*/
|
|
3111
3162
|
setSpikesDisplay(textCallback: (spikes: GridEntitySpikes) => string): void;
|
|
3112
3163
|
/**
|
|
@@ -3118,6 +3169,8 @@ declare class DebugDisplay extends Feature {
|
|
|
3118
3169
|
* reason, you typically only need to set the function once at the beginning of your mod.
|
|
3119
3170
|
*
|
|
3120
3171
|
* In order to use this function, you must upgrade your mod with `ISCFeature.DEBUG_DISPLAY`.
|
|
3172
|
+
*
|
|
3173
|
+
* @public
|
|
3121
3174
|
*/
|
|
3122
3175
|
setTNTDisplay(textCallback: (tnt: GridEntityTNT) => string): void;
|
|
3123
3176
|
/**
|
|
@@ -3129,6 +3182,8 @@ declare class DebugDisplay extends Feature {
|
|
|
3129
3182
|
* reason, you typically only need to set the function once at the beginning of your mod.
|
|
3130
3183
|
*
|
|
3131
3184
|
* In order to use this function, you must upgrade your mod with `ISCFeature.DEBUG_DISPLAY`.
|
|
3185
|
+
*
|
|
3186
|
+
* @public
|
|
3132
3187
|
*/
|
|
3133
3188
|
setPoopDisplay(textCallback: (poop: GridEntityPoop) => string): void;
|
|
3134
3189
|
/**
|
|
@@ -3140,6 +3195,8 @@ declare class DebugDisplay extends Feature {
|
|
|
3140
3195
|
* reason, you typically only need to set the function once at the beginning of your mod.
|
|
3141
3196
|
*
|
|
3142
3197
|
* In order to use this function, you must upgrade your mod with `ISCFeature.DEBUG_DISPLAY`.
|
|
3198
|
+
*
|
|
3199
|
+
* @public
|
|
3143
3200
|
*/
|
|
3144
3201
|
setDoorDisplay(textCallback: (door: GridEntityDoor) => string): void;
|
|
3145
3202
|
/**
|
|
@@ -3151,6 +3208,8 @@ declare class DebugDisplay extends Feature {
|
|
|
3151
3208
|
* reason, you typically only need to set the function once at the beginning of your mod.
|
|
3152
3209
|
*
|
|
3153
3210
|
* In order to use this function, you must upgrade your mod with `ISCFeature.DEBUG_DISPLAY`.
|
|
3211
|
+
*
|
|
3212
|
+
* @public
|
|
3154
3213
|
*/
|
|
3155
3214
|
setPressurePlateDisplay(textCallback: (pressurePlate: GridEntityPressurePlate) => string): void;
|
|
3156
3215
|
private toggleFeature;
|
|
@@ -3162,6 +3221,7 @@ declare class DebugDisplay extends Feature {
|
|
|
3162
3221
|
* @param force Optional. A boolean that represents the value to force the display to. For
|
|
3163
3222
|
* example, you can specify true to always make the display turn on, regardless of
|
|
3164
3223
|
* whether it is already on.
|
|
3224
|
+
* @public
|
|
3165
3225
|
*/
|
|
3166
3226
|
togglePlayerDisplay(force?: boolean): void;
|
|
3167
3227
|
/**
|
|
@@ -3172,6 +3232,7 @@ declare class DebugDisplay extends Feature {
|
|
|
3172
3232
|
* @param force Optional. A boolean that represents the value to force the display to. For
|
|
3173
3233
|
* example, you can specify true to always make the display turn on, regardless of
|
|
3174
3234
|
* whether it is already on.
|
|
3235
|
+
* @public
|
|
3175
3236
|
*/
|
|
3176
3237
|
toggleTearDisplay(force?: boolean): void;
|
|
3177
3238
|
/**
|
|
@@ -3183,6 +3244,7 @@ declare class DebugDisplay extends Feature {
|
|
|
3183
3244
|
* @param force Optional. A boolean that represents the value to force the display to. For
|
|
3184
3245
|
* example, you can specify true to always make the display turn on, regardless of
|
|
3185
3246
|
* whether it is already on.
|
|
3247
|
+
* @public
|
|
3186
3248
|
*/
|
|
3187
3249
|
toggleFamiliarDisplay(force?: boolean): void;
|
|
3188
3250
|
/**
|
|
@@ -3193,6 +3255,7 @@ declare class DebugDisplay extends Feature {
|
|
|
3193
3255
|
* @param force Optional. A boolean that represents the value to force the display to. For
|
|
3194
3256
|
* example, you can specify true to always make the display turn on, regardless of
|
|
3195
3257
|
* whether it is already on.
|
|
3258
|
+
* @public
|
|
3196
3259
|
*/
|
|
3197
3260
|
toggleBombDisplay(force?: boolean): void;
|
|
3198
3261
|
/**
|
|
@@ -3203,6 +3266,7 @@ declare class DebugDisplay extends Feature {
|
|
|
3203
3266
|
* @param force Optional. A boolean that represents the value to force the display to. For
|
|
3204
3267
|
* example, you can specify true to always make the display turn on, regardless of
|
|
3205
3268
|
* whether it is already on.
|
|
3269
|
+
* @public
|
|
3206
3270
|
*/
|
|
3207
3271
|
togglePickupDisplay(force?: boolean): void;
|
|
3208
3272
|
/**
|
|
@@ -3213,6 +3277,7 @@ declare class DebugDisplay extends Feature {
|
|
|
3213
3277
|
* @param force Optional. A boolean that represents the value to force the display to. For
|
|
3214
3278
|
* example, you can specify true to always make the display turn on, regardless of
|
|
3215
3279
|
* whether it is already on.
|
|
3280
|
+
* @public
|
|
3216
3281
|
*/
|
|
3217
3282
|
toggleSlotDisplay(force?: boolean): void;
|
|
3218
3283
|
/**
|
|
@@ -3223,6 +3288,7 @@ declare class DebugDisplay extends Feature {
|
|
|
3223
3288
|
* @param force Optional. A boolean that represents the value to force the display to. For
|
|
3224
3289
|
* example, you can specify true to always make the display turn on, regardless of
|
|
3225
3290
|
* whether it is already on.
|
|
3291
|
+
* @public
|
|
3226
3292
|
*/
|
|
3227
3293
|
toggleLaserDisplay(force?: boolean): void;
|
|
3228
3294
|
/**
|
|
@@ -3233,6 +3299,7 @@ declare class DebugDisplay extends Feature {
|
|
|
3233
3299
|
* @param force Optional. A boolean that represents the value to force the display to. For
|
|
3234
3300
|
* example, you can specify true to always make the display turn on, regardless of
|
|
3235
3301
|
* whether it is already on.
|
|
3302
|
+
* @public
|
|
3236
3303
|
*/
|
|
3237
3304
|
toggleKnifeDisplay(force?: boolean): void;
|
|
3238
3305
|
/**
|
|
@@ -3244,6 +3311,7 @@ declare class DebugDisplay extends Feature {
|
|
|
3244
3311
|
* @param force Optional. A boolean that represents the value to force the display to. For
|
|
3245
3312
|
* example, you can specify true to always make the display turn on, regardless of
|
|
3246
3313
|
* whether it is already on.
|
|
3314
|
+
* @public
|
|
3247
3315
|
*/
|
|
3248
3316
|
toggleProjectileDisplay(force?: boolean): void;
|
|
3249
3317
|
/**
|
|
@@ -3254,6 +3322,7 @@ declare class DebugDisplay extends Feature {
|
|
|
3254
3322
|
* @param force Optional. A boolean that represents the value to force the display to. For
|
|
3255
3323
|
* example, you can specify true to always make the display turn on, regardless of
|
|
3256
3324
|
* whether it is already on.
|
|
3325
|
+
* @public
|
|
3257
3326
|
*/
|
|
3258
3327
|
toggleEffectDisplay(force?: boolean): void;
|
|
3259
3328
|
/**
|
|
@@ -3264,6 +3333,7 @@ declare class DebugDisplay extends Feature {
|
|
|
3264
3333
|
* @param force Optional. A boolean that represents the value to force the display to. For
|
|
3265
3334
|
* example, you can specify true to always make the display turn on, regardless of
|
|
3266
3335
|
* whether it is already on.
|
|
3336
|
+
* @public
|
|
3267
3337
|
*/
|
|
3268
3338
|
toggleNPCDisplay(force?: boolean): void;
|
|
3269
3339
|
/**
|
|
@@ -3274,6 +3344,7 @@ declare class DebugDisplay extends Feature {
|
|
|
3274
3344
|
* @param force Optional. A boolean that represents the value to force the display to. For
|
|
3275
3345
|
* example, you can specify true to always make the display turn on, regardless of
|
|
3276
3346
|
* whether it is already on.
|
|
3347
|
+
* @public
|
|
3277
3348
|
*/
|
|
3278
3349
|
toggleRockDisplay(force?: boolean): void;
|
|
3279
3350
|
/**
|
|
@@ -3284,6 +3355,7 @@ declare class DebugDisplay extends Feature {
|
|
|
3284
3355
|
* @param force Optional. A boolean that represents the value to force the display to. For
|
|
3285
3356
|
* example, you can specify true to always make the display turn on, regardless of
|
|
3286
3357
|
* whether it is already on.
|
|
3358
|
+
* @public
|
|
3287
3359
|
*/
|
|
3288
3360
|
togglePitDisplay(force?: boolean): void;
|
|
3289
3361
|
/**
|
|
@@ -3294,6 +3366,7 @@ declare class DebugDisplay extends Feature {
|
|
|
3294
3366
|
* @param force Optional. A boolean that represents the value to force the display to. For
|
|
3295
3367
|
* example, you can specify true to always make the display turn on, regardless of
|
|
3296
3368
|
* whether it is already on.
|
|
3369
|
+
* @public
|
|
3297
3370
|
*/
|
|
3298
3371
|
toggleSpikesDisplay(force?: boolean): void;
|
|
3299
3372
|
/**
|
|
@@ -3304,6 +3377,7 @@ declare class DebugDisplay extends Feature {
|
|
|
3304
3377
|
* @param force Optional. A boolean that represents the value to force the display to. For
|
|
3305
3378
|
* example, you can specify true to always make the display turn on, regardless of
|
|
3306
3379
|
* whether it is already on.
|
|
3380
|
+
* @public
|
|
3307
3381
|
*/
|
|
3308
3382
|
toggleTNTDisplay(force?: boolean): void;
|
|
3309
3383
|
/**
|
|
@@ -3314,6 +3388,7 @@ declare class DebugDisplay extends Feature {
|
|
|
3314
3388
|
* @param force Optional. A boolean that represents the value to force the display to. For
|
|
3315
3389
|
* example, you can specify true to always make the display turn on, regardless of
|
|
3316
3390
|
* whether it is already on.
|
|
3391
|
+
* @public
|
|
3317
3392
|
*/
|
|
3318
3393
|
togglePoopDisplay(force?: boolean): void;
|
|
3319
3394
|
/**
|
|
@@ -3324,6 +3399,7 @@ declare class DebugDisplay extends Feature {
|
|
|
3324
3399
|
* @param force Optional. A boolean that represents the value to force the display to. For
|
|
3325
3400
|
* example, you can specify true to always make the display turn on, regardless of
|
|
3326
3401
|
* whether it is already on.
|
|
3402
|
+
* @public
|
|
3327
3403
|
*/
|
|
3328
3404
|
toggleDoorDisplay(force?: boolean): void;
|
|
3329
3405
|
/**
|
|
@@ -3335,6 +3411,7 @@ declare class DebugDisplay extends Feature {
|
|
|
3335
3411
|
* @param force Optional. A boolean that represents the value to force the display to. For
|
|
3336
3412
|
* example, you can specify true to always make the display turn on, regardless of
|
|
3337
3413
|
* whether it is already on.
|
|
3414
|
+
* @public
|
|
3338
3415
|
*/
|
|
3339
3416
|
togglePressurePlateDisplay(force?: boolean): void;
|
|
3340
3417
|
}
|
|
@@ -3625,6 +3702,7 @@ declare class DeployJSONRoom extends Feature {
|
|
|
3625
3702
|
* to a random seed.
|
|
3626
3703
|
* @param verbose Optional. If specified, will write entries to the "log.txt" file that describe
|
|
3627
3704
|
* what the function is doing. Default is false.
|
|
3705
|
+
* @public
|
|
3628
3706
|
*/
|
|
3629
3707
|
deployJSONRoom(jsonRoom: JSONRoom | Readonly<JSONRoom>, seedOrRNG: Seed | RNG | undefined, verbose?: boolean): void;
|
|
3630
3708
|
}
|
|
@@ -3756,6 +3834,8 @@ declare class DisableInputs extends Feature {
|
|
|
3756
3834
|
* capacity.
|
|
3757
3835
|
*
|
|
3758
3836
|
* In order to use this function, you must upgrade your mod with `ISCFeature.DISABLE_INPUTS`.
|
|
3837
|
+
*
|
|
3838
|
+
* @public
|
|
3759
3839
|
*/
|
|
3760
3840
|
areInputsEnabled(): boolean;
|
|
3761
3841
|
/**
|
|
@@ -3768,6 +3848,7 @@ declare class DisableInputs extends Feature {
|
|
|
3768
3848
|
* this was part of the code for a custom enemy called "Super Gaper", then you could
|
|
3769
3849
|
* use a key of "SuperGaper". The name is necessary so that multiple mod features can
|
|
3770
3850
|
* work in tandem.
|
|
3851
|
+
* @public
|
|
3771
3852
|
*/
|
|
3772
3853
|
enableAllInputs(key: string): void;
|
|
3773
3854
|
/**
|
|
@@ -3785,6 +3866,7 @@ declare class DisableInputs extends Feature {
|
|
|
3785
3866
|
* use a key of "SuperGaper". The name is necessary so that multiple mod features can
|
|
3786
3867
|
* work in tandem.
|
|
3787
3868
|
* @param buttonActions An array of the actions to action.
|
|
3869
|
+
* @public
|
|
3788
3870
|
*/
|
|
3789
3871
|
disableInputs(key: string, ...buttonActions: ButtonAction[]): void;
|
|
3790
3872
|
/**
|
|
@@ -3799,6 +3881,7 @@ declare class DisableInputs extends Feature {
|
|
|
3799
3881
|
* this was part of the code for a custom enemy called "Super Gaper", then you could
|
|
3800
3882
|
* use a key of "SuperGaper". The name is necessary so that multiple mod features can
|
|
3801
3883
|
* work in tandem.
|
|
3884
|
+
* @public
|
|
3802
3885
|
*/
|
|
3803
3886
|
disableAllInputs(key: string): void;
|
|
3804
3887
|
/**
|
|
@@ -3814,6 +3897,7 @@ declare class DisableInputs extends Feature {
|
|
|
3814
3897
|
* use a key of "SuperGaper". The name is necessary so that multiple mod features can
|
|
3815
3898
|
* work in tandem.
|
|
3816
3899
|
* @param blacklist A set of ButtonActions to disallow.
|
|
3900
|
+
* @public
|
|
3817
3901
|
*/
|
|
3818
3902
|
enableAllInputsExceptFor(key: string, blacklist: Set<ButtonAction> | ReadonlySet<ButtonAction>): void;
|
|
3819
3903
|
/**
|
|
@@ -3829,6 +3913,7 @@ declare class DisableInputs extends Feature {
|
|
|
3829
3913
|
* use a key of "SuperGaper". The name is necessary so that multiple mod features can
|
|
3830
3914
|
* work in tandem.
|
|
3831
3915
|
* @param whitelist A set of ButtonActions to allow.
|
|
3916
|
+
* @public
|
|
3832
3917
|
*/
|
|
3833
3918
|
disableAllInputsExceptFor(key: string, whitelist: Set<ButtonAction> | ReadonlySet<ButtonAction>): void;
|
|
3834
3919
|
/**
|
|
@@ -3844,6 +3929,7 @@ declare class DisableInputs extends Feature {
|
|
|
3844
3929
|
* this was part of the code for a custom enemy called "Super Gaper", then you could
|
|
3845
3930
|
* use a key of "SuperGaper". The name is necessary so that multiple mod features can
|
|
3846
3931
|
* work in tandem.
|
|
3932
|
+
* @public
|
|
3847
3933
|
*/
|
|
3848
3934
|
disableMovementInputs(key: string): void;
|
|
3849
3935
|
/**
|
|
@@ -3858,6 +3944,7 @@ declare class DisableInputs extends Feature {
|
|
|
3858
3944
|
* this was part of the code for a custom enemy called "Super Gaper", then you could
|
|
3859
3945
|
* use a key of "SuperGaper". The name is necessary so that multiple mod features can
|
|
3860
3946
|
* work in tandem.
|
|
3947
|
+
* @public
|
|
3861
3948
|
*/
|
|
3862
3949
|
disableShootingInputs(key: string): void;
|
|
3863
3950
|
}
|
|
@@ -4180,6 +4267,8 @@ declare class EdenStartingStatsHealth extends Feature {
|
|
|
4180
4267
|
* Returns undefined if passed a player that is not Eden.
|
|
4181
4268
|
*
|
|
4182
4269
|
* In order to use this function, you must upgrade your mod with `ISCFeature.EDEN_STARTING_STATS`.
|
|
4270
|
+
*
|
|
4271
|
+
* @public
|
|
4183
4272
|
*/
|
|
4184
4273
|
getEdenStartingHealth(player: EntityPlayer): Readonly<PlayerHealth> | undefined;
|
|
4185
4274
|
/**
|
|
@@ -4189,6 +4278,8 @@ declare class EdenStartingStatsHealth extends Feature {
|
|
|
4189
4278
|
* Returns undefined if passed a player that is not Eden.
|
|
4190
4279
|
*
|
|
4191
4280
|
* In order to use this function, you must upgrade your mod with `ISCFeature.EDEN_STARTING_STATS`.
|
|
4281
|
+
*
|
|
4282
|
+
* @public
|
|
4192
4283
|
*/
|
|
4193
4284
|
getEdenStartingStat<T extends PlayerStat>(player: EntityPlayer, playerStat: T): PlayerStats[T] | undefined;
|
|
4194
4285
|
/**
|
|
@@ -4198,6 +4289,8 @@ declare class EdenStartingStatsHealth extends Feature {
|
|
|
4198
4289
|
* Returns undefined if passed a player that is not Eden.
|
|
4199
4290
|
*
|
|
4200
4291
|
* In order to use this function, you must upgrade your mod with `ISCFeature.EDEN_STARTING_STATS`.
|
|
4292
|
+
*
|
|
4293
|
+
* @public
|
|
4201
4294
|
*/
|
|
4202
4295
|
getEdenStartingStats(player: EntityPlayer): Readonly<PlayerStats> | undefined;
|
|
4203
4296
|
}
|
|
@@ -4342,6 +4435,8 @@ declare class ExtraConsoleCommands extends Feature {
|
|
|
4342
4435
|
*
|
|
4343
4436
|
* In order to use this function, you must upgrade your mod with
|
|
4344
4437
|
* `ISCFeature.EXTRA_CONSOLE_COMMANDS`.
|
|
4438
|
+
*
|
|
4439
|
+
* @public
|
|
4345
4440
|
*/
|
|
4346
4441
|
addConsoleCommand(commandName: string, commandFunction: (params: string) => void): void;
|
|
4347
4442
|
/**
|
|
@@ -4354,6 +4449,8 @@ declare class ExtraConsoleCommands extends Feature {
|
|
|
4354
4449
|
*
|
|
4355
4450
|
* In order to use this function, you must upgrade your mod with
|
|
4356
4451
|
* `ISCFeature.EXTRA_CONSOLE_COMMANDS`.
|
|
4452
|
+
*
|
|
4453
|
+
* @public
|
|
4357
4454
|
*/
|
|
4358
4455
|
removeConsoleCommand(commandName: string): void;
|
|
4359
4456
|
/**
|
|
@@ -4365,6 +4462,8 @@ declare class ExtraConsoleCommands extends Feature {
|
|
|
4365
4462
|
*
|
|
4366
4463
|
* In order to use this function, you must upgrade your mod with
|
|
4367
4464
|
* `ISCFeature.EXTRA_CONSOLE_COMMANDS`.
|
|
4465
|
+
*
|
|
4466
|
+
* @public
|
|
4368
4467
|
*/
|
|
4369
4468
|
removeAllConsoleCommands(): void;
|
|
4370
4469
|
}
|
|
@@ -4387,6 +4486,8 @@ declare class FadeInRemover extends Feature {
|
|
|
4387
4486
|
* You can restore the vanilla behavior with the `restoreFadeIn` function.
|
|
4388
4487
|
*
|
|
4389
4488
|
* In order to use this function, you must upgrade your mod with `ISCFeature.FADE_IN_REMOVER`.
|
|
4489
|
+
*
|
|
4490
|
+
* @public
|
|
4390
4491
|
*/
|
|
4391
4492
|
removeFadeIn(): void;
|
|
4392
4493
|
/**
|
|
@@ -4394,6 +4495,8 @@ declare class FadeInRemover extends Feature {
|
|
|
4394
4495
|
* function.
|
|
4395
4496
|
*
|
|
4396
4497
|
* In order to use this function, you must upgrade your mod with `ISCFeature.FADE_IN_REMOVER`.
|
|
4498
|
+
*
|
|
4499
|
+
* @public
|
|
4397
4500
|
*/
|
|
4398
4501
|
restoreFadeIn(): void;
|
|
4399
4502
|
}
|
|
@@ -4410,6 +4513,8 @@ declare class FastReset extends Feature {
|
|
|
4410
4513
|
* You can disable the fast-reset feature with the `disableFastReset` function.
|
|
4411
4514
|
*
|
|
4412
4515
|
* In order to use this function, you must upgrade your mod with `ISCFeature.FAST_RESET`.
|
|
4516
|
+
*
|
|
4517
|
+
* @public
|
|
4413
4518
|
*/
|
|
4414
4519
|
enableFastReset(): void;
|
|
4415
4520
|
/**
|
|
@@ -4417,6 +4522,8 @@ declare class FastReset extends Feature {
|
|
|
4417
4522
|
* `enableFastReset` function.
|
|
4418
4523
|
*
|
|
4419
4524
|
* In order to use this function, you must upgrade your mod with `ISCFeature.FAST_RESET`.
|
|
4525
|
+
*
|
|
4526
|
+
* @public
|
|
4420
4527
|
*/
|
|
4421
4528
|
disableFastReset(): void;
|
|
4422
4529
|
}
|
|
@@ -4577,6 +4684,8 @@ declare class FlyingDetection extends Feature {
|
|
|
4577
4684
|
* Hanged Man, Bat Wing, and so on.
|
|
4578
4685
|
*
|
|
4579
4686
|
* In order to use this function, you must upgrade your mod with `ISCFeature.FLYING_DETECTION`.
|
|
4687
|
+
*
|
|
4688
|
+
* @public
|
|
4580
4689
|
*/
|
|
4581
4690
|
hasFlyingTemporaryEffect(player: EntityPlayer): boolean;
|
|
4582
4691
|
}
|
|
@@ -4611,6 +4720,8 @@ declare class ForgottenSwitch extends Feature {
|
|
|
4611
4720
|
* Forgotten. This takes 1 game frame to take effect.
|
|
4612
4721
|
*
|
|
4613
4722
|
* In order to use this function, you must upgrade your mod with `ISCFeature.FORGOTTEN_SWITCH`.
|
|
4723
|
+
*
|
|
4724
|
+
* @public
|
|
4614
4725
|
*/
|
|
4615
4726
|
forgottenSwitch(player: EntityPlayer): void;
|
|
4616
4727
|
}
|
|
@@ -4682,6 +4793,8 @@ declare class GameReorderedCallbacks extends Feature {
|
|
|
4682
4793
|
*
|
|
4683
4794
|
* In order to use this function, you must upgrade your mod with
|
|
4684
4795
|
* `ISCFeature.GAME_REORDERED_CALLBACKS`.
|
|
4796
|
+
*
|
|
4797
|
+
* @public
|
|
4685
4798
|
*/
|
|
4686
4799
|
forceNewLevelCallback(): void;
|
|
4687
4800
|
/**
|
|
@@ -4696,6 +4809,8 @@ declare class GameReorderedCallbacks extends Feature {
|
|
|
4696
4809
|
*
|
|
4697
4810
|
* In order to use this function, you must upgrade your mod with
|
|
4698
4811
|
* `ISCFeature.GAME_REORDERED_CALLBACKS`.
|
|
4812
|
+
*
|
|
4813
|
+
* @public
|
|
4699
4814
|
*/
|
|
4700
4815
|
forceNewRoomCallback(): void;
|
|
4701
4816
|
/**
|
|
@@ -4707,6 +4822,8 @@ declare class GameReorderedCallbacks extends Feature {
|
|
|
4707
4822
|
*
|
|
4708
4823
|
* In order to use this function, you must upgrade your mod with
|
|
4709
4824
|
* `ISCFeature.GAME_REORDERED_CALLBACKS`.
|
|
4825
|
+
*
|
|
4826
|
+
* @public
|
|
4710
4827
|
*/
|
|
4711
4828
|
reorderedCallbacksSetStage(stage: LevelStage, stageType: StageType): void;
|
|
4712
4829
|
}
|
|
@@ -4831,7 +4948,7 @@ export declare function getAllGridIndexes(): int[];
|
|
|
4831
4948
|
* Helper function to get an array with every non-null pill color. This includes all gold colors and
|
|
4832
4949
|
* all horse colors.
|
|
4833
4950
|
*/
|
|
4834
|
-
export declare function getAllPillColors(): PillColor[];
|
|
4951
|
+
export declare function getAllPillColors(): readonly PillColor[];
|
|
4835
4952
|
|
|
4836
4953
|
/**
|
|
4837
4954
|
* Helper function to get every player with no restrictions, by using `Game.GetNumPlayers` and
|
|
@@ -5966,7 +6083,7 @@ export declare function getHighestEnumValue<T extends TranspiledEnum>(transpiled
|
|
|
5966
6083
|
export declare function getHorsePillColor(pillColor: PillColor): PillColor;
|
|
5967
6084
|
|
|
5968
6085
|
/** Helper function to get an array with every non-gold horse pill color. */
|
|
5969
|
-
export declare function getHorsePillColors(): PillColor[];
|
|
6086
|
+
export declare function getHorsePillColors(): readonly PillColor[];
|
|
5970
6087
|
|
|
5971
6088
|
/**
|
|
5972
6089
|
* In the options menu, players have the ability to set a HUD offset (which gets written to the
|
|
@@ -6335,7 +6452,7 @@ export declare function getNextStageType(upwards?: boolean): StageType;
|
|
|
6335
6452
|
export declare function getNormalPillColorFromHorse(pillColor: PillColor): PillColor;
|
|
6336
6453
|
|
|
6337
6454
|
/** Helper function to get an array with every non-gold and non-horse pill color. */
|
|
6338
|
-
export declare function getNormalPillColors(): PillColor[];
|
|
6455
|
+
export declare function getNormalPillColors(): readonly PillColor[];
|
|
6339
6456
|
|
|
6340
6457
|
/**
|
|
6341
6458
|
* Helper function to get the corresponding normal trinket type from a golden trinket type.
|
|
@@ -6777,7 +6894,7 @@ export declare function getPlayerTransformations(player: EntityPlayer): Set<Play
|
|
|
6777
6894
|
* Helper function to get all of the trinkets that the player is currently holding. This will not
|
|
6778
6895
|
* include any smelted trinkets.
|
|
6779
6896
|
*/
|
|
6780
|
-
export declare function getPlayerTrinkets(player: EntityPlayer): TrinketType[];
|
|
6897
|
+
export declare function getPlayerTrinkets(player: EntityPlayer): readonly TrinketType[];
|
|
6781
6898
|
|
|
6782
6899
|
/**
|
|
6783
6900
|
* Use this helper function as a workaround for the `EntityPlayer.GetPocketItem` method not working
|
|
@@ -8027,12 +8144,12 @@ export declare function getUnusedDoorSlots(): DoorSlot[];
|
|
|
8027
8144
|
export declare function getUsableActiveItemSlots(player: EntityPlayer, collectibleType: CollectibleType): ActiveSlot[];
|
|
8028
8145
|
|
|
8029
8146
|
/**
|
|
8030
|
-
* Returns
|
|
8147
|
+
* Returns an array containing every vanilla collectible type with the given quality.
|
|
8031
8148
|
*
|
|
8032
8149
|
* Note that this function will only return vanilla collectible types. To handle modded collectible
|
|
8033
8150
|
* types, use the `getCollectibleTypesOfQuality` helper function instead.
|
|
8034
8151
|
*/
|
|
8035
|
-
export declare function getVanillaCollectibleTypesOfQuality(quality: Quality):
|
|
8152
|
+
export declare function getVanillaCollectibleTypesOfQuality(quality: Quality): readonly CollectibleType[];
|
|
8036
8153
|
|
|
8037
8154
|
export declare function getVanillaPillEffectsOfType(pillEffectType: ItemConfigPillEffectType): readonly PillEffect[];
|
|
8038
8155
|
|
|
@@ -10189,8 +10306,10 @@ declare class ItemPoolDetection extends Feature {
|
|
|
10189
10306
|
* expensive, so only use it in situations where the lag is acceptable.
|
|
10190
10307
|
*
|
|
10191
10308
|
* In order to use this function, you must upgrade your mod with `ISCFeature.ITEM_POOL_DETECTION`.
|
|
10309
|
+
*
|
|
10310
|
+
* @public
|
|
10192
10311
|
*/
|
|
10193
|
-
getCollectiblesInItemPool(itemPoolType: ItemPoolType): CollectibleType[];
|
|
10312
|
+
getCollectiblesInItemPool(itemPoolType: ItemPoolType): readonly CollectibleType[];
|
|
10194
10313
|
/**
|
|
10195
10314
|
* Helper function to see if the given collectible is still present in the given item pool.
|
|
10196
10315
|
*
|
|
@@ -10202,6 +10321,8 @@ declare class ItemPoolDetection extends Feature {
|
|
|
10202
10321
|
* blacklist every collectible except for the one provided.
|
|
10203
10322
|
*
|
|
10204
10323
|
* In order to use this function, you must upgrade your mod with `ISCFeature.ITEM_POOL_DETECTION`.
|
|
10324
|
+
*
|
|
10325
|
+
* @public
|
|
10205
10326
|
*/
|
|
10206
10327
|
isCollectibleInItemPool(collectibleType: CollectibleType, itemPoolType: ItemPoolType): boolean;
|
|
10207
10328
|
/**
|
|
@@ -10219,6 +10340,8 @@ declare class ItemPoolDetection extends Feature {
|
|
|
10219
10340
|
* collectibles from item pools).
|
|
10220
10341
|
*
|
|
10221
10342
|
* In order to use this function, you must upgrade your mod with `ISCFeature.ITEM_POOL_DETECTION`.
|
|
10343
|
+
*
|
|
10344
|
+
* @public
|
|
10222
10345
|
*/
|
|
10223
10346
|
isCollectibleUnlocked(collectibleType: CollectibleType, itemPoolType: ItemPoolType): boolean;
|
|
10224
10347
|
}
|
|
@@ -13470,6 +13593,8 @@ declare class ModdedElementDetection extends Feature {
|
|
|
13470
13593
|
*
|
|
13471
13594
|
* In order to use this function, you must upgrade your mod with
|
|
13472
13595
|
* `ISCFeature.MODDED_ELEMENT_DETECTION`.
|
|
13596
|
+
*
|
|
13597
|
+
* @public
|
|
13473
13598
|
*/
|
|
13474
13599
|
getFirstModdedCollectibleType(): CollectibleType | undefined;
|
|
13475
13600
|
/**
|
|
@@ -13487,6 +13612,8 @@ declare class ModdedElementDetection extends Feature {
|
|
|
13487
13612
|
*
|
|
13488
13613
|
* In order to use this function, you must upgrade your mod with
|
|
13489
13614
|
* `ISCFeature.MODDED_ELEMENT_DETECTION`.
|
|
13615
|
+
*
|
|
13616
|
+
* @public
|
|
13490
13617
|
*/
|
|
13491
13618
|
getLastCollectibleType(): CollectibleType;
|
|
13492
13619
|
/**
|
|
@@ -13500,6 +13627,8 @@ declare class ModdedElementDetection extends Feature {
|
|
|
13500
13627
|
*
|
|
13501
13628
|
* In order to use this function, you must upgrade your mod with
|
|
13502
13629
|
* `ISCFeature.MODDED_ELEMENT_DETECTION`.
|
|
13630
|
+
*
|
|
13631
|
+
* @public
|
|
13503
13632
|
*/
|
|
13504
13633
|
getNumCollectibleTypes(): int;
|
|
13505
13634
|
/**
|
|
@@ -13511,6 +13640,8 @@ declare class ModdedElementDetection extends Feature {
|
|
|
13511
13640
|
*
|
|
13512
13641
|
* In order to use this function, you must upgrade your mod with
|
|
13513
13642
|
* `ISCFeature.MODDED_ELEMENT_DETECTION`.
|
|
13643
|
+
*
|
|
13644
|
+
* @public
|
|
13514
13645
|
*/
|
|
13515
13646
|
getNumModdedCollectibleTypes(): int;
|
|
13516
13647
|
/**
|
|
@@ -13521,6 +13652,8 @@ declare class ModdedElementDetection extends Feature {
|
|
|
13521
13652
|
*
|
|
13522
13653
|
* In order to use this function, you must upgrade your mod with
|
|
13523
13654
|
* `ISCFeature.MODDED_ELEMENT_DETECTION`.
|
|
13655
|
+
*
|
|
13656
|
+
* @public
|
|
13524
13657
|
*/
|
|
13525
13658
|
getFirstModdedTrinketType(): TrinketType | undefined;
|
|
13526
13659
|
/**
|
|
@@ -13537,6 +13670,8 @@ declare class ModdedElementDetection extends Feature {
|
|
|
13537
13670
|
*
|
|
13538
13671
|
* In order to use this function, you must upgrade your mod with
|
|
13539
13672
|
* `ISCFeature.MODDED_ELEMENT_DETECTION`.
|
|
13673
|
+
*
|
|
13674
|
+
* @public
|
|
13540
13675
|
*/
|
|
13541
13676
|
getLastTrinketType(): TrinketType;
|
|
13542
13677
|
/**
|
|
@@ -13549,6 +13684,8 @@ declare class ModdedElementDetection extends Feature {
|
|
|
13549
13684
|
*
|
|
13550
13685
|
* In order to use this function, you must upgrade your mod with
|
|
13551
13686
|
* `ISCFeature.MODDED_ELEMENT_DETECTION`.
|
|
13687
|
+
*
|
|
13688
|
+
* @public
|
|
13552
13689
|
*/
|
|
13553
13690
|
getNumTrinketTypes(): int;
|
|
13554
13691
|
/**
|
|
@@ -13559,6 +13696,8 @@ declare class ModdedElementDetection extends Feature {
|
|
|
13559
13696
|
*
|
|
13560
13697
|
* In order to use this function, you must upgrade your mod with
|
|
13561
13698
|
* `ISCFeature.MODDED_ELEMENT_DETECTION`.
|
|
13699
|
+
*
|
|
13700
|
+
* @public
|
|
13562
13701
|
*/
|
|
13563
13702
|
getNumModdedTrinketTypes(): int;
|
|
13564
13703
|
/**
|
|
@@ -13569,6 +13708,8 @@ declare class ModdedElementDetection extends Feature {
|
|
|
13569
13708
|
*
|
|
13570
13709
|
* In order to use this function, you must upgrade your mod with
|
|
13571
13710
|
* `ISCFeature.MODDED_ELEMENT_DETECTION`.
|
|
13711
|
+
*
|
|
13712
|
+
* @public
|
|
13572
13713
|
*/
|
|
13573
13714
|
getFirstModdedCardType(): CardType | undefined;
|
|
13574
13715
|
/**
|
|
@@ -13582,6 +13723,8 @@ declare class ModdedElementDetection extends Feature {
|
|
|
13582
13723
|
*
|
|
13583
13724
|
* In order to use this function, you must upgrade your mod with
|
|
13584
13725
|
* `ISCFeature.MODDED_ELEMENT_DETECTION`.
|
|
13726
|
+
*
|
|
13727
|
+
* @public
|
|
13585
13728
|
*/
|
|
13586
13729
|
getLastCardType(): CardType;
|
|
13587
13730
|
/**
|
|
@@ -13594,6 +13737,8 @@ declare class ModdedElementDetection extends Feature {
|
|
|
13594
13737
|
*
|
|
13595
13738
|
* In order to use this function, you must upgrade your mod with
|
|
13596
13739
|
* `ISCFeature.MODDED_ELEMENT_DETECTION`.
|
|
13740
|
+
*
|
|
13741
|
+
* @public
|
|
13597
13742
|
*/
|
|
13598
13743
|
getNumCardTypes(): int;
|
|
13599
13744
|
/**
|
|
@@ -13602,6 +13747,8 @@ declare class ModdedElementDetection extends Feature {
|
|
|
13602
13747
|
*
|
|
13603
13748
|
* In order to use this function, you must upgrade your mod with
|
|
13604
13749
|
* `ISCFeature.MODDED_ELEMENT_DETECTION`.
|
|
13750
|
+
*
|
|
13751
|
+
* @public
|
|
13605
13752
|
*/
|
|
13606
13753
|
getNumModdedCardTypes(): int;
|
|
13607
13754
|
/**
|
|
@@ -13613,6 +13760,8 @@ declare class ModdedElementDetection extends Feature {
|
|
|
13613
13760
|
*
|
|
13614
13761
|
* In order to use this function, you must upgrade your mod with
|
|
13615
13762
|
* `ISCFeature.MODDED_ELEMENT_DETECTION`.
|
|
13763
|
+
*
|
|
13764
|
+
* @public
|
|
13616
13765
|
*/
|
|
13617
13766
|
getFirstModdedPillEffect(): PillEffect | undefined;
|
|
13618
13767
|
/**
|
|
@@ -13627,6 +13776,8 @@ declare class ModdedElementDetection extends Feature {
|
|
|
13627
13776
|
*
|
|
13628
13777
|
* In order to use this function, you must upgrade your mod with
|
|
13629
13778
|
* `ISCFeature.MODDED_ELEMENT_DETECTION`.
|
|
13779
|
+
*
|
|
13780
|
+
* @public
|
|
13630
13781
|
*/
|
|
13631
13782
|
getLastPillEffect(): PillEffect;
|
|
13632
13783
|
/**
|
|
@@ -13641,6 +13792,8 @@ declare class ModdedElementDetection extends Feature {
|
|
|
13641
13792
|
*
|
|
13642
13793
|
* In order to use this function, you must upgrade your mod with
|
|
13643
13794
|
* `ISCFeature.MODDED_ELEMENT_DETECTION`.
|
|
13795
|
+
*
|
|
13796
|
+
* @public
|
|
13644
13797
|
*/
|
|
13645
13798
|
getNumPillEffects(): int;
|
|
13646
13799
|
/**
|
|
@@ -13650,6 +13803,8 @@ declare class ModdedElementDetection extends Feature {
|
|
|
13650
13803
|
*
|
|
13651
13804
|
* In order to use this function, you must upgrade your mod with
|
|
13652
13805
|
* `ISCFeature.MODDED_ELEMENT_DETECTION`.
|
|
13806
|
+
*
|
|
13807
|
+
* @public
|
|
13653
13808
|
*/
|
|
13654
13809
|
getNumModdedPillEffects(): int;
|
|
13655
13810
|
}
|
|
@@ -13682,21 +13837,21 @@ declare class ModdedElementSets extends Feature {
|
|
|
13682
13837
|
private readonly moddedPillEffectsSet;
|
|
13683
13838
|
private readonly cacheFlagToCollectibleTypesMap;
|
|
13684
13839
|
private readonly cacheFlagToTrinketTypesMap;
|
|
13685
|
-
private
|
|
13686
|
-
private
|
|
13687
|
-
private
|
|
13840
|
+
private flyingCollectibleTypes;
|
|
13841
|
+
private permanentFlyingCollectibleTypes;
|
|
13842
|
+
private flyingTrinketTypes;
|
|
13688
13843
|
private readonly tagToCollectibleTypesMap;
|
|
13689
13844
|
private readonly edenActiveCollectibleTypesSet;
|
|
13690
13845
|
private readonly edenPassiveCollectibleTypesSet;
|
|
13691
13846
|
private readonly qualityToCollectibleTypesMap;
|
|
13692
13847
|
private readonly itemConfigCardTypeToCardTypeMap;
|
|
13693
13848
|
/**
|
|
13694
|
-
* The
|
|
13849
|
+
* The array of card types that are not:
|
|
13695
13850
|
*
|
|
13696
13851
|
* - ItemConfigCardType.RUNE
|
|
13697
13852
|
* - ItemConfigCardType.SPECIAL_OBJECT
|
|
13698
13853
|
*/
|
|
13699
|
-
private readonly
|
|
13854
|
+
private readonly cardTypeCardArray;
|
|
13700
13855
|
private readonly moddedElementDetection;
|
|
13701
13856
|
private lazyInit;
|
|
13702
13857
|
private lazyInitModdedCollectibleTypes;
|
|
@@ -13723,6 +13878,8 @@ declare class ModdedElementSets extends Feature {
|
|
|
13723
13878
|
* order).
|
|
13724
13879
|
*
|
|
13725
13880
|
* In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
|
|
13881
|
+
*
|
|
13882
|
+
* @public
|
|
13726
13883
|
*/
|
|
13727
13884
|
getCollectibleTypes(): readonly CollectibleType[];
|
|
13728
13885
|
/**
|
|
@@ -13737,6 +13894,8 @@ declare class ModdedElementSets extends Feature {
|
|
|
13737
13894
|
* order).
|
|
13738
13895
|
*
|
|
13739
13896
|
* In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
|
|
13897
|
+
*
|
|
13898
|
+
* @public
|
|
13740
13899
|
*/
|
|
13741
13900
|
getCollectibleTypeSet(): ReadonlySet<CollectibleType>;
|
|
13742
13901
|
/**
|
|
@@ -13750,6 +13909,8 @@ declare class ModdedElementSets extends Feature {
|
|
|
13750
13909
|
* order).
|
|
13751
13910
|
*
|
|
13752
13911
|
* In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
|
|
13912
|
+
*
|
|
13913
|
+
* @public
|
|
13753
13914
|
*/
|
|
13754
13915
|
getModdedCollectibleTypes(): readonly CollectibleType[];
|
|
13755
13916
|
/**
|
|
@@ -13763,6 +13924,8 @@ declare class ModdedElementSets extends Feature {
|
|
|
13763
13924
|
* order).
|
|
13764
13925
|
*
|
|
13765
13926
|
* In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
|
|
13927
|
+
*
|
|
13928
|
+
* @public
|
|
13766
13929
|
*/
|
|
13767
13930
|
getModdedCollectibleTypesSet(): ReadonlySet<CollectibleType>;
|
|
13768
13931
|
/**
|
|
@@ -13776,6 +13939,8 @@ declare class ModdedElementSets extends Feature {
|
|
|
13776
13939
|
* order).
|
|
13777
13940
|
*
|
|
13778
13941
|
* In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
|
|
13942
|
+
*
|
|
13943
|
+
* @public
|
|
13779
13944
|
*/
|
|
13780
13945
|
getPlayerCollectibleMap(player: EntityPlayer): Map<CollectibleType, int>;
|
|
13781
13946
|
/**
|
|
@@ -13789,6 +13954,8 @@ declare class ModdedElementSets extends Feature {
|
|
|
13789
13954
|
* order).
|
|
13790
13955
|
*
|
|
13791
13956
|
* In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
|
|
13957
|
+
*
|
|
13958
|
+
* @public
|
|
13792
13959
|
*/
|
|
13793
13960
|
getTrinketTypes(): readonly TrinketType[];
|
|
13794
13961
|
/**
|
|
@@ -13802,6 +13969,8 @@ declare class ModdedElementSets extends Feature {
|
|
|
13802
13969
|
* order).
|
|
13803
13970
|
*
|
|
13804
13971
|
* In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
|
|
13972
|
+
*
|
|
13973
|
+
* @public
|
|
13805
13974
|
*/
|
|
13806
13975
|
getTrinketTypesSet(): ReadonlySet<TrinketType>;
|
|
13807
13976
|
/**
|
|
@@ -13815,6 +13984,8 @@ declare class ModdedElementSets extends Feature {
|
|
|
13815
13984
|
* order).
|
|
13816
13985
|
*
|
|
13817
13986
|
* In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
|
|
13987
|
+
*
|
|
13988
|
+
* @public
|
|
13818
13989
|
*/
|
|
13819
13990
|
getModdedTrinketTypes(): readonly TrinketType[];
|
|
13820
13991
|
/**
|
|
@@ -13828,6 +13999,8 @@ declare class ModdedElementSets extends Feature {
|
|
|
13828
13999
|
* order).
|
|
13829
14000
|
*
|
|
13830
14001
|
* In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
|
|
14002
|
+
*
|
|
14003
|
+
* @public
|
|
13831
14004
|
*/
|
|
13832
14005
|
getModdedTrinketTypesSet(): ReadonlySet<TrinketType>;
|
|
13833
14006
|
/**
|
|
@@ -13840,6 +14013,8 @@ declare class ModdedElementSets extends Feature {
|
|
|
13840
14013
|
* not all card types will necessarily be present when a mod first loads (due to mod load order).
|
|
13841
14014
|
*
|
|
13842
14015
|
* In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
|
|
14016
|
+
*
|
|
14017
|
+
* @public
|
|
13843
14018
|
*/
|
|
13844
14019
|
getCardTypes(): readonly CardType[];
|
|
13845
14020
|
/**
|
|
@@ -13852,6 +14027,8 @@ declare class ModdedElementSets extends Feature {
|
|
|
13852
14027
|
* not all card types will necessarily be present when a mod first loads (due to mod load order).
|
|
13853
14028
|
*
|
|
13854
14029
|
* In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
|
|
14030
|
+
*
|
|
14031
|
+
* @public
|
|
13855
14032
|
*/
|
|
13856
14033
|
getCardTypesSet(): ReadonlySet<CardType>;
|
|
13857
14034
|
/**
|
|
@@ -13864,6 +14041,8 @@ declare class ModdedElementSets extends Feature {
|
|
|
13864
14041
|
* not all card types will necessarily be present when a mod first loads (due to mod load order).
|
|
13865
14042
|
*
|
|
13866
14043
|
* In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
|
|
14044
|
+
*
|
|
14045
|
+
* @public
|
|
13867
14046
|
*/
|
|
13868
14047
|
getModdedCardTypes(): readonly CardType[];
|
|
13869
14048
|
/**
|
|
@@ -13876,6 +14055,8 @@ declare class ModdedElementSets extends Feature {
|
|
|
13876
14055
|
* not all card types will necessarily be present when a mod first loads (due to mod load order).
|
|
13877
14056
|
*
|
|
13878
14057
|
* In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
|
|
14058
|
+
*
|
|
14059
|
+
* @public
|
|
13879
14060
|
*/
|
|
13880
14061
|
getModdedCardTypesSet(): ReadonlySet<CardType>;
|
|
13881
14062
|
/**
|
|
@@ -13889,6 +14070,8 @@ declare class ModdedElementSets extends Feature {
|
|
|
13889
14070
|
* order).
|
|
13890
14071
|
*
|
|
13891
14072
|
* In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
|
|
14073
|
+
*
|
|
14074
|
+
* @public
|
|
13892
14075
|
*/
|
|
13893
14076
|
getPillEffects(): readonly PillEffect[];
|
|
13894
14077
|
/**
|
|
@@ -13902,6 +14085,8 @@ declare class ModdedElementSets extends Feature {
|
|
|
13902
14085
|
* order).
|
|
13903
14086
|
*
|
|
13904
14087
|
* In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
|
|
14088
|
+
*
|
|
14089
|
+
* @public
|
|
13905
14090
|
*/
|
|
13906
14091
|
getPillEffectsSet(): ReadonlySet<PillEffect>;
|
|
13907
14092
|
/**
|
|
@@ -13915,6 +14100,8 @@ declare class ModdedElementSets extends Feature {
|
|
|
13915
14100
|
* order).
|
|
13916
14101
|
*
|
|
13917
14102
|
* In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
|
|
14103
|
+
*
|
|
14104
|
+
* @public
|
|
13918
14105
|
*/
|
|
13919
14106
|
getModdedPillEffects(): readonly PillEffect[];
|
|
13920
14107
|
/**
|
|
@@ -13928,6 +14115,8 @@ declare class ModdedElementSets extends Feature {
|
|
|
13928
14115
|
* order).
|
|
13929
14116
|
*
|
|
13930
14117
|
* In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
|
|
14118
|
+
*
|
|
14119
|
+
* @public
|
|
13931
14120
|
*/
|
|
13932
14121
|
getModdedPillEffectsSet(): ReadonlySet<PillEffect>;
|
|
13933
14122
|
/**
|
|
@@ -13939,8 +14128,10 @@ declare class ModdedElementSets extends Feature {
|
|
|
13939
14128
|
* order).
|
|
13940
14129
|
*
|
|
13941
14130
|
* In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
|
|
14131
|
+
*
|
|
14132
|
+
* @public
|
|
13942
14133
|
*/
|
|
13943
|
-
getCollectibleTypesWithCacheFlag(cacheFlag: CacheFlag):
|
|
14134
|
+
getCollectibleTypesWithCacheFlag(cacheFlag: CacheFlag): readonly CollectibleType[];
|
|
13944
14135
|
/**
|
|
13945
14136
|
* Returns a set containing every trinket type with the given cache flag, including modded
|
|
13946
14137
|
* trinkets.
|
|
@@ -13950,8 +14141,10 @@ declare class ModdedElementSets extends Feature {
|
|
|
13950
14141
|
* order).
|
|
13951
14142
|
*
|
|
13952
14143
|
* In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
|
|
14144
|
+
*
|
|
14145
|
+
* @public
|
|
13953
14146
|
*/
|
|
13954
|
-
getTrinketsTypesWithCacheFlag(cacheFlag: CacheFlag):
|
|
14147
|
+
getTrinketsTypesWithCacheFlag(cacheFlag: CacheFlag): readonly TrinketType[];
|
|
13955
14148
|
/**
|
|
13956
14149
|
* Returns an array containing every collectible type that the player has that matches the
|
|
13957
14150
|
* provided `CacheFlag`.
|
|
@@ -13975,8 +14168,10 @@ declare class ModdedElementSets extends Feature {
|
|
|
13975
14168
|
* order).
|
|
13976
14169
|
*
|
|
13977
14170
|
* In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
|
|
14171
|
+
*
|
|
14172
|
+
* @public
|
|
13978
14173
|
*/
|
|
13979
|
-
getPlayerCollectiblesWithCacheFlag(player: EntityPlayer, cacheFlag: CacheFlag): CollectibleType[];
|
|
14174
|
+
getPlayerCollectiblesWithCacheFlag(player: EntityPlayer, cacheFlag: CacheFlag): readonly CollectibleType[];
|
|
13980
14175
|
/**
|
|
13981
14176
|
* Returns a map containing every trinket type that the player has that matches the provided
|
|
13982
14177
|
* `CacheFlag`. The values of the map correspond to the multiplier for that trinket.
|
|
@@ -13986,6 +14181,8 @@ declare class ModdedElementSets extends Feature {
|
|
|
13986
14181
|
* order).
|
|
13987
14182
|
*
|
|
13988
14183
|
* In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
|
|
14184
|
+
*
|
|
14185
|
+
* @public
|
|
13989
14186
|
*/
|
|
13990
14187
|
getPlayerTrinketsWithCacheFlag(player: EntityPlayer, cacheFlag: CacheFlag): Map<TrinketType, int>;
|
|
13991
14188
|
/**
|
|
@@ -14008,8 +14205,9 @@ declare class ModdedElementSets extends Feature {
|
|
|
14008
14205
|
*
|
|
14009
14206
|
* @param includeConditionalItems Whether collectibles that only grant flight conditionally should
|
|
14010
14207
|
* be included in the set (like Empty Vessel).
|
|
14208
|
+
* @public
|
|
14011
14209
|
*/
|
|
14012
|
-
getFlyingCollectibleTypes(includeConditionalItems: boolean):
|
|
14210
|
+
getFlyingCollectibleTypes(includeConditionalItems: boolean): readonly CollectibleType[];
|
|
14013
14211
|
/**
|
|
14014
14212
|
* Returns a set of all of the trinkets that grant flight. (All vanilla trinkets that grant flight
|
|
14015
14213
|
* do so conditionally, like Bat Wing and Azazel's Stump.)
|
|
@@ -14023,8 +14221,10 @@ declare class ModdedElementSets extends Feature {
|
|
|
14023
14221
|
* order).
|
|
14024
14222
|
*
|
|
14025
14223
|
* In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
|
|
14224
|
+
*
|
|
14225
|
+
* @public
|
|
14026
14226
|
*/
|
|
14027
|
-
getFlyingTrinketTypes():
|
|
14227
|
+
getFlyingTrinketTypes(): readonly TrinketType[];
|
|
14028
14228
|
/**
|
|
14029
14229
|
* Returns a set containing every collectible type with the given tag.
|
|
14030
14230
|
*
|
|
@@ -14040,8 +14240,10 @@ declare class ModdedElementSets extends Feature {
|
|
|
14040
14240
|
* order).
|
|
14041
14241
|
*
|
|
14042
14242
|
* In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
|
|
14243
|
+
*
|
|
14244
|
+
* @public
|
|
14043
14245
|
*/
|
|
14044
|
-
getCollectibleTypesWithTag(itemConfigTag: ItemConfigTag):
|
|
14246
|
+
getCollectibleTypesWithTag(itemConfigTag: ItemConfigTag): readonly CollectibleType[];
|
|
14045
14247
|
/**
|
|
14046
14248
|
* Returns an array of collectible types that a player has with a particular tag.
|
|
14047
14249
|
*
|
|
@@ -14050,8 +14252,10 @@ declare class ModdedElementSets extends Feature {
|
|
|
14050
14252
|
* order).
|
|
14051
14253
|
*
|
|
14052
14254
|
* In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
|
|
14255
|
+
*
|
|
14256
|
+
* @public
|
|
14053
14257
|
*/
|
|
14054
|
-
getPlayerCollectiblesWithTag(player: EntityPlayer, itemConfigTag: ItemConfigTag): CollectibleType[];
|
|
14258
|
+
getPlayerCollectiblesWithTag(player: EntityPlayer, itemConfigTag: ItemConfigTag): readonly CollectibleType[];
|
|
14055
14259
|
/**
|
|
14056
14260
|
* Helper function to get all of the collectible types in the game that count towards a particular
|
|
14057
14261
|
* transformation.
|
|
@@ -14067,8 +14271,10 @@ declare class ModdedElementSets extends Feature {
|
|
|
14067
14271
|
* order).
|
|
14068
14272
|
*
|
|
14069
14273
|
* In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
|
|
14274
|
+
*
|
|
14275
|
+
* @public
|
|
14070
14276
|
*/
|
|
14071
|
-
getCollectibleTypesForTransformation(playerForm: PlayerForm):
|
|
14277
|
+
getCollectibleTypesForTransformation(playerForm: PlayerForm): readonly CollectibleType[];
|
|
14072
14278
|
/**
|
|
14073
14279
|
* Returns an array of collectible types that a player has that count towards a particular
|
|
14074
14280
|
* transformation.
|
|
@@ -14078,8 +14284,10 @@ declare class ModdedElementSets extends Feature {
|
|
|
14078
14284
|
* order).
|
|
14079
14285
|
*
|
|
14080
14286
|
* In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
|
|
14287
|
+
*
|
|
14288
|
+
* @public
|
|
14081
14289
|
*/
|
|
14082
|
-
getPlayerCollectiblesForTransformation(player: EntityPlayer, playerForm: PlayerForm): CollectibleType[];
|
|
14290
|
+
getPlayerCollectiblesForTransformation(player: EntityPlayer, playerForm: PlayerForm): readonly CollectibleType[];
|
|
14083
14291
|
/**
|
|
14084
14292
|
* Returns a set containing every valid passive item that can be randomly granted to Eden as a
|
|
14085
14293
|
* starting item.
|
|
@@ -14091,6 +14299,8 @@ declare class ModdedElementSets extends Feature {
|
|
|
14091
14299
|
* order).
|
|
14092
14300
|
*
|
|
14093
14301
|
* In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
|
|
14302
|
+
*
|
|
14303
|
+
* @public
|
|
14094
14304
|
*/
|
|
14095
14305
|
getEdenActiveCollectibleTypes(): ReadonlySet<CollectibleType>;
|
|
14096
14306
|
/**
|
|
@@ -14104,6 +14314,8 @@ declare class ModdedElementSets extends Feature {
|
|
|
14104
14314
|
* order).
|
|
14105
14315
|
*
|
|
14106
14316
|
* In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
|
|
14317
|
+
*
|
|
14318
|
+
* @public
|
|
14107
14319
|
*/
|
|
14108
14320
|
getEdenPassiveCollectibleTypes(): ReadonlySet<CollectibleType>;
|
|
14109
14321
|
/**
|
|
@@ -14122,6 +14334,7 @@ declare class ModdedElementSets extends Feature {
|
|
|
14122
14334
|
* `RNG.Next` method will be called. If `undefined` is provided, it will default
|
|
14123
14335
|
* to a random seed.
|
|
14124
14336
|
* @param exceptions Optional. An array of runes to not select.
|
|
14337
|
+
* @public
|
|
14125
14338
|
*/
|
|
14126
14339
|
getRandomEdenActiveCollectibleType(seedOrRNG: Seed | RNG | undefined, exceptions?: CollectibleType[] | readonly CollectibleType[]): CollectibleType;
|
|
14127
14340
|
/**
|
|
@@ -14141,18 +14354,21 @@ declare class ModdedElementSets extends Feature {
|
|
|
14141
14354
|
* `RNG.Next` method will be called. If `undefined` is provided, it will default
|
|
14142
14355
|
* to a random seed.
|
|
14143
14356
|
* @param exceptions Optional. An array of runes to not select.
|
|
14357
|
+
* @public
|
|
14144
14358
|
*/
|
|
14145
14359
|
getRandomEdenPassiveCollectibleType(seedOrRNG: Seed | RNG | undefined, exceptions?: CollectibleType[] | readonly CollectibleType[]): CollectibleType;
|
|
14146
14360
|
/**
|
|
14147
|
-
* Returns
|
|
14361
|
+
* Returns an array containing every collectible type with the given quality.
|
|
14148
14362
|
*
|
|
14149
14363
|
* This function can only be called if at least one callback has been executed. This is because
|
|
14150
14364
|
* not all collectible types will necessarily be present when a mod first loads (due to mod load
|
|
14151
14365
|
* order).
|
|
14152
14366
|
*
|
|
14153
14367
|
* In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
|
|
14368
|
+
*
|
|
14369
|
+
* @public
|
|
14154
14370
|
*/
|
|
14155
|
-
getCollectibleTypesOfQuality(quality: Quality):
|
|
14371
|
+
getCollectibleTypesOfQuality(quality: Quality): readonly CollectibleType[];
|
|
14156
14372
|
/**
|
|
14157
14373
|
* Returns an array of collectible types that a player has that are of a particular quality.
|
|
14158
14374
|
*
|
|
@@ -14161,20 +14377,24 @@ declare class ModdedElementSets extends Feature {
|
|
|
14161
14377
|
* order).
|
|
14162
14378
|
*
|
|
14163
14379
|
* In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
|
|
14380
|
+
*
|
|
14381
|
+
* @public
|
|
14164
14382
|
*/
|
|
14165
|
-
getPlayerCollectiblesOfQuality(player: EntityPlayer, quality: Quality): CollectibleType[];
|
|
14383
|
+
getPlayerCollectiblesOfQuality(player: EntityPlayer, quality: Quality): readonly CollectibleType[];
|
|
14166
14384
|
/**
|
|
14167
|
-
* Helper function to get
|
|
14385
|
+
* Helper function to get an array of card types matching the `ItemConfigCardType`.
|
|
14168
14386
|
*
|
|
14169
|
-
* This function is variadic, meaning that you can you can specify N card types to get
|
|
14387
|
+
* This function is variadic, meaning that you can you can specify N card types to get an array
|
|
14170
14388
|
* containing cards that match any of the specified types.
|
|
14171
14389
|
*
|
|
14172
14390
|
* This function can only be called if at least one callback has been executed. This is because
|
|
14173
14391
|
* not all card types will necessarily be present when a mod first loads (due to mod load order).
|
|
14174
14392
|
*
|
|
14175
14393
|
* In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
|
|
14394
|
+
*
|
|
14395
|
+
* @public
|
|
14176
14396
|
*/
|
|
14177
|
-
getCardTypesOfType(...itemConfigCardTypes: ItemConfigCardType[]):
|
|
14397
|
+
getCardTypesOfType(...itemConfigCardTypes: ItemConfigCardType[]): readonly CardType[];
|
|
14178
14398
|
/**
|
|
14179
14399
|
* Helper function to get a random card type that matches the provided `ItemConfigCardType`.
|
|
14180
14400
|
*
|
|
@@ -14192,6 +14412,7 @@ declare class ModdedElementSets extends Feature {
|
|
|
14192
14412
|
* `RNG.Next` method will be called. If `undefined` is provided, it will default
|
|
14193
14413
|
* to a random seed.
|
|
14194
14414
|
* @param exceptions Optional. An array of cards to not select.
|
|
14415
|
+
* @public
|
|
14195
14416
|
*/
|
|
14196
14417
|
getRandomCardTypeOfType(itemConfigCardType: ItemConfigCardType, seedOrRNG: Seed | RNG | undefined, exceptions?: CardType[]): CardType;
|
|
14197
14418
|
/**
|
|
@@ -14213,6 +14434,7 @@ declare class ModdedElementSets extends Feature {
|
|
|
14213
14434
|
* `RNG.Next` method will be called. If `undefined` is provided, it will default
|
|
14214
14435
|
* to a random seed.
|
|
14215
14436
|
* @param exceptions Optional. An array of cards to not select.
|
|
14437
|
+
* @public
|
|
14216
14438
|
*/
|
|
14217
14439
|
getRandomCard(seedOrRNG: Seed | RNG | undefined, exceptions?: CardType[]): CardType;
|
|
14218
14440
|
/**
|
|
@@ -14231,6 +14453,7 @@ declare class ModdedElementSets extends Feature {
|
|
|
14231
14453
|
* `RNG.Next` method will be called. If `undefined` is provided, it will default
|
|
14232
14454
|
* to a random seed.
|
|
14233
14455
|
* @param exceptions Optional. An array of runes to not select.
|
|
14456
|
+
* @public
|
|
14234
14457
|
*/
|
|
14235
14458
|
getRandomRune(seedOrRNG: Seed | RNG | undefined, exceptions?: CardType[]): CardType;
|
|
14236
14459
|
}
|
|
@@ -14609,6 +14832,7 @@ declare class NoSirenSteal extends Feature {
|
|
|
14609
14832
|
* @param familiarVariant The familiar variant to blacklist.
|
|
14610
14833
|
* @param familiarSubType The sub-type to blacklist. Optional. The default is to blacklist all
|
|
14611
14834
|
* sub-types of the given variant.
|
|
14835
|
+
* @public
|
|
14612
14836
|
*/
|
|
14613
14837
|
setFamiliarNoSirenSteal(familiarVariant: FamiliarVariant, familiarSubType?: int): void;
|
|
14614
14838
|
}
|
|
@@ -14902,6 +15126,12 @@ declare class Pause extends Feature {
|
|
|
14902
15126
|
private readonly postUpdate;
|
|
14903
15127
|
private stopTearsAndProjectilesFromMoving;
|
|
14904
15128
|
private readonly inputActionGetActionValue;
|
|
15129
|
+
/**
|
|
15130
|
+
* Helper function to check if the pause feature from `isaacscript-common` is currently
|
|
15131
|
+
* pseudo-pausing the game.
|
|
15132
|
+
*
|
|
15133
|
+
* @public
|
|
15134
|
+
*/
|
|
14905
15135
|
isPaused(): boolean;
|
|
14906
15136
|
/**
|
|
14907
15137
|
* Helper function to emulate what happens when the player pauses the game. Use the `unpause`
|
|
@@ -14913,12 +15143,16 @@ declare class Pause extends Feature {
|
|
|
14913
15143
|
* `ButtonAction.CONSOLE`)
|
|
14914
15144
|
*
|
|
14915
15145
|
* In order to use this function, you must upgrade your mod with `ISCFeature.PAUSE`.
|
|
15146
|
+
*
|
|
15147
|
+
* @public
|
|
14916
15148
|
*/
|
|
14917
15149
|
pause(): void;
|
|
14918
15150
|
/**
|
|
14919
15151
|
* Helper function to put things back to normal after the `pause` function was used.
|
|
14920
15152
|
*
|
|
14921
15153
|
* In order to use this function, you must upgrade your mod with `ISCFeature.PAUSE`.
|
|
15154
|
+
*
|
|
15155
|
+
* @public
|
|
14922
15156
|
*/
|
|
14923
15157
|
unpause(): void;
|
|
14924
15158
|
}
|
|
@@ -14944,6 +15178,7 @@ declare class PersistentEntities extends Feature {
|
|
|
14944
15178
|
* @param removeEntity Optional. True by default. Set to false if you want to stop an entity from
|
|
14945
15179
|
* being persistent but you don't want to actually remove the
|
|
14946
15180
|
* currently-spawned entity from the room.
|
|
15181
|
+
* @public
|
|
14947
15182
|
*/
|
|
14948
15183
|
removePersistentEntity(persistentEntityIndex: int, removeEntity?: boolean): void;
|
|
14949
15184
|
/**
|
|
@@ -14963,6 +15198,7 @@ declare class PersistentEntities extends Feature {
|
|
|
14963
15198
|
*
|
|
14964
15199
|
* @returns An object containing the entity and the persistent entity index. You can use the index
|
|
14965
15200
|
* with the `removePersistentEntity` function.
|
|
15201
|
+
* @public
|
|
14966
15202
|
*/
|
|
14967
15203
|
spawnPersistentEntity(entityType: EntityType, variant: int, subType: int, position: Vector): {
|
|
14968
15204
|
entity: Entity;
|
|
@@ -15155,6 +15391,7 @@ declare class PlayerCollectibleTracking extends Feature {
|
|
|
15155
15391
|
* @param player The player to get the collectible types for.
|
|
15156
15392
|
* @param includeActiveCollectibles Optional. If true, will include all active collectibles.
|
|
15157
15393
|
* Default is true.
|
|
15394
|
+
* @public
|
|
15158
15395
|
*/
|
|
15159
15396
|
getPlayerCollectibleTypes(player: EntityPlayer, includeActiveCollectibles?: boolean): readonly CollectibleType[];
|
|
15160
15397
|
/**
|
|
@@ -15165,6 +15402,8 @@ declare class PlayerCollectibleTracking extends Feature {
|
|
|
15165
15402
|
*
|
|
15166
15403
|
* In order to use this function, you must upgrade your mod with
|
|
15167
15404
|
* `ISCFeature.PLAYER_COLLECTIBLE_TRACKING`.
|
|
15405
|
+
*
|
|
15406
|
+
* @public
|
|
15168
15407
|
*/
|
|
15169
15408
|
getPlayerLastPassiveCollectibleType(player: EntityPlayer): CollectibleType | undefined;
|
|
15170
15409
|
}
|
|
@@ -15320,6 +15559,8 @@ declare class PonyDetection extends Feature {
|
|
|
15320
15559
|
* Detecting this is difficult, as the temporary effect will disappear upon entering a new room.
|
|
15321
15560
|
*
|
|
15322
15561
|
* In order to use this function, you must upgrade your mod with `ISCFeature.PONY_DETECTION`.
|
|
15562
|
+
*
|
|
15563
|
+
* @public
|
|
15323
15564
|
*/
|
|
15324
15565
|
isPlayerUsingPony(player: EntityPlayer): boolean;
|
|
15325
15566
|
/**
|
|
@@ -15327,6 +15568,8 @@ declare class PonyDetection extends Feature {
|
|
|
15327
15568
|
* Detecting this is difficult, as the temporary effect will disappear upon entering a new room.
|
|
15328
15569
|
*
|
|
15329
15570
|
* In order to use this function, you must upgrade your mod with `ISCFeature.PONY_DETECTION`.
|
|
15571
|
+
*
|
|
15572
|
+
* @public
|
|
15330
15573
|
*/
|
|
15331
15574
|
anyPlayerUsingPony(): boolean;
|
|
15332
15575
|
}
|
|
@@ -15522,6 +15765,8 @@ declare class PreventChildEntities extends Feature {
|
|
|
15522
15765
|
*
|
|
15523
15766
|
* In order to use this function, you must upgrade your mod with
|
|
15524
15767
|
* `ISCFeature.PREVENT_CHILD_ENTITIES`.
|
|
15768
|
+
*
|
|
15769
|
+
* @public
|
|
15525
15770
|
*/
|
|
15526
15771
|
preventChildEntities(entity: Entity): void;
|
|
15527
15772
|
}
|
|
@@ -16365,14 +16610,33 @@ declare class RoomClearFrame extends Feature {
|
|
|
16365
16610
|
* Helper function to get the game frame (i.e. `Game.GetFrameCount`) of the last time that this
|
|
16366
16611
|
* room was cleared. Returns undefined if the room has never been cleared.
|
|
16367
16612
|
*
|
|
16613
|
+
* Note that if the room is left, all room clear tracking for it will be discarded.
|
|
16614
|
+
*
|
|
16368
16615
|
* In order to use this function, you must upgrade your mod with `ISCFeature.ROOM_CLEAR_FRAME`.
|
|
16616
|
+
*
|
|
16617
|
+
* @public
|
|
16369
16618
|
*/
|
|
16370
16619
|
getRoomClearGameFrame(): int | undefined;
|
|
16620
|
+
/**
|
|
16621
|
+
* Helper function to get the render frame (i.e. `Isaac.GetFrameCount`) of the last time that this
|
|
16622
|
+
* room was cleared. Returns undefined if the room has never been cleared.
|
|
16623
|
+
*
|
|
16624
|
+
* Note that if the room is left, all room clear tracking for it will be discarded.
|
|
16625
|
+
*
|
|
16626
|
+
* In order to use this function, you must upgrade your mod with `ISCFeature.ROOM_CLEAR_FRAME`.
|
|
16627
|
+
*
|
|
16628
|
+
* @public
|
|
16629
|
+
*/
|
|
16630
|
+
getRoomClearRenderFrame(): int | undefined;
|
|
16371
16631
|
/**
|
|
16372
16632
|
* Helper function to get the room frame (i.e. `Room.GetFrameCount`) of the last time that this
|
|
16373
16633
|
* room was cleared. Returns undefined if the room has never been cleared.
|
|
16374
16634
|
*
|
|
16635
|
+
* Note that if the room is left, all room clear tracking for it will be discarded.
|
|
16636
|
+
*
|
|
16375
16637
|
* In order to use this function, you must upgrade your mod with `ISCFeature.ROOM_CLEAR_FRAME`.
|
|
16638
|
+
*
|
|
16639
|
+
* @public
|
|
16376
16640
|
*/
|
|
16377
16641
|
getRoomClearRoomFrame(): int | undefined;
|
|
16378
16642
|
}
|
|
@@ -16418,6 +16682,8 @@ declare class RoomHistory extends Feature {
|
|
|
16418
16682
|
* Helper function to manually delete the last room description from the internal array. This is
|
|
16419
16683
|
* useful if a mod needs to send the player to a room temporarily and the room should not count as
|
|
16420
16684
|
* the player having traveled to that room.
|
|
16685
|
+
*
|
|
16686
|
+
* @public
|
|
16421
16687
|
*/
|
|
16422
16688
|
deleteLastRoomDescription(): void;
|
|
16423
16689
|
/**
|
|
@@ -16425,6 +16691,8 @@ declare class RoomHistory extends Feature {
|
|
|
16425
16691
|
* run. (Re-entering the same room will increment the number returned.)
|
|
16426
16692
|
*
|
|
16427
16693
|
* In order to use this function, you must upgrade your mod with `ISCFeature.ROOM_HISTORY`.
|
|
16694
|
+
*
|
|
16695
|
+
* @public
|
|
16428
16696
|
*/
|
|
16429
16697
|
getNumRoomsEntered(): int;
|
|
16430
16698
|
/**
|
|
@@ -16432,6 +16700,8 @@ declare class RoomHistory extends Feature {
|
|
|
16432
16700
|
* this run.
|
|
16433
16701
|
*
|
|
16434
16702
|
* In order to use this function, you must upgrade your mod with `ISCFeature.ROOM_HISTORY`.
|
|
16703
|
+
*
|
|
16704
|
+
* @public
|
|
16435
16705
|
*/
|
|
16436
16706
|
getRoomHistory(): ReadonlyArray<Readonly<RoomDescription>>;
|
|
16437
16707
|
/**
|
|
@@ -16441,6 +16711,8 @@ declare class RoomHistory extends Feature {
|
|
|
16441
16711
|
* the run), the starting room will be returned.
|
|
16442
16712
|
*
|
|
16443
16713
|
* In order to use this function, you must upgrade your mod with `ISCFeature.ROOM_HISTORY`.
|
|
16714
|
+
*
|
|
16715
|
+
* @public
|
|
16444
16716
|
*/
|
|
16445
16717
|
getPreviousRoomDescription(): Readonly<RoomDescription>;
|
|
16446
16718
|
/**
|
|
@@ -16453,9 +16725,15 @@ declare class RoomHistory extends Feature {
|
|
|
16453
16725
|
* of the run.
|
|
16454
16726
|
*
|
|
16455
16727
|
* In order to use this function, you must upgrade your mod with `ISCFeature.ROOM_HISTORY`.
|
|
16728
|
+
*
|
|
16729
|
+
* @public
|
|
16456
16730
|
*/
|
|
16457
16731
|
getLatestRoomDescription(): Readonly<RoomDescription> | undefined;
|
|
16458
|
-
/**
|
|
16732
|
+
/**
|
|
16733
|
+
* Helper function to detect if the player is on the first room of the room.
|
|
16734
|
+
*
|
|
16735
|
+
* @public
|
|
16736
|
+
*/
|
|
16459
16737
|
inFirstRoom(): boolean;
|
|
16460
16738
|
/**
|
|
16461
16739
|
* Helper function to detect if the game is in the state where the room index has changed to a new
|
|
@@ -16467,6 +16745,8 @@ declare class RoomHistory extends Feature {
|
|
|
16467
16745
|
* entity is despawning.
|
|
16468
16746
|
*
|
|
16469
16747
|
* In order to use this function, you must upgrade your mod with `ISCFeature.ROOM_HISTORY`.
|
|
16748
|
+
*
|
|
16749
|
+
* @public
|
|
16470
16750
|
*/
|
|
16471
16751
|
isLeavingRoom(): boolean;
|
|
16472
16752
|
}
|
|
@@ -16506,9 +16786,10 @@ declare class RunInNFrames extends Feature {
|
|
|
16506
16786
|
* the game inside of the `POST_NEW_ROOM`, `POST_NEW_LEVEL`, or `POST_GAME_STARTED` callbacks when
|
|
16507
16787
|
* a run is first starting.
|
|
16508
16788
|
*
|
|
16509
|
-
* You can optionally specify a `PlayerType` to restart the game as that character.
|
|
16510
|
-
*
|
|
16511
16789
|
* In order to use this function, you must upgrade your mod with `ISCFeature.RUN_IN_N_FRAMES`.
|
|
16790
|
+
*
|
|
16791
|
+
* @param character Optional. If specified, will restart the game as the specified character.
|
|
16792
|
+
* @public
|
|
16512
16793
|
*/
|
|
16513
16794
|
restartNextRenderFrame(character?: PlayerType): void;
|
|
16514
16795
|
/**
|
|
@@ -16527,6 +16808,7 @@ declare class RunInNFrames extends Feature {
|
|
|
16527
16808
|
* @param numGameFrames The amount of game frames to wait before running the function.
|
|
16528
16809
|
* @param cancelIfRoomChanges Optional. Whether to cancel running the function if a new room is
|
|
16529
16810
|
* loaded in the interim. Default is false.
|
|
16811
|
+
* @public
|
|
16530
16812
|
*/
|
|
16531
16813
|
runInNGameFrames(func: () => void, numGameFrames: int, cancelIfRoomChanges?: boolean): void;
|
|
16532
16814
|
/**
|
|
@@ -16545,6 +16827,7 @@ declare class RunInNFrames extends Feature {
|
|
|
16545
16827
|
* @param numRenderFrames The amount of render frames to wait before running the function.
|
|
16546
16828
|
* @param cancelIfRoomChanges Optional. Whether to cancel running the function if a new room is
|
|
16547
16829
|
* loaded in the interim. Default is false.
|
|
16830
|
+
* @public
|
|
16548
16831
|
*/
|
|
16549
16832
|
runInNRenderFrames(func: () => void, numRenderFrames: int, cancelIfRoomChanges?: boolean): void;
|
|
16550
16833
|
/**
|
|
@@ -16580,6 +16863,7 @@ declare class RunInNFrames extends Feature {
|
|
|
16580
16863
|
* @param func The function to run.
|
|
16581
16864
|
* @param cancelIfRoomChanges Optional. Whether to cancel running the function if a new room is
|
|
16582
16865
|
* loaded in the interim. Default is false.
|
|
16866
|
+
* @public
|
|
16583
16867
|
*/
|
|
16584
16868
|
runNextGameFrame(func: () => void, cancelIfRoomChanges?: boolean): void;
|
|
16585
16869
|
/**
|
|
@@ -16595,6 +16879,7 @@ declare class RunInNFrames extends Feature {
|
|
|
16595
16879
|
* @param func The function to run.
|
|
16596
16880
|
* @param cancelIfRoomChanges Optional. Whether to cancel running the function if a new room is
|
|
16597
16881
|
* loaded in the interim. Default is false.
|
|
16882
|
+
* @public
|
|
16598
16883
|
*/
|
|
16599
16884
|
runNextRenderFrame(func: () => void, cancelIfRoomChanges?: boolean): void;
|
|
16600
16885
|
/**
|
|
@@ -16616,6 +16901,7 @@ declare class RunInNFrames extends Feature {
|
|
|
16616
16901
|
* interval.
|
|
16617
16902
|
* @param cancelIfRoomChanges Optional. Whether to cancel running the function if a new room is
|
|
16618
16903
|
* loaded in the interim. Default is false.
|
|
16904
|
+
* @public
|
|
16619
16905
|
*/
|
|
16620
16906
|
setIntervalGameFrames(func: () => boolean, numGameFrames: int, runImmediately: boolean, cancelIfRoomChanges?: boolean): void;
|
|
16621
16907
|
/**
|
|
@@ -16637,6 +16923,7 @@ declare class RunInNFrames extends Feature {
|
|
|
16637
16923
|
* interval.
|
|
16638
16924
|
* @param cancelIfRoomChanges Optional. Whether to cancel running the function if a new room is
|
|
16639
16925
|
* loaded in the interim. Default is false.
|
|
16926
|
+
* @public
|
|
16640
16927
|
*/
|
|
16641
16928
|
setIntervalRenderFrames(func: () => boolean, numRenderFrames: int, runImmediately: boolean, cancelIfRoomChanges?: boolean): void;
|
|
16642
16929
|
}
|
|
@@ -16674,6 +16961,8 @@ declare class RunNextRun extends Feature {
|
|
|
16674
16961
|
* deferred functions manually using serializable data.
|
|
16675
16962
|
*
|
|
16676
16963
|
* In order to use this function, you must upgrade your mod with `ISCFeature.RUN_NEXT_ROOM`.
|
|
16964
|
+
*
|
|
16965
|
+
* @public
|
|
16677
16966
|
*/
|
|
16678
16967
|
runNextRun(func: () => void): void;
|
|
16679
16968
|
}
|
|
@@ -16859,6 +17148,7 @@ declare class SaveDataManager extends Feature {
|
|
|
16859
17148
|
* specify `false` to this argument in order to completely disable saving
|
|
16860
17149
|
* data. (Specifying `false` will allow you to use non-serializable objects
|
|
16861
17150
|
* in your save data, such as `EntityPtr`.
|
|
17151
|
+
* @public
|
|
16862
17152
|
*/
|
|
16863
17153
|
saveDataManager<Persistent, Run, Level>(key: string | object, v: SaveData<Persistent, Run, Level>, conditionalFunc?: () => boolean): void;
|
|
16864
17154
|
saveDataManager(key: string | object, v: SaveData, conditionalFunc: false): void;
|
|
@@ -16875,6 +17165,8 @@ declare class SaveDataManager extends Feature {
|
|
|
16875
17165
|
* result in lost state.
|
|
16876
17166
|
*
|
|
16877
17167
|
* In order to use this function, you must upgrade your mod with `ISCFeature.SAVE_DATA_MANAGER`.
|
|
17168
|
+
*
|
|
17169
|
+
* @public
|
|
16878
17170
|
*/
|
|
16879
17171
|
saveDataManagerLoad(): void;
|
|
16880
17172
|
/**
|
|
@@ -16883,6 +17175,8 @@ declare class SaveDataManager extends Feature {
|
|
|
16883
17175
|
* all of its variables to disk immediately.
|
|
16884
17176
|
*
|
|
16885
17177
|
* In order to use this function, you must upgrade your mod with `ISCFeature.SAVE_DATA_MANAGER`.
|
|
17178
|
+
*
|
|
17179
|
+
* @public
|
|
16886
17180
|
*/
|
|
16887
17181
|
saveDataManagerSave(): void;
|
|
16888
17182
|
/**
|
|
@@ -16892,6 +17186,8 @@ declare class SaveDataManager extends Feature {
|
|
|
16892
17186
|
* e.g. `l print(g.feature1.run.foo)`
|
|
16893
17187
|
*
|
|
16894
17188
|
* In order to use this function, you must upgrade your mod with `ISCFeature.SAVE_DATA_MANAGER`.
|
|
17189
|
+
*
|
|
17190
|
+
* @public
|
|
16895
17191
|
*/
|
|
16896
17192
|
saveDataManagerSetGlobal(): void;
|
|
16897
17193
|
/**
|
|
@@ -16905,6 +17201,8 @@ declare class SaveDataManager extends Feature {
|
|
|
16905
17201
|
* This function is variadic, which means you can pass as many classes as you want to register.
|
|
16906
17202
|
*
|
|
16907
17203
|
* In order to use this function, you must upgrade your mod with `ISCFeature.SAVE_DATA_MANAGER`.
|
|
17204
|
+
*
|
|
17205
|
+
* @public
|
|
16908
17206
|
*/
|
|
16909
17207
|
saveDataManagerRegisterClass(...tstlClasses: AnyClass[]): void;
|
|
16910
17208
|
/**
|
|
@@ -16912,6 +17210,8 @@ declare class SaveDataManager extends Feature {
|
|
|
16912
17210
|
* "saveDataManager" method.
|
|
16913
17211
|
*
|
|
16914
17212
|
* In order to use this function, you must upgrade your mod with `ISCFeature.SAVE_DATA_MANAGER`.
|
|
17213
|
+
*
|
|
17214
|
+
* @public
|
|
16915
17215
|
*/
|
|
16916
17216
|
saveDataManagerRemove(key: string): void;
|
|
16917
17217
|
/**
|
|
@@ -16935,6 +17235,8 @@ declare class SaveDataManager extends Feature {
|
|
|
16935
17235
|
* ```
|
|
16936
17236
|
*
|
|
16937
17237
|
* In order to use this function, you must upgrade your mod with `ISCFeature.SAVE_DATA_MANAGER`.
|
|
17238
|
+
*
|
|
17239
|
+
* @public
|
|
16938
17240
|
*/
|
|
16939
17241
|
saveDataManagerReset(key: string, childObjectKey: SaveDataKey): void;
|
|
16940
17242
|
/**
|
|
@@ -16949,8 +17251,16 @@ declare class SaveDataManager extends Feature {
|
|
|
16949
17251
|
* explicitly call the `saveDataManagerSave` function.
|
|
16950
17252
|
*
|
|
16951
17253
|
* In order to use this function, you must upgrade your mod with `ISCFeature.SAVE_DATA_MANAGER`.
|
|
17254
|
+
*
|
|
17255
|
+
* @public
|
|
16952
17256
|
*/
|
|
16953
17257
|
saveDataManagerInMenu(): boolean;
|
|
17258
|
+
/**
|
|
17259
|
+
* Helper function to see all of the mod features that are using the save data manager. Useful for
|
|
17260
|
+
* debugging if a certain mod feature is not getting its data saved correctly.
|
|
17261
|
+
*
|
|
17262
|
+
* @public
|
|
17263
|
+
*/
|
|
16954
17264
|
saveDataManagerLogSubscribers(): void;
|
|
16955
17265
|
}
|
|
16956
17266
|
|
|
@@ -18050,6 +18360,7 @@ declare class SpawnRockAltRewards extends Feature {
|
|
|
18050
18360
|
* `RNG.Next` method will be called. If `undefined` is provided, it will default
|
|
18051
18361
|
* to a random seed.
|
|
18052
18362
|
* @returns Whether this function spawned something.
|
|
18363
|
+
* @public
|
|
18053
18364
|
*/
|
|
18054
18365
|
spawnRockAltReward(positionOrGridIndex: Vector | int, rockAltType: RockAltType, seedOrRNG: Seed | RNG | undefined): boolean;
|
|
18055
18366
|
/**
|
|
@@ -18235,6 +18546,7 @@ declare class StageHistory extends Feature {
|
|
|
18235
18546
|
*
|
|
18236
18547
|
* @param upwards Whether the player should go up to Cathedral in the case of being on Womb 2.
|
|
18237
18548
|
* Default is false.
|
|
18549
|
+
* @public
|
|
18238
18550
|
*/
|
|
18239
18551
|
getNextStageTypeWithHistory(upwards?: boolean): StageType;
|
|
18240
18552
|
/**
|
|
@@ -18252,6 +18564,8 @@ declare class StageHistory extends Feature {
|
|
|
18252
18564
|
* Helper function to get all of the stages that a player has visited thus far on this run.
|
|
18253
18565
|
*
|
|
18254
18566
|
* In order to use this function, you must upgrade your mod with `ISCFeature.STAGE_HISTORY`.
|
|
18567
|
+
*
|
|
18568
|
+
* @public
|
|
18255
18569
|
*/
|
|
18256
18570
|
getStageHistory(): readonly StageHistoryEntry[];
|
|
18257
18571
|
/**
|
|
@@ -18290,6 +18604,8 @@ declare class StartAmbush extends Feature {
|
|
|
18290
18604
|
* and then removing the sack and the pickups that the sack dropped.
|
|
18291
18605
|
*
|
|
18292
18606
|
* In order to use this function, you must upgrade your mod with `ISCFeature.START_AMBUSH`.
|
|
18607
|
+
*
|
|
18608
|
+
* @public
|
|
18293
18609
|
*/
|
|
18294
18610
|
startAmbush(): void;
|
|
18295
18611
|
}
|
|
@@ -18383,6 +18699,8 @@ declare class TaintedLazarusPlayers extends Feature {
|
|
|
18383
18699
|
*
|
|
18384
18700
|
* In order to use this function, you must upgrade your mod with
|
|
18385
18701
|
* `ISCFeature.CHARACTER_HEALTH_CONVERSION`.
|
|
18702
|
+
*
|
|
18703
|
+
* @public
|
|
18386
18704
|
*/
|
|
18387
18705
|
getTaintedLazarusSubPlayer(player: EntityPlayer): EntityPlayer | undefined;
|
|
18388
18706
|
}
|
|
@@ -18584,6 +18902,8 @@ declare class UnlockAchievementsDetection extends Feature {
|
|
|
18584
18902
|
*
|
|
18585
18903
|
* In order to use this function, you must upgrade your mod with
|
|
18586
18904
|
* `ISCFeature.UNLOCK_ACHIEVEMENTS_DETECTION`.
|
|
18905
|
+
*
|
|
18906
|
+
* @public
|
|
18587
18907
|
*/
|
|
18588
18908
|
canRunUnlockAchievements(): boolean;
|
|
18589
18909
|
}
|