isaacscript-common 76.2.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.
Files changed (121) hide show
  1. package/dist/classes/features/callbackLogic/CustomGridEntities.d.ts +8 -0
  2. package/dist/classes/features/callbackLogic/CustomGridEntities.d.ts.map +1 -1
  3. package/dist/classes/features/callbackLogic/GameReorderedCallbacks.d.ts +6 -0
  4. package/dist/classes/features/callbackLogic/GameReorderedCallbacks.d.ts.map +1 -1
  5. package/dist/classes/features/other/CharacterHealthConversion.d.ts +2 -0
  6. package/dist/classes/features/other/CharacterHealthConversion.d.ts.map +1 -1
  7. package/dist/classes/features/other/CharacterStats.d.ts +2 -0
  8. package/dist/classes/features/other/CharacterStats.d.ts.map +1 -1
  9. package/dist/classes/features/other/CollectibleItemPoolType.d.ts +2 -0
  10. package/dist/classes/features/other/CollectibleItemPoolType.d.ts.map +1 -1
  11. package/dist/classes/features/other/CustomHotkeys.d.ts +4 -0
  12. package/dist/classes/features/other/CustomHotkeys.d.ts.map +1 -1
  13. package/dist/classes/features/other/CustomItemPools.d.ts +2 -0
  14. package/dist/classes/features/other/CustomItemPools.d.ts.map +1 -1
  15. package/dist/classes/features/other/CustomPickups.d.ts +1 -0
  16. package/dist/classes/features/other/CustomPickups.d.ts.map +1 -1
  17. package/dist/classes/features/other/CustomStages.d.ts +3 -0
  18. package/dist/classes/features/other/CustomStages.d.ts.map +1 -1
  19. package/dist/classes/features/other/DebugDisplay.d.ts +54 -0
  20. package/dist/classes/features/other/DebugDisplay.d.ts.map +1 -1
  21. package/dist/classes/features/other/DeployJSONRoom.d.ts +1 -0
  22. package/dist/classes/features/other/DeployJSONRoom.d.ts.map +1 -1
  23. package/dist/classes/features/other/DisableInputs.d.ts +9 -0
  24. package/dist/classes/features/other/DisableInputs.d.ts.map +1 -1
  25. package/dist/classes/features/other/EdenStartingStatsHealth.d.ts +6 -0
  26. package/dist/classes/features/other/EdenStartingStatsHealth.d.ts.map +1 -1
  27. package/dist/classes/features/other/ExtraConsoleCommands.d.ts +6 -0
  28. package/dist/classes/features/other/ExtraConsoleCommands.d.ts.map +1 -1
  29. package/dist/classes/features/other/FadeInRemover.d.ts +4 -0
  30. package/dist/classes/features/other/FadeInRemover.d.ts.map +1 -1
  31. package/dist/classes/features/other/FastReset.d.ts +4 -0
  32. package/dist/classes/features/other/FastReset.d.ts.map +1 -1
  33. package/dist/classes/features/other/FlyingDetection.d.ts +2 -0
  34. package/dist/classes/features/other/FlyingDetection.d.ts.map +1 -1
  35. package/dist/classes/features/other/ForgottenSwitch.d.ts +2 -0
  36. package/dist/classes/features/other/ForgottenSwitch.d.ts.map +1 -1
  37. package/dist/classes/features/other/ItemPoolDetection.d.ts +6 -0
  38. package/dist/classes/features/other/ItemPoolDetection.d.ts.map +1 -1
  39. package/dist/classes/features/other/ModdedElementDetection.d.ts +32 -0
  40. package/dist/classes/features/other/ModdedElementDetection.d.ts.map +1 -1
  41. package/dist/classes/features/other/ModdedElementSets.d.ts +68 -0
  42. package/dist/classes/features/other/ModdedElementSets.d.ts.map +1 -1
  43. package/dist/classes/features/other/NoSirenSteal.d.ts +1 -0
  44. package/dist/classes/features/other/NoSirenSteal.d.ts.map +1 -1
  45. package/dist/classes/features/other/Pause.d.ts +10 -0
  46. package/dist/classes/features/other/Pause.d.ts.map +1 -1
  47. package/dist/classes/features/other/PersistentEntities.d.ts +2 -0
  48. package/dist/classes/features/other/PersistentEntities.d.ts.map +1 -1
  49. package/dist/classes/features/other/PlayerCollectibleTracking.d.ts +3 -0
  50. package/dist/classes/features/other/PlayerCollectibleTracking.d.ts.map +1 -1
  51. package/dist/classes/features/other/PonyDetection.d.ts +4 -0
  52. package/dist/classes/features/other/PonyDetection.d.ts.map +1 -1
  53. package/dist/classes/features/other/PreventChildEntities.d.ts +2 -0
  54. package/dist/classes/features/other/PreventChildEntities.d.ts.map +1 -1
  55. package/dist/classes/features/other/RoomClearFrame.d.ts +19 -0
  56. package/dist/classes/features/other/RoomClearFrame.d.ts.map +1 -1
  57. package/dist/classes/features/other/RoomClearFrame.lua +8 -2
  58. package/dist/classes/features/other/RoomHistory.d.ts +17 -1
  59. package/dist/classes/features/other/RoomHistory.d.ts.map +1 -1
  60. package/dist/classes/features/other/RunInNFrames.d.ts +9 -2
  61. package/dist/classes/features/other/RunInNFrames.d.ts.map +1 -1
  62. package/dist/classes/features/other/RunNextRun.d.ts +2 -0
  63. package/dist/classes/features/other/RunNextRun.d.ts.map +1 -1
  64. package/dist/classes/features/other/SaveDataManager.d.ts +21 -0
  65. package/dist/classes/features/other/SaveDataManager.d.ts.map +1 -1
  66. package/dist/classes/features/other/SpawnRockAltRewards.d.ts +1 -0
  67. package/dist/classes/features/other/SpawnRockAltRewards.d.ts.map +1 -1
  68. package/dist/classes/features/other/StageHistory.d.ts +3 -0
  69. package/dist/classes/features/other/StageHistory.d.ts.map +1 -1
  70. package/dist/classes/features/other/StartAmbush.d.ts +2 -0
  71. package/dist/classes/features/other/StartAmbush.d.ts.map +1 -1
  72. package/dist/classes/features/other/TaintedLazarusPlayers.d.ts +2 -0
  73. package/dist/classes/features/other/TaintedLazarusPlayers.d.ts.map +1 -1
  74. package/dist/classes/features/other/UnlockAchievementsDetection.d.ts +2 -0
  75. package/dist/classes/features/other/UnlockAchievementsDetection.d.ts.map +1 -1
  76. package/dist/classes/private/CustomCallback.d.ts +0 -1
  77. package/dist/classes/private/CustomCallback.d.ts.map +1 -1
  78. package/dist/classes/private/CustomCallback.lua +0 -19
  79. package/dist/functions/players.d.ts.map +1 -1
  80. package/dist/functions/players.lua +7 -7
  81. package/dist/index.rollup.d.ts +324 -4
  82. package/dist/isaacscript-common.lua +370 -383
  83. package/package.json +1 -1
  84. package/src/classes/features/callbackLogic/CustomGridEntities.ts +8 -0
  85. package/src/classes/features/callbackLogic/GameReorderedCallbacks.ts +6 -0
  86. package/src/classes/features/other/CharacterHealthConversion.ts +2 -0
  87. package/src/classes/features/other/CharacterStats.ts +2 -0
  88. package/src/classes/features/other/CollectibleItemPoolType.ts +2 -0
  89. package/src/classes/features/other/CustomHotkeys.ts +4 -0
  90. package/src/classes/features/other/CustomItemPools.ts +2 -0
  91. package/src/classes/features/other/CustomPickups.ts +1 -0
  92. package/src/classes/features/other/CustomStages.ts +3 -0
  93. package/src/classes/features/other/DebugDisplay.ts +54 -0
  94. package/src/classes/features/other/DeployJSONRoom.ts +1 -0
  95. package/src/classes/features/other/DisableInputs.ts +9 -0
  96. package/src/classes/features/other/EdenStartingStatsHealth.ts +6 -0
  97. package/src/classes/features/other/ExtraConsoleCommands.ts +6 -0
  98. package/src/classes/features/other/FadeInRemover.ts +4 -0
  99. package/src/classes/features/other/FastReset.ts +4 -0
  100. package/src/classes/features/other/FlyingDetection.ts +2 -0
  101. package/src/classes/features/other/ForgottenSwitch.ts +2 -0
  102. package/src/classes/features/other/ItemPoolDetection.ts +6 -0
  103. package/src/classes/features/other/ModdedElementDetection.ts +32 -0
  104. package/src/classes/features/other/ModdedElementSets.ts +68 -0
  105. package/src/classes/features/other/NoSirenSteal.ts +1 -0
  106. package/src/classes/features/other/Pause.ts +10 -0
  107. package/src/classes/features/other/PersistentEntities.ts +2 -0
  108. package/src/classes/features/other/PlayerCollectibleTracking.ts +3 -0
  109. package/src/classes/features/other/PonyDetection.ts +4 -0
  110. package/src/classes/features/other/PreventChildEntities.ts +2 -0
  111. package/src/classes/features/other/RoomClearFrame.ts +27 -1
  112. package/src/classes/features/other/RoomHistory.ts +17 -1
  113. package/src/classes/features/other/RunInNFrames.ts +9 -2
  114. package/src/classes/features/other/RunNextRun.ts +2 -0
  115. package/src/classes/features/other/SaveDataManager.ts +21 -0
  116. package/src/classes/features/other/SpawnRockAltRewards.ts +1 -0
  117. package/src/classes/features/other/StageHistory.ts +3 -0
  118. package/src/classes/features/other/StartAmbush.ts +2 -0
  119. package/src/classes/features/other/TaintedLazarusPlayers.ts +2 -0
  120. package/src/classes/features/other/UnlockAchievementsDetection.ts +2 -0
  121. package/src/classes/private/CustomCallback.ts +0 -15
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "isaacscript-common",
3
- "version": "76.2.0",
3
+ "version": "76.3.0",
4
4
  "description": "Helper functions and features for IsaacScript mods.",
5
5
  "keywords": [
6
6
  "isaac",
@@ -224,6 +224,7 @@ export class CustomGridEntities extends Feature {
224
224
  * custom grid entity. Default is `GridEntityType.DECORATION`.
225
225
  * @param baseGridEntityVariant Optional. The variant of the grid entity to use as a "base" for
226
226
  * this custom grid entity. Default is 0.
227
+ * @public
227
228
  */
228
229
  @Exported
229
230
  public spawnCustomGridEntity(
@@ -292,6 +293,7 @@ export class CustomGridEntities extends Feature {
292
293
  * function multiple times.
293
294
  * @returns The grid entity that was removed. Returns undefined if no grid entity was found at the
294
295
  * given location or if the given grid entity was not a custom grid entity.
296
+ * @public
295
297
  */
296
298
  @Exported
297
299
  public removeCustomGridEntity(
@@ -342,6 +344,8 @@ export class CustomGridEntities extends Feature {
342
344
  *
343
345
  * In order to use this function, you must upgrade your mod with
344
346
  * `ISCFeature.CUSTOM_GRID_ENTITIES`.
347
+ *
348
+ * @public
345
349
  */
346
350
  @Exported
347
351
  public getCustomGridEntities(): Array<{
@@ -377,6 +381,8 @@ export class CustomGridEntities extends Feature {
377
381
  *
378
382
  * In order to use this function, you must upgrade your mod with
379
383
  * `ISCFeature.CUSTOM_GRID_ENTITIES`.
384
+ *
385
+ * @public
380
386
  */
381
387
  @Exported
382
388
  public getCustomGridEntityType(
@@ -412,6 +418,8 @@ export class CustomGridEntities extends Feature {
412
418
  *
413
419
  * In order to use this function, you must upgrade your mod with
414
420
  * `ISCFeature.CUSTOM_GRID_ENTITIES`.
421
+ *
422
+ * @public
415
423
  */
416
424
  @Exported
417
425
  public isCustomGridEntity(gridEntityOrGridIndex: GridEntity | int): boolean {
@@ -198,6 +198,8 @@ export class GameReorderedCallbacks extends Feature {
198
198
  *
199
199
  * In order to use this function, you must upgrade your mod with
200
200
  * `ISCFeature.GAME_REORDERED_CALLBACKS`.
201
+ *
202
+ * @public
201
203
  */
202
204
  @Exported
203
205
  public forceNewLevelCallback(): void {
@@ -216,6 +218,8 @@ export class GameReorderedCallbacks extends Feature {
216
218
  *
217
219
  * In order to use this function, you must upgrade your mod with
218
220
  * `ISCFeature.GAME_REORDERED_CALLBACKS`.
221
+ *
222
+ * @public
219
223
  */
220
224
  @Exported
221
225
  public forceNewRoomCallback(): void {
@@ -231,6 +235,8 @@ export class GameReorderedCallbacks extends Feature {
231
235
  *
232
236
  * In order to use this function, you must upgrade your mod with
233
237
  * `ISCFeature.GAME_REORDERED_CALLBACKS`.
238
+ *
239
+ * @public
234
240
  */
235
241
  @Exported
236
242
  public reorderedCallbacksSetStage(
@@ -85,6 +85,8 @@ export class CharacterHealthConversion extends Feature {
85
85
  *
86
86
  * In order to use this function, you must upgrade your mod with
87
87
  * `ISCFeature.CHARACTER_HEALTH_CONVERSION`.
88
+ *
89
+ * @public
88
90
  */
89
91
  @Exported
90
92
  public registerCharacterHealthConversion(
@@ -59,6 +59,8 @@ export class CharacterStats extends Feature {
59
59
  * not the `MaxFireDelay` format.
60
60
  *
61
61
  * In order to use this function, you must upgrade your mod with `ISCFeature.CHARACTER_STATS`.
62
+ *
63
+ * @public
62
64
  */
63
65
  @Exported
64
66
  public registerCharacterStats(
@@ -61,6 +61,8 @@ export class CollectibleItemPoolType extends Feature {
61
61
  *
62
62
  * In order to use this function, you must upgrade your mod with
63
63
  * `ISCFeature.COLLECTIBLE_ITEM_POOL_TYPE`.
64
+ *
65
+ * @public
64
66
  */
65
67
  @Exported
66
68
  public getCollectibleItemPoolType(collectible: EntityPickup): ItemPoolType {
@@ -73,6 +73,7 @@ export class CustomHotkeys extends Feature {
73
73
  * @param getKeyFunc The function that returns the key that will trigger the hotkey.
74
74
  * @param triggerFunc A function containing the arbitrary code that you want to execute when the
75
75
  * hotkey is triggered.
76
+ * @public
76
77
  */
77
78
  @Exported
78
79
  public setConditionalHotkey(
@@ -101,6 +102,7 @@ export class CustomHotkeys extends Feature {
101
102
  * @param keyboard The key that you want to trigger the hotkey.
102
103
  * @param triggerFunc A function containing the arbitrary code that you want to execute when the
103
104
  * hotkey is triggered.
105
+ * @public
104
106
  */
105
107
  @Exported
106
108
  public setHotkey(keyboard: Keyboard, triggerFunc: () => void): void {
@@ -120,6 +122,7 @@ export class CustomHotkeys extends Feature {
120
122
  *
121
123
  * @param getKeyFunc Equal to the `getKeyFunc` that you passed when initially registering the
122
124
  * hotkey.
125
+ * @public
123
126
  */
124
127
  @Exported
125
128
  public unsetConditionalHotkey(getKeyFunc: () => Keyboard | undefined): void {
@@ -139,6 +142,7 @@ export class CustomHotkeys extends Feature {
139
142
  *
140
143
  * @param keyboard Equal to the keyboard value that you passed when initially registering the
141
144
  * hotkey.
145
+ * @public
142
146
  */
143
147
  @Exported
144
148
  public unsetHotkey(keyboard: Keyboard): void {
@@ -75,6 +75,7 @@ export class CustomItemPools extends Feature {
75
75
  * you are creating. The first element in he tuple is the `CollectibleType`,
76
76
  * and the second element in the tuple is the float that represents the weight
77
77
  * of the collectible.
78
+ * @public
78
79
  */
79
80
  @Exported
80
81
  public registerCustomItemPool(
@@ -111,6 +112,7 @@ export class CustomItemPools extends Feature {
111
112
  * Default is true.
112
113
  * @param defaultItem Optional. The collectible to return if the item pool is depleted. Default is
113
114
  * `CollectibleType.NULL`.
115
+ * @public
114
116
  */
115
117
  @Exported
116
118
  public getCustomItemPoolCollectible(
@@ -132,6 +132,7 @@ export class CustomPickups extends Feature {
132
132
  * will always immediately collect the pickup when they collide with it.
133
133
  * Specify this function if your pickup should only be able to be collected
134
134
  * under certain conditions.
135
+ * @public
135
136
  */
136
137
  @Exported
137
138
  public registerCustomPickup(
@@ -489,6 +489,7 @@ export class CustomStages extends Feature {
489
489
  * announces the name of the level. Default is true.
490
490
  * @param verbose Optional. Whether to log additional information about the rooms that are chosen.
491
491
  * Default is false.
492
+ * @public
492
493
  */
493
494
  @Exported
494
495
  public setCustomStage(
@@ -598,6 +599,8 @@ export class CustomStages extends Feature {
598
599
  * to a vanilla floor.
599
600
  *
600
601
  * In order to use this function, you must upgrade your mod with `ISCFeature.CUSTOM_STAGES`.
602
+ *
603
+ * @public
601
604
  */
602
605
  @Exported
603
606
  public disableCustomStage(): void {
@@ -72,6 +72,8 @@ export class DebugDisplay extends Feature {
72
72
  * ```
73
73
  *
74
74
  * In order to use this function, you must upgrade your mod with `ISCFeature.DEBUG_DISPLAY`.
75
+ *
76
+ * @public
75
77
  */
76
78
  @Exported
77
79
  public setPlayerDisplay(
@@ -89,6 +91,8 @@ export class DebugDisplay extends Feature {
89
91
  * reason, you typically only need to set the function once at the beginning of your mod.
90
92
  *
91
93
  * In order to use this function, you must upgrade your mod with `ISCFeature.DEBUG_DISPLAY`.
94
+ *
95
+ * @public
92
96
  */
93
97
  @Exported
94
98
  public setTearDisplay(textCallback: (tear: EntityTear) => string): void {
@@ -104,6 +108,8 @@ export class DebugDisplay extends Feature {
104
108
  * reason, you typically only need to set the function once at the beginning of your mod.
105
109
  *
106
110
  * In order to use this function, you must upgrade your mod with `ISCFeature.DEBUG_DISPLAY`.
111
+ *
112
+ * @public
107
113
  */
108
114
  @Exported
109
115
  public setFamiliarDisplay(
@@ -121,6 +127,8 @@ export class DebugDisplay extends Feature {
121
127
  * reason, you typically only need to set the function once at the beginning of your mod.
122
128
  *
123
129
  * In order to use this function, you must upgrade your mod with `ISCFeature.DEBUG_DISPLAY`.
130
+ *
131
+ * @public
124
132
  */
125
133
  @Exported
126
134
  public setBombDisplay(textCallback: (bomb: EntityBomb) => string): void {
@@ -136,6 +144,8 @@ export class DebugDisplay extends Feature {
136
144
  * reason, you typically only need to set the function once at the beginning of your mod.
137
145
  *
138
146
  * In order to use this function, you must upgrade your mod with `ISCFeature.DEBUG_DISPLAY`.
147
+ *
148
+ * @public
139
149
  */
140
150
  @Exported
141
151
  public setPickupDisplay(
@@ -153,6 +163,8 @@ export class DebugDisplay extends Feature {
153
163
  * reason, you typically only need to set the function once at the beginning of your mod.
154
164
  *
155
165
  * In order to use this function, you must upgrade your mod with `ISCFeature.DEBUG_DISPLAY`.
166
+ *
167
+ * @public
156
168
  */
157
169
  @Exported
158
170
  public setSlotDisplay(textCallback: (slot: Entity) => string): void {
@@ -168,6 +180,8 @@ export class DebugDisplay extends Feature {
168
180
  * reason, you typically only need to set the function once at the beginning of your mod.
169
181
  *
170
182
  * In order to use this function, you must upgrade your mod with `ISCFeature.DEBUG_DISPLAY`.
183
+ *
184
+ * @public
171
185
  */
172
186
  @Exported
173
187
  public setLaserDisplay(textCallback: (laser: EntityLaser) => string): void {
@@ -183,6 +197,8 @@ export class DebugDisplay extends Feature {
183
197
  * reason, you typically only need to set the function once at the beginning of your mod.
184
198
  *
185
199
  * In order to use this function, you must upgrade your mod with `ISCFeature.DEBUG_DISPLAY`.
200
+ *
201
+ * @public
186
202
  */
187
203
  @Exported
188
204
  public setKnifeDisplay(textCallback: (knife: EntityKnife) => string): void {
@@ -198,6 +214,8 @@ export class DebugDisplay extends Feature {
198
214
  * reason, you typically only need to set the function once at the beginning of your mod.
199
215
  *
200
216
  * In order to use this function, you must upgrade your mod with `ISCFeature.DEBUG_DISPLAY`.
217
+ *
218
+ * @public
201
219
  */
202
220
  @Exported
203
221
  public setProjectileDisplay(
@@ -215,6 +233,8 @@ export class DebugDisplay extends Feature {
215
233
  * reason, you typically only need to set the function once at the beginning of your mod.
216
234
  *
217
235
  * In order to use this function, you must upgrade your mod with `ISCFeature.DEBUG_DISPLAY`.
236
+ *
237
+ * @public
218
238
  */
219
239
  @Exported
220
240
  public setEffectDisplay(
@@ -232,6 +252,8 @@ export class DebugDisplay extends Feature {
232
252
  * reason, you typically only need to set the function once at the beginning of your mod.
233
253
  *
234
254
  * In order to use this function, you must upgrade your mod with `ISCFeature.DEBUG_DISPLAY`.
255
+ *
256
+ * @public
235
257
  */
236
258
  @Exported
237
259
  public setNPCDisplay(textCallback: (npc: EntityNPC) => string): void {
@@ -247,6 +269,8 @@ export class DebugDisplay extends Feature {
247
269
  * reason, you typically only need to set the function once at the beginning of your mod.
248
270
  *
249
271
  * In order to use this function, you must upgrade your mod with `ISCFeature.DEBUG_DISPLAY`.
272
+ *
273
+ * @public
250
274
  */
251
275
  @Exported
252
276
  public setRockDisplay(textCallback: (rock: GridEntityRock) => string): void {
@@ -262,6 +286,8 @@ export class DebugDisplay extends Feature {
262
286
  * reason, you typically only need to set the function once at the beginning of your mod.
263
287
  *
264
288
  * In order to use this function, you must upgrade your mod with `ISCFeature.DEBUG_DISPLAY`.
289
+ *
290
+ * @public
265
291
  */
266
292
  @Exported
267
293
  public setPitDisplay(textCallback: (pit: GridEntityPit) => string): void {
@@ -277,6 +303,8 @@ export class DebugDisplay extends Feature {
277
303
  * reason, you typically only need to set the function once at the beginning of your mod.
278
304
  *
279
305
  * In order to use this function, you must upgrade your mod with `ISCFeature.DEBUG_DISPLAY`.
306
+ *
307
+ * @public
280
308
  */
281
309
  @Exported
282
310
  public setSpikesDisplay(
@@ -294,6 +322,8 @@ export class DebugDisplay extends Feature {
294
322
  * reason, you typically only need to set the function once at the beginning of your mod.
295
323
  *
296
324
  * In order to use this function, you must upgrade your mod with `ISCFeature.DEBUG_DISPLAY`.
325
+ *
326
+ * @public
297
327
  */
298
328
  @Exported
299
329
  public setTNTDisplay(textCallback: (tnt: GridEntityTNT) => string): void {
@@ -309,6 +339,8 @@ export class DebugDisplay extends Feature {
309
339
  * reason, you typically only need to set the function once at the beginning of your mod.
310
340
  *
311
341
  * In order to use this function, you must upgrade your mod with `ISCFeature.DEBUG_DISPLAY`.
342
+ *
343
+ * @public
312
344
  */
313
345
  @Exported
314
346
  public setPoopDisplay(textCallback: (poop: GridEntityPoop) => string): void {
@@ -324,6 +356,8 @@ export class DebugDisplay extends Feature {
324
356
  * reason, you typically only need to set the function once at the beginning of your mod.
325
357
  *
326
358
  * In order to use this function, you must upgrade your mod with `ISCFeature.DEBUG_DISPLAY`.
359
+ *
360
+ * @public
327
361
  */
328
362
  @Exported
329
363
  public setDoorDisplay(textCallback: (door: GridEntityDoor) => string): void {
@@ -339,6 +373,8 @@ export class DebugDisplay extends Feature {
339
373
  * reason, you typically only need to set the function once at the beginning of your mod.
340
374
  *
341
375
  * In order to use this function, you must upgrade your mod with `ISCFeature.DEBUG_DISPLAY`.
376
+ *
377
+ * @public
342
378
  */
343
379
  @Exported
344
380
  public setPressurePlateDisplay(
@@ -378,6 +414,7 @@ export class DebugDisplay extends Feature {
378
414
  * @param force Optional. A boolean that represents the value to force the display to. For
379
415
  * example, you can specify true to always make the display turn on, regardless of
380
416
  * whether it is already on.
417
+ * @public
381
418
  */
382
419
  @Exported
383
420
  public togglePlayerDisplay(force?: boolean): void {
@@ -392,6 +429,7 @@ export class DebugDisplay extends Feature {
392
429
  * @param force Optional. A boolean that represents the value to force the display to. For
393
430
  * example, you can specify true to always make the display turn on, regardless of
394
431
  * whether it is already on.
432
+ * @public
395
433
  */
396
434
  @Exported
397
435
  public toggleTearDisplay(force?: boolean): void {
@@ -407,6 +445,7 @@ export class DebugDisplay extends Feature {
407
445
  * @param force Optional. A boolean that represents the value to force the display to. For
408
446
  * example, you can specify true to always make the display turn on, regardless of
409
447
  * whether it is already on.
448
+ * @public
410
449
  */
411
450
  @Exported
412
451
  public toggleFamiliarDisplay(force?: boolean): void {
@@ -421,6 +460,7 @@ export class DebugDisplay extends Feature {
421
460
  * @param force Optional. A boolean that represents the value to force the display to. For
422
461
  * example, you can specify true to always make the display turn on, regardless of
423
462
  * whether it is already on.
463
+ * @public
424
464
  */
425
465
  @Exported
426
466
  public toggleBombDisplay(force?: boolean): void {
@@ -435,6 +475,7 @@ export class DebugDisplay extends Feature {
435
475
  * @param force Optional. A boolean that represents the value to force the display to. For
436
476
  * example, you can specify true to always make the display turn on, regardless of
437
477
  * whether it is already on.
478
+ * @public
438
479
  */
439
480
  @Exported
440
481
  public togglePickupDisplay(force?: boolean): void {
@@ -449,6 +490,7 @@ export class DebugDisplay extends Feature {
449
490
  * @param force Optional. A boolean that represents the value to force the display to. For
450
491
  * example, you can specify true to always make the display turn on, regardless of
451
492
  * whether it is already on.
493
+ * @public
452
494
  */
453
495
  @Exported
454
496
  public toggleSlotDisplay(force?: boolean): void {
@@ -463,6 +505,7 @@ export class DebugDisplay extends Feature {
463
505
  * @param force Optional. A boolean that represents the value to force the display to. For
464
506
  * example, you can specify true to always make the display turn on, regardless of
465
507
  * whether it is already on.
508
+ * @public
466
509
  */
467
510
  @Exported
468
511
  public toggleLaserDisplay(force?: boolean): void {
@@ -477,6 +520,7 @@ export class DebugDisplay extends Feature {
477
520
  * @param force Optional. A boolean that represents the value to force the display to. For
478
521
  * example, you can specify true to always make the display turn on, regardless of
479
522
  * whether it is already on.
523
+ * @public
480
524
  */
481
525
  @Exported
482
526
  public toggleKnifeDisplay(force?: boolean): void {
@@ -492,6 +536,7 @@ export class DebugDisplay extends Feature {
492
536
  * @param force Optional. A boolean that represents the value to force the display to. For
493
537
  * example, you can specify true to always make the display turn on, regardless of
494
538
  * whether it is already on.
539
+ * @public
495
540
  */
496
541
  @Exported
497
542
  public toggleProjectileDisplay(force?: boolean): void {
@@ -506,6 +551,7 @@ export class DebugDisplay extends Feature {
506
551
  * @param force Optional. A boolean that represents the value to force the display to. For
507
552
  * example, you can specify true to always make the display turn on, regardless of
508
553
  * whether it is already on.
554
+ * @public
509
555
  */
510
556
  @Exported
511
557
  public toggleEffectDisplay(force?: boolean): void {
@@ -520,6 +566,7 @@ export class DebugDisplay extends Feature {
520
566
  * @param force Optional. A boolean that represents the value to force the display to. For
521
567
  * example, you can specify true to always make the display turn on, regardless of
522
568
  * whether it is already on.
569
+ * @public
523
570
  */
524
571
  @Exported
525
572
  public toggleNPCDisplay(force?: boolean): void {
@@ -534,6 +581,7 @@ export class DebugDisplay extends Feature {
534
581
  * @param force Optional. A boolean that represents the value to force the display to. For
535
582
  * example, you can specify true to always make the display turn on, regardless of
536
583
  * whether it is already on.
584
+ * @public
537
585
  */
538
586
  @Exported
539
587
  public toggleRockDisplay(force?: boolean): void {
@@ -548,6 +596,7 @@ export class DebugDisplay extends Feature {
548
596
  * @param force Optional. A boolean that represents the value to force the display to. For
549
597
  * example, you can specify true to always make the display turn on, regardless of
550
598
  * whether it is already on.
599
+ * @public
551
600
  */
552
601
  @Exported
553
602
  public togglePitDisplay(force?: boolean): void {
@@ -562,6 +611,7 @@ export class DebugDisplay extends Feature {
562
611
  * @param force Optional. A boolean that represents the value to force the display to. For
563
612
  * example, you can specify true to always make the display turn on, regardless of
564
613
  * whether it is already on.
614
+ * @public
565
615
  */
566
616
  @Exported
567
617
  public toggleSpikesDisplay(force?: boolean): void {
@@ -576,6 +626,7 @@ export class DebugDisplay extends Feature {
576
626
  * @param force Optional. A boolean that represents the value to force the display to. For
577
627
  * example, you can specify true to always make the display turn on, regardless of
578
628
  * whether it is already on.
629
+ * @public
579
630
  */
580
631
  @Exported
581
632
  public toggleTNTDisplay(force?: boolean): void {
@@ -590,6 +641,7 @@ export class DebugDisplay extends Feature {
590
641
  * @param force Optional. A boolean that represents the value to force the display to. For
591
642
  * example, you can specify true to always make the display turn on, regardless of
592
643
  * whether it is already on.
644
+ * @public
593
645
  */
594
646
  @Exported
595
647
  public togglePoopDisplay(force?: boolean): void {
@@ -604,6 +656,7 @@ export class DebugDisplay extends Feature {
604
656
  * @param force Optional. A boolean that represents the value to force the display to. For
605
657
  * example, you can specify true to always make the display turn on, regardless of
606
658
  * whether it is already on.
659
+ * @public
607
660
  */
608
661
  @Exported
609
662
  public toggleDoorDisplay(force?: boolean): void {
@@ -619,6 +672,7 @@ export class DebugDisplay extends Feature {
619
672
  * @param force Optional. A boolean that represents the value to force the display to. For
620
673
  * example, you can specify true to always make the display turn on, regardless of
621
674
  * whether it is already on.
675
+ * @public
622
676
  */
623
677
  @Exported
624
678
  public togglePressurePlateDisplay(force?: boolean): void {
@@ -222,6 +222,7 @@ export class DeployJSONRoom extends Feature {
222
222
  * to a random seed.
223
223
  * @param verbose Optional. If specified, will write entries to the "log.txt" file that describe
224
224
  * what the function is doing. Default is false.
225
+ * @public
225
226
  */
226
227
  @Exported
227
228
  public deployJSONRoom(
@@ -116,6 +116,8 @@ export class DisableInputs extends Feature {
116
116
  * capacity.
117
117
  *
118
118
  * In order to use this function, you must upgrade your mod with `ISCFeature.DISABLE_INPUTS`.
119
+ *
120
+ * @public
119
121
  */
120
122
  @Exported
121
123
  public areInputsEnabled(): boolean {
@@ -136,6 +138,7 @@ export class DisableInputs extends Feature {
136
138
  * this was part of the code for a custom enemy called "Super Gaper", then you could
137
139
  * use a key of "SuperGaper". The name is necessary so that multiple mod features can
138
140
  * work in tandem.
141
+ * @public
139
142
  */
140
143
  @Exported
141
144
  public enableAllInputs(key: string): void {
@@ -158,6 +161,7 @@ export class DisableInputs extends Feature {
158
161
  * use a key of "SuperGaper". The name is necessary so that multiple mod features can
159
162
  * work in tandem.
160
163
  * @param buttonActions An array of the actions to action.
164
+ * @public
161
165
  */
162
166
  @Exported
163
167
  public disableInputs(key: string, ...buttonActions: ButtonAction[]): void {
@@ -177,6 +181,7 @@ export class DisableInputs extends Feature {
177
181
  * this was part of the code for a custom enemy called "Super Gaper", then you could
178
182
  * use a key of "SuperGaper". The name is necessary so that multiple mod features can
179
183
  * work in tandem.
184
+ * @public
180
185
  */
181
186
  @Exported
182
187
  public disableAllInputs(key: string): void {
@@ -197,6 +202,7 @@ export class DisableInputs extends Feature {
197
202
  * use a key of "SuperGaper". The name is necessary so that multiple mod features can
198
203
  * work in tandem.
199
204
  * @param blacklist A set of ButtonActions to disallow.
205
+ * @public
200
206
  */
201
207
  @Exported
202
208
  public enableAllInputsExceptFor(
@@ -220,6 +226,7 @@ export class DisableInputs extends Feature {
220
226
  * use a key of "SuperGaper". The name is necessary so that multiple mod features can
221
227
  * work in tandem.
222
228
  * @param whitelist A set of ButtonActions to allow.
229
+ * @public
223
230
  */
224
231
  @Exported
225
232
  public disableAllInputsExceptFor(
@@ -243,6 +250,7 @@ export class DisableInputs extends Feature {
243
250
  * this was part of the code for a custom enemy called "Super Gaper", then you could
244
251
  * use a key of "SuperGaper". The name is necessary so that multiple mod features can
245
252
  * work in tandem.
253
+ * @public
246
254
  */
247
255
  @Exported
248
256
  public disableMovementInputs(key: string): void {
@@ -261,6 +269,7 @@ export class DisableInputs extends Feature {
261
269
  * this was part of the code for a custom enemy called "Super Gaper", then you could
262
270
  * use a key of "SuperGaper". The name is necessary so that multiple mod features can
263
271
  * work in tandem.
272
+ * @public
264
273
  */
265
274
  @Exported
266
275
  public disableShootingInputs(key: string): void {
@@ -74,6 +74,8 @@ export class EdenStartingStatsHealth extends Feature {
74
74
  * Returns undefined if passed a player that is not Eden.
75
75
  *
76
76
  * In order to use this function, you must upgrade your mod with `ISCFeature.EDEN_STARTING_STATS`.
77
+ *
78
+ * @public
77
79
  */
78
80
  @Exported
79
81
  public getEdenStartingHealth(
@@ -89,6 +91,8 @@ export class EdenStartingStatsHealth extends Feature {
89
91
  * Returns undefined if passed a player that is not Eden.
90
92
  *
91
93
  * In order to use this function, you must upgrade your mod with `ISCFeature.EDEN_STARTING_STATS`.
94
+ *
95
+ * @public
92
96
  */
93
97
  @Exported
94
98
  public getEdenStartingStat<T extends PlayerStat>(
@@ -110,6 +114,8 @@ export class EdenStartingStatsHealth extends Feature {
110
114
  * Returns undefined if passed a player that is not Eden.
111
115
  *
112
116
  * In order to use this function, you must upgrade your mod with `ISCFeature.EDEN_STARTING_STATS`.
117
+ *
118
+ * @public
113
119
  */
114
120
  @Exported
115
121
  public getEdenStartingStats(
@@ -250,6 +250,8 @@ export class ExtraConsoleCommands extends Feature {
250
250
  *
251
251
  * In order to use this function, you must upgrade your mod with
252
252
  * `ISCFeature.EXTRA_CONSOLE_COMMANDS`.
253
+ *
254
+ * @public
253
255
  */
254
256
  @Exported
255
257
  public addConsoleCommand(
@@ -295,6 +297,8 @@ export class ExtraConsoleCommands extends Feature {
295
297
  *
296
298
  * In order to use this function, you must upgrade your mod with
297
299
  * `ISCFeature.EXTRA_CONSOLE_COMMANDS`.
300
+ *
301
+ * @public
298
302
  */
299
303
  @Exported
300
304
  public removeConsoleCommand(commandName: string): void {
@@ -327,6 +331,8 @@ export class ExtraConsoleCommands extends Feature {
327
331
  *
328
332
  * In order to use this function, you must upgrade your mod with
329
333
  * `ISCFeature.EXTRA_CONSOLE_COMMANDS`.
334
+ *
335
+ * @public
330
336
  */
331
337
  @Exported
332
338
  public removeAllConsoleCommands(): void {
@@ -37,6 +37,8 @@ export class FadeInRemover extends Feature {
37
37
  * You can restore the vanilla behavior with the `restoreFadeIn` function.
38
38
  *
39
39
  * In order to use this function, you must upgrade your mod with `ISCFeature.FADE_IN_REMOVER`.
40
+ *
41
+ * @public
40
42
  */
41
43
  @Exported
42
44
  public removeFadeIn(): void {
@@ -48,6 +50,8 @@ export class FadeInRemover extends Feature {
48
50
  * function.
49
51
  *
50
52
  * In order to use this function, you must upgrade your mod with `ISCFeature.FADE_IN_REMOVER`.
53
+ *
54
+ * @public
51
55
  */
52
56
  @Exported
53
57
  public restoreFadeIn(): void {
@@ -42,6 +42,8 @@ export class FastReset extends Feature {
42
42
  * You can disable the fast-reset feature with the `disableFastReset` function.
43
43
  *
44
44
  * In order to use this function, you must upgrade your mod with `ISCFeature.FAST_RESET`.
45
+ *
46
+ * @public
45
47
  */
46
48
  @Exported
47
49
  public enableFastReset(): void {
@@ -53,6 +55,8 @@ export class FastReset extends Feature {
53
55
  * `enableFastReset` function.
54
56
  *
55
57
  * In order to use this function, you must upgrade your mod with `ISCFeature.FAST_RESET`.
58
+ *
59
+ * @public
56
60
  */
57
61
  @Exported
58
62
  public disableFastReset(): void {
@@ -27,6 +27,8 @@ export class FlyingDetection extends Feature {
27
27
  * Hanged Man, Bat Wing, and so on.
28
28
  *
29
29
  * In order to use this function, you must upgrade your mod with `ISCFeature.FLYING_DETECTION`.
30
+ *
31
+ * @public
30
32
  */
31
33
  @Exported
32
34
  public hasFlyingTemporaryEffect(player: EntityPlayer): boolean {
@@ -28,6 +28,8 @@ export class ForgottenSwitch extends Feature {
28
28
  * Forgotten. This takes 1 game frame to take effect.
29
29
  *
30
30
  * In order to use this function, you must upgrade your mod with `ISCFeature.FORGOTTEN_SWITCH`.
31
+ *
32
+ * @public
31
33
  */
32
34
  @Exported
33
35
  public forgottenSwitch(player: EntityPlayer): void {