isaacscript-common 76.1.0 → 76.3.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/ForgottenSwitch.d.ts +2 -0
- package/dist/classes/features/other/ForgottenSwitch.d.ts.map +1 -1
- package/dist/classes/features/other/ItemPoolDetection.d.ts +6 -0
- 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 +68 -0
- package/dist/classes/features/other/ModdedElementSets.d.ts.map +1 -1
- 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/playerCollectibles.d.ts +6 -0
- package/dist/functions/playerCollectibles.d.ts.map +1 -1
- package/dist/functions/playerCollectibles.lua +30 -23
- package/dist/functions/players.d.ts.map +1 -1
- package/dist/functions/players.lua +7 -7
- package/dist/index.rollup.d.ts +331 -4
- package/dist/isaacscript-common.lua +400 -406
- 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 +6 -0
- package/src/classes/features/other/ModdedElementDetection.ts +32 -0
- package/src/classes/features/other/ModdedElementSets.ts +68 -0
- 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/playerCollectibles.ts +12 -0
- package/src/functions/players.ts +12 -12
package/dist/index.rollup.d.ts
CHANGED
|
@@ -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
|
}
|
|
@@ -4759,6 +4876,13 @@ export declare function getAdjacentNonExistingRoomGridIndexes(roomGridIndex?: in
|
|
|
4759
4876
|
*/
|
|
4760
4877
|
export declare function getAdjacentRoomGridIndexes(roomGridIndex?: int): readonly int[];
|
|
4761
4878
|
|
|
4879
|
+
/**
|
|
4880
|
+
* Helper function to get the adjusted price for a pickup, depending on how many Steam Sales all
|
|
4881
|
+
* players currently have. (For example, if Jacob has one Steam Sale and Esau has one Steam Sale,
|
|
4882
|
+
* the prices for items in the shop would be the same as if Isaac had two Steam Sales.)
|
|
4883
|
+
*/
|
|
4884
|
+
export declare function getAdjustedPrice(basePrice: int): int;
|
|
4885
|
+
|
|
4762
4886
|
/**
|
|
4763
4887
|
* Helper function to get all of the non-dead bosses in the room.
|
|
4764
4888
|
*
|
|
@@ -10182,6 +10306,8 @@ declare class ItemPoolDetection extends Feature {
|
|
|
10182
10306
|
* expensive, so only use it in situations where the lag is acceptable.
|
|
10183
10307
|
*
|
|
10184
10308
|
* In order to use this function, you must upgrade your mod with `ISCFeature.ITEM_POOL_DETECTION`.
|
|
10309
|
+
*
|
|
10310
|
+
* @public
|
|
10185
10311
|
*/
|
|
10186
10312
|
getCollectiblesInItemPool(itemPoolType: ItemPoolType): CollectibleType[];
|
|
10187
10313
|
/**
|
|
@@ -10195,6 +10321,8 @@ declare class ItemPoolDetection extends Feature {
|
|
|
10195
10321
|
* blacklist every collectible except for the one provided.
|
|
10196
10322
|
*
|
|
10197
10323
|
* In order to use this function, you must upgrade your mod with `ISCFeature.ITEM_POOL_DETECTION`.
|
|
10324
|
+
*
|
|
10325
|
+
* @public
|
|
10198
10326
|
*/
|
|
10199
10327
|
isCollectibleInItemPool(collectibleType: CollectibleType, itemPoolType: ItemPoolType): boolean;
|
|
10200
10328
|
/**
|
|
@@ -10212,6 +10340,8 @@ declare class ItemPoolDetection extends Feature {
|
|
|
10212
10340
|
* collectibles from item pools).
|
|
10213
10341
|
*
|
|
10214
10342
|
* In order to use this function, you must upgrade your mod with `ISCFeature.ITEM_POOL_DETECTION`.
|
|
10343
|
+
*
|
|
10344
|
+
* @public
|
|
10215
10345
|
*/
|
|
10216
10346
|
isCollectibleUnlocked(collectibleType: CollectibleType, itemPoolType: ItemPoolType): boolean;
|
|
10217
10347
|
}
|
|
@@ -13463,6 +13593,8 @@ declare class ModdedElementDetection extends Feature {
|
|
|
13463
13593
|
*
|
|
13464
13594
|
* In order to use this function, you must upgrade your mod with
|
|
13465
13595
|
* `ISCFeature.MODDED_ELEMENT_DETECTION`.
|
|
13596
|
+
*
|
|
13597
|
+
* @public
|
|
13466
13598
|
*/
|
|
13467
13599
|
getFirstModdedCollectibleType(): CollectibleType | undefined;
|
|
13468
13600
|
/**
|
|
@@ -13480,6 +13612,8 @@ declare class ModdedElementDetection extends Feature {
|
|
|
13480
13612
|
*
|
|
13481
13613
|
* In order to use this function, you must upgrade your mod with
|
|
13482
13614
|
* `ISCFeature.MODDED_ELEMENT_DETECTION`.
|
|
13615
|
+
*
|
|
13616
|
+
* @public
|
|
13483
13617
|
*/
|
|
13484
13618
|
getLastCollectibleType(): CollectibleType;
|
|
13485
13619
|
/**
|
|
@@ -13493,6 +13627,8 @@ declare class ModdedElementDetection extends Feature {
|
|
|
13493
13627
|
*
|
|
13494
13628
|
* In order to use this function, you must upgrade your mod with
|
|
13495
13629
|
* `ISCFeature.MODDED_ELEMENT_DETECTION`.
|
|
13630
|
+
*
|
|
13631
|
+
* @public
|
|
13496
13632
|
*/
|
|
13497
13633
|
getNumCollectibleTypes(): int;
|
|
13498
13634
|
/**
|
|
@@ -13504,6 +13640,8 @@ declare class ModdedElementDetection extends Feature {
|
|
|
13504
13640
|
*
|
|
13505
13641
|
* In order to use this function, you must upgrade your mod with
|
|
13506
13642
|
* `ISCFeature.MODDED_ELEMENT_DETECTION`.
|
|
13643
|
+
*
|
|
13644
|
+
* @public
|
|
13507
13645
|
*/
|
|
13508
13646
|
getNumModdedCollectibleTypes(): int;
|
|
13509
13647
|
/**
|
|
@@ -13514,6 +13652,8 @@ declare class ModdedElementDetection extends Feature {
|
|
|
13514
13652
|
*
|
|
13515
13653
|
* In order to use this function, you must upgrade your mod with
|
|
13516
13654
|
* `ISCFeature.MODDED_ELEMENT_DETECTION`.
|
|
13655
|
+
*
|
|
13656
|
+
* @public
|
|
13517
13657
|
*/
|
|
13518
13658
|
getFirstModdedTrinketType(): TrinketType | undefined;
|
|
13519
13659
|
/**
|
|
@@ -13530,6 +13670,8 @@ declare class ModdedElementDetection extends Feature {
|
|
|
13530
13670
|
*
|
|
13531
13671
|
* In order to use this function, you must upgrade your mod with
|
|
13532
13672
|
* `ISCFeature.MODDED_ELEMENT_DETECTION`.
|
|
13673
|
+
*
|
|
13674
|
+
* @public
|
|
13533
13675
|
*/
|
|
13534
13676
|
getLastTrinketType(): TrinketType;
|
|
13535
13677
|
/**
|
|
@@ -13542,6 +13684,8 @@ declare class ModdedElementDetection extends Feature {
|
|
|
13542
13684
|
*
|
|
13543
13685
|
* In order to use this function, you must upgrade your mod with
|
|
13544
13686
|
* `ISCFeature.MODDED_ELEMENT_DETECTION`.
|
|
13687
|
+
*
|
|
13688
|
+
* @public
|
|
13545
13689
|
*/
|
|
13546
13690
|
getNumTrinketTypes(): int;
|
|
13547
13691
|
/**
|
|
@@ -13552,6 +13696,8 @@ declare class ModdedElementDetection extends Feature {
|
|
|
13552
13696
|
*
|
|
13553
13697
|
* In order to use this function, you must upgrade your mod with
|
|
13554
13698
|
* `ISCFeature.MODDED_ELEMENT_DETECTION`.
|
|
13699
|
+
*
|
|
13700
|
+
* @public
|
|
13555
13701
|
*/
|
|
13556
13702
|
getNumModdedTrinketTypes(): int;
|
|
13557
13703
|
/**
|
|
@@ -13562,6 +13708,8 @@ declare class ModdedElementDetection extends Feature {
|
|
|
13562
13708
|
*
|
|
13563
13709
|
* In order to use this function, you must upgrade your mod with
|
|
13564
13710
|
* `ISCFeature.MODDED_ELEMENT_DETECTION`.
|
|
13711
|
+
*
|
|
13712
|
+
* @public
|
|
13565
13713
|
*/
|
|
13566
13714
|
getFirstModdedCardType(): CardType | undefined;
|
|
13567
13715
|
/**
|
|
@@ -13575,6 +13723,8 @@ declare class ModdedElementDetection extends Feature {
|
|
|
13575
13723
|
*
|
|
13576
13724
|
* In order to use this function, you must upgrade your mod with
|
|
13577
13725
|
* `ISCFeature.MODDED_ELEMENT_DETECTION`.
|
|
13726
|
+
*
|
|
13727
|
+
* @public
|
|
13578
13728
|
*/
|
|
13579
13729
|
getLastCardType(): CardType;
|
|
13580
13730
|
/**
|
|
@@ -13587,6 +13737,8 @@ declare class ModdedElementDetection extends Feature {
|
|
|
13587
13737
|
*
|
|
13588
13738
|
* In order to use this function, you must upgrade your mod with
|
|
13589
13739
|
* `ISCFeature.MODDED_ELEMENT_DETECTION`.
|
|
13740
|
+
*
|
|
13741
|
+
* @public
|
|
13590
13742
|
*/
|
|
13591
13743
|
getNumCardTypes(): int;
|
|
13592
13744
|
/**
|
|
@@ -13595,6 +13747,8 @@ declare class ModdedElementDetection extends Feature {
|
|
|
13595
13747
|
*
|
|
13596
13748
|
* In order to use this function, you must upgrade your mod with
|
|
13597
13749
|
* `ISCFeature.MODDED_ELEMENT_DETECTION`.
|
|
13750
|
+
*
|
|
13751
|
+
* @public
|
|
13598
13752
|
*/
|
|
13599
13753
|
getNumModdedCardTypes(): int;
|
|
13600
13754
|
/**
|
|
@@ -13606,6 +13760,8 @@ declare class ModdedElementDetection extends Feature {
|
|
|
13606
13760
|
*
|
|
13607
13761
|
* In order to use this function, you must upgrade your mod with
|
|
13608
13762
|
* `ISCFeature.MODDED_ELEMENT_DETECTION`.
|
|
13763
|
+
*
|
|
13764
|
+
* @public
|
|
13609
13765
|
*/
|
|
13610
13766
|
getFirstModdedPillEffect(): PillEffect | undefined;
|
|
13611
13767
|
/**
|
|
@@ -13620,6 +13776,8 @@ declare class ModdedElementDetection extends Feature {
|
|
|
13620
13776
|
*
|
|
13621
13777
|
* In order to use this function, you must upgrade your mod with
|
|
13622
13778
|
* `ISCFeature.MODDED_ELEMENT_DETECTION`.
|
|
13779
|
+
*
|
|
13780
|
+
* @public
|
|
13623
13781
|
*/
|
|
13624
13782
|
getLastPillEffect(): PillEffect;
|
|
13625
13783
|
/**
|
|
@@ -13634,6 +13792,8 @@ declare class ModdedElementDetection extends Feature {
|
|
|
13634
13792
|
*
|
|
13635
13793
|
* In order to use this function, you must upgrade your mod with
|
|
13636
13794
|
* `ISCFeature.MODDED_ELEMENT_DETECTION`.
|
|
13795
|
+
*
|
|
13796
|
+
* @public
|
|
13637
13797
|
*/
|
|
13638
13798
|
getNumPillEffects(): int;
|
|
13639
13799
|
/**
|
|
@@ -13643,6 +13803,8 @@ declare class ModdedElementDetection extends Feature {
|
|
|
13643
13803
|
*
|
|
13644
13804
|
* In order to use this function, you must upgrade your mod with
|
|
13645
13805
|
* `ISCFeature.MODDED_ELEMENT_DETECTION`.
|
|
13806
|
+
*
|
|
13807
|
+
* @public
|
|
13646
13808
|
*/
|
|
13647
13809
|
getNumModdedPillEffects(): int;
|
|
13648
13810
|
}
|
|
@@ -13716,6 +13878,8 @@ declare class ModdedElementSets extends Feature {
|
|
|
13716
13878
|
* order).
|
|
13717
13879
|
*
|
|
13718
13880
|
* In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
|
|
13881
|
+
*
|
|
13882
|
+
* @public
|
|
13719
13883
|
*/
|
|
13720
13884
|
getCollectibleTypes(): readonly CollectibleType[];
|
|
13721
13885
|
/**
|
|
@@ -13730,6 +13894,8 @@ declare class ModdedElementSets extends Feature {
|
|
|
13730
13894
|
* order).
|
|
13731
13895
|
*
|
|
13732
13896
|
* In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
|
|
13897
|
+
*
|
|
13898
|
+
* @public
|
|
13733
13899
|
*/
|
|
13734
13900
|
getCollectibleTypeSet(): ReadonlySet<CollectibleType>;
|
|
13735
13901
|
/**
|
|
@@ -13743,6 +13909,8 @@ declare class ModdedElementSets extends Feature {
|
|
|
13743
13909
|
* order).
|
|
13744
13910
|
*
|
|
13745
13911
|
* In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
|
|
13912
|
+
*
|
|
13913
|
+
* @public
|
|
13746
13914
|
*/
|
|
13747
13915
|
getModdedCollectibleTypes(): readonly CollectibleType[];
|
|
13748
13916
|
/**
|
|
@@ -13756,6 +13924,8 @@ declare class ModdedElementSets extends Feature {
|
|
|
13756
13924
|
* order).
|
|
13757
13925
|
*
|
|
13758
13926
|
* In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
|
|
13927
|
+
*
|
|
13928
|
+
* @public
|
|
13759
13929
|
*/
|
|
13760
13930
|
getModdedCollectibleTypesSet(): ReadonlySet<CollectibleType>;
|
|
13761
13931
|
/**
|
|
@@ -13769,6 +13939,8 @@ declare class ModdedElementSets extends Feature {
|
|
|
13769
13939
|
* order).
|
|
13770
13940
|
*
|
|
13771
13941
|
* In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
|
|
13942
|
+
*
|
|
13943
|
+
* @public
|
|
13772
13944
|
*/
|
|
13773
13945
|
getPlayerCollectibleMap(player: EntityPlayer): Map<CollectibleType, int>;
|
|
13774
13946
|
/**
|
|
@@ -13782,6 +13954,8 @@ declare class ModdedElementSets extends Feature {
|
|
|
13782
13954
|
* order).
|
|
13783
13955
|
*
|
|
13784
13956
|
* In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
|
|
13957
|
+
*
|
|
13958
|
+
* @public
|
|
13785
13959
|
*/
|
|
13786
13960
|
getTrinketTypes(): readonly TrinketType[];
|
|
13787
13961
|
/**
|
|
@@ -13795,6 +13969,8 @@ declare class ModdedElementSets extends Feature {
|
|
|
13795
13969
|
* order).
|
|
13796
13970
|
*
|
|
13797
13971
|
* In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
|
|
13972
|
+
*
|
|
13973
|
+
* @public
|
|
13798
13974
|
*/
|
|
13799
13975
|
getTrinketTypesSet(): ReadonlySet<TrinketType>;
|
|
13800
13976
|
/**
|
|
@@ -13808,6 +13984,8 @@ declare class ModdedElementSets extends Feature {
|
|
|
13808
13984
|
* order).
|
|
13809
13985
|
*
|
|
13810
13986
|
* In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
|
|
13987
|
+
*
|
|
13988
|
+
* @public
|
|
13811
13989
|
*/
|
|
13812
13990
|
getModdedTrinketTypes(): readonly TrinketType[];
|
|
13813
13991
|
/**
|
|
@@ -13821,6 +13999,8 @@ declare class ModdedElementSets extends Feature {
|
|
|
13821
13999
|
* order).
|
|
13822
14000
|
*
|
|
13823
14001
|
* In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
|
|
14002
|
+
*
|
|
14003
|
+
* @public
|
|
13824
14004
|
*/
|
|
13825
14005
|
getModdedTrinketTypesSet(): ReadonlySet<TrinketType>;
|
|
13826
14006
|
/**
|
|
@@ -13833,6 +14013,8 @@ declare class ModdedElementSets extends Feature {
|
|
|
13833
14013
|
* not all card types will necessarily be present when a mod first loads (due to mod load order).
|
|
13834
14014
|
*
|
|
13835
14015
|
* In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
|
|
14016
|
+
*
|
|
14017
|
+
* @public
|
|
13836
14018
|
*/
|
|
13837
14019
|
getCardTypes(): readonly CardType[];
|
|
13838
14020
|
/**
|
|
@@ -13845,6 +14027,8 @@ declare class ModdedElementSets extends Feature {
|
|
|
13845
14027
|
* not all card types will necessarily be present when a mod first loads (due to mod load order).
|
|
13846
14028
|
*
|
|
13847
14029
|
* In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
|
|
14030
|
+
*
|
|
14031
|
+
* @public
|
|
13848
14032
|
*/
|
|
13849
14033
|
getCardTypesSet(): ReadonlySet<CardType>;
|
|
13850
14034
|
/**
|
|
@@ -13857,6 +14041,8 @@ declare class ModdedElementSets extends Feature {
|
|
|
13857
14041
|
* not all card types will necessarily be present when a mod first loads (due to mod load order).
|
|
13858
14042
|
*
|
|
13859
14043
|
* In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
|
|
14044
|
+
*
|
|
14045
|
+
* @public
|
|
13860
14046
|
*/
|
|
13861
14047
|
getModdedCardTypes(): readonly CardType[];
|
|
13862
14048
|
/**
|
|
@@ -13869,6 +14055,8 @@ declare class ModdedElementSets extends Feature {
|
|
|
13869
14055
|
* not all card types will necessarily be present when a mod first loads (due to mod load order).
|
|
13870
14056
|
*
|
|
13871
14057
|
* In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
|
|
14058
|
+
*
|
|
14059
|
+
* @public
|
|
13872
14060
|
*/
|
|
13873
14061
|
getModdedCardTypesSet(): ReadonlySet<CardType>;
|
|
13874
14062
|
/**
|
|
@@ -13882,6 +14070,8 @@ declare class ModdedElementSets extends Feature {
|
|
|
13882
14070
|
* order).
|
|
13883
14071
|
*
|
|
13884
14072
|
* In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
|
|
14073
|
+
*
|
|
14074
|
+
* @public
|
|
13885
14075
|
*/
|
|
13886
14076
|
getPillEffects(): readonly PillEffect[];
|
|
13887
14077
|
/**
|
|
@@ -13895,6 +14085,8 @@ declare class ModdedElementSets extends Feature {
|
|
|
13895
14085
|
* order).
|
|
13896
14086
|
*
|
|
13897
14087
|
* In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
|
|
14088
|
+
*
|
|
14089
|
+
* @public
|
|
13898
14090
|
*/
|
|
13899
14091
|
getPillEffectsSet(): ReadonlySet<PillEffect>;
|
|
13900
14092
|
/**
|
|
@@ -13908,6 +14100,8 @@ declare class ModdedElementSets extends Feature {
|
|
|
13908
14100
|
* order).
|
|
13909
14101
|
*
|
|
13910
14102
|
* In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
|
|
14103
|
+
*
|
|
14104
|
+
* @public
|
|
13911
14105
|
*/
|
|
13912
14106
|
getModdedPillEffects(): readonly PillEffect[];
|
|
13913
14107
|
/**
|
|
@@ -13921,6 +14115,8 @@ declare class ModdedElementSets extends Feature {
|
|
|
13921
14115
|
* order).
|
|
13922
14116
|
*
|
|
13923
14117
|
* In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
|
|
14118
|
+
*
|
|
14119
|
+
* @public
|
|
13924
14120
|
*/
|
|
13925
14121
|
getModdedPillEffectsSet(): ReadonlySet<PillEffect>;
|
|
13926
14122
|
/**
|
|
@@ -13932,6 +14128,8 @@ declare class ModdedElementSets extends Feature {
|
|
|
13932
14128
|
* order).
|
|
13933
14129
|
*
|
|
13934
14130
|
* In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
|
|
14131
|
+
*
|
|
14132
|
+
* @public
|
|
13935
14133
|
*/
|
|
13936
14134
|
getCollectibleTypesWithCacheFlag(cacheFlag: CacheFlag): ReadonlySet<CollectibleType>;
|
|
13937
14135
|
/**
|
|
@@ -13943,6 +14141,8 @@ declare class ModdedElementSets extends Feature {
|
|
|
13943
14141
|
* order).
|
|
13944
14142
|
*
|
|
13945
14143
|
* In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
|
|
14144
|
+
*
|
|
14145
|
+
* @public
|
|
13946
14146
|
*/
|
|
13947
14147
|
getTrinketsTypesWithCacheFlag(cacheFlag: CacheFlag): ReadonlySet<TrinketType>;
|
|
13948
14148
|
/**
|
|
@@ -13968,6 +14168,8 @@ declare class ModdedElementSets extends Feature {
|
|
|
13968
14168
|
* order).
|
|
13969
14169
|
*
|
|
13970
14170
|
* In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
|
|
14171
|
+
*
|
|
14172
|
+
* @public
|
|
13971
14173
|
*/
|
|
13972
14174
|
getPlayerCollectiblesWithCacheFlag(player: EntityPlayer, cacheFlag: CacheFlag): CollectibleType[];
|
|
13973
14175
|
/**
|
|
@@ -13979,6 +14181,8 @@ declare class ModdedElementSets extends Feature {
|
|
|
13979
14181
|
* order).
|
|
13980
14182
|
*
|
|
13981
14183
|
* In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
|
|
14184
|
+
*
|
|
14185
|
+
* @public
|
|
13982
14186
|
*/
|
|
13983
14187
|
getPlayerTrinketsWithCacheFlag(player: EntityPlayer, cacheFlag: CacheFlag): Map<TrinketType, int>;
|
|
13984
14188
|
/**
|
|
@@ -14001,6 +14205,7 @@ declare class ModdedElementSets extends Feature {
|
|
|
14001
14205
|
*
|
|
14002
14206
|
* @param includeConditionalItems Whether collectibles that only grant flight conditionally should
|
|
14003
14207
|
* be included in the set (like Empty Vessel).
|
|
14208
|
+
* @public
|
|
14004
14209
|
*/
|
|
14005
14210
|
getFlyingCollectibleTypes(includeConditionalItems: boolean): ReadonlySet<CollectibleType>;
|
|
14006
14211
|
/**
|
|
@@ -14016,6 +14221,8 @@ declare class ModdedElementSets extends Feature {
|
|
|
14016
14221
|
* order).
|
|
14017
14222
|
*
|
|
14018
14223
|
* In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
|
|
14224
|
+
*
|
|
14225
|
+
* @public
|
|
14019
14226
|
*/
|
|
14020
14227
|
getFlyingTrinketTypes(): ReadonlySet<TrinketType>;
|
|
14021
14228
|
/**
|
|
@@ -14033,6 +14240,8 @@ declare class ModdedElementSets extends Feature {
|
|
|
14033
14240
|
* order).
|
|
14034
14241
|
*
|
|
14035
14242
|
* In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
|
|
14243
|
+
*
|
|
14244
|
+
* @public
|
|
14036
14245
|
*/
|
|
14037
14246
|
getCollectibleTypesWithTag(itemConfigTag: ItemConfigTag): ReadonlySet<CollectibleType>;
|
|
14038
14247
|
/**
|
|
@@ -14043,6 +14252,8 @@ declare class ModdedElementSets extends Feature {
|
|
|
14043
14252
|
* order).
|
|
14044
14253
|
*
|
|
14045
14254
|
* In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
|
|
14255
|
+
*
|
|
14256
|
+
* @public
|
|
14046
14257
|
*/
|
|
14047
14258
|
getPlayerCollectiblesWithTag(player: EntityPlayer, itemConfigTag: ItemConfigTag): CollectibleType[];
|
|
14048
14259
|
/**
|
|
@@ -14060,6 +14271,8 @@ declare class ModdedElementSets extends Feature {
|
|
|
14060
14271
|
* order).
|
|
14061
14272
|
*
|
|
14062
14273
|
* In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
|
|
14274
|
+
*
|
|
14275
|
+
* @public
|
|
14063
14276
|
*/
|
|
14064
14277
|
getCollectibleTypesForTransformation(playerForm: PlayerForm): ReadonlySet<CollectibleType>;
|
|
14065
14278
|
/**
|
|
@@ -14071,6 +14284,8 @@ declare class ModdedElementSets extends Feature {
|
|
|
14071
14284
|
* order).
|
|
14072
14285
|
*
|
|
14073
14286
|
* In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
|
|
14287
|
+
*
|
|
14288
|
+
* @public
|
|
14074
14289
|
*/
|
|
14075
14290
|
getPlayerCollectiblesForTransformation(player: EntityPlayer, playerForm: PlayerForm): CollectibleType[];
|
|
14076
14291
|
/**
|
|
@@ -14084,6 +14299,8 @@ declare class ModdedElementSets extends Feature {
|
|
|
14084
14299
|
* order).
|
|
14085
14300
|
*
|
|
14086
14301
|
* In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
|
|
14302
|
+
*
|
|
14303
|
+
* @public
|
|
14087
14304
|
*/
|
|
14088
14305
|
getEdenActiveCollectibleTypes(): ReadonlySet<CollectibleType>;
|
|
14089
14306
|
/**
|
|
@@ -14097,6 +14314,8 @@ declare class ModdedElementSets extends Feature {
|
|
|
14097
14314
|
* order).
|
|
14098
14315
|
*
|
|
14099
14316
|
* In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
|
|
14317
|
+
*
|
|
14318
|
+
* @public
|
|
14100
14319
|
*/
|
|
14101
14320
|
getEdenPassiveCollectibleTypes(): ReadonlySet<CollectibleType>;
|
|
14102
14321
|
/**
|
|
@@ -14115,6 +14334,7 @@ declare class ModdedElementSets extends Feature {
|
|
|
14115
14334
|
* `RNG.Next` method will be called. If `undefined` is provided, it will default
|
|
14116
14335
|
* to a random seed.
|
|
14117
14336
|
* @param exceptions Optional. An array of runes to not select.
|
|
14337
|
+
* @public
|
|
14118
14338
|
*/
|
|
14119
14339
|
getRandomEdenActiveCollectibleType(seedOrRNG: Seed | RNG | undefined, exceptions?: CollectibleType[] | readonly CollectibleType[]): CollectibleType;
|
|
14120
14340
|
/**
|
|
@@ -14134,6 +14354,7 @@ declare class ModdedElementSets extends Feature {
|
|
|
14134
14354
|
* `RNG.Next` method will be called. If `undefined` is provided, it will default
|
|
14135
14355
|
* to a random seed.
|
|
14136
14356
|
* @param exceptions Optional. An array of runes to not select.
|
|
14357
|
+
* @public
|
|
14137
14358
|
*/
|
|
14138
14359
|
getRandomEdenPassiveCollectibleType(seedOrRNG: Seed | RNG | undefined, exceptions?: CollectibleType[] | readonly CollectibleType[]): CollectibleType;
|
|
14139
14360
|
/**
|
|
@@ -14144,6 +14365,8 @@ declare class ModdedElementSets extends Feature {
|
|
|
14144
14365
|
* order).
|
|
14145
14366
|
*
|
|
14146
14367
|
* In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
|
|
14368
|
+
*
|
|
14369
|
+
* @public
|
|
14147
14370
|
*/
|
|
14148
14371
|
getCollectibleTypesOfQuality(quality: Quality): ReadonlySet<CollectibleType>;
|
|
14149
14372
|
/**
|
|
@@ -14154,6 +14377,8 @@ declare class ModdedElementSets extends Feature {
|
|
|
14154
14377
|
* order).
|
|
14155
14378
|
*
|
|
14156
14379
|
* In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
|
|
14380
|
+
*
|
|
14381
|
+
* @public
|
|
14157
14382
|
*/
|
|
14158
14383
|
getPlayerCollectiblesOfQuality(player: EntityPlayer, quality: Quality): CollectibleType[];
|
|
14159
14384
|
/**
|
|
@@ -14166,6 +14391,8 @@ declare class ModdedElementSets extends Feature {
|
|
|
14166
14391
|
* not all card types will necessarily be present when a mod first loads (due to mod load order).
|
|
14167
14392
|
*
|
|
14168
14393
|
* In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
|
|
14394
|
+
*
|
|
14395
|
+
* @public
|
|
14169
14396
|
*/
|
|
14170
14397
|
getCardTypesOfType(...itemConfigCardTypes: ItemConfigCardType[]): Set<CardType>;
|
|
14171
14398
|
/**
|
|
@@ -14185,6 +14412,7 @@ declare class ModdedElementSets extends Feature {
|
|
|
14185
14412
|
* `RNG.Next` method will be called. If `undefined` is provided, it will default
|
|
14186
14413
|
* to a random seed.
|
|
14187
14414
|
* @param exceptions Optional. An array of cards to not select.
|
|
14415
|
+
* @public
|
|
14188
14416
|
*/
|
|
14189
14417
|
getRandomCardTypeOfType(itemConfigCardType: ItemConfigCardType, seedOrRNG: Seed | RNG | undefined, exceptions?: CardType[]): CardType;
|
|
14190
14418
|
/**
|
|
@@ -14206,6 +14434,7 @@ declare class ModdedElementSets extends Feature {
|
|
|
14206
14434
|
* `RNG.Next` method will be called. If `undefined` is provided, it will default
|
|
14207
14435
|
* to a random seed.
|
|
14208
14436
|
* @param exceptions Optional. An array of cards to not select.
|
|
14437
|
+
* @public
|
|
14209
14438
|
*/
|
|
14210
14439
|
getRandomCard(seedOrRNG: Seed | RNG | undefined, exceptions?: CardType[]): CardType;
|
|
14211
14440
|
/**
|
|
@@ -14224,6 +14453,7 @@ declare class ModdedElementSets extends Feature {
|
|
|
14224
14453
|
* `RNG.Next` method will be called. If `undefined` is provided, it will default
|
|
14225
14454
|
* to a random seed.
|
|
14226
14455
|
* @param exceptions Optional. An array of runes to not select.
|
|
14456
|
+
* @public
|
|
14227
14457
|
*/
|
|
14228
14458
|
getRandomRune(seedOrRNG: Seed | RNG | undefined, exceptions?: CardType[]): CardType;
|
|
14229
14459
|
}
|
|
@@ -14602,6 +14832,7 @@ declare class NoSirenSteal extends Feature {
|
|
|
14602
14832
|
* @param familiarVariant The familiar variant to blacklist.
|
|
14603
14833
|
* @param familiarSubType The sub-type to blacklist. Optional. The default is to blacklist all
|
|
14604
14834
|
* sub-types of the given variant.
|
|
14835
|
+
* @public
|
|
14605
14836
|
*/
|
|
14606
14837
|
setFamiliarNoSirenSteal(familiarVariant: FamiliarVariant, familiarSubType?: int): void;
|
|
14607
14838
|
}
|
|
@@ -14895,6 +15126,12 @@ declare class Pause extends Feature {
|
|
|
14895
15126
|
private readonly postUpdate;
|
|
14896
15127
|
private stopTearsAndProjectilesFromMoving;
|
|
14897
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
|
+
*/
|
|
14898
15135
|
isPaused(): boolean;
|
|
14899
15136
|
/**
|
|
14900
15137
|
* Helper function to emulate what happens when the player pauses the game. Use the `unpause`
|
|
@@ -14906,12 +15143,16 @@ declare class Pause extends Feature {
|
|
|
14906
15143
|
* `ButtonAction.CONSOLE`)
|
|
14907
15144
|
*
|
|
14908
15145
|
* In order to use this function, you must upgrade your mod with `ISCFeature.PAUSE`.
|
|
15146
|
+
*
|
|
15147
|
+
* @public
|
|
14909
15148
|
*/
|
|
14910
15149
|
pause(): void;
|
|
14911
15150
|
/**
|
|
14912
15151
|
* Helper function to put things back to normal after the `pause` function was used.
|
|
14913
15152
|
*
|
|
14914
15153
|
* In order to use this function, you must upgrade your mod with `ISCFeature.PAUSE`.
|
|
15154
|
+
*
|
|
15155
|
+
* @public
|
|
14915
15156
|
*/
|
|
14916
15157
|
unpause(): void;
|
|
14917
15158
|
}
|
|
@@ -14937,6 +15178,7 @@ declare class PersistentEntities extends Feature {
|
|
|
14937
15178
|
* @param removeEntity Optional. True by default. Set to false if you want to stop an entity from
|
|
14938
15179
|
* being persistent but you don't want to actually remove the
|
|
14939
15180
|
* currently-spawned entity from the room.
|
|
15181
|
+
* @public
|
|
14940
15182
|
*/
|
|
14941
15183
|
removePersistentEntity(persistentEntityIndex: int, removeEntity?: boolean): void;
|
|
14942
15184
|
/**
|
|
@@ -14956,6 +15198,7 @@ declare class PersistentEntities extends Feature {
|
|
|
14956
15198
|
*
|
|
14957
15199
|
* @returns An object containing the entity and the persistent entity index. You can use the index
|
|
14958
15200
|
* with the `removePersistentEntity` function.
|
|
15201
|
+
* @public
|
|
14959
15202
|
*/
|
|
14960
15203
|
spawnPersistentEntity(entityType: EntityType, variant: int, subType: int, position: Vector): {
|
|
14961
15204
|
entity: Entity;
|
|
@@ -15148,6 +15391,7 @@ declare class PlayerCollectibleTracking extends Feature {
|
|
|
15148
15391
|
* @param player The player to get the collectible types for.
|
|
15149
15392
|
* @param includeActiveCollectibles Optional. If true, will include all active collectibles.
|
|
15150
15393
|
* Default is true.
|
|
15394
|
+
* @public
|
|
15151
15395
|
*/
|
|
15152
15396
|
getPlayerCollectibleTypes(player: EntityPlayer, includeActiveCollectibles?: boolean): readonly CollectibleType[];
|
|
15153
15397
|
/**
|
|
@@ -15158,6 +15402,8 @@ declare class PlayerCollectibleTracking extends Feature {
|
|
|
15158
15402
|
*
|
|
15159
15403
|
* In order to use this function, you must upgrade your mod with
|
|
15160
15404
|
* `ISCFeature.PLAYER_COLLECTIBLE_TRACKING`.
|
|
15405
|
+
*
|
|
15406
|
+
* @public
|
|
15161
15407
|
*/
|
|
15162
15408
|
getPlayerLastPassiveCollectibleType(player: EntityPlayer): CollectibleType | undefined;
|
|
15163
15409
|
}
|
|
@@ -15313,6 +15559,8 @@ declare class PonyDetection extends Feature {
|
|
|
15313
15559
|
* Detecting this is difficult, as the temporary effect will disappear upon entering a new room.
|
|
15314
15560
|
*
|
|
15315
15561
|
* In order to use this function, you must upgrade your mod with `ISCFeature.PONY_DETECTION`.
|
|
15562
|
+
*
|
|
15563
|
+
* @public
|
|
15316
15564
|
*/
|
|
15317
15565
|
isPlayerUsingPony(player: EntityPlayer): boolean;
|
|
15318
15566
|
/**
|
|
@@ -15320,6 +15568,8 @@ declare class PonyDetection extends Feature {
|
|
|
15320
15568
|
* Detecting this is difficult, as the temporary effect will disappear upon entering a new room.
|
|
15321
15569
|
*
|
|
15322
15570
|
* In order to use this function, you must upgrade your mod with `ISCFeature.PONY_DETECTION`.
|
|
15571
|
+
*
|
|
15572
|
+
* @public
|
|
15323
15573
|
*/
|
|
15324
15574
|
anyPlayerUsingPony(): boolean;
|
|
15325
15575
|
}
|
|
@@ -15515,6 +15765,8 @@ declare class PreventChildEntities extends Feature {
|
|
|
15515
15765
|
*
|
|
15516
15766
|
* In order to use this function, you must upgrade your mod with
|
|
15517
15767
|
* `ISCFeature.PREVENT_CHILD_ENTITIES`.
|
|
15768
|
+
*
|
|
15769
|
+
* @public
|
|
15518
15770
|
*/
|
|
15519
15771
|
preventChildEntities(entity: Entity): void;
|
|
15520
15772
|
}
|
|
@@ -16358,14 +16610,33 @@ declare class RoomClearFrame extends Feature {
|
|
|
16358
16610
|
* Helper function to get the game frame (i.e. `Game.GetFrameCount`) of the last time that this
|
|
16359
16611
|
* room was cleared. Returns undefined if the room has never been cleared.
|
|
16360
16612
|
*
|
|
16613
|
+
* Note that if the room is left, all room clear tracking for it will be discarded.
|
|
16614
|
+
*
|
|
16361
16615
|
* In order to use this function, you must upgrade your mod with `ISCFeature.ROOM_CLEAR_FRAME`.
|
|
16616
|
+
*
|
|
16617
|
+
* @public
|
|
16362
16618
|
*/
|
|
16363
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;
|
|
16364
16631
|
/**
|
|
16365
16632
|
* Helper function to get the room frame (i.e. `Room.GetFrameCount`) of the last time that this
|
|
16366
16633
|
* room was cleared. Returns undefined if the room has never been cleared.
|
|
16367
16634
|
*
|
|
16635
|
+
* Note that if the room is left, all room clear tracking for it will be discarded.
|
|
16636
|
+
*
|
|
16368
16637
|
* In order to use this function, you must upgrade your mod with `ISCFeature.ROOM_CLEAR_FRAME`.
|
|
16638
|
+
*
|
|
16639
|
+
* @public
|
|
16369
16640
|
*/
|
|
16370
16641
|
getRoomClearRoomFrame(): int | undefined;
|
|
16371
16642
|
}
|
|
@@ -16411,6 +16682,8 @@ declare class RoomHistory extends Feature {
|
|
|
16411
16682
|
* Helper function to manually delete the last room description from the internal array. This is
|
|
16412
16683
|
* useful if a mod needs to send the player to a room temporarily and the room should not count as
|
|
16413
16684
|
* the player having traveled to that room.
|
|
16685
|
+
*
|
|
16686
|
+
* @public
|
|
16414
16687
|
*/
|
|
16415
16688
|
deleteLastRoomDescription(): void;
|
|
16416
16689
|
/**
|
|
@@ -16418,6 +16691,8 @@ declare class RoomHistory extends Feature {
|
|
|
16418
16691
|
* run. (Re-entering the same room will increment the number returned.)
|
|
16419
16692
|
*
|
|
16420
16693
|
* In order to use this function, you must upgrade your mod with `ISCFeature.ROOM_HISTORY`.
|
|
16694
|
+
*
|
|
16695
|
+
* @public
|
|
16421
16696
|
*/
|
|
16422
16697
|
getNumRoomsEntered(): int;
|
|
16423
16698
|
/**
|
|
@@ -16425,6 +16700,8 @@ declare class RoomHistory extends Feature {
|
|
|
16425
16700
|
* this run.
|
|
16426
16701
|
*
|
|
16427
16702
|
* In order to use this function, you must upgrade your mod with `ISCFeature.ROOM_HISTORY`.
|
|
16703
|
+
*
|
|
16704
|
+
* @public
|
|
16428
16705
|
*/
|
|
16429
16706
|
getRoomHistory(): ReadonlyArray<Readonly<RoomDescription>>;
|
|
16430
16707
|
/**
|
|
@@ -16434,6 +16711,8 @@ declare class RoomHistory extends Feature {
|
|
|
16434
16711
|
* the run), the starting room will be returned.
|
|
16435
16712
|
*
|
|
16436
16713
|
* In order to use this function, you must upgrade your mod with `ISCFeature.ROOM_HISTORY`.
|
|
16714
|
+
*
|
|
16715
|
+
* @public
|
|
16437
16716
|
*/
|
|
16438
16717
|
getPreviousRoomDescription(): Readonly<RoomDescription>;
|
|
16439
16718
|
/**
|
|
@@ -16446,9 +16725,15 @@ declare class RoomHistory extends Feature {
|
|
|
16446
16725
|
* of the run.
|
|
16447
16726
|
*
|
|
16448
16727
|
* In order to use this function, you must upgrade your mod with `ISCFeature.ROOM_HISTORY`.
|
|
16728
|
+
*
|
|
16729
|
+
* @public
|
|
16449
16730
|
*/
|
|
16450
16731
|
getLatestRoomDescription(): Readonly<RoomDescription> | undefined;
|
|
16451
|
-
/**
|
|
16732
|
+
/**
|
|
16733
|
+
* Helper function to detect if the player is on the first room of the room.
|
|
16734
|
+
*
|
|
16735
|
+
* @public
|
|
16736
|
+
*/
|
|
16452
16737
|
inFirstRoom(): boolean;
|
|
16453
16738
|
/**
|
|
16454
16739
|
* Helper function to detect if the game is in the state where the room index has changed to a new
|
|
@@ -16460,6 +16745,8 @@ declare class RoomHistory extends Feature {
|
|
|
16460
16745
|
* entity is despawning.
|
|
16461
16746
|
*
|
|
16462
16747
|
* In order to use this function, you must upgrade your mod with `ISCFeature.ROOM_HISTORY`.
|
|
16748
|
+
*
|
|
16749
|
+
* @public
|
|
16463
16750
|
*/
|
|
16464
16751
|
isLeavingRoom(): boolean;
|
|
16465
16752
|
}
|
|
@@ -16499,9 +16786,10 @@ declare class RunInNFrames extends Feature {
|
|
|
16499
16786
|
* the game inside of the `POST_NEW_ROOM`, `POST_NEW_LEVEL`, or `POST_GAME_STARTED` callbacks when
|
|
16500
16787
|
* a run is first starting.
|
|
16501
16788
|
*
|
|
16502
|
-
* You can optionally specify a `PlayerType` to restart the game as that character.
|
|
16503
|
-
*
|
|
16504
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
|
|
16505
16793
|
*/
|
|
16506
16794
|
restartNextRenderFrame(character?: PlayerType): void;
|
|
16507
16795
|
/**
|
|
@@ -16520,6 +16808,7 @@ declare class RunInNFrames extends Feature {
|
|
|
16520
16808
|
* @param numGameFrames The amount of game frames to wait before running the function.
|
|
16521
16809
|
* @param cancelIfRoomChanges Optional. Whether to cancel running the function if a new room is
|
|
16522
16810
|
* loaded in the interim. Default is false.
|
|
16811
|
+
* @public
|
|
16523
16812
|
*/
|
|
16524
16813
|
runInNGameFrames(func: () => void, numGameFrames: int, cancelIfRoomChanges?: boolean): void;
|
|
16525
16814
|
/**
|
|
@@ -16538,6 +16827,7 @@ declare class RunInNFrames extends Feature {
|
|
|
16538
16827
|
* @param numRenderFrames The amount of render frames to wait before running the function.
|
|
16539
16828
|
* @param cancelIfRoomChanges Optional. Whether to cancel running the function if a new room is
|
|
16540
16829
|
* loaded in the interim. Default is false.
|
|
16830
|
+
* @public
|
|
16541
16831
|
*/
|
|
16542
16832
|
runInNRenderFrames(func: () => void, numRenderFrames: int, cancelIfRoomChanges?: boolean): void;
|
|
16543
16833
|
/**
|
|
@@ -16573,6 +16863,7 @@ declare class RunInNFrames extends Feature {
|
|
|
16573
16863
|
* @param func The function to run.
|
|
16574
16864
|
* @param cancelIfRoomChanges Optional. Whether to cancel running the function if a new room is
|
|
16575
16865
|
* loaded in the interim. Default is false.
|
|
16866
|
+
* @public
|
|
16576
16867
|
*/
|
|
16577
16868
|
runNextGameFrame(func: () => void, cancelIfRoomChanges?: boolean): void;
|
|
16578
16869
|
/**
|
|
@@ -16588,6 +16879,7 @@ declare class RunInNFrames extends Feature {
|
|
|
16588
16879
|
* @param func The function to run.
|
|
16589
16880
|
* @param cancelIfRoomChanges Optional. Whether to cancel running the function if a new room is
|
|
16590
16881
|
* loaded in the interim. Default is false.
|
|
16882
|
+
* @public
|
|
16591
16883
|
*/
|
|
16592
16884
|
runNextRenderFrame(func: () => void, cancelIfRoomChanges?: boolean): void;
|
|
16593
16885
|
/**
|
|
@@ -16609,6 +16901,7 @@ declare class RunInNFrames extends Feature {
|
|
|
16609
16901
|
* interval.
|
|
16610
16902
|
* @param cancelIfRoomChanges Optional. Whether to cancel running the function if a new room is
|
|
16611
16903
|
* loaded in the interim. Default is false.
|
|
16904
|
+
* @public
|
|
16612
16905
|
*/
|
|
16613
16906
|
setIntervalGameFrames(func: () => boolean, numGameFrames: int, runImmediately: boolean, cancelIfRoomChanges?: boolean): void;
|
|
16614
16907
|
/**
|
|
@@ -16630,6 +16923,7 @@ declare class RunInNFrames extends Feature {
|
|
|
16630
16923
|
* interval.
|
|
16631
16924
|
* @param cancelIfRoomChanges Optional. Whether to cancel running the function if a new room is
|
|
16632
16925
|
* loaded in the interim. Default is false.
|
|
16926
|
+
* @public
|
|
16633
16927
|
*/
|
|
16634
16928
|
setIntervalRenderFrames(func: () => boolean, numRenderFrames: int, runImmediately: boolean, cancelIfRoomChanges?: boolean): void;
|
|
16635
16929
|
}
|
|
@@ -16667,6 +16961,8 @@ declare class RunNextRun extends Feature {
|
|
|
16667
16961
|
* deferred functions manually using serializable data.
|
|
16668
16962
|
*
|
|
16669
16963
|
* In order to use this function, you must upgrade your mod with `ISCFeature.RUN_NEXT_ROOM`.
|
|
16964
|
+
*
|
|
16965
|
+
* @public
|
|
16670
16966
|
*/
|
|
16671
16967
|
runNextRun(func: () => void): void;
|
|
16672
16968
|
}
|
|
@@ -16852,6 +17148,7 @@ declare class SaveDataManager extends Feature {
|
|
|
16852
17148
|
* specify `false` to this argument in order to completely disable saving
|
|
16853
17149
|
* data. (Specifying `false` will allow you to use non-serializable objects
|
|
16854
17150
|
* in your save data, such as `EntityPtr`.
|
|
17151
|
+
* @public
|
|
16855
17152
|
*/
|
|
16856
17153
|
saveDataManager<Persistent, Run, Level>(key: string | object, v: SaveData<Persistent, Run, Level>, conditionalFunc?: () => boolean): void;
|
|
16857
17154
|
saveDataManager(key: string | object, v: SaveData, conditionalFunc: false): void;
|
|
@@ -16868,6 +17165,8 @@ declare class SaveDataManager extends Feature {
|
|
|
16868
17165
|
* result in lost state.
|
|
16869
17166
|
*
|
|
16870
17167
|
* In order to use this function, you must upgrade your mod with `ISCFeature.SAVE_DATA_MANAGER`.
|
|
17168
|
+
*
|
|
17169
|
+
* @public
|
|
16871
17170
|
*/
|
|
16872
17171
|
saveDataManagerLoad(): void;
|
|
16873
17172
|
/**
|
|
@@ -16876,6 +17175,8 @@ declare class SaveDataManager extends Feature {
|
|
|
16876
17175
|
* all of its variables to disk immediately.
|
|
16877
17176
|
*
|
|
16878
17177
|
* In order to use this function, you must upgrade your mod with `ISCFeature.SAVE_DATA_MANAGER`.
|
|
17178
|
+
*
|
|
17179
|
+
* @public
|
|
16879
17180
|
*/
|
|
16880
17181
|
saveDataManagerSave(): void;
|
|
16881
17182
|
/**
|
|
@@ -16885,6 +17186,8 @@ declare class SaveDataManager extends Feature {
|
|
|
16885
17186
|
* e.g. `l print(g.feature1.run.foo)`
|
|
16886
17187
|
*
|
|
16887
17188
|
* In order to use this function, you must upgrade your mod with `ISCFeature.SAVE_DATA_MANAGER`.
|
|
17189
|
+
*
|
|
17190
|
+
* @public
|
|
16888
17191
|
*/
|
|
16889
17192
|
saveDataManagerSetGlobal(): void;
|
|
16890
17193
|
/**
|
|
@@ -16898,6 +17201,8 @@ declare class SaveDataManager extends Feature {
|
|
|
16898
17201
|
* This function is variadic, which means you can pass as many classes as you want to register.
|
|
16899
17202
|
*
|
|
16900
17203
|
* In order to use this function, you must upgrade your mod with `ISCFeature.SAVE_DATA_MANAGER`.
|
|
17204
|
+
*
|
|
17205
|
+
* @public
|
|
16901
17206
|
*/
|
|
16902
17207
|
saveDataManagerRegisterClass(...tstlClasses: AnyClass[]): void;
|
|
16903
17208
|
/**
|
|
@@ -16905,6 +17210,8 @@ declare class SaveDataManager extends Feature {
|
|
|
16905
17210
|
* "saveDataManager" method.
|
|
16906
17211
|
*
|
|
16907
17212
|
* In order to use this function, you must upgrade your mod with `ISCFeature.SAVE_DATA_MANAGER`.
|
|
17213
|
+
*
|
|
17214
|
+
* @public
|
|
16908
17215
|
*/
|
|
16909
17216
|
saveDataManagerRemove(key: string): void;
|
|
16910
17217
|
/**
|
|
@@ -16928,6 +17235,8 @@ declare class SaveDataManager extends Feature {
|
|
|
16928
17235
|
* ```
|
|
16929
17236
|
*
|
|
16930
17237
|
* In order to use this function, you must upgrade your mod with `ISCFeature.SAVE_DATA_MANAGER`.
|
|
17238
|
+
*
|
|
17239
|
+
* @public
|
|
16931
17240
|
*/
|
|
16932
17241
|
saveDataManagerReset(key: string, childObjectKey: SaveDataKey): void;
|
|
16933
17242
|
/**
|
|
@@ -16942,8 +17251,16 @@ declare class SaveDataManager extends Feature {
|
|
|
16942
17251
|
* explicitly call the `saveDataManagerSave` function.
|
|
16943
17252
|
*
|
|
16944
17253
|
* In order to use this function, you must upgrade your mod with `ISCFeature.SAVE_DATA_MANAGER`.
|
|
17254
|
+
*
|
|
17255
|
+
* @public
|
|
16945
17256
|
*/
|
|
16946
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
|
+
*/
|
|
16947
17264
|
saveDataManagerLogSubscribers(): void;
|
|
16948
17265
|
}
|
|
16949
17266
|
|
|
@@ -18043,6 +18360,7 @@ declare class SpawnRockAltRewards extends Feature {
|
|
|
18043
18360
|
* `RNG.Next` method will be called. If `undefined` is provided, it will default
|
|
18044
18361
|
* to a random seed.
|
|
18045
18362
|
* @returns Whether this function spawned something.
|
|
18363
|
+
* @public
|
|
18046
18364
|
*/
|
|
18047
18365
|
spawnRockAltReward(positionOrGridIndex: Vector | int, rockAltType: RockAltType, seedOrRNG: Seed | RNG | undefined): boolean;
|
|
18048
18366
|
/**
|
|
@@ -18228,6 +18546,7 @@ declare class StageHistory extends Feature {
|
|
|
18228
18546
|
*
|
|
18229
18547
|
* @param upwards Whether the player should go up to Cathedral in the case of being on Womb 2.
|
|
18230
18548
|
* Default is false.
|
|
18549
|
+
* @public
|
|
18231
18550
|
*/
|
|
18232
18551
|
getNextStageTypeWithHistory(upwards?: boolean): StageType;
|
|
18233
18552
|
/**
|
|
@@ -18245,6 +18564,8 @@ declare class StageHistory extends Feature {
|
|
|
18245
18564
|
* Helper function to get all of the stages that a player has visited thus far on this run.
|
|
18246
18565
|
*
|
|
18247
18566
|
* In order to use this function, you must upgrade your mod with `ISCFeature.STAGE_HISTORY`.
|
|
18567
|
+
*
|
|
18568
|
+
* @public
|
|
18248
18569
|
*/
|
|
18249
18570
|
getStageHistory(): readonly StageHistoryEntry[];
|
|
18250
18571
|
/**
|
|
@@ -18283,6 +18604,8 @@ declare class StartAmbush extends Feature {
|
|
|
18283
18604
|
* and then removing the sack and the pickups that the sack dropped.
|
|
18284
18605
|
*
|
|
18285
18606
|
* In order to use this function, you must upgrade your mod with `ISCFeature.START_AMBUSH`.
|
|
18607
|
+
*
|
|
18608
|
+
* @public
|
|
18286
18609
|
*/
|
|
18287
18610
|
startAmbush(): void;
|
|
18288
18611
|
}
|
|
@@ -18376,6 +18699,8 @@ declare class TaintedLazarusPlayers extends Feature {
|
|
|
18376
18699
|
*
|
|
18377
18700
|
* In order to use this function, you must upgrade your mod with
|
|
18378
18701
|
* `ISCFeature.CHARACTER_HEALTH_CONVERSION`.
|
|
18702
|
+
*
|
|
18703
|
+
* @public
|
|
18379
18704
|
*/
|
|
18380
18705
|
getTaintedLazarusSubPlayer(player: EntityPlayer): EntityPlayer | undefined;
|
|
18381
18706
|
}
|
|
@@ -18577,6 +18902,8 @@ declare class UnlockAchievementsDetection extends Feature {
|
|
|
18577
18902
|
*
|
|
18578
18903
|
* In order to use this function, you must upgrade your mod with
|
|
18579
18904
|
* `ISCFeature.UNLOCK_ACHIEVEMENTS_DETECTION`.
|
|
18905
|
+
*
|
|
18906
|
+
* @public
|
|
18580
18907
|
*/
|
|
18581
18908
|
canRunUnlockAchievements(): boolean;
|
|
18582
18909
|
}
|