Binding of Isaac Lua API Documentation

https://wofsauge.github.io/IsaacDocs/
Admin
Community-curated Lua API documentation for The Binding of Isaac modding, providing comprehensive...
Tokens:924,437
Snippets:14,846
Trust Score:9.7
Update:2 months ago
Show doc for...
Tokens:
Raw
### GetBlackHearts Example Setup

Source: https://wofsauge.github.io/IsaacDocs/rep/EntityPlayer.html?q=%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5

Visual representation of heart configuration for GetBlackHearts.

```text
1
```

```text
B S S B B S S B B
```

--------------------------------

### Example Usage: Obtaining a RoomConfigEntry

Source: https://wofsauge.github.io/IsaacDocs/rep/RoomConfig_Entry.html?q=%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5

This example demonstrates how to get an instance of the RoomConfigEntry class using game and level functions.

```APIDOC
## Example Code

```lua
local level = Game():GetLevel()
local roomDescriptor = level:GetCurrentRoomDesc()
local roomConfigRoom = roomDescriptor.Data
local spawnList = roomConfigRoom.Spawns
local roomConfigSpawn = spawnList:Get(0)
local roomConfigEntry = roomConfigSpawn:PickEntry(0)
```
```

--------------------------------

### Example Usage

Source: https://wofsauge.github.io/IsaacDocs/rep/RoomConfig_Entry.html?q=%5E5%5E5+%5E5

This example demonstrates how to obtain a RoomConfigEntry instance.

```APIDOC
```lua
local level = Game():GetLevel()
local roomDescriptor = level:GetCurrentRoomDesc()
local roomConfigRoom = roomDescriptor.Data
local spawnList = roomConfigRoom.Spawns
local roomConfigSpawn = spawnList:Get(0)
local roomConfigEntry = roomConfigSpawn:PickEntry(0)
```
```

--------------------------------

### GetDevilRoomChance Example

Source: https://wofsauge.github.io/IsaacDocs/rep/Room.html?q=%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5

Example code demonstrating the usage of GetDevilRoomChance.

```lua
  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
```

--------------------------------

### FireKnife Example

Source: https://wofsauge.github.io/IsaacDocs/rep/EntityKnife.html?q=%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5

This example demonstrates how to get the player and use the FireKnife function to create a knife entity. Ensure the player object is valid before calling this function.

```lua
local knifeEntity = Isaac.GetPlayer():FireKnife(Isaac.GetPlayer())
```

--------------------------------

### Start Debugger Server in ZeroBrane Studio

Source: https://wofsauge.github.io/IsaacDocs/rep/tutorials/ZeroBraneStudio.html?q=%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5

In ZeroBrane Studio, set the project directory to your current file and start the debugger server. Ensure ZeroBrane has network access if prompted.

```lua
StartDebug()
```

--------------------------------

### Get EffectList Example

Source: https://wofsauge.github.io/IsaacDocs/rep/CppContainer_Vector_EffectList.html

Demonstrates how to retrieve the EffectList for a player. This is typically done through the player's temporary effects.

```lua
local player = Isaac.GetPlayer()
local tempEffects = player:GetEffects()
local effectlist = tempEffects:GetEffectsList()
```

--------------------------------

### ShowItemText with Player and Item Example

Source: https://wofsauge.github.io/IsaacDocs/rep/HUD.html

Example of how to use the ShowItemText function with player and item objects.

```APIDOC
## ShowItemText (EntityPlayer, ItemConfigItem)

### Description
Displays "streak text". You can use this to simulate the player picking up an item without them actually picking anything up.

### Method Signatures
`void ShowItemText(EntityPlayer Player, ItemConfigItem Item)`
`void ShowItemText(EntityPlayer Player, ItemConfigItem Item, boolean StackUpText)`

### Example Usage
```lua
local function showSadOnionText()
  local game = Game()
  local hud = game:GetHUD()
  local itemConfig = Isaac.GetItemConfig()

  local player = Isaac.GetPlayer()
  local itemConfigItem = itemConfig:GetCollectible(CollectibleType.COLLECTIBLE_SAD_ONION)
  hud:ShowItemText(player, itemConfigItem)
end
```
```

--------------------------------

### Safe Entity Reference Management

Source: https://wofsauge.github.io/IsaacDocs/rep/EntityPtr.html?q=%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5

This example demonstrates how to use EntityPtr to safely manage references to entities, particularly the player. It includes functions to initialize the pointer, retrieve the entity when the game starts, and safely get the player entity from the pointer, handling cases where the pointer or the referenced entity might be nil.

```lua
local playerPtr = nil

local function postPlayerInit(player)
  playerPtr = EntityPtr(player)
end

local function postGameStarted()
  local player = getPlayerFromPtr(playerPtr)
end

local function getPlayerFromPtr()
  if playerPtr == nil then
    return nil
  end

  if playerPtr.Ref == nil then
    return nil
  end

  return playerPtr.Ref:ToPlayer()
end
```

--------------------------------

### Get Projectile Entity Example

Source: https://wofsauge.github.io/IsaacDocs/rep/EntityProjectile.html

This example demonstrates how to obtain a projectile entity from the room's entities. Ensure the entity at the specified index is indeed a projectile.

```lua
local entity = Isaac.GetRoomEntities()[1]:ToProjectile()
```

--------------------------------

### Get Starting Room Index

Source: https://wofsauge.github.io/IsaacDocs/rep/Level.html

Returns the index of the level's starting room.

```lua
int GetStartingRoomIndex ( )
```

--------------------------------

### Obtaining a RoomConfigEntry Instance

Source: https://wofsauge.github.io/IsaacDocs/rep/RoomConfig_Entry.html?q=%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5

You can obtain an instance of the RoomConfigEntry class using the `Room_Spawn.PickEntry` function. The example code demonstrates the typical workflow to get a room configuration entry.

```APIDOC
## Obtaining a RoomConfigEntry Instance

You can get this class by using the following function:
* Room_Spawn.PickEntry

### Example Code
```lua
local level = Game():GetLevel()
local roomDescriptor = level:GetCurrentRoomDesc()
local roomConfigRoom = roomDescriptor.Data
local spawnList = roomConfigRoom.Spawns
local roomConfigSpawn = spawnList:Get(0)
local roomConfigEntry = roomConfigSpawn:PickEntry(0)
```
```

--------------------------------

### Start ZeroBrane Debugger Server

Source: https://wofsauge.github.io/IsaacDocs/rep/tutorials/ZeroBraneStudio.html

In ZeroBrane Studio, set the project directory to the location of your Lua file and start the debugger server. You may need to allow network access.

```lua
Project > Start debugger server
```

--------------------------------

### AddKeys Example

Source: https://wofsauge.github.io/IsaacDocs/rep/EntityPlayer.html

Adds 1 key to the player.

```lua
Isaac.GetPlayer():AddKeys(1)
```

