External
Helper functions that have to do with external programs.
Functions
Section titled “Functions”rebirthItemTrackerRemoveCollectible()
Section titled “rebirthItemTrackerRemoveCollectible()”rebirthItemTrackerRemoveCollectible(…
collectibleTypes):void
Defined in: packages/isaacscript-common/src/functions/external.ts:39
Helper function to let the Rebirth Item Tracker know that it should remove a collectible from its list.
The “item tracker” in this function does not refer to the in-game item tracker, but rather to the external Python program.
This function is variadic, meaning that you can pass as many collectible types as you want to remove.
Note that calling this function is not normally necessary when removing collectibles from
players. For example, when you remove a collectible with the EntityPlayer.RemoveCollectible
method, a message is sent to the log file by the game and the item tracker will automatically
remove it. However, in some cases, manually removing collectibles can be useful:
- We may be giving the player a “fake” collectible (e.g. 1-Up for the purposes of an extra life) and do not want the fake collectible to show up on the tracker.
- We may be removing a starting active item. Since active items are never removed from the tracker, we want to tell the item tracker that the player never had a particular active item to begin with.
Parameters
Section titled “Parameters”collectibleTypes
Section titled “collectibleTypes”…readonly CollectibleType[]
Returns
Section titled “Returns”void
https://github.com/Rchardon/RebirthItemTracker
rebirthItemTrackerWriteToFile()
Section titled “rebirthItemTrackerWriteToFile()”rebirthItemTrackerWriteToFile(
msg):void
Defined in: packages/isaacscript-common/src/functions/external.ts:62
Helper function to let the Rebirth Item Tracker know that it should write the submitted text string to a file. This is useful for capturing text in programs like Open Broadcaster Software (OBS).
The “item tracker” in this function does not refer to the in-game item tracker, but rather to the external Python program.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”void