isaacscript-common 31.7.2 → 31.8.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/index.rollup.d.ts +215 -153
- package/dist/isaacscript-common.lua +144 -14
- package/dist/lualib_bundle.lua +99 -3
- package/dist/src/classes/ModFeature.d.ts +2 -2
- package/dist/src/classes/callbacks/PostPlayerFatalDamage.d.ts +1 -1
- package/dist/src/classes/callbacks/PostPlayerFatalDamage.d.ts.map +1 -1
- package/dist/src/classes/callbacks/PostUsePillFilter.d.ts +2 -2
- package/dist/src/classes/callbacks/PostUsePillFilter.lua +2 -2
- package/dist/src/classes/features/callbackLogic/CustomGridEntities.d.ts +1 -1
- package/dist/src/classes/features/other/CustomItemPools.d.ts +1 -1
- package/dist/src/classes/features/other/CustomTrapdoors.d.ts +2 -2
- package/dist/src/classes/features/other/DebugDisplay.d.ts +18 -18
- package/dist/src/classes/features/other/ModdedElementSets.d.ts +2 -2
- package/dist/src/classes/features/other/RunInNFrames.d.ts +14 -14
- package/dist/src/classes/features/other/SaveDataManager.d.ts +2 -2
- package/dist/src/classes/features/other/SpawnRockAltRewards.d.ts +1 -1
- package/dist/src/classes/features/other/StageHistory.d.ts +2 -2
- package/dist/src/classes/features/other/extraConsoleCommands/commands.d.ts +1 -1
- package/dist/src/classes/features/other/extraConsoleCommands/commands.d.ts.map +1 -1
- package/dist/src/classes/features/other/extraConsoleCommands/commands.lua +1 -1
- package/dist/src/functions/array.d.ts +4 -4
- package/dist/src/functions/array.lua +4 -4
- package/dist/src/functions/cards.d.ts +1 -1
- package/dist/src/functions/cards.d.ts.map +1 -1
- package/dist/src/functions/cards.lua +1 -1
- package/dist/src/functions/charge.d.ts +1 -1
- package/dist/src/functions/charge.lua +1 -1
- package/dist/src/functions/collectibles.d.ts +3 -3
- package/dist/src/functions/collectibles.lua +3 -3
- package/dist/src/functions/debugFunctions.d.ts +2 -2
- package/dist/src/functions/debugFunctions.lua +2 -2
- package/dist/src/functions/deepCopy.d.ts +2 -2
- package/dist/src/functions/deepCopy.lua +2 -2
- package/dist/src/functions/globals.d.ts +1 -1
- package/dist/src/functions/globals.lua +1 -1
- package/dist/src/functions/gridEntities.d.ts +6 -6
- package/dist/src/functions/gridEntities.lua +6 -6
- package/dist/src/functions/gridEntitiesSpecific.d.ts +22 -22
- package/dist/src/functions/gridEntitiesSpecific.lua +22 -22
- package/dist/src/functions/input.d.ts +4 -4
- package/dist/src/functions/input.lua +4 -4
- package/dist/src/functions/logEntities.d.ts +1 -1
- package/dist/src/functions/logEntities.lua +1 -1
- package/dist/src/functions/minimap.d.ts +17 -20
- package/dist/src/functions/minimap.d.ts.map +1 -1
- package/dist/src/functions/minimap.lua +17 -20
- package/dist/src/functions/nextStage.d.ts +2 -2
- package/dist/src/functions/nextStage.lua +2 -2
- package/dist/src/functions/pills.d.ts +2 -2
- package/dist/src/functions/pills.lua +2 -2
- package/dist/src/functions/playerHealth.d.ts +4 -4
- package/dist/src/functions/playerHealth.lua +4 -4
- package/dist/src/functions/playerIndex.d.ts +2 -3
- package/dist/src/functions/playerIndex.d.ts.map +1 -1
- package/dist/src/functions/playerIndex.lua +2 -3
- package/dist/src/functions/players.d.ts +5 -5
- package/dist/src/functions/players.lua +5 -5
- package/dist/src/functions/pocketItems.d.ts +5 -5
- package/dist/src/functions/pocketItems.lua +5 -5
- package/dist/src/functions/revive.d.ts +3 -3
- package/dist/src/functions/revive.lua +3 -3
- package/dist/src/functions/rooms.d.ts +7 -7
- package/dist/src/functions/rooms.lua +7 -7
- package/dist/src/functions/run.d.ts +1 -1
- package/dist/src/functions/run.lua +1 -1
- package/dist/src/functions/set.d.ts +1 -1
- package/dist/src/functions/set.lua +1 -1
- package/dist/src/functions/stage.d.ts +64 -7
- package/dist/src/functions/stage.d.ts.map +1 -1
- package/dist/src/functions/stage.lua +80 -16
- package/dist/src/functions/trinkets.d.ts +1 -1
- package/dist/src/functions/trinkets.lua +1 -1
- package/package.json +2 -2
- package/src/classes/ModFeature.ts +2 -2
- package/src/classes/callbacks/PostPlayerFatalDamage.ts +1 -1
- package/src/classes/callbacks/PostUsePillFilter.ts +2 -2
- package/src/classes/features/callbackLogic/CustomGridEntities.ts +1 -1
- package/src/classes/features/other/CustomItemPools.ts +1 -1
- package/src/classes/features/other/CustomTrapdoors.ts +2 -2
- package/src/classes/features/other/DebugDisplay.ts +18 -18
- package/src/classes/features/other/DisableInputs.ts +2 -2
- package/src/classes/features/other/ModdedElementSets.ts +2 -2
- package/src/classes/features/other/RunInNFrames.ts +15 -15
- package/src/classes/features/other/SaveDataManager.ts +2 -2
- package/src/classes/features/other/SpawnRockAltRewards.ts +1 -1
- package/src/classes/features/other/StageHistory.ts +2 -2
- package/src/classes/features/other/extraConsoleCommands/commands.ts +1 -1
- package/src/functions/array.ts +4 -4
- package/src/functions/cards.ts +1 -1
- package/src/functions/charge.ts +1 -1
- package/src/functions/collectibles.ts +3 -3
- package/src/functions/debugFunctions.ts +2 -2
- package/src/functions/deepCopy.ts +3 -3
- package/src/functions/globals.ts +1 -1
- package/src/functions/gridEntities.ts +6 -6
- package/src/functions/gridEntitiesSpecific.ts +22 -22
- package/src/functions/input.ts +4 -4
- package/src/functions/logEntities.ts +1 -1
- package/src/functions/minimap.ts +17 -20
- package/src/functions/nextStage.ts +2 -2
- package/src/functions/pills.ts +2 -2
- package/src/functions/playerHealth.ts +4 -4
- package/src/functions/playerIndex.ts +2 -3
- package/src/functions/players.ts +5 -5
- package/src/functions/pocketItems.ts +5 -5
- package/src/functions/revive.ts +3 -3
- package/src/functions/rooms.ts +7 -7
- package/src/functions/run.ts +1 -1
- package/src/functions/set.ts +1 -1
- package/src/functions/stage.ts +139 -33
- package/src/functions/trinkets.ts +1 -1
|
@@ -256,7 +256,7 @@ end
|
|
|
256
256
|
--
|
|
257
257
|
-- @param crawlSpaceVariant Optional. If specified, will only remove the crawl spaces that match
|
|
258
258
|
-- this variant. Default is -1, which matches every variant.
|
|
259
|
-
-- @param updateRoom Optional. Whether
|
|
259
|
+
-- @param updateRoom Optional. Whether to update the room after the crawl spaces are removed.
|
|
260
260
|
-- Default is false. For more information, see the description of the
|
|
261
261
|
-- `removeGridEntities` helper function.
|
|
262
262
|
-- @param cap Optional. If specified, will only remove the given amount of crawl spaces.
|
|
@@ -275,8 +275,8 @@ end
|
|
|
275
275
|
--
|
|
276
276
|
-- @param pitVariant Optional. If specified, will only remove the pits that match this variant.
|
|
277
277
|
-- Default is -1, which matches every variant.
|
|
278
|
-
-- @param updateRoom Optional. Whether
|
|
279
|
-
--
|
|
278
|
+
-- @param updateRoom Optional. Whether to update the room after the pits are removed. Default is
|
|
279
|
+
-- false. For more information, see the description of the `removeGridEntities`
|
|
280
280
|
-- helper function.
|
|
281
281
|
-- @param cap Optional. If specified, will only remove the given amount of pits.
|
|
282
282
|
-- @returns The pits that were removed.
|
|
@@ -297,9 +297,9 @@ end
|
|
|
297
297
|
--
|
|
298
298
|
-- @param poopVariant Optional. If specified, will only remove the poops that match this variant.
|
|
299
299
|
-- Default is -1, which matches every variant.
|
|
300
|
-
-- @param updateRoom Optional. Whether
|
|
301
|
-
--
|
|
302
|
-
--
|
|
300
|
+
-- @param updateRoom Optional. Whether to update the room after the poops are removed. Default is
|
|
301
|
+
-- false. For more information, see the description of the `removeGridEntities`
|
|
302
|
+
-- helper function.
|
|
303
303
|
-- @param cap Optional. If specified, will only remove the given amount of poops.
|
|
304
304
|
-- @returns The poops that were removed.
|
|
305
305
|
function ____exports.removeAllPoops(self, poopVariant, updateRoom, cap)
|
|
@@ -316,8 +316,8 @@ end
|
|
|
316
316
|
--
|
|
317
317
|
-- @param pressurePlateVariant Optional. If specified, will only remove the pressure plates that
|
|
318
318
|
-- match this variant. Default is -1, which matches every variant.
|
|
319
|
-
-- @param updateRoom Optional. Whether
|
|
320
|
-
--
|
|
319
|
+
-- @param updateRoom Optional. Whether to update the room after the pressure plates are removed.
|
|
320
|
+
-- Default is false. For more information, see the description of the
|
|
321
321
|
-- `removeGridEntities` helper function.
|
|
322
322
|
-- @param cap Optional. If specified, will only remove the given amount of pressure plates.
|
|
323
323
|
-- @returns The pressure plates that were removed.
|
|
@@ -337,9 +337,9 @@ end
|
|
|
337
337
|
-- Default is -1, which matches every variant. Note that this is not the same thing
|
|
338
338
|
-- as the `RockVariant` enum, since that only applies to `GridEntityType.ROCK`, and
|
|
339
339
|
-- other types of grid entities can be the `GridEntityRock` class.
|
|
340
|
-
-- @param updateRoom Optional. Whether
|
|
341
|
-
--
|
|
342
|
-
--
|
|
340
|
+
-- @param updateRoom Optional. Whether to update the room after the rocks are removed. Default is
|
|
341
|
+
-- false. For more information, see the description of the `removeGridEntities`
|
|
342
|
+
-- helper function.
|
|
343
343
|
-- @param cap Optional. If specified, will only remove the given amount of rocks.
|
|
344
344
|
-- @returns The rocks that were removed.
|
|
345
345
|
function ____exports.removeAllRocks(self, variant, updateRoom, cap)
|
|
@@ -356,9 +356,9 @@ end
|
|
|
356
356
|
--
|
|
357
357
|
-- @param variant Optional. If specified, will only remove the spikes that match this variant.
|
|
358
358
|
-- Default is -1, which matches every variant.
|
|
359
|
-
-- @param updateRoom Optional. Whether
|
|
360
|
-
--
|
|
361
|
-
--
|
|
359
|
+
-- @param updateRoom Optional. Whether to update the room after the spikes are removed. Default is
|
|
360
|
+
-- false. For more information, see the description of the `removeGridEntities`
|
|
361
|
+
-- helper function.
|
|
362
362
|
-- @param cap Optional. If specified, will only remove the given amount of spikes.
|
|
363
363
|
-- @returns The spikes that were removed.
|
|
364
364
|
function ____exports.removeAllSpikes(self, variant, updateRoom, cap)
|
|
@@ -375,8 +375,8 @@ end
|
|
|
375
375
|
--
|
|
376
376
|
-- @param variant Optional. If specified, will only remove the TNTs that match this variant. Default
|
|
377
377
|
-- is -1, which matches every variant.
|
|
378
|
-
-- @param updateRoom Optional. Whether
|
|
379
|
-
--
|
|
378
|
+
-- @param updateRoom Optional. Whether to update the room after the TNTs are removed. Default is
|
|
379
|
+
-- false. For more information, see the description of the `removeGridEntities`
|
|
380
380
|
-- helper function.
|
|
381
381
|
-- @param cap Optional. If specified, will only remove the given amount of TNTs.
|
|
382
382
|
-- @returns The TNTs that were removed.
|
|
@@ -394,9 +394,9 @@ end
|
|
|
394
394
|
--
|
|
395
395
|
-- @param variant Optional. If specified, will only remove the teleporters that match this variant.
|
|
396
396
|
-- Default is -1, which matches every variant.
|
|
397
|
-
-- @param updateRoom Optional. Whether
|
|
398
|
-
--
|
|
399
|
-
--
|
|
397
|
+
-- @param updateRoom Optional. Whether to update the room after the teleporters are removed. Default
|
|
398
|
+
-- is false. For more information, see the description of the `removeGridEntities`
|
|
399
|
+
-- helper function.
|
|
400
400
|
-- @param cap Optional. If specified, will only remove the given amount of teleporters.
|
|
401
401
|
-- @returns The teleporters that were removed.
|
|
402
402
|
function ____exports.removeAllTeleporters(self, variant, updateRoom, cap)
|
|
@@ -413,9 +413,9 @@ end
|
|
|
413
413
|
--
|
|
414
414
|
-- @param trapdoorVariant Optional. If specified, will only remove the trapdoors that match this
|
|
415
415
|
-- variant. Default is -1, which matches every variant.
|
|
416
|
-
-- @param updateRoom Optional. Whether
|
|
417
|
-
--
|
|
418
|
-
--
|
|
416
|
+
-- @param updateRoom Optional. Whether to update the room after the trapdoors are removed. Default
|
|
417
|
+
-- is false. For more information, see the description of the `removeGridEntities`
|
|
418
|
+
-- helper function.
|
|
419
419
|
-- @param cap Optional. If specified, will only remove the given amount of trapdoors.
|
|
420
420
|
-- @returns The trapdoors that were removed.
|
|
421
421
|
function ____exports.removeAllTrapdoors(self, trapdoorVariant, updateRoom, cap)
|
|
@@ -13,14 +13,14 @@ export declare const SHOOTING_ACTIONS_SET: ReadonlySet<ButtonAction>;
|
|
|
13
13
|
export declare function controllerToString(controller: Controller): string | undefined;
|
|
14
14
|
/**
|
|
15
15
|
* Helper function to get the movement actions that the specified `ControllerIndex` is currently
|
|
16
|
-
* pressing down. This returns an array because a player can
|
|
17
|
-
*
|
|
16
|
+
* pressing down. This returns an array because a player can be holding down more than one movement
|
|
17
|
+
* key at a time.
|
|
18
18
|
*/
|
|
19
19
|
export declare function getMoveActions(controllerIndex: ControllerIndex): ButtonAction[];
|
|
20
20
|
/**
|
|
21
21
|
* Helper function to get the shooting actions that the specified `ControllerIndex` is currently
|
|
22
|
-
* pressing down. This returns an array because a player can
|
|
23
|
-
*
|
|
22
|
+
* pressing down. This returns an array because a player can be holding down more than one shooting
|
|
23
|
+
* key at a time.
|
|
24
24
|
*/
|
|
25
25
|
export declare function getShootActions(controllerIndex: ControllerIndex): ButtonAction[];
|
|
26
26
|
/**
|
|
@@ -42,8 +42,8 @@ function ____exports.controllerToString(self, controller)
|
|
|
42
42
|
return trimPrefix(nil, key, "BUTTON_")
|
|
43
43
|
end
|
|
44
44
|
--- Helper function to get the movement actions that the specified `ControllerIndex` is currently
|
|
45
|
-
-- pressing down. This returns an array because a player can
|
|
46
|
-
--
|
|
45
|
+
-- pressing down. This returns an array because a player can be holding down more than one movement
|
|
46
|
+
-- key at a time.
|
|
47
47
|
function ____exports.getMoveActions(self, controllerIndex)
|
|
48
48
|
return __TS__ArrayFilter(
|
|
49
49
|
____exports.MOVEMENT_ACTIONS,
|
|
@@ -51,8 +51,8 @@ function ____exports.getMoveActions(self, controllerIndex)
|
|
|
51
51
|
)
|
|
52
52
|
end
|
|
53
53
|
--- Helper function to get the shooting actions that the specified `ControllerIndex` is currently
|
|
54
|
-
-- pressing down. This returns an array because a player can
|
|
55
|
-
--
|
|
54
|
+
-- pressing down. This returns an array because a player can be holding down more than one shooting
|
|
55
|
+
-- key at a time.
|
|
56
56
|
function ____exports.getShootActions(self, controllerIndex)
|
|
57
57
|
return __TS__ArrayFilter(
|
|
58
58
|
____exports.SHOOTING_ACTIONS,
|
|
@@ -5,7 +5,7 @@ export declare function logAllEntities(this: void, includeBackgroundEffects: boo
|
|
|
5
5
|
/**
|
|
6
6
|
* Helper function for printing out every grid entity (or filtered grid entity) in the current room.
|
|
7
7
|
*
|
|
8
|
-
* @param includeWalls Optional. Whether
|
|
8
|
+
* @param includeWalls Optional. Whether oto log the walls. Default is false.
|
|
9
9
|
* @param gridEntityTypeFilter Optional. If specified, will only log the given `GridEntityType`.
|
|
10
10
|
* Default is undefined.
|
|
11
11
|
*/
|
|
@@ -193,7 +193,7 @@ function ____exports.logAllEntities(includeBackgroundEffects, entityTypeFilter)
|
|
|
193
193
|
end
|
|
194
194
|
--- Helper function for printing out every grid entity (or filtered grid entity) in the current room.
|
|
195
195
|
--
|
|
196
|
-
-- @param includeWalls Optional. Whether
|
|
196
|
+
-- @param includeWalls Optional. Whether oto log the walls. Default is false.
|
|
197
197
|
-- @param gridEntityTypeFilter Optional. If specified, will only log the given `GridEntityType`.
|
|
198
198
|
-- Default is undefined.
|
|
199
199
|
function ____exports.logAllGridEntities(includeWalls, gridEntityTypeFilter)
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
import type { DisplayFlag } from "isaac-typescript-definitions";
|
|
2
2
|
/**
|
|
3
3
|
* Helper function to add a `DisplayFlag` to a particular room's minimap display flags (e.g. whether
|
|
4
|
-
*
|
|
4
|
+
* it is visible and so on).
|
|
5
5
|
*
|
|
6
|
-
* This function automatically accounts for
|
|
6
|
+
* This function automatically accounts for if MinimapAPI is being used.
|
|
7
7
|
*
|
|
8
8
|
* @param roomGridIndex Set to undefined to use the current room index.
|
|
9
9
|
* @param displayFlag The `DisplayFlag` to set. (See the `DisplayFlag` enum.)
|
|
@@ -14,7 +14,7 @@ export declare function addRoomDisplayFlag(roomGridIndex: int | undefined, displ
|
|
|
14
14
|
/**
|
|
15
15
|
* Helper function to set the value of `DisplayFlag` for every room on the floor to 0.
|
|
16
16
|
*
|
|
17
|
-
* This function automatically accounts for
|
|
17
|
+
* This function automatically accounts for if MinimapAPI is being used.
|
|
18
18
|
*
|
|
19
19
|
* This function automatically calls the `Level.UpdateVisibility` after setting the flags so that
|
|
20
20
|
* the changes will be immediately visible.
|
|
@@ -23,7 +23,7 @@ export declare function clearFloorDisplayFlags(): void;
|
|
|
23
23
|
/**
|
|
24
24
|
* Helper function to set the value of `DisplayFlag` for a room 0.
|
|
25
25
|
*
|
|
26
|
-
* This function automatically accounts for
|
|
26
|
+
* This function automatically accounts for if MinimapAPI is being used.
|
|
27
27
|
*
|
|
28
28
|
* This function automatically calls the `Level.UpdateVisibility` after setting the flags so that
|
|
29
29
|
* the changes will be immediately visible.
|
|
@@ -37,21 +37,19 @@ export declare function clearRoomDisplayFlags(roomGridIndex: int): void;
|
|
|
37
37
|
* Helper function to get the minimap `DisplayFlag` value for every room on the floor. Returns a map
|
|
38
38
|
* that is indexed by the room's safe grid index.
|
|
39
39
|
*
|
|
40
|
-
* This function automatically accounts for
|
|
40
|
+
* This function automatically accounts for if MinimapAPI is being used.
|
|
41
41
|
*
|
|
42
|
-
* @param minimapAPI Optional.
|
|
43
|
-
* true.
|
|
42
|
+
* @param minimapAPI Optional. If MinimapAPI should be used, if present. Default is true.
|
|
44
43
|
*/
|
|
45
44
|
export declare function getFloorDisplayFlags(minimapAPI?: boolean): Map<int, BitFlags<DisplayFlag>>;
|
|
46
45
|
/**
|
|
47
|
-
* Helper function to get a particular room's minimap display flags (e.g. whether
|
|
48
|
-
*
|
|
46
|
+
* Helper function to get a particular room's minimap display flags (e.g. whether it is visible and
|
|
47
|
+
* so on).
|
|
49
48
|
*
|
|
50
|
-
* This function automatically accounts for
|
|
49
|
+
* This function automatically accounts for if MinimapAPI is being used.
|
|
51
50
|
*
|
|
52
51
|
* @param roomGridIndex Optional. Default is the current room index.
|
|
53
|
-
* @param minimapAPI Optional.
|
|
54
|
-
* true.
|
|
52
|
+
* @param minimapAPI Optional. If MinimapAPI should be used, if present. Default is true.
|
|
55
53
|
*/
|
|
56
54
|
export declare function getRoomDisplayFlags(roomGridIndex?: int, minimapAPI?: boolean): BitFlags<DisplayFlag>;
|
|
57
55
|
/**
|
|
@@ -61,15 +59,14 @@ export declare function getRoomDisplayFlags(roomGridIndex?: int, minimapAPI?: bo
|
|
|
61
59
|
* This is because if the player enters into the room or walks into an adjacent room, the room will
|
|
62
60
|
* reappear on the minimap.
|
|
63
61
|
*
|
|
64
|
-
* This function automatically accounts for
|
|
62
|
+
* This function automatically accounts for if MinimapAPI is being used.
|
|
65
63
|
*/
|
|
66
64
|
export declare function hideRoomOnMinimap(roomGridIndex: int): void;
|
|
67
65
|
/**
|
|
68
66
|
* Helper function to check if a given room is visible on the minimap.
|
|
69
67
|
*
|
|
70
68
|
* @param roomGridIndex The room to check.
|
|
71
|
-
* @param minimapAPI Optional. Whether
|
|
72
|
-
* true.
|
|
69
|
+
* @param minimapAPI Optional. Whether MinimapAPI should be used, if present. Default is true.
|
|
73
70
|
*/
|
|
74
71
|
export declare function isRoomVisible(roomGridIndex: int, minimapAPI?: boolean): boolean;
|
|
75
72
|
/**
|
|
@@ -78,7 +75,7 @@ export declare function isRoomVisible(roomGridIndex: int, minimapAPI?: boolean):
|
|
|
78
75
|
* This function automatically calls the `Level.UpdateVisibility` after setting the flags so that
|
|
79
76
|
* the changes will be immediately visible.
|
|
80
77
|
*
|
|
81
|
-
* This function automatically accounts for
|
|
78
|
+
* This function automatically accounts for if MinimapAPI is being used.
|
|
82
79
|
*/
|
|
83
80
|
export declare function setAllDisplayFlags(displayFlags: BitFlags<DisplayFlag>): void;
|
|
84
81
|
/**
|
|
@@ -87,16 +84,16 @@ export declare function setAllDisplayFlags(displayFlags: BitFlags<DisplayFlag>):
|
|
|
87
84
|
* This function automatically calls the `Level.UpdateVisibility` after setting the flags so that
|
|
88
85
|
* the changes will be immediately visible.
|
|
89
86
|
*
|
|
90
|
-
* This function automatically accounts for
|
|
87
|
+
* This function automatically accounts for if MinimapAPI is being used.
|
|
91
88
|
*
|
|
92
89
|
* @param displayFlagsMap A map of the display flags that is indexed by the room's safe grid index.
|
|
93
90
|
*/
|
|
94
91
|
export declare function setFloorDisplayFlags(displayFlagsMap: Map<int, BitFlags<DisplayFlag>>): void;
|
|
95
92
|
/**
|
|
96
|
-
* Helper function to set a particular room's minimap display flags (e.g. whether
|
|
97
|
-
*
|
|
93
|
+
* Helper function to set a particular room's minimap display flags (e.g. whether it is visible and
|
|
94
|
+
* so on).
|
|
98
95
|
*
|
|
99
|
-
* This function automatically accounts for
|
|
96
|
+
* This function automatically accounts for if MinimapAPI is being used.
|
|
100
97
|
*
|
|
101
98
|
* @param roomGridIndex Set to undefined to use the current room index.
|
|
102
99
|
* @param displayFlags The bit flags value to set. (See the `DisplayFlag` enum.)
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"minimap.d.ts","sourceRoot":"","sources":["../../../src/functions/minimap.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAQhE;;;;;;;;;;GAUG;AACH,wBAAgB,kBAAkB,CAChC,aAAa,EAAE,GAAG,GAAG,SAAS,EAC9B,WAAW,EAAE,WAAW,EACxB,gBAAgB,UAAO,GACtB,IAAI,CAIN;AAED;;;;;;;GAOG;AACH,wBAAgB,sBAAsB,IAAI,IAAI,CAE7C;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,qBAAqB,CAAC,aAAa,EAAE,GAAG,GAAG,IAAI,CAE9D;AAED
|
|
1
|
+
{"version":3,"file":"minimap.d.ts","sourceRoot":"","sources":["../../../src/functions/minimap.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAQhE;;;;;;;;;;GAUG;AACH,wBAAgB,kBAAkB,CAChC,aAAa,EAAE,GAAG,GAAG,SAAS,EAC9B,WAAW,EAAE,WAAW,EACxB,gBAAgB,UAAO,GACtB,IAAI,CAIN;AAED;;;;;;;GAOG;AACH,wBAAgB,sBAAsB,IAAI,IAAI,CAE7C;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,qBAAqB,CAAC,aAAa,EAAE,GAAG,GAAG,IAAI,CAE9D;AAED;;;;;;;GAOG;AACH,wBAAgB,oBAAoB,CAClC,UAAU,UAAO,GAChB,GAAG,CAAC,GAAG,EAAE,QAAQ,CAAC,WAAW,CAAC,CAAC,CAUjC;AAED;;;;;;;;GAQG;AACH,wBAAgB,mBAAmB,CACjC,aAAa,CAAC,EAAE,GAAG,EACnB,UAAU,UAAO,GAChB,QAAQ,CAAC,WAAW,CAAC,CAiBvB;AAED;;;;;;;;GAQG;AACH,wBAAgB,iBAAiB,CAAC,aAAa,EAAE,GAAG,GAAG,IAAI,CAe1D;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,aAAa,EAAE,GAAG,EAAE,UAAU,UAAO,GAAG,OAAO,CAG5E;AAED;;;;;;;GAOG;AACH,wBAAgB,kBAAkB,CAAC,YAAY,EAAE,QAAQ,CAAC,WAAW,CAAC,GAAG,IAAI,CAW5E;AAED;;;;;;;;;GASG;AACH,wBAAgB,oBAAoB,CAClC,eAAe,EAAE,GAAG,CAAC,GAAG,EAAE,QAAQ,CAAC,WAAW,CAAC,CAAC,GAC/C,IAAI,CAWN;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,mBAAmB,CACjC,aAAa,EAAE,GAAG,GAAG,SAAS,EAC9B,YAAY,EAAE,QAAQ,CAAC,WAAW,CAAC,EACnC,gBAAgB,UAAO,GACtB,IAAI,CAsBN"}
|
|
@@ -16,14 +16,13 @@ local ____rooms = require("src.functions.rooms")
|
|
|
16
16
|
local getRoomsInsideGrid = ____rooms.getRoomsInsideGrid
|
|
17
17
|
local ____utils = require("src.functions.utils")
|
|
18
18
|
local assertDefined = ____utils.assertDefined
|
|
19
|
-
--- Helper function to get a particular room's minimap display flags (e.g. whether
|
|
20
|
-
--
|
|
19
|
+
--- Helper function to get a particular room's minimap display flags (e.g. whether it is visible and
|
|
20
|
+
-- so on).
|
|
21
21
|
--
|
|
22
|
-
-- This function automatically accounts for
|
|
22
|
+
-- This function automatically accounts for if MinimapAPI is being used.
|
|
23
23
|
--
|
|
24
24
|
-- @param roomGridIndex Optional. Default is the current room index.
|
|
25
|
-
-- @param minimapAPI Optional.
|
|
26
|
-
-- true.
|
|
25
|
+
-- @param minimapAPI Optional. If MinimapAPI should be used, if present. Default is true.
|
|
27
26
|
function ____exports.getRoomDisplayFlags(self, roomGridIndex, minimapAPI)
|
|
28
27
|
if minimapAPI == nil then
|
|
29
28
|
minimapAPI = true
|
|
@@ -48,7 +47,7 @@ end
|
|
|
48
47
|
-- This function automatically calls the `Level.UpdateVisibility` after setting the flags so that
|
|
49
48
|
-- the changes will be immediately visible.
|
|
50
49
|
--
|
|
51
|
-
-- This function automatically accounts for
|
|
50
|
+
-- This function automatically accounts for if MinimapAPI is being used.
|
|
52
51
|
function ____exports.setAllDisplayFlags(self, displayFlags)
|
|
53
52
|
for ____, room in ipairs(getRoomsInsideGrid(nil)) do
|
|
54
53
|
____exports.setRoomDisplayFlags(nil, room.SafeGridIndex, displayFlags, false)
|
|
@@ -58,10 +57,10 @@ function ____exports.setAllDisplayFlags(self, displayFlags)
|
|
|
58
57
|
level:UpdateVisibility()
|
|
59
58
|
end
|
|
60
59
|
end
|
|
61
|
-
--- Helper function to set a particular room's minimap display flags (e.g. whether
|
|
62
|
-
--
|
|
60
|
+
--- Helper function to set a particular room's minimap display flags (e.g. whether it is visible and
|
|
61
|
+
-- so on).
|
|
63
62
|
--
|
|
64
|
-
-- This function automatically accounts for
|
|
63
|
+
-- This function automatically accounts for if MinimapAPI is being used.
|
|
65
64
|
--
|
|
66
65
|
-- @param roomGridIndex Set to undefined to use the current room index.
|
|
67
66
|
-- @param displayFlags The bit flags value to set. (See the `DisplayFlag` enum.)
|
|
@@ -94,9 +93,9 @@ function ____exports.setRoomDisplayFlags(self, roomGridIndex, displayFlags, upda
|
|
|
94
93
|
end
|
|
95
94
|
end
|
|
96
95
|
--- Helper function to add a `DisplayFlag` to a particular room's minimap display flags (e.g. whether
|
|
97
|
-
--
|
|
96
|
+
-- it is visible and so on).
|
|
98
97
|
--
|
|
99
|
-
-- This function automatically accounts for
|
|
98
|
+
-- This function automatically accounts for if MinimapAPI is being used.
|
|
100
99
|
--
|
|
101
100
|
-- @param roomGridIndex Set to undefined to use the current room index.
|
|
102
101
|
-- @param displayFlag The `DisplayFlag` to set. (See the `DisplayFlag` enum.)
|
|
@@ -112,7 +111,7 @@ function ____exports.addRoomDisplayFlag(self, roomGridIndex, displayFlag, update
|
|
|
112
111
|
end
|
|
113
112
|
--- Helper function to set the value of `DisplayFlag` for every room on the floor to 0.
|
|
114
113
|
--
|
|
115
|
-
-- This function automatically accounts for
|
|
114
|
+
-- This function automatically accounts for if MinimapAPI is being used.
|
|
116
115
|
--
|
|
117
116
|
-- This function automatically calls the `Level.UpdateVisibility` after setting the flags so that
|
|
118
117
|
-- the changes will be immediately visible.
|
|
@@ -121,7 +120,7 @@ function ____exports.clearFloorDisplayFlags(self)
|
|
|
121
120
|
end
|
|
122
121
|
--- Helper function to set the value of `DisplayFlag` for a room 0.
|
|
123
122
|
--
|
|
124
|
-
-- This function automatically accounts for
|
|
123
|
+
-- This function automatically accounts for if MinimapAPI is being used.
|
|
125
124
|
--
|
|
126
125
|
-- This function automatically calls the `Level.UpdateVisibility` after setting the flags so that
|
|
127
126
|
-- the changes will be immediately visible.
|
|
@@ -135,10 +134,9 @@ end
|
|
|
135
134
|
--- Helper function to get the minimap `DisplayFlag` value for every room on the floor. Returns a map
|
|
136
135
|
-- that is indexed by the room's safe grid index.
|
|
137
136
|
--
|
|
138
|
-
-- This function automatically accounts for
|
|
137
|
+
-- This function automatically accounts for if MinimapAPI is being used.
|
|
139
138
|
--
|
|
140
|
-
-- @param minimapAPI Optional.
|
|
141
|
-
-- true.
|
|
139
|
+
-- @param minimapAPI Optional. If MinimapAPI should be used, if present. Default is true.
|
|
142
140
|
function ____exports.getFloorDisplayFlags(self, minimapAPI)
|
|
143
141
|
if minimapAPI == nil then
|
|
144
142
|
minimapAPI = true
|
|
@@ -157,7 +155,7 @@ end
|
|
|
157
155
|
-- This is because if the player enters into the room or walks into an adjacent room, the room will
|
|
158
156
|
-- reappear on the minimap.
|
|
159
157
|
--
|
|
160
|
-
-- This function automatically accounts for
|
|
158
|
+
-- This function automatically accounts for if MinimapAPI is being used.
|
|
161
159
|
function ____exports.hideRoomOnMinimap(self, roomGridIndex)
|
|
162
160
|
____exports.clearRoomDisplayFlags(nil, roomGridIndex)
|
|
163
161
|
if MinimapAPI ~= nil then
|
|
@@ -173,8 +171,7 @@ end
|
|
|
173
171
|
--- Helper function to check if a given room is visible on the minimap.
|
|
174
172
|
--
|
|
175
173
|
-- @param roomGridIndex The room to check.
|
|
176
|
-
-- @param minimapAPI Optional. Whether
|
|
177
|
-
-- true.
|
|
174
|
+
-- @param minimapAPI Optional. Whether MinimapAPI should be used, if present. Default is true.
|
|
178
175
|
function ____exports.isRoomVisible(self, roomGridIndex, minimapAPI)
|
|
179
176
|
if minimapAPI == nil then
|
|
180
177
|
minimapAPI = true
|
|
@@ -187,7 +184,7 @@ end
|
|
|
187
184
|
-- This function automatically calls the `Level.UpdateVisibility` after setting the flags so that
|
|
188
185
|
-- the changes will be immediately visible.
|
|
189
186
|
--
|
|
190
|
-
-- This function automatically accounts for
|
|
187
|
+
-- This function automatically accounts for if MinimapAPI is being used.
|
|
191
188
|
--
|
|
192
189
|
-- @param displayFlagsMap A map of the display flags that is indexed by the room's safe grid index.
|
|
193
190
|
function ____exports.setFloorDisplayFlags(self, displayFlagsMap)
|
|
@@ -16,8 +16,8 @@ export declare function getNextStage(): LevelStage;
|
|
|
16
16
|
* `getNextStageTypeUsingHistory` helper function instead (from the stage history feature). Handling
|
|
17
17
|
* this requires stateful tracking as the player progresses through the run.
|
|
18
18
|
*
|
|
19
|
-
* @param upwards Whether
|
|
20
|
-
*
|
|
19
|
+
* @param upwards Whether the player should go up to Cathedral in the case of being on Womb 2.
|
|
20
|
+
* Default is false.
|
|
21
21
|
*/
|
|
22
22
|
export declare function getNextStageType(upwards?: boolean): StageType;
|
|
23
23
|
//# sourceMappingURL=nextStage.d.ts.map
|
|
@@ -88,8 +88,8 @@ end
|
|
|
88
88
|
-- `getNextStageTypeUsingHistory` helper function instead (from the stage history feature). Handling
|
|
89
89
|
-- this requires stateful tracking as the player progresses through the run.
|
|
90
90
|
--
|
|
91
|
-
-- @param upwards Whether
|
|
92
|
-
--
|
|
91
|
+
-- @param upwards Whether the player should go up to Cathedral in the case of being on Womb 2.
|
|
92
|
+
-- Default is false.
|
|
93
93
|
function ____exports.getNextStageType(self, upwards)
|
|
94
94
|
if upwards == nil then
|
|
95
95
|
upwards = false
|
|
@@ -52,8 +52,8 @@ export declare function getPillColorFromEffect(pillEffect: PillEffect): PillColo
|
|
|
52
52
|
/**
|
|
53
53
|
* Helper function to get a pill effect class from a PillEffect enum value. In this context, the
|
|
54
54
|
* class is equal to the numerical prefix in the "class" tag in the "pocketitems.xml" file. Use the
|
|
55
|
-
* `getPillEffectType` helper function to determine whether
|
|
56
|
-
*
|
|
55
|
+
* `getPillEffectType` helper function to determine whether the pill effect is positive, negative,
|
|
56
|
+
* or neutral.
|
|
57
57
|
*
|
|
58
58
|
* Due to limitations in the API, this function will not work properly for modded pill effects, and
|
|
59
59
|
* will always return `DEFAULT_PILL_EFFECT_CLASS` in those cases.
|
|
@@ -111,8 +111,8 @@ function ____exports.getPillColorFromEffect(self, pillEffect)
|
|
|
111
111
|
end
|
|
112
112
|
--- Helper function to get a pill effect class from a PillEffect enum value. In this context, the
|
|
113
113
|
-- class is equal to the numerical prefix in the "class" tag in the "pocketitems.xml" file. Use the
|
|
114
|
-
-- `getPillEffectType` helper function to determine whether
|
|
115
|
-
--
|
|
114
|
+
-- `getPillEffectType` helper function to determine whether the pill effect is positive, negative,
|
|
115
|
+
-- or neutral.
|
|
116
116
|
--
|
|
117
117
|
-- Due to limitations in the API, this function will not work properly for modded pill effects, and
|
|
118
118
|
-- will always return `DEFAULT_PILL_EFFECT_CLASS` in those cases.
|
|
@@ -12,7 +12,7 @@ export declare function addPlayerHealthType(player: EntityPlayer, healthType: He
|
|
|
12
12
|
*/
|
|
13
13
|
export declare function canPickEternalHearts(player: EntityPlayer): boolean;
|
|
14
14
|
/**
|
|
15
|
-
* Returns whether
|
|
15
|
+
* Returns whether all of the player's soul-heart-type hearts are black hearts.
|
|
16
16
|
*
|
|
17
17
|
* Note that this function does not consider red heart containers.
|
|
18
18
|
*
|
|
@@ -26,7 +26,7 @@ export declare function canPickEternalHearts(player: EntityPlayer): boolean;
|
|
|
26
26
|
*/
|
|
27
27
|
export declare function doesPlayerHaveAllBlackHearts(player: EntityPlayer): boolean;
|
|
28
28
|
/**
|
|
29
|
-
* Returns whether
|
|
29
|
+
* Returns whether all of the player's soul-heart-type hearts are soul hearts.
|
|
30
30
|
*
|
|
31
31
|
* Note that this function does not consider red heart containers.
|
|
32
32
|
*
|
|
@@ -98,8 +98,8 @@ export declare function getPlayerSoulHearts(player: EntityPlayer): int;
|
|
|
98
98
|
*
|
|
99
99
|
* If Tainted Magdalene has Birthright, she will gained an additional non-temporary heart container.
|
|
100
100
|
*
|
|
101
|
-
* This function does not validate whether
|
|
102
|
-
*
|
|
101
|
+
* This function does not validate whether the provided player is Tainted Magdalene; that should be
|
|
102
|
+
* accomplished before invoking this function.
|
|
103
103
|
*/
|
|
104
104
|
export declare function getTaintedMagdaleneNonTemporaryMaxHearts(player: EntityPlayer): int;
|
|
105
105
|
/** Returns a `PlayerHealth` object with all zeros. */
|
|
@@ -276,7 +276,7 @@ function ____exports.canPickEternalHearts(self, player)
|
|
|
276
276
|
local heartLimit = player:GetHeartLimit()
|
|
277
277
|
return eternalHearts == 0 or maxHearts ~= heartLimit
|
|
278
278
|
end
|
|
279
|
-
--- Returns whether
|
|
279
|
+
--- Returns whether all of the player's soul-heart-type hearts are black hearts.
|
|
280
280
|
--
|
|
281
281
|
-- Note that this function does not consider red heart containers.
|
|
282
282
|
--
|
|
@@ -292,7 +292,7 @@ function ____exports.doesPlayerHaveAllBlackHearts(self, player)
|
|
|
292
292
|
local blackHearts = ____exports.getPlayerBlackHearts(nil, player)
|
|
293
293
|
return blackHearts > 0 and soulHearts == 0
|
|
294
294
|
end
|
|
295
|
-
--- Returns whether
|
|
295
|
+
--- Returns whether all of the player's soul-heart-type hearts are soul hearts.
|
|
296
296
|
--
|
|
297
297
|
-- Note that this function does not consider red heart containers.
|
|
298
298
|
--
|
|
@@ -496,8 +496,8 @@ end
|
|
|
496
496
|
--
|
|
497
497
|
-- If Tainted Magdalene has Birthright, she will gained an additional non-temporary heart container.
|
|
498
498
|
--
|
|
499
|
-
-- This function does not validate whether
|
|
500
|
-
--
|
|
499
|
+
-- This function does not validate whether the provided player is Tainted Magdalene; that should be
|
|
500
|
+
-- accomplished before invoking this function.
|
|
501
501
|
function ____exports.getTaintedMagdaleneNonTemporaryMaxHearts(self, player)
|
|
502
502
|
local maxHearts = player:GetMaxHearts()
|
|
503
503
|
local hasBirthright = player:HasCollectible(CollectibleType.BIRTHRIGHT)
|
|
@@ -65,9 +65,8 @@ export declare function getPlayerIndexVanilla(playerToFind: EntityPlayer): int |
|
|
|
65
65
|
*
|
|
66
66
|
* If this is not desired, use the `getAllPlayers` helper function instead.
|
|
67
67
|
*
|
|
68
|
-
* @param performCharacterExclusions Whether
|
|
69
|
-
*
|
|
70
|
-
* false.
|
|
68
|
+
* @param performCharacterExclusions Whether to exclude characters that are not directly controlled
|
|
69
|
+
* by the player (i.e. Esau & Tainted Soul). Default is false.
|
|
71
70
|
*/
|
|
72
71
|
export declare function getPlayers(performCharacterExclusions?: boolean): EntityPlayer[];
|
|
73
72
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"playerIndex.d.ts","sourceRoot":"","sources":["../../../src/functions/playerIndex.ts"],"names":[],"mappings":";;;AAOA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAUxD;;;;;;GAMG;AACH,wBAAgB,aAAa,IAAI,YAAY,EAAE,CAU9C;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,YAAY,GAAG,YAAY,EAAE,CAMpE;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CAChC,WAAW,EAAE,WAAW,GACvB,YAAY,GAAG,SAAS,CAG1B;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,wBAAgB,cAAc,CAC5B,MAAM,EAAE,YAAY,EACpB,6BAA6B,UAAQ,GACpC,WAAW,CA8Bb;AAiBD;;;;;;GAMG;AACH,wBAAgB,qBAAqB,CACnC,YAAY,EAAE,YAAY,GACzB,GAAG,GAAG,SAAS,CAajB;AAED
|
|
1
|
+
{"version":3,"file":"playerIndex.d.ts","sourceRoot":"","sources":["../../../src/functions/playerIndex.ts"],"names":[],"mappings":";;;AAOA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAUxD;;;;;;GAMG;AACH,wBAAgB,aAAa,IAAI,YAAY,EAAE,CAU9C;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,YAAY,GAAG,YAAY,EAAE,CAMpE;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CAChC,WAAW,EAAE,WAAW,GACvB,YAAY,GAAG,SAAS,CAG1B;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,wBAAgB,cAAc,CAC5B,MAAM,EAAE,YAAY,EACpB,6BAA6B,UAAQ,GACpC,WAAW,CA8Bb;AAiBD;;;;;;GAMG;AACH,wBAAgB,qBAAqB,CACnC,YAAY,EAAE,YAAY,GACzB,GAAG,GAAG,SAAS,CAajB;AAED;;;;;;;;GAQG;AACH,wBAAgB,UAAU,CAAC,0BAA0B,UAAQ,GAAG,YAAY,EAAE,CAS7E;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAChC,SAAS,EAAE,eAAe,GACzB,YAAY,GAAG,SAAS,CAa1B;AAED;;;GAGG;AACH,wBAAgB,aAAa,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAE3D;AAED;;;GAGG;AACH,wBAAgB,WAAW,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAMzD"}
|
|
@@ -89,9 +89,8 @@ end
|
|
|
89
89
|
--
|
|
90
90
|
-- If this is not desired, use the `getAllPlayers` helper function instead.
|
|
91
91
|
--
|
|
92
|
-
-- @param performCharacterExclusions Whether
|
|
93
|
-
--
|
|
94
|
-
-- false.
|
|
92
|
+
-- @param performCharacterExclusions Whether to exclude characters that are not directly controlled
|
|
93
|
+
-- by the player (i.e. Esau & Tainted Soul). Default is false.
|
|
95
94
|
function ____exports.getPlayers(self, performCharacterExclusions)
|
|
96
95
|
if performCharacterExclusions == nil then
|
|
97
96
|
performCharacterExclusions = false
|
|
@@ -53,7 +53,7 @@ export declare function canPlayerCrushRocks(player: EntityPlayer): boolean;
|
|
|
53
53
|
*
|
|
54
54
|
* If the player does not have an item currently queued, then this function will be a no-op.
|
|
55
55
|
*
|
|
56
|
-
* Returns whether
|
|
56
|
+
* Returns whether an item was actually dequeued.
|
|
57
57
|
*/
|
|
58
58
|
export declare function dequeueItem(player: EntityPlayer): boolean;
|
|
59
59
|
/**
|
|
@@ -210,8 +210,8 @@ export declare function hasForm(player: EntityPlayer, ...playerForms: PlayerForm
|
|
|
210
210
|
/** After touching a white fire, a player will turn into The Lost until they clear a room. */
|
|
211
211
|
export declare function hasLostCurse(player: EntityPlayer): boolean;
|
|
212
212
|
/**
|
|
213
|
-
* Returns whether
|
|
214
|
-
*
|
|
213
|
+
* Returns whether the player can hold an additional active item, beyond what they are currently
|
|
214
|
+
* carrying. This takes the Schoolbag into account.
|
|
215
215
|
*
|
|
216
216
|
* If the player is the Tainted Soul, this always returns false, since that character cannot pick up
|
|
217
217
|
* items. (Only Tainted Forgotten can pick up items.)
|
|
@@ -331,7 +331,7 @@ export declare function removeTrinketCostume(player: EntityPlayer, trinketType:
|
|
|
331
331
|
* @param activeSlot Optional. The slot to set. Default is `ActiveSlot.PRIMARY`.
|
|
332
332
|
* @param charge Optional. The argument of charges to set. If not specified, the item will be set
|
|
333
333
|
* with maximum charges.
|
|
334
|
-
* @param keepInPools Optional. Whether
|
|
334
|
+
* @param keepInPools Optional. Whether to remove the item from pools. Default is false.
|
|
335
335
|
*/
|
|
336
336
|
export declare function setActiveItem(player: EntityPlayer, collectibleType: CollectibleType, activeSlot?: ActiveSlot, charge?: int, keepInPools?: boolean): void;
|
|
337
337
|
/**
|
|
@@ -340,7 +340,7 @@ export declare function setActiveItem(player: EntityPlayer, collectibleType: Col
|
|
|
340
340
|
* The method used in this function was discovered by im_tem.
|
|
341
341
|
*
|
|
342
342
|
* @param player The player to apply or remove the blindfold state from.
|
|
343
|
-
* @param enabled Whether
|
|
343
|
+
* @param enabled Whether to apply or remove the blindfold.
|
|
344
344
|
* @param modifyCostume Optional. Whether to add or remove the blindfold costume. Default is true.
|
|
345
345
|
*/
|
|
346
346
|
export declare function setBlindfold(player: EntityPlayer, enabled: boolean, modifyCostume?: boolean): void;
|
|
@@ -152,7 +152,7 @@ end
|
|
|
152
152
|
--
|
|
153
153
|
-- If the player does not have an item currently queued, then this function will be a no-op.
|
|
154
154
|
--
|
|
155
|
-
-- Returns whether
|
|
155
|
+
-- Returns whether an item was actually dequeued.
|
|
156
156
|
function ____exports.dequeueItem(self, player)
|
|
157
157
|
if player.QueuedItem.Item == nil then
|
|
158
158
|
return false
|
|
@@ -449,8 +449,8 @@ function ____exports.hasLostCurse(self, player)
|
|
|
449
449
|
local effects = player:GetEffects()
|
|
450
450
|
return effects:HasNullEffect(NullItemID.LOST_CURSE)
|
|
451
451
|
end
|
|
452
|
-
--- Returns whether
|
|
453
|
-
--
|
|
452
|
+
--- Returns whether the player can hold an additional active item, beyond what they are currently
|
|
453
|
+
-- carrying. This takes the Schoolbag into account.
|
|
454
454
|
--
|
|
455
455
|
-- If the player is the Tainted Soul, this always returns false, since that character cannot pick up
|
|
456
456
|
-- items. (Only Tainted Forgotten can pick up items.)
|
|
@@ -660,7 +660,7 @@ end
|
|
|
660
660
|
-- @param activeSlot Optional. The slot to set. Default is `ActiveSlot.PRIMARY`.
|
|
661
661
|
-- @param charge Optional. The argument of charges to set. If not specified, the item will be set
|
|
662
662
|
-- with maximum charges.
|
|
663
|
-
-- @param keepInPools Optional. Whether
|
|
663
|
+
-- @param keepInPools Optional. Whether to remove the item from pools. Default is false.
|
|
664
664
|
function ____exports.setActiveItem(self, player, collectibleType, activeSlot, charge, keepInPools)
|
|
665
665
|
if activeSlot == nil then
|
|
666
666
|
activeSlot = ActiveSlot.PRIMARY
|
|
@@ -728,7 +728,7 @@ end
|
|
|
728
728
|
-- The method used in this function was discovered by im_tem.
|
|
729
729
|
--
|
|
730
730
|
-- @param player The player to apply or remove the blindfold state from.
|
|
731
|
-
-- @param enabled Whether
|
|
731
|
+
-- @param enabled Whether to apply or remove the blindfold.
|
|
732
732
|
-- @param modifyCostume Optional. Whether to add or remove the blindfold costume. Default is true.
|
|
733
733
|
function ____exports.setBlindfold(self, player, enabled, modifyCostume)
|
|
734
734
|
if modifyCostume == nil then
|
|
@@ -25,17 +25,17 @@ export declare function getFirstPill(player: EntityPlayer): PocketItemDescriptio
|
|
|
25
25
|
*/
|
|
26
26
|
export declare function getPocketItems(player: EntityPlayer): PocketItemDescription[];
|
|
27
27
|
/**
|
|
28
|
-
* Returns whether
|
|
29
|
-
*
|
|
30
|
-
*
|
|
28
|
+
* Returns whether the player can hold an additional pocket item, beyond what they are currently
|
|
29
|
+
* carrying. This takes into account items that modify the max number of pocket items, like Starter
|
|
30
|
+
* Deck.
|
|
31
31
|
*
|
|
32
32
|
* If the player is the Tainted Soul, this always returns false, since that character cannot pick up
|
|
33
33
|
* items. (Only Tainted Forgotten can pick up items.)
|
|
34
34
|
*/
|
|
35
35
|
export declare function hasOpenPocketItemSlot(player: EntityPlayer): boolean;
|
|
36
36
|
/**
|
|
37
|
-
* Helper function to determine whether
|
|
38
|
-
*
|
|
37
|
+
* Helper function to determine whether the player's "active" pocket item slot is set to their
|
|
38
|
+
* pocket active item.
|
|
39
39
|
*/
|
|
40
40
|
export declare function isFirstSlotPocketActiveItem(player: EntityPlayer): boolean;
|
|
41
41
|
/** Helper function to see if two sets of pocket item descriptions are identical. */
|