--------------------------------

### MC_POST_GAME_STARTED

Source: https://wofsauge.github.io/IsaacDocs/rep/enums/ModCallbacks.html

This function gets called when you start a game. The boolean value indicates if the run is a continuation of a previous one.

```APIDOC
## MC_POST_GAME_STARTED

### Description
This function gets called when you start a game. The boolean value is true when you continue a run, false when you start a new one. This callback will be called after MC_POST_NEW_ROOM and after MC_POST_NEW_LEVEL.

Returning any value will have no effect on later callback executions.

### Example Code
```lua
local function onStart(_,bool)
    print(bool)
end
mod:AddCallback(ModCallbacks.MC_POST_GAME_STARTED, onStart)
```

### DLC
| DLC | Value | Name | Function Args | Optional Args | Return Type |
|---|---|---|---|---|---|
| 15 | MC_POST_GAME_STARTED | (IsContinued [bool]) | - | void |
```

--------------------------------

### Example Mod Directory Structure

Source: https://wofsauge.github.io/IsaacDocs/rep/tutorials/ExampleProject.html?q=%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5

An example of a specific mod folder path named customTears.

```text
C:\Program Files (x86)\Steam\steamapps\common\The Binding of Isaac Rebirth\mods\customTears
```

--------------------------------

### Start Stage Transition

Source: https://wofsauge.github.io/IsaacDocs/rep/Game.html

Starts a stage transition animation. Setting SameStage to true reseeds the stage. Special TransitionOverride values trigger unique stage progressions.

```lua
void StartStageTransition ( boolean SameStage, int TransitionOverride, EntityPlayer Player )
```

--------------------------------

### Get Door Entity Example

Source: https://wofsauge.github.io/IsaacDocs/rep/GridEntityDoor.html?q=%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5

Demonstrates how to obtain a door entity from a room. This is typically used to interact with specific doors in the game world.

```lua
Game():GetRoom():GetGridEntity(25):ToDoor()
```

--------------------------------

### ShowItemText Example

Source: https://wofsauge.github.io/IsaacDocs/rep/HUD.html

Example of how to use the ShowItemText function to display custom text on the HUD.

```APIDOC
## ShowItemText (string, string, boolean)

### Description
Displays "streak text". You can use this to simulate the player picking up an item without them actually picking anything up. The name of the method is misleading, as you can generate any arbitrary text - it does not necessarily have to do with an item.

### Method Signature
`void ShowItemText(string MainString, string SecondaryString, boolean IsCurseDisplay = false)`
`void ShowItemText(string MainString, string SecondaryString, boolean IsCurseDisplay = false, boolean StackUpText)`

### Example Usage
```lua
local function showHelpText()
  local game = Game()
  local hud = game:GetHUD()

  hud:ShowItemText("Don't touch the spikes!", "It will drain your mana.")
end
```
```

--------------------------------

### Get Grid Entity as Poop

Source: https://wofsauge.github.io/IsaacDocs/rep/GridEntityPoop.html?q=%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5

This example shows how to retrieve a grid entity at a specific position and convert it to a poop object.

```lua
Game():GetRoom():GetGridEntity(25):ToPoop()
```

--------------------------------

### Example bombcostumes.xml configuration

Source: https://wofsauge.github.io/IsaacDocs/rep/xml/bombcostumes.html?q=%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5

A basic example showing how to define a bomb variant and a rule that applies a specific animation when a TearFlag is present.

```xml
<bombcostumes anm2root="gfx/items/pick ups/bombs/">
    <bomb variant="0"> <!-- Normal bomb -->
        <!-- TearFlag 31 == TearFlags.TEAR_GLOW -->
        <rule includeFlags="31" body="glow.anm2" />
    </bomb>
</bombcostumes>
```

--------------------------------

### Accessing GridEntityPit

Source: https://wofsauge.github.io/IsaacDocs/rep/GridEntityPit.html?q=%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5

Demonstrates how to get a GridEntityPit instance. This is typically done by first getting the game room, then the grid entity at a specific position, and finally calling ToPit() on it.

```lua
Game():GetRoom():GetGridEntity(25):ToPit()
```

--------------------------------

### Restart(Challenge CurrentChallenge)

Source: https://wofsauge.github.io/IsaacDocs/rep/Seeds.html

Re-selects a random start seed, provided the current start seed was not custom.

```APIDOC
## void Restart(Challenge CurrentChallenge)

### Description
Re-selects a random start seed, but only if the start seed was not custom.
```

--------------------------------

### Example bombcostumes.xml Configuration

Source: https://wofsauge.github.io/IsaacDocs/rep/xml/bombcostumes.html?q=%5E5

This example demonstrates how to apply a custom 'glow' animation to normal bombs when they have the TearFlags.TEAR_GLOW flag set. Ensure the 'anm2root' path is correctly set.

```xml
<bombcostumes anm2root="gfx/items/pick ups/bombs/">
    <bomb variant="0"> 
        <rule includeFlags="31" body="glow.anm2" />
    </bomb>
</bombcostumes>
```

--------------------------------

### Initialize and use a Font object

Source: https://wofsauge.github.io/IsaacDocs/rep/GlobalFunctions.html?q=%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5

Demonstrates initializing a font object, loading a font file, and drawing a string to the screen.

```lua
local f = Font() -- init font object
f:Load("font/terminus.fnt") -- load a font into the font object
f:DrawString("Hello World!",60,50,KColor(1,1,1,1),0,true) -- render string with loaded font on position 60x50y
```

--------------------------------

### GridEntitySpikes Class

Source: https://wofsauge.github.io/IsaacDocs/rep/GridEntitySpikes.html

You can get this class by using the GridEntity.ToSpikes() function. An example usage is shown below.

```APIDOC
## Class "GridEntitySpikes"

You can get this class by using the following function:
  * GridEntity.ToSpikes()

Example Code
`Game():GetRoom():GetGridEntity(25):ToSpikes()`

### Variables
#### Timeout
* int Timeout
* * *
* * *

```

--------------------------------

### PostInit

Source: https://wofsauge.github.io/IsaacDocs/rep/GridEntity.html?q=%5E5

Performs post-initialization tasks for the GridEntity.

```APIDOC
## PostInit ()

### Description
Performs post-initialization tasks for the GridEntity.

### Method
void PostInit ( )
```

--------------------------------

### Get Challenge ID by Name Example

Source: https://wofsauge.github.io/IsaacDocs/rep/Isaac.html

Retrieves the internal ID of a challenge given its name.

```lua
local challengeId = Isaac.GetChallengeIdByName("The Keeper")
```

--------------------------------

### Get Trinket ID by Name Example

Source: https://wofsauge.github.io/IsaacDocs/rep/Isaac.html

Retrieves the internal ID of a trinket given its HUD name.

```lua
local trinketId = Isaac.GetTrinketIdByName("The Nail")
```

--------------------------------

### Instantiate SFXManager

Source: https://wofsauge.github.io/IsaacDocs/rep/SFXManager.html

Demonstrates how to create an instance of the SFXManager class.

```lua
local sfxManager = SFXManager()
```

--------------------------------

### Instantiate Game Class

Source: https://wofsauge.github.io/IsaacDocs/rep/Game.html

Demonstrates how to create a new instance of the Game class.

```lua
local game = Game()
```

--------------------------------

### Get Sound ID by Name Example

Source: https://wofsauge.github.io/IsaacDocs/rep/Isaac.html

Retrieves the internal ID of a sound effect given its name.

```lua
local soundId = Isaac.GetSoundIdByName("jump")
```

--------------------------------

### Execute Command Example

Source: https://wofsauge.github.io/IsaacDocs/rep/Isaac.html

Executes a game command and returns its output. Use with caution.

```lua
local result = Isaac.ExecuteCommand("debug 1")
```

--------------------------------

### Get Music ID by Name Example

Source: https://wofsauge.github.io/IsaacDocs/rep/Isaac.html

Retrieves the internal ID of a music track given its name.

```lua
local musicId = Isaac.GetMusicIdByName("Basement")
```

--------------------------------

### Get Item ID by Name Example

Source: https://wofsauge.github.io/IsaacDocs/rep/Isaac.html

Retrieves the internal ID of an item given its HUD name.

```lua
local itemId = Isaac.GetItemIdByName("Brimstone")
```

--------------------------------

### MC_POST_LASER_INIT

Source: https://wofsauge.github.io/IsaacDocs/rep/enums/ModCallbacks.html

Callback executed after a laser is initialized. Note that some entity data may be incomplete at this stage.

```APIDOC
## MC_POST_LASER_INIT

### Description
Callback executed after a laser is initialized. Returning any value has no effect on later callback executions. Accessing the initialized entity provides incomplete data; only Position, Velocity, SpawnerType, SpawnerVariant, SpawnerEntity, and some others are set.

### Function Args
- LaserVariant (type inferred from context)

### Return Type
void
```

--------------------------------

### Game Initialization

Source: https://wofsauge.github.io/IsaacDocs/rep/Game.html

Retrieves the current game instance.

```APIDOC
## Game Game ( )

### Description
Retrieves the current game instance.

### Method
Game

### Endpoint
N/A (SDK Function)

### Return Value
- Game (Game) - The current game instance.
```

--------------------------------

### Get Entity Type by Name Example

Source: https://wofsauge.github.io/IsaacDocs/rep/Isaac.html

Retrieves the EntityType enum value for a given entity name.

```lua
local enemyType = Isaac.GetEntityTypeByName("Monstro")
```

--------------------------------

### Get Card ID by Name Example

Source: https://wofsauge.github.io/IsaacDocs/rep/Isaac.html

Retrieves the internal ID of a card given its HUD name.

```lua
local cardId = Isaac.GetCardIdByName("The Fool")
```

--------------------------------

### Game Initialization

Source: https://wofsauge.github.io/IsaacDocs/rep/Game.html?q=%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5

Initializes a new game instance. This is the primary entry point for starting a game.

```APIDOC
## Game Game ( )

### Description
Initializes and returns a new game instance.

### Method
Game

### Endpoint
N/A (SDK function)

### Return Value
- **Game** - The newly created game instance.
```

--------------------------------

### Get Pill Effect by Name Example

Source: https://wofsauge.github.io/IsaacDocs/rep/Isaac.html

Retrieves the PillEffect enum value for a given pill effect name.

```lua
local pillEffect = Isaac.GetPillEffectByName("Health Up")
```

--------------------------------

### MC_POST_GAME_STARTED

Source: https://wofsauge.github.io/IsaacDocs/rep/enums/ModCallbacks.html

Callback executed after a new game has started. Useful for initializing mod data at the beginning of a game.

```APIDOC
## MC_POST_GAME_STARTED

### Description
Callback executed after a new game has started. Useful for initializing mod data at the beginning of a game.

### Function Signature
`MC_POST_GAME_STARTED(IsContinued [bool])`

### Return Type
`void`
```

--------------------------------

### Start Room Transition

Source: https://wofsauge.github.io/IsaacDocs/rep/Game.html

Initiates a transition to a new room. Avoid interrupting the PIXELATION animation to prevent log spam.

```lua
void StartRoomTransition ( int RoomIndex, Direction Direction, RoomTransitionAnim Animation = RoomTransitionAnim.WALK, EntityPlayer Player = nil, int Dimension = -1 )
```

--------------------------------

### Get Player Type by Name Example

Source: https://wofsauge.github.io/IsaacDocs/rep/Isaac.html

Retrieves the PlayerType enum value for a given player name, optionally checking for tainted versions.

```lua
local playerType = Isaac.GetPlayerTypeByName("Isaac", false)
```

--------------------------------

### Post Initialization

Source: https://wofsauge.github.io/IsaacDocs/rep/GridEntity.html

Performs actions after the GridEntity has been initialized.

```lua
void PostInit ( )
```

--------------------------------

### Post Initialization

Source: https://wofsauge.github.io/IsaacDocs/rep/GridEntity.html?q=%5E5%5E5+%5E5

Performs actions after the GridEntity has been initialized.

```lua
PostInit()
```

--------------------------------

### Register MC_POST_GAME_STARTED Callback

Source: https://wofsauge.github.io/IsaacDocs/rep/enums/ModCallbacks.html

This callback is triggered when a game starts. The boolean argument indicates if the run is a continuation of a previous one. Use this to perform actions at the beginning of a game session.

```lua
local function onStart(_,bool)
    print(bool)
end
mod:AddCallback(ModCallbacks.MC_POST_GAME_STARTED, onStart)
```

--------------------------------

### EntityPlayer.FireTear()

Source: https://wofsauge.github.io/IsaacDocs/rep/EntityTear.html?q=%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5

This function can be used to get the EntityTear class. It is a way to access tear-specific functionalities. Example: `local tearEntity = Isaac.GetPlayer():FireTear( Vector(0,0), Vector(1, 1) )`

```APIDOC
## EntityPlayer.FireTear()

### Description
Fires a tear projectile from the player entity. This is the primary way to create a new tear.

### Parameters
- **position** (Vector) - The starting position of the tear.
- **velocity** (Vector) - The initial velocity of the tear.

### Example
```lua
local tearEntity = Isaac.GetPlayer():FireTear( Vector(0,0), Vector(1, 1) )
```
```

--------------------------------

### MC_POST_PLAYER_INIT

Source: https://wofsauge.github.io/IsaacDocs/rep/enums/ModCallbacks.html

Callback executed after a player is initialized. Useful for setting up player-specific mod data.

```APIDOC
## MC_POST_PLAYER_INIT

### Description
Callback executed after a player is initialized. Useful for setting up player-specific mod data.

### Function Signature
`MC_POST_PLAYER_INIT(EntityPlayer)`

### Optional Arguments
`PlayerVariant*`

### Return Type
`void`
```

--------------------------------

### Get

Source: https://wofsauge.github.io/IsaacDocs/rep/CppContainer_ArrayProxy_RoomConfigSpawns.html?q=%5E5

Returns a RoomConfig Spawn at the index of the list provided.

```APIDOC
## Get ()

### Description
Returns a RoomConfig Spawn at the specified index from the list.

### Method
Get

### Parameters
#### Path Parameters
- **idx** (int) - Required - The index of the spawn to retrieve.

### Return Value
RoomConfig Spawn - The spawn configuration at the given index.
```

--------------------------------

### Players XML Structure Example

Source: https://wofsauge.github.io/IsaacDocs/rep/xml/players.html?q=%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5

This XML snippet demonstrates the basic structure for defining a player character within the players.xml file. It includes attributes for character name, appearance, stats, and starting items.

```xml
<players root="gfx/characters/costumes/"
         portraitroot="gfx/ui/boss/"
         nameimageroot="gfx/ui/boss/">
    <player name="Bob" skin="character_Bob.png" hp="4"
          black="4" pocketActive="712" items="1,4" keys="3"
          nameimage="playername_Bob.png"
          portrait="playerportrait_Bob.png"
          skinColor="-1" canShoot="false"
          birthright="You are now a gamer"/>
</players>
```

--------------------------------

### XML Challenge Definition

Source: https://wofsauge.github.io/IsaacDocs/rep/xml/challenges.html?q=%5E5

Defines a custom challenge with specific starting items, room filters, curse filters, and player abilities. This example creates a challenge where players cannot shoot and certain rooms/curses are disabled.

```xml
<challenges version="1">
    <challenge playertype="0" name="My new challenge" endstage="8" startingitems="25,81,100" roomfilter="1" cursefilter="1" canshoot="false" />
</challenges>
```

--------------------------------

### Print 'Hello World!' on Card Use

Source: https://wofsauge.github.io/IsaacDocs/rep/enums/ModCallbacks.html

This callback will print 'Hello World!' to the console every time any card is used by any player. It registers a function to the MC_USE_CARD callback without specifying a particular card.

```lua
function mod:myFunction(cardID, playerWhoUsedItem, useFlags)
    print("Hello World!")
end
mod:AddCallback(ModCallbacks.MC_USE_CARD, mod.myFunction)
```

--------------------------------

### Spawn Entity Example

Source: https://wofsauge.github.io/IsaacDocs/rep/Entity.html

This code snippet demonstrates how to spawn a new entity in the game. It specifies the entity type, variant, and initial position. Ensure the correct EntityType and PickupVariant are used for the desired outcome.

```lua
local entity = Isaac.Spawn(EntityType.ENTITY_PICKUP, PickupVariant.PICKUP_COLLECTIBLE, 0, Vector(320,280), Vector(0,0), nil)
```

--------------------------------

### Passing Shader Parameters with Lua

Source: https://wofsauge.github.io/IsaacDocs/rep/tutorials/Writingscreenshaders.html

Registers a mod and defines a callback function to provide shader parameters. This example shows how to get the player's position and the current frame count to pass to the 'RandomColors' shader.

```lua
local mod = RegisterMod("ShaderMod", 1)
function mod:GetShaderParams(shaderName)
    if shaderName == 'RandomColors' then
        local playerPos = Isaac.GetPlayer().Position
        local params = {
            PlayerPos = {   playerPos.X / 100.0,
                            playerPos.Y / 100.0 },
                            Time = Isaac.GetFrameCount()
            }
        return params;
    end
end
mod:AddCallback(ModCallbacks.MC_GET_SHADER_PARAMS, mod.GetShaderParams)
```

--------------------------------

### Game Constructor

Source: https://wofsauge.github.io/IsaacDocs/rep/Game.html

Demonstrates how to create a new instance of the Game class.

```APIDOC
## Game()

### Description
This is the constructor for the Game class. It allows you to create a new game instance.

### Method
Constructor

### Endpoint
N/A (Class Constructor)

### Parameters
None

### Request Example
```lua
local game = Game()
```

### Response
#### Success Response (Instance)
- **game** (Game) - A new instance of the Game class.

#### Response Example
```lua
-- No direct response example for constructor, but the created object is of type Game.
```
```

--------------------------------

### EntityPtr Constructor

Source: https://wofsauge.github.io/IsaacDocs/rep/EntityPtr.html?q=%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5

Demonstrates how to create an EntityPtr instance by referencing an existing entity, such as the player.

```APIDOC
## EntityPtr()

### Description
Constructs a new EntityPtr instance.

### Parameters
* **Entity** (Entity) - The entity to create a pointer to.

### Request Example
```lua
local myPointer = EntityPtr(Isaac.GetPlayer())
```
```

--------------------------------

### Get() Function

Source: https://wofsauge.github.io/IsaacDocs/rep/CppContainer_EntityList.html?q=%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5

The Get() function retrieves an entity from the list at a specified index.

```APIDOC
## Get ()

### Entity Get ( int idx )

Returns an Entity at the index of the list provided.
```

--------------------------------

### Get() Function

Source: https://wofsauge.github.io/IsaacDocs/rep/CppContainer_EntityList.html?q=%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5

The Get function retrieves an Entity from the list at a specified index.

```APIDOC
## Functions
### Get ()
#### Entity Get ( int idx )
Returns an Entity at the index of the list provided.
```

--------------------------------

### Load ANM2 File and Render Sprite

Source: https://wofsauge.github.io/IsaacDocs/rep/Sprite.html

This example demonstrates creating a new sprite, loading an ANM2 file with specified graphics loading behavior, and then rendering the sprite at a given position. The ANM2Path should be relative to the 'resources' folder.

```lua
local mySprite = Sprite()
mySprite:Load("gfx/myCoolAnimation.anm2", true)
mySprite:Render(Vector(75,75), Vector(0,0), Vector(0,0))
```

--------------------------------

### Initialize and Render a Sprite

Source: https://wofsauge.github.io/IsaacDocs/rep/Sprite.html?q=%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5

Creates a new sprite instance, loads an animation file, and renders it at a specific screen position.

```lua
local mySprite = Sprite()
mySprite:Load("gfx/myCoolAnimation.anm2", true)
mySprite:Render(Vector(75,75), Vector(0,0), Vector(0,0))
```

--------------------------------

### Mod API Example: Minimap Library

Source: https://wofsauge.github.io/IsaacDocs/rep/tutorials/CustomCallbacks.html?q=%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5

Demonstrates how a library mod can expose custom callbacks for dependent mods to use. Dependent mods can add callbacks without needing to wait for the library to load.

```lua
-- ... callback where the minimap is enlarged
Isaac.RunCallback("MINIMAPLIB_POST_MINIMAP_ENLARGE", nil, currentSize)
```

```lua
MOD2:AddCallback("MINIMAPLIB_POST_MINIMAP_ENLARGE", function(_, currentSize)
    print("Minimap size has changed!", currentSize)
    -- do something using currentSize
end)
```

--------------------------------

### Enable

Source: https://wofsauge.github.io/IsaacDocs/rep/MusicManager.html?q=%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5

Enables the MusicManager, allowing music playback to resume or start.

```APIDOC
## Enable ()

### Description
Enables the MusicManager, allowing music playback.
```

--------------------------------

### Entity DepthOffset Example

Source: https://wofsauge.github.io/IsaacDocs/rep/Entity.html

This example demonstrates how the DepthOffset variable affects the rendering order of entities by modifying their Y position for rendering.

```lua
entity1.Position.Y -- => 50
entity2.Position.Y -- => 45
-- Entity1 is rendered in front of Entity2

entity1.DepthOffset = -10
-- new Entity1 renderYPosition => 40
-- Entity2 is rendered in front of Entity1
```

--------------------------------

### Instantiate Game Class

Source: https://wofsauge.github.io/IsaacDocs/rep/Game.html?q=%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5

Demonstrates how to create a new instance of the Game class. This is the primary way to access game functionalities.

```lua
local game = Game()

```

--------------------------------

### Example GridEntity State

Source: https://wofsauge.github.io/IsaacDocs/rep/GridEntity.html?q=%5E5%5E5+%5E5

Represents a state for a GridEntity. State 1 is a generic example, while state 2 signifies destroyed rocks.

```plaintext
1
```

```plaintext
2
```

--------------------------------

### Get Number of Entries in Lua Table (No Keys)

Source: https://wofsauge.github.io/IsaacDocs/rep/tutorials/MathAndLuaTips.html

Use the '#' operator to get the number of entries in a Lua table that does not have keys defined.

```lua
local exampleTable = {"apple", 69, 1337, -3}
print(#exampleTable) -- Result: 4
```

--------------------------------

### Game Constructor

Source: https://wofsauge.github.io/IsaacDocs/rep/Game.html?q=%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5

Initializes a new Game object. This is the primary way to start or interact with a game instance.

```APIDOC
## Game Game ( )

### Description
Returns a Game object.

### Method
Game()

### Example Code
```lua
local game = Game()
print(game:IsPaused()) -- returns true if the game is paused
```
```

--------------------------------

### Enable

Source: https://wofsauge.github.io/IsaacDocs/rep/MusicManager.html

Enables the music manager.

```APIDOC
## Enable

### Description
Enables the music manager.

### Method
`void Enable()`
```

--------------------------------

### Get Random Room Index

Source: https://wofsauge.github.io/IsaacDocs/rep/Level.html

Gets the index of a random room, with options to force an error room and use a specific seed.

```lua
int GetRandomRoomIndex ( boolean IAmErrorRoom, int Seed )
```

--------------------------------

### Get Entity ID String

Source: https://wofsauge.github.io/IsaacDocs/rep/entities/Overview.html?q=%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5

Use this helper function to get a string representation of an entity's Type, Variant, and SubType. This is useful for logging or debugging.

```lua
-- Helper function to get a string containing an entity's type, variant, and sub-type.
local function getEntityID(entity)
  return tostring(entity.Type) .. "." .. tostring(entity.Variant) .. "." .. tostring(entity.SubType)
end
```

--------------------------------

### Console Output Example

Source: https://wofsauge.github.io/IsaacDocs/rep/Isaac.html

Outputs a string to the game's console. Useful for debugging.

```lua
Isaac.ConsoleOutput("Hello, Isaac!")
```

--------------------------------

### Get Room Descriptor (Read-Only and Writable)

Source: https://wofsauge.github.io/IsaacDocs/rep/Level.html

Retrieves the RoomDescriptor for the current room in both read-only and writable forms. Use GetRoomByIdx() with GetCurrentRoomIndex() to get a writable version.

```lua
local level = Game():GetLevel()
local readOnlyRoomDesc = level:GetCurrentRoomDesc()
local writeableRoomDesc = level:GetRoomByIdx(level:GetCurrentRoomIndex())
```

--------------------------------

### StartRoomTransition

Source: https://wofsauge.github.io/IsaacDocs/rep/Game.html?q=%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5

Initiates a transition to a different room.

```APIDOC
## StartRoomTransition

### Description
Initiates a transition to a different room.

### Parameters
#### Path Parameters
- **RoomIndex** (int) - Required - The index of the room to transition to.
- **Direction** (Direction) - Required - The direction of the transition.
- **Animation** (RoomTransitionAnim) - Optional - The animation to use for the transition. Defaults to RoomTransitionAnim.WALK.
- **Player** (EntityPlayer) - Optional - The player involved in the transition. Defaults to nil.
- **Dimension** (int) - Optional - The dimension for the transition. Defaults to -1.
```

--------------------------------

### Get Card from Pool

Source: https://wofsauge.github.io/IsaacDocs/rep/ItemPool.html

Retrieves a card from the item pool based on the provided parameters. This function is used to get a card with specific seeding and playing conditions.

```lua
Card GetCard ( int Seed, boolean Playing, boolean Rune, boolean OnlyRunes )
```

--------------------------------

### MC_POST_LASER_INIT

Source: https://wofsauge.github.io/IsaacDocs/rep/enums/ModCallbacks.html

Callback executed when a laser beam is initialized. Useful for modifying laser properties.

```APIDOC
## MC_POST_LASER_INIT

### Description
Callback executed when a laser beam is initialized. Useful for modifying laser properties.

### Function Signature
`MC_POST_LASER_INIT(EntityLaser)`

### Optional Arguments
`LaserVariant`

### Return Type
`void`
```

--------------------------------

### EntityPtr Constructor

Source: https://wofsauge.github.io/IsaacDocs/rep/EntityPtr.html?q=%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5

Demonstrates how to create an instance of EntityPtr by passing an existing Entity object to its constructor.

```APIDOC
## EntityPtr Constructor

### Description
Creates a new EntityPtr instance that holds a reference to the provided Entity.

### Syntax
`EntityPtr(Entity entity)`

### Parameters
*   `entity` (Entity) - The entity to create a pointer to.

### Example
```lua
local player = Isaac.GetPlayer()
local playerPtr = EntityPtr(player)
```
```

--------------------------------

### InitBabySkin

Source: https://wofsauge.github.io/IsaacDocs/rep/EntityPlayer.html?q=%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5

Initializes the baby skin for the player.

```APIDOC
void InitBabySkin ( )
```

--------------------------------

### Check Item Tag Example

Source: https://wofsauge.github.io/IsaacDocs/rep/enums/ItemConfig.html?q=%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5

