isaacscript-common 20.12.2 → 20.13.0

package/dist/index.d.ts

@@ -5158,6 +5158,28 @@ export declare function getMatchingGridEntities(gridEntityType: GridEntityType,
 
 export declare function getMoveActions(): ReadonlySet<ButtonAction>;
 
+/**
+ * Helper function to get the current effect that the Mysterious Paper trinket is providing to the
+ * player. Returns undefined if the player does not have the Mysterious Paper trinket.
+ *
+ * The Mysterious Paper trinket has four different effects:
+ *
+ * - The Polaroid (collectible)
+ * - The Negative (collectible)
+ * - A Missing Page (trinket)
+ * - Missing Poster (trinket)
+ *
+ * It rotates between these four effects on every frame. Note that Mysterious Paper will cause the
+ * `EntityPlayer.HasCollectible` and `EntityPlayer.HasTrinket` methods to return true for the
+ * respective items on the particular frame, with the exception of the Missing Poster. (The player
+ * will never "have" the Missing Poster, even on the correct corresponding frame.)
+ *
+ * @param player The player to look at.
+ * @param frameCount Optional. The frame count that corresponds to time the effect will be active.
+ *                   Default is the current frame.
+ */
+export declare function getMysteriousPaperEffectForFrame(player: EntityPlayer, frameCount?: int): MysteriousPaperEffect | undefined;
+
 /**
  * Helper function to get the first player with the lowest frame count. Useful to find a freshly
  * spawned player after using items like Esau Jr. Don't use this function if two or more players
@@ -5307,7 +5329,7 @@ export declare function getOtherPlayers(player: EntityPlayer): EntityPlayer[];
  *               (because the first level is this function, the second level is the calling
  *               function, and the third level is the parent of the calling function).
  */
-export declare function getParentFunctionDescription(levels?: number): string | undefined;
+export declare function getParentFunctionDescription(this: void, levels?: number): string | undefined;
 
 /**
  * Helper function to get the closest value from an array of strings based on partial search text.
@@ -6459,7 +6481,7 @@ export declare function getTotalPlayerCollectibles(collectibleType: CollectibleT
  * This will only work if the `--luadebug` launch option is enabled or the Racing+ sandbox is
  * enabled.
  */
-export declare function getTraceback(): string;
+export declare function getTraceback(this: void): string;
 
 /**
  * Helper function to get a transformation name from a PlayerForm enum.
@@ -8410,8 +8432,8 @@ export declare function lockDoor(door: GridEntityDoor): void;
 /**
  * Helper function to avoid typing out `Isaac.DebugString()`.
  *
- * If you have the "--luadebug" launch flag turned on or the Racing+ sandbox enabled, then this
- * function will also prepend the function name and the line number before the string, like this:
+ * If you have the "--luadebug" launch flag turned on, then this function will also prepend the
+ * function name and the line number before the string, like this:
  *
  * ```text
  * [INFO] - Lua Debug: saveToDisk:42494 - The save data manager wrote data to the "save#.dat" file.
@@ -8419,11 +8441,15 @@ export declare function lockDoor(door: GridEntityDoor): void;
  *
  * Subsequently, it is recommended that you turn on the "--luadebug" launch flag when developing
  * your mod so that debugging becomes a little bit easier.
+ *
+ * @param msg The message to log.
+ * @param includeParentFunction Optional. Whether to prefix the message with the function name and
+ *                              line number, as shown in the above example. Default is true.
  */
-export declare function log(msg: string): void;
+export declare function log(this: void, msg: string, includeParentFunction?: boolean): void;
 
 /** Helper function for printing out every entity (or filtered entity) in the current room. */
-export declare function logAllEntities(includeBackgroundEffects: boolean, entityTypeFilter?: EntityType): void;
+export declare function logAllEntities(this: void, includeBackgroundEffects: boolean, entityTypeFilter?: EntityType): void;
 
 /**
  * Helper function for printing out every grid entity (or filtered grid entity) in the current room.
@@ -8432,7 +8458,7 @@ export declare function logAllEntities(includeBackgroundEffects: boolean, entity
  * @param gridEntityTypeFilter Optional. If specified, will only log the given `GridEntityType`.
  *                             Default is undefined.
  */
-export declare function logAllGridEntities(includeWalls?: boolean, gridEntityTypeFilter?: GridEntityType): void;
+export declare function logAllGridEntities(this: void, includeWalls?: boolean, gridEntityTypeFilter?: GridEntityType): void;
 
 /**
  * Helper function to log a message to the "log.txt" file and to print it to the screen at the same
@@ -8441,25 +8467,25 @@ export declare function logAllGridEntities(includeWalls?: boolean, gridEntityTyp
 export declare function logAndPrint(msg: string): void;
 
 /** Helper function to enumerate all of the values in an array. */
-export declare function logArray<T>(array: T[] | readonly T[]): void;
+export declare function logArray<T>(this: void, array: T[] | readonly T[]): void;
 
-export declare function logCollectibleTypes(collectibleTypes: CollectibleType[]): void;
+export declare function logCollectibleTypes(this: void, collectibleTypes: CollectibleType[]): void;
 
-export declare function logColor(color: Color): void;
+export declare function logColor(this: void, color: Color): void;
 
 /** Helper function for printing out every damage flag that is turned on. Useful when debugging. */
-export declare function logDamageFlags(flags: DamageFlag | BitFlags<DamageFlag>): void;
+export declare function logDamageFlags(this: void, flags: DamageFlag | BitFlags<DamageFlag>): void;
 
 /** Helper function for logging an array of specific entities. */
-export declare function logEntities(entities: Entity[]): void;
+export declare function logEntities(this: void, entities: Entity[]): void;
 
 /** Helper function to log information about a specific entity. */
-export declare function logEntity(entity: Entity): void;
+export declare function logEntity(this: void, entity: Entity): void;
 
 /** Helper function for printing out every entity flag that is turned on. Useful when debugging. */
-export declare function logEntityFlags(flags: EntityFlag | BitFlags<EntityFlag>): void;
+export declare function logEntityFlags(this: void, flags: EntityFlag | BitFlags<EntityFlag>): void;
 
-export declare function logEntityID(entity: Entity): void;
+export declare function logEntityID(this: void, entity: Entity): void;
 
 /**
  * Helper function to log an error message and also print it to the console for better visibility.
@@ -8467,67 +8493,67 @@ export declare function logEntityID(entity: Entity): void;
  * This is useful in situations where using the `error` function would be dangerous (since it
  * prevents all of the subsequent code in the callback from running).
  */
-export declare function logError(msg: string): void;
+export declare function logError(this: void, msg: string): void;
 
 /** Helper function for printing out every flag that is turned on. Useful when debugging. */
-export declare function logFlags<T extends BitFlag | BitFlag128>(flags: T | BitFlags<T>, flagEnum: Record<string, T>, description?: string): void;
+export declare function logFlags<T extends BitFlag | BitFlag128>(this: void, flags: T | BitFlags<T>, flagEnum: Record<string, T>, description?: string): void;
 
 /**
  * Helper function for printing out every game state flag that is turned on. Useful when debugging.
  */
-export declare function logGameStateFlags(): void;
+export declare function logGameStateFlags(this: void): void;
 
 /** Helper function for logging an array of specific grid entities. */
-export declare function logGridEntities(gridEntities: GridEntity[]): void;
+export declare function logGridEntities(this: void, gridEntities: GridEntity[]): void;
 
 /** Helper function for log information about a specific grid entity. */
-export declare function logGridEntity(gridEntity: GridEntity): void;
+export declare function logGridEntity(this: void, gridEntity: GridEntity): void;
 
-export declare function logKColor(kColor: KColor): void;
+export declare function logKColor(this: void, kColor: KColor): void;
 
 /**
  * Helper function for printing out every level state flag that is turned on. Useful when debugging.
  */
-export declare function logLevelStateFlags(): void;
+export declare function logLevelStateFlags(this: void): void;
 
-export declare function logMap(map: Map<AnyNotNil, unknown>): void;
+export declare function logMap(this: void, map: Map<AnyNotNil, unknown>): void;
 
 export declare function logNewGlobals(): void;
 
-export declare function logPlayerEffects(player: EntityPlayer): void;
+export declare function logPlayerEffects(this: void, player: EntityPlayer): void;
 
-export declare function logPlayerHealth(player: EntityPlayer): void;
+export declare function logPlayerHealth(this: void, player: EntityPlayer): void;
 
 /**
  * Helper function for printing out every projectile flag that is turned on. Useful when debugging.
  */
-export declare function logProjectileFlags(flags: ProjectileFlag | BitFlags<ProjectileFlag>): void;
+export declare function logProjectileFlags(this: void, flags: ProjectileFlag | BitFlags<ProjectileFlag>): void;
 
 /**
  * Helper function to log information about the entity that corresponding to a pointer hash. (Only
  * use this when debugging, since retrieving the corresponding entity is expensive.)
  */
-export declare function logPtrHash(ptrHash: PtrHash): void;
+export declare function logPtrHash(this: void, ptrHash: PtrHash): void;
 
 /**
  * Helper function to log information about the entity that corresponding to one or more pointer
  * hashes. (Only use this when debugging, since retrieving the corresponding entity is expensive.)
  */
-export declare function logPtrHashes(ptrHashes: PtrHash[]): void;
+export declare function logPtrHashes(this: void, ptrHashes: PtrHash[]): void;
 
 /** Helper function for logging information about the current room. */
-export declare function logRoom(): void;
+export declare function logRoom(this: void): void;
 
 /**
  * Helper function for printing out every seed effect (i.e. Easter Egg) that is turned on for the
  * particular run.
  */
-export declare function logSeedEffects(): void;
+export declare function logSeedEffects(this: void): void;
 
-export declare function logSet(set: Set<AnyNotNil> | ReadonlySet<AnyNotNil>): void;
+export declare function logSet(this: void, set: Set<AnyNotNil> | ReadonlySet<AnyNotNil>): void;
 
 /** Helper function for logging every sound effect that is currently playing. */
-export declare function logSounds(): void;
+export declare function logSounds(this: void): void;
 
 /**
  * Helper function for logging every key and value of a Lua table. This is a deep log; the function
@@ -8539,13 +8565,13 @@ export declare function logSounds(): void;
  * In order to prevent infinite recursion, this function will not log a sub-table when there are 10
  * or more parent tables.
  */
-export declare function logTable(luaTable: unknown, parentTables?: number): void;
+export declare function logTable(this: void, luaTable: unknown, parentTables?: number): void;
 
 /**
  * Helper function to print out the differences between the entries of two tables. Note that this
  * will only do a shallow comparison.
  */
-export declare function logTableDifferences<K extends AnyNotNil, V>(table1: LuaMap<K, V>, table2: LuaMap<K, V>): void;
+export declare function logTableDifferences<K extends AnyNotNil, V>(this: void, table1: LuaMap<K, V>, table2: LuaMap<K, V>): void;
 
 /**
  * Helper function to log the keys of a Lua table. This is not a deep log; only the keys of the
@@ -8553,21 +8579,21 @@ export declare function logTableDifferences<K extends AnyNotNil, V>(table1: LuaM
  *
  * This function is useful for tables that have recursive references.
  */
-export declare function logTableKeys(luaTable: unknown): void;
+export declare function logTableKeys(this: void, luaTable: unknown): void;
 
 /** Helper function for printing out every tear flag that is turned on. Useful when debugging. */
-export declare function logTearFlags(flags: TearFlag | BitFlags<TearFlag>): void;
+export declare function logTearFlags(this: void, flags: TearFlag | BitFlags<TearFlag>): void;
 
 /** Helper function for printing out every use flag that is turned on. Useful when debugging. */
-export declare function logUseFlags(flags: UseFlag | BitFlags<UseFlag>): void;
+export declare function logUseFlags(this: void, flags: UseFlag | BitFlags<UseFlag>): void;
 
 /**
  * Helper function to enumerate all of the properties of a "userdata" object (i.e. an object from
  * the Isaac API).
  */
-export declare function logUserdata(userdata: unknown): void;
+export declare function logUserdata(this: void, userdata: unknown): void;
 
-export declare function logVector(vector: Vector, round?: boolean): void;
+export declare function logVector(this: void, vector: Vector, round?: boolean): void;
 
 /** Helper type to match all of the lowercase keys of an object. */
 export declare type LowercaseKeys<T> = StartsWithLowercase<keyof T>;
@@ -11633,6 +11659,19 @@ export declare function movePlayersToCenter(radius?: float): void;
  */
 export declare const musicManager: MusicManager;
 
+/**
+ * The possible effects that the Mysterious Paper trinket can grant.
+ *
+ * This enum has hard-coded values because they correspond to the specific in-game frame count of
+ * the player.
+ */
+export declare enum MysteriousPaperEffect {
+    POLAROID = 0,
+    NEGATIVE = 1,
+    MISSING_PAGE = 2,
+    MISSING_POSTER = 3
+}
+
 /** This is near the top door. */
 export declare const NEW_FLOOR_STARTING_POSITION_GREED_MODE: Vector;
 
@@ -15097,7 +15136,7 @@ export declare function todo(...args: unknown[]): void;
  * This will only work if the `--luadebug` launch option is enabled or the Racing+ sandbox is
  * enabled.
  */
-export declare function traceback(): void;
+export declare function traceback(this: void): void;
 
 /** Maps transformation names to the values of the `PlayerForm` enum. */
 export declare const TRANSFORMATION_NAME_TO_PLAYER_FORM_MAP: ReadonlyMap<string, PlayerForm>;