Baldi's Basics Plus Glue API
Modding API for Baldi's Basics Plus
Loading...
Searching...
No Matches
BBPGlue.API.BBPScene Class Referencesealed

Represents scene/level metadata and related assets. More...

Public Member Functions

 BBPScene (object? raw)
 Initializes a new instance of the BBPScene class wrapping a raw object.

Properties

int AdditionalNpcs [get, set]
 Gets or sets the number of additional NPCs to spawn on this level.
object? BaldiPrefab [get, set]
 Gets or sets the Baldi prefab used for this scene.
bool Exists [get]
 Determines whether the underlying raw object exists.
object? ExtraAsset [get, set]
 Gets or sets an extra asset object associated with the scene.
object? ForcedNpcs [get, set]
 Gets or sets forced NPCs for this scene.
object? LevelAsset [get, set]
 Gets or sets the level asset associated with the scene.
object? LevelContainer [get, set]
 Gets or sets the container object that groups level elements.
int LevelNumber [get, set]
 Gets or sets the numeric level index.
object? LevelObject [get, set]
 Gets or sets the level object associated with the scene.
string LevelTitle [get, set]
 Gets or sets the human-readable title of the level.
object? Manager [get, set]
 Gets or sets the scene manager object associated with this scene.
int MapPrice [get, set]
 Gets or sets the price for the map in this scene.
string NameKey [get, set]
 Gets or sets the localization key for the scene's name.
BBPScene NextLevel [get]
 Gets the next level's scene metadata.
IList? PotentialNpcs [get]
 Gets the list of potential NPCs that may appear on this scene.
object? PotentialStickers [get, set]
 Gets or sets potential stickers available on this scene.
IList? PreviousLevels [get]
 Gets the list of previous levels for this scene if available.
object? RandomizedLevelObjects [get, set]
 Gets or sets randomized level objects for the scene.
object? Raw [get]
 The raw underlying scene object wrapped by this API class, or null if none.
object? ShopItems [get, set]
 Gets or sets the collection of shop items available in this scene.
bool Skippable [get, set]
 Gets or sets whether the scene is skippable.
Cubemap? Skybox [get, set]
 Gets or sets the cubemap used for the scene's skybox.
Color SkyboxColor [get, set]
 Gets or sets the skybox color for the scene.
bool StoreUsesNextLevelData [get, set]
 Gets or sets whether the store uses data from the next level.
int TotalShopItems [get, set]
 Gets or sets the total number of shop items available on this level.
bool UsesMap [get, set]
 Gets or sets whether this scene uses an in-game map.

Detailed Description

Represents scene/level metadata and related assets.

Constructor & Destructor Documentation

◆ BBPScene()

BBPGlue.API.BBPScene.BBPScene ( object? raw)

Initializes a new instance of the BBPScene class wrapping a raw object.

Parameters
rawThe raw underlying object instance or null.

Property Documentation

◆ AdditionalNpcs

int BBPGlue.API.BBPScene.AdditionalNpcs
getset

Gets or sets the number of additional NPCs to spawn on this level.

Returns
The count of additional NPCs as an integer.

◆ BaldiPrefab

object? BBPGlue.API.BBPScene.BaldiPrefab
getset

Gets or sets the Baldi prefab used for this scene.

Returns
The Baldi prefab object or null.

◆ Exists

bool BBPGlue.API.BBPScene.Exists
get

Determines whether the underlying raw object exists.

◆ ExtraAsset

object? BBPGlue.API.BBPScene.ExtraAsset
getset

Gets or sets an extra asset object associated with the scene.

Returns
The extra asset object or null.

◆ ForcedNpcs

object? BBPGlue.API.BBPScene.ForcedNpcs
getset

Gets or sets forced NPCs for this scene.

Returns
An object representing forced NPCs or null.

◆ LevelAsset

object? BBPGlue.API.BBPScene.LevelAsset
getset

Gets or sets the level asset associated with the scene.

Returns
The level asset object or null.

◆ LevelContainer

object? BBPGlue.API.BBPScene.LevelContainer
getset

Gets or sets the container object that groups level elements.

Returns
The level container object or null.

◆ LevelNumber

int BBPGlue.API.BBPScene.LevelNumber
getset

Gets or sets the numeric level index.

Returns
The level number as an integer.

◆ LevelObject

object? BBPGlue.API.BBPScene.LevelObject
getset

Gets or sets the level object associated with the scene.

Returns
The level object or null.

◆ LevelTitle

string BBPGlue.API.BBPScene.LevelTitle
getset

Gets or sets the human-readable title of the level.

Returns
The level title as a string.

◆ Manager

object? BBPGlue.API.BBPScene.Manager
getset

Gets or sets the scene manager object associated with this scene.

Returns
The manager object or null.

◆ MapPrice

int BBPGlue.API.BBPScene.MapPrice
getset

Gets or sets the price for the map in this scene.

Returns
The map price as an integer.

◆ NameKey

string BBPGlue.API.BBPScene.NameKey
getset

Gets or sets the localization key for the scene's name.

Returns
The name key as a string.

◆ NextLevel

BBPScene BBPGlue.API.BBPScene.NextLevel
get

Gets the next level's scene metadata.

Returns
A BBPScene instance representing the next level.

◆ PotentialNpcs

IList? BBPGlue.API.BBPScene.PotentialNpcs
get

Gets the list of potential NPCs that may appear on this scene.

Returns
An IList of potential NPCs or null.

◆ PotentialStickers

object? BBPGlue.API.BBPScene.PotentialStickers
getset

Gets or sets potential stickers available on this scene.

Returns
An object representing potential stickers or null.

◆ PreviousLevels

IList? BBPGlue.API.BBPScene.PreviousLevels
get

Gets the list of previous levels for this scene if available.

Returns
An IList of previous levels or null.

◆ RandomizedLevelObjects

object? BBPGlue.API.BBPScene.RandomizedLevelObjects
getset

Gets or sets randomized level objects for the scene.

Returns
An object representing randomized level objects or null.

◆ Raw

object? BBPGlue.API.BBPScene.Raw
get

The raw underlying scene object wrapped by this API class, or null if none.

◆ ShopItems

object? BBPGlue.API.BBPScene.ShopItems
getset

Gets or sets the collection of shop items available in this scene.

Returns
An object representing shop items or null.

◆ Skippable

bool BBPGlue.API.BBPScene.Skippable
getset

Gets or sets whether the scene is skippable.

Returns
True if skippable; otherwise false.

◆ Skybox

Cubemap? BBPGlue.API.BBPScene.Skybox
getset

Gets or sets the cubemap used for the scene's skybox.

Returns
The Cubemap or null.

◆ SkyboxColor

Color BBPGlue.API.BBPScene.SkyboxColor
getset

Gets or sets the skybox color for the scene.

Returns
The skybox color as a Color.

◆ StoreUsesNextLevelData

bool BBPGlue.API.BBPScene.StoreUsesNextLevelData
getset

Gets or sets whether the store uses data from the next level.

Returns
True if the store uses next level data; otherwise false.

◆ TotalShopItems

int BBPGlue.API.BBPScene.TotalShopItems
getset

Gets or sets the total number of shop items available on this level.

Returns
The total shop items as an integer.

◆ UsesMap

bool BBPGlue.API.BBPScene.UsesMap
getset

Gets or sets whether this scene uses an in-game map.

Returns
True if a map is used; otherwise false.
The documentation for this class was generated from the following file: