Home

Welcome to the StageAPI documentation!

StageAPI is a mod for The Binding of Isaac Afterbirth+ that enables mod developers to add completely new floors to the game! Contained within this wiki is documentation of all the functions that you will be able to use to customize your floor, as well as some simple guides for getting started.

When creating a mod that uses StageAPI, you'll need to remember a few things. Firstly, you should include code like this:

local function fnName()               -- This function will be called when the StageAPI loads
    -- do StageAPI things
end

local START_FUNC = fnName             -- Defines the function that will be called when StageAPI loads

if StageAPI then START_FUNC()         -- Blob that, assuming the above code was implemented correctly, will ensure that your function is called when StageAPI loads.
else if not __stageAPIInit then
    __stageAPIInit = {}
end __stageAPIInit[#__stageAPIInit + 1] = START_FUNC
end

With that, your function fnName will be called when StageAPI initializes. Inside that function you will define your floors and all of their attributes, starting with getting your stage object like so:

StageObject StageAPI.getStageConfig(stageName, rooms, bossRooms, isMultiStage)

From there you can look at the StageAPI and StageObject docs to figure out the rest!