Demonstrates how to retrieve an item's configuration and check if it possesses a specific tag using bitwise AND operations. This is useful for conditional logic based on item properties.

```lua
local sadOnionConfig = Isaac.GetItemConfig():GetCollectible(1)
if sadOnionConfig.Tags & ItemConfig.TAG_SUMMONABLE == ItemConfig.TAG_SUMMONABLE then
    print("This item has the tag 'summonable'")
end
```

--------------------------------

### Get Entity ID Helper Function

Source: https://wofsauge.github.io/IsaacDocs/rep/entities/Overview.html

Use this helper function to get a string representing an entity's Type, Variant, and SubType. This is useful for uniquely identifying entities.

```lua
local function getEntityID(entity)
  return tostring(entity.Type) .. "." .. tostring(entity.Variant) .. "." .. tostring(entity.SubType)
end
```

--------------------------------

### EntityPtr Constructor

Source: https://wofsauge.github.io/IsaacDocs/rep/EntityPtr.html?q=%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5

Demonstrates how to create an EntityPtr instance by passing an existing Entity object to its constructor.

```APIDOC
## Constructor: EntityPtr()

### Description
Creates a new EntityPtr instance that holds a reference to the provided Entity.

### Parameters
*   **Entity ref** (Entity) - The entity to create a pointer for.

### Example
```lua
local player = Isaac.GetPlayer()
local playerPtr = EntityPtr(player)
```
```

--------------------------------

### Get Mouse Position

Source: https://wofsauge.github.io/IsaacDocs/rep/Input.html

Retrieves the current mouse position in either game or render coordinates. Use this to get the mouse's location for in-game actions or UI elements.

```lua
local mousePos = Input.GetMousePosition(true) -- get mouse position in world coordinates
local screenPos = Isaac.WorldToScreen(mousePos) -- transfer game- to screen coordinates
Isaac.RenderText("Hello World!", screenPos.X, screenPos.Y, 1 ,1 ,1 ,1 )
```

--------------------------------

### Accessing RoomConfigRoom

Source: https://wofsauge.github.io/IsaacDocs/rep/RoomConfig_Room.html

Demonstrates how to retrieve the RoomConfigRoom instance from the current room descriptor.

```lua
local game = Game()
local level = game:GetLevel()
local roomDescriptor = level:GetCurrentRoomDesc()
local roomConfigRoom = roomDescriptor.Data
```

--------------------------------

### GetBossColorIdx

Source: https://wofsauge.github.io/IsaacDocs/rep/EntityNPC.html?q=%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5

Gets the boss color index. Note: This will return the boss color index reduced by 1. To get the actual color as set in bosscolors.xml, add +1 to the result.

```APIDOC
## GetBossColorIdx()

### Description
Gets the boss color index.

### Returns
* **int** - The boss color index (reduced by 1).
```

--------------------------------

### Spawning an Entity

Source: https://wofsauge.github.io/IsaacDocs/rep/Entity.html

This example demonstrates how to spawn a new entity in the game using the Isaac.Spawn function. It specifies the entity type, variant, subtype, position, velocity, and owner.

```APIDOC
## Isaac.Spawn()

### Description
Spawns a new entity in the game.

### Parameters
- **entityType** (EntityType) - The type of entity to spawn.
- **entityVariant** (int) - The variant of the entity.
- **entitySubtype** (int) - The subtype of the entity.
- **position** (Vector) - The world position where the entity should spawn.
- **velocity** (Vector) - The initial velocity of the entity.
- **owner** (Entity) - The entity that owns this spawned entity (can be nil).

### Request Example
```lua
local entity = Isaac.Spawn(EntityType.ENTITY_PICKUP, PickupVariant.PICKUP_COLLECTIBLE, 0, Vector(320,280), Vector(0,0), nil)
```
```

--------------------------------

### Get Boss Color Index

Source: https://wofsauge.github.io/IsaacDocs/rep/EntityNPC.html?q=%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5

Returns the boss color index. Note that this value is reduced by 1; add 1 to get the actual color index as defined in bosscolors.xml.

```lua
int GetBossColorIdx ( )
```

--------------------------------

### GetRandomPlayer Example

Source: https://wofsauge.github.io/IsaacDocs/rep/Game.html?q=%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5

Selects a random player within a specified radius around a given position.

```lua
EntityPlayer GetRandomPlayer ( Vector Pos, float Radius )
```

--------------------------------

### StartRoomTransition

Source: https://wofsauge.github.io/IsaacDocs/rep/Game.html?q=%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5

Initiates a transition to a specified room with various animation options and player handling. Note the potential for buffer overflow with the PIXELATION animation if interrupted.

```APIDOC
## StartRoomTransition ( int RoomIndex, Direction Direction, RoomTransitionAnim Animation = RoomTransitionAnim.WALK, EntityPlayer Player = nil, int Dimension = -1 )

### Description
Initiates a transition to a specified room with various animation options and player handling. Note the potential for buffer overflow with the PIXELATION animation if interrupted.

### Parameters
#### Path Parameters
- **RoomIndex** (int) - Description of the target room index.
- **Direction** (Direction) - The direction of the transition (Note: this parameter is ignored by the game).
- **Animation** (RoomTransitionAnim) - Optional. The type of transition animation to use. Defaults to RoomTransitionAnim.WALK.
- **Player** (EntityPlayer) - Optional. The player entity involved in the transition. Defaults to nil.
- **Dimension** (int) - Optional. The ID of the dimension to get the room from. Defaults to -1 (current dimension).

### Dimension Info
- **-1**: Current dimension
- **0**: Main dimension
- **1**: Secondary dimension, used by Downpour mirror dimension and Mines escape sequence
- **2**: Death Certificate dimension

### Notes
The boss vs screen overrides all of these transitions. Using RoomTransitionAnim.DEATH_CERTIFICATE will make the player appear lying down after the vs screen and pause the game while they get up.

### Bugs
The Direction variable is completely ignored; the game calculates the direction between rooms itself. It has no impact on doors.
```

--------------------------------

### Register Mod Example

Source: https://wofsauge.github.io/IsaacDocs/rep/Isaac.html

Registers a mod with the game, providing its reference, name, and API version.

```lua
Isaac.RegisterMod(modRef, "MyAwesomeMod", 1)
```

--------------------------------

### Get Grid Entity ID Helper Function

Source: https://wofsauge.github.io/IsaacDocs/rep/entities/Overview.html

Use this helper function to get a string representing a grid entity's Type and Variant. Grid entities do not use SubTypes.

```lua
local function getGridEntityID(gridEntity)
  local gridEntityType = gridEntity:GetType()
  local gridEntityVariant = gridEntity:GetVariant()
  return tostring(gridEntityType) .. "." .. tostring(gridEntityVariant)
end
```

--------------------------------

### EntityPtr Constructor

Source: https://wofsauge.github.io/IsaacDocs/rep/EntityPtr.html?q=%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5

Demonstrates how to create an EntityPtr instance by passing an Entity object to its constructor.

```APIDOC
## EntityPtr Constructor

### Description
Creates a new EntityPtr instance that holds a reference to a given Entity.

### Syntax
```lua
EntityPtr(Entity entity)
```

### Parameters
*   **entity** (Entity) - The entity to create a pointer to.

### Example
```lua
local playerPtr = EntityPtr(Isaac.GetPlayer())
```
```

--------------------------------

### Get Mouse Position

Source: https://wofsauge.github.io/IsaacDocs/rep/Input.html?q=%5E5%5E5+%5E5

Retrieves the current mouse position in either game or render coordinates. Use this to get the mouse's location for UI elements or game world interactions.

```lua
local mousePos = Input.GetMousePosition(true)
```

```lua
local mousePos = Input.GetMousePosition(true) -- get mouse position in world coordinates
local screenPos = Isaac.WorldToScreen(mousePos) -- transfer game- to screen coordinates
Isaac.RenderText("Hello World!", screenPos.X, screenPos.Y, 1 ,1 ,1 ,1 )
```

--------------------------------

### GetPlayer

Source: https://wofsauge.github.io/IsaacDocs/rep/Isaac.html

Gets the player entity.

```APIDOC
## GetPlayer()

### Description
Gets the player entity.

### Method
`EntityPlayer GetPlayer(int playerID = 0)`

### Parameters
* **playerID** (int, optional) - The ID of the player to get. Defaults to 0.
```

--------------------------------

### Starting Challenges

Source: https://wofsauge.github.io/IsaacDocs/rep/tutorials/DebugConsole.html?q=%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5

Initiate a new run based on a specific challenge ID.

```text
challenge 20
```

--------------------------------

### Render()

Source: https://wofsauge.github.io/IsaacDocs/rep/Game.html?q=%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5

Renders the current game state to the screen.

```APIDOC
## Render()

### Description
Draws the current game scene and all its elements to the screen.

### Method
void

### Endpoint
N/A (Function call)
```

--------------------------------

### GetColor

Source: https://wofsauge.github.io/IsaacDocs/rep/Entity.html

Gets the color of the entity.

```APIDOC
## GetColor

### Description
Gets the color of the entity.

### Method
const Color GetColor ( )
```

--------------------------------

### Enable

Source: https://wofsauge.github.io/IsaacDocs/rep/MusicManager.html?q=%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5

Enables the MusicManager, allowing music playback to resume.

```APIDOC
## Enable()

### Description
Enables the MusicManager, allowing music playback.
```

--------------------------------

### GetAngleDegrees

Source: https://wofsauge.github.io/IsaacDocs/rep/Vector.html?q=%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5

Gets the angle of the vector in degrees.

```APIDOC
## GetAngleDegrees

### Description
Gets the angle of the vector in degrees.

### Signature
`float GetAngleDegrees()`
```

--------------------------------

### Y Property

Source: https://wofsauge.github.io/IsaacDocs/rep/RoomConfig_Spawn.html?q=%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5

Gets the Y-coordinate of the spawn point.

```APIDOC
## Y

### Description
Returns the Y-coordinate of the spawn.

### Return Value
- **int** - The Y-coordinate.
```

--------------------------------

### GetPlanetariumChance

Source: https://wofsauge.github.io/IsaacDocs/rep/Level.html

Returns the probability of getting a Planetarium.

```APIDOC
## GetPlanetariumChance

### Description
Returns the probability of getting a Planetarium (in the 0-1 range).

### Method
float GetPlanetariumChance ( )

```

--------------------------------

### StartStageTransition

Source: https://wofsauge.github.io/IsaacDocs/rep/Game.html?q=%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5

Starts a transition animation between stages, with options to reseed the stage or override the next stage progression. Be aware of potential crashes and inconsistencies.

```APIDOC
## StartStageTransition ( boolean SameStage, int TransitionOverride, EntityPlayer Player )

### Description
Starts a transition animation, like the ones used when entering a trapdoor or light beam to reach the next stage. `SameStage` determines if the stage is reseeded. `TransitionOverride` allows triggering special stage transitions.

### Parameters
#### Path Parameters
- **SameStage** (boolean) - If true, the stage will be reseeded. Otherwise, the game progresses to the next stage.
- **TransitionOverride** (int) - An integer to trigger special stage transitions:
  - **2**: Sacrifice Room teleportation (progresses to Dark Room).
  - **3**: Void trapdoor (progresses to The Void).
  - **4**: Unknown (freezes logic updates).
  - **5**: Ascent transition (handles Ascent versions of stages).
  - **6**: Home Glowing Hourglass (progresses to Home).
- **Player** (EntityPlayer) - The player entity involved in the transition.

### Notes
- The next stage is selected based on internal game rules, including `GameStateFlag.STATE_SECRET_PATH`, `GameStateFlag.STATE_HEAVEN_PATH`, `GameStateFlag.STATE_BACKWARDS_PATH`, and specific stage checks (e.g., Corpse II / XL).

### Bugs
This function will crash if not provided with an `EntityPlayer`. It is also noted for being inconsistent and sometimes crashing without apparent reason due to improper calls to `Game::StartStageTransition`.
```

--------------------------------

### GetNonCompleteRoomIndex

Source: https://wofsauge.github.io/IsaacDocs/rep/Level.html

Gets the index of a room that has not been completed.

```APIDOC
## GetNonCompleteRoomIndex

### Description
Gets the index of a room that has not been completed.

### Method
int GetNonCompleteRoomIndex ( )

```

--------------------------------

### Black Heart Bitmask Example

Source: https://wofsauge.github.io/IsaacDocs/rep/EntityPlayer.html

Demonstrates how to interpret the bitmask returned by GetBlackHearts.

```text
1
```

```text
B S S B B S S B B
```

```lua
Isaac.GetPlayer():GetBlackHearts() -- returns 409, which is 0001 1001 1001 in binary. Therefore, the read order is right to left.
```

```lua
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
-- if you setup your hearts as described above then you'll get the following values
-- GetSoulHearts = 18
-- GetBlackHearts = 409
local tbl = {}
local player = Isaac.GetPlayer()
-- loop over all the soul hearts
-- divide by 2 because we need to go from half to whole hearts
-- math.ceil to make sure we account for a possible half heart at the end
for i = 0, math.ceil(player:GetSoulHearts() / 2) - 1 do
  -- you can also use BitSet128 here if you want: BitSet128(player:GetBlackHearts(),0):Get(i)
  table.insert(tbl, (player:GetBlackHearts() & (1 << i)) > 0 and 'B' or 'S')
end
if player:GetSoulHearts() % 2 ~= 0 then
  tbl[#tbl] = string.lower(tbl[#tbl]) -- lowercase to indicate half heart at end
end
print(table.concat(tbl, ' ')) -- prints: B S S B B S S B B
```

