Skip to content

Class "RoomConfigSet"⚓︎

Info

You can get this class by using the following function:

Example Code

local roomConfigSet = RoomConfig.GetStage(StbType.BASEMENT):GetRoomSet(0)

Operators⚓︎

__len ()⚓︎

int __len ( )⚓︎

The length (#) operation. Returns the amount of entities in the list.

Functions⚓︎

AddRooms ()⚓︎

RoomConfigRoom[] AddRooms ( table[] Rooms )⚓︎

Adds the provided Lua Rooms to the RoomConfigSet. For details on how to generate Lua Rooms, refer to the Custom StageAPI Github page.

The function returns a table containing the placed RoomConfigRoom objects, in the same order as the input Rooms table. If a room at a given index could not be converted into a valid RoomConfigRoom, the corresponding entry in the returned table will be nil instead.

Get ()⚓︎

RoomConfigRoom Get ( int idx )⚓︎

Returns a RoomConfigRoom at the index of the list provided.

LoadStb ()⚓︎

RoomConfigRoom[] LoadStb ( string StbFileName )⚓︎

Adds the rooms from the provided .stb file to the RoomConfigSet. Files can only be loaded starting from the .../content(-repentogon)/rooms/ folder of all mods (so you should not include content/rooms/ in your path).

If files from multiple mods match the filename, they will all be loaded.

Variables⚓︎

Size⚓︎

const int Size⚓︎

The amount of entities in the list.