StageObject

StageObject

Object that contains all of the values and functions necessary to create a stage. Obtained through StageAPI.GetStageConfig

Functions

MoveToStage

StageObject:MoveToStage(floor)

floor is optional, and can be 1 or 2. If not specified, it is chosen based on whether or not this floor isMultiStage.

SetRooms

StageObject:SetRooms(roomData)

SetBossRooms

StageObject:SetBossRooms(roomData)

Boss rooms are chosen from with seeded randomization when entered. Portraits must be set with StageObject:SetBossPortrait()

SetMultiStage

StageObject:SetMultiStage(boolean isMultiStage)

SetNameSprite

StageObject:setNameSprite(pngFloor1, pngFloor2)

Sets the streak sprite to play when you reach this stage.

SetBackdrop

StageObject:SetBackdrop(backdropData, anm2)

anm2 is optional. backdropData is explained in more detail under StageAPI.ChangeRoomBackdrop

SetRocks

StageObject:SetRocks(pngRock, anm2)

anm2 is optional. Sets the rock sprite for this stage.

SetPits

StageObject:SetPits(pngPit, anm2)

anm2 is optional. Sets the pit sprite for this stage.

SetBridges

StageObject:SetBridges(pngBridge)

SetDoors

StageObject:SetDoors(pngDoor, anm2)

anm2 is optional. Sets the door sprite for this stage.

SetDecoration

StageObject:SetDecoration(pngDecoration, animation, anm2)

Sets Decoration sprites for this stage. Animation is prepended to a random number to select which animation to play, and defaults to Prop. anm2 is optional.

SetTransitionIcon

StageObject:SetTransitionIcon(pngIcon)

Sets icon used in custom transition animation for this stage.

SetMusic

StageObject:SetMusic(musicID)

SetBossMusic

StageObject:SetBossMusic(musicID)

SetBossSpot

StageObject:SetBossSpot(pngBossSpot)

SetBossPortrait

StageObject:SetBossPortrait(bossType, pngPortrait, bossVariant, bossSubType)

Stores boss portrait data to stage. If a boss with valid boss portrait data spawns when a boss room is selected randomly, the portrait will be played with StageAPI.PlayBossIntro