--------------------------------

### Screen to World Conversion Example

Source: https://wofsauge.github.io/IsaacDocs/rep/Isaac.html

Converts screen coordinates to world coordinates. Useful for UI interactions.

```lua
local worldPos = Isaac.ScreenToWorld(Vector(100, 100))
```

--------------------------------

### GetName

Source: https://wofsauge.github.io/IsaacDocs/rep/Level.html

Gets the name of the current level.

```APIDOC
## GetName

### Description
Gets the name of the current level.

### Method
string GetName ( )

```

--------------------------------

### Spawn Entity Example

Source: https://wofsauge.github.io/IsaacDocs/rep/Isaac.html

Spawns a new entity in the game world. Requires entity type, variant, subtype, position, velocity, and a spawner.

```lua
local player = Isaac.GetPlayer()
Isaac.Spawn(EntityType.ENTITY_FLY, 0, 0, player.Position, Vector(0,0), player)
```

--------------------------------

### GetCurrentRoomIndex

Source: https://wofsauge.github.io/IsaacDocs/rep/Level.html

Gets the index of the current room.

```APIDOC
## GetCurrentRoomIndex

### Description
This will always return the room index on the level grid, on which you entered the current room from.

### Method
int GetCurrentRoomIndex ( )

```

--------------------------------

### Black Hearts Bitmask Example

Source: https://wofsauge.github.io/IsaacDocs/rep/EntityPlayer.html?q=%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5

Demonstrates how to interpret the bitmask returned by GetBlackHearts.

```text
1
```

```text
B S S B B S S B B
```

```lua
Isaac.GetPlayer():GetBlackHearts() -- returns 409, which is 0001 1001 1001 in binary. Therefore, the read order is right to left.
```

```lua
-- if you setup your hearts as described above then you'll get the following values
-- GetSoulHearts = 18
-- GetBlackHearts = 409
local tbl = {}
local player = Isaac.GetPlayer()
-- loop over all the soul hearts
-- divide by 2 because we need to go from half to whole hearts
-- math.ceil to make sure we account for a possible half heart at the end
for i = 0, math.ceil(player:GetSoulHearts() / 2) - 1 do
  -- you can also use BitSet128 here if you want: BitSet128(player:GetBlackHearts(),0):Get(i)
  table.insert(tbl, (player:GetBlackHearts() & (1 << i)) > 0 and 'B' or 'S')
end
if player:GetSoulHearts() % 2 ~= 0 then
  tbl[#tbl] = string.lower(tbl[#tbl]) -- lowercase to indicate half heart at end
end
print(table.concat(tbl, ' ')) -- prints: B S S B B S S B B
```

--------------------------------

### GetCurrentRoom

Source: https://wofsauge.github.io/IsaacDocs/rep/Level.html

Gets the current room object.

```APIDOC
## GetCurrentRoom

### Description
Gets the current room object.

### Method
Room GetCurrentRoom ( )

```

--------------------------------

### Instantiate FontRenderSettings

Source: https://wofsauge.github.io/IsaacDocs/rep/FontRenderSettings.html

Create a new instance of FontRenderSettings to customize text rendering. This is the initial step before applying specific settings.

```lua
local settings = FontRenderSettings()
```

--------------------------------

### GetItemConfig

Source: https://wofsauge.github.io/IsaacDocs/rep/Isaac.html

Gets the item configuration table.

```APIDOC
## GetItemConfig()

### Description
Gets the item configuration table.

### Method
`ItemConfig GetItemConfig()`
```

--------------------------------

### GetChallenge

Source: https://wofsauge.github.io/IsaacDocs/rep/Isaac.html?q=%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5

Gets the current challenge information.

```APIDOC
## GetChallenge ()

### Description
Gets the current challenge information.

### Method
`Challenge GetChallenge ( )`
```

--------------------------------

### Spawn Entities

Source: https://wofsauge.github.io/IsaacDocs/rep/tutorials/DebugConsole.html?q=%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5

Use the spawn command to place entities in the room using names or ID syntax.

```text
spawn mega maw
spawn 20
spawn 10.1
spawn 10.2.0.4
```

```text
Type.Variant.Subtype.Champion
```

--------------------------------

### Get Type

Source: https://wofsauge.github.io/IsaacDocs/rep/GridEntity.html?q=%5E5%5E5+%5E5

Retrieves the GridEntityType of the GridEntity.

```lua
GetType()
```

--------------------------------

### Get Type

Source: https://wofsauge.github.io/IsaacDocs/rep/GridEntity.html

Retrieves the type of the GridEntity.

```lua
GridEntityType GetType ( )
```

--------------------------------

### GetMaxTrinkets

Source: https://wofsauge.github.io/IsaacDocs/rep/EntityPlayer.html

Get the number of trinkets you can carry.

```APIDOC
## int GetMaxTrinkets ( )

### Description
Get the number of trinkets you can carry. (1 on default. 2 with moms purse or similar).
```

--------------------------------

### Play

Source: https://wofsauge.github.io/IsaacDocs/rep/Sprite.html?q=%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5

Starts executing the given animation from frame 0.

```APIDOC
## void Play ( string AnimationName, boolean Force )

### Description
Starts executing the given animation, starting at frame 0. After calling this method, you must call the Sprite.Update method on every update frame to advance the animation.

### Parameters
- **AnimationName** (string) - The name of the animation to play.
- **Force** (boolean) - If true, the currently playing animation will be stopped.
```

--------------------------------

### GetPlayerTarget

Source: https://wofsauge.github.io/IsaacDocs/rep/EntityNPC.html?q=%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5

Gets the player target of the NPC.

```APIDOC
## GetPlayerTarget()

### Description
Gets the player target of the NPC.

### Returns
* **Entity** - The player entity targeted by the NPC.
```

--------------------------------

### Init

Source: https://wofsauge.github.io/IsaacDocs/rep/GridEntity.html?q=%5E5

Initializes the GridEntity with a seed.

```APIDOC
## Init ()

### Description
Initializes the GridEntity with a seed.

### Method
void Init ( int Seed )

### Parameters
#### Path Parameters
- **Seed** (int) - Required - The seed for initialization.
```

--------------------------------

### GetPlayerTarget

Source: https://wofsauge.github.io/IsaacDocs/rep/EntityNPC.html?q=%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5%5E5+%5E5

Gets the player target of the NPC.

```APIDOC
## GetPlayerTarget ()

### Description
Gets the player target of the NPC.

### Return Value
* **Entity** - The player entity targeted by the NPC.
```

--------------------------------

### GetPlayerTarget

Source: https://wofsauge.github.io/IsaacDocs/rep/EntityNPC.html

Gets the player target of the NPC.

```APIDOC
## GetPlayerTarget()

### Description
Gets the player target of the NPC.
```
Tokens:
Raw