BBPGlue.API.BBP Class Reference

Central entrypoint for the modding API providing access to common subsystems. More...

Static Public Member Functions
static void	Error (string message)
	Writes an error message to the API console logger.
static void	Log (string message)
	Writes an informational message to the API console logger.
static void	Warn (string message)
	Writes a warning message to the API console logger.

Properties
static BBPAssetLoader	Assets = new BBPAssetLoader() [get]
	Asset loading and management API (textures, audio, prefabs).
static BBPAuthoring	Authoring = new BBPAuthoring() [get]
	Authoring API for cloning and creating new prefabs (used for custom pickups, items, and NPCs).
static BBPCallbacks	Callbacks = new BBPCallbacks() [get]
	Centralized callback groups for subscribing to game events.
static BBPEntities	Entities = new BBPEntities() [get]
	Collection of runtime entity helpers and lookup functions.
static BBPEnvironment	Environment = new BBPEnvironment() [get]
	Environment and world-related utilities and state.
static BBPEvents	Events = new BBPEvents() [get]
	Event dispatch surface exposing runtime events for mods to subscribe to.
static BBPExperimental	Experimental = new BBPExperimental() [get]
	Experimental API surfaces that may change between versions.
static BBPGame	Game = new BBPGame() [get]
	Provides access to game-wide state and controls.
static BBPHud	Hud = new BBPHud() [get]
	HUD-related API surface for manipulating on-screen UI.
static BBPItems	Items = new BBPItems() [get]
	Item management and lookup utilities.
static BBPPlayer	Player = new BBPPlayer() [get]
	Provides access to player-related API surfaces and utilities.
static BBPPrefabs	Prefabs = new BBPPrefabs() [get]
	Access to commonly used prefab objects exposed by the game.
static BBPSeed	Seed = new BBPSeed() [get]
	Provides access to random seed and deterministic utilities.

Detailed Description

Central entrypoint for the modding API providing access to common subsystems.

Member Function Documentation

Error()

void BBPGlue.API.BBP.Error ( string message )

static

Writes an error message to the API console logger.

Parameters

message

The error message to log.

Log()

void BBPGlue.API.BBP.Log ( string message )

static

Writes an informational message to the API console logger.

Parameters

message

The message to log.

Warn()

void BBPGlue.API.BBP.Warn ( string message )

static

Writes a warning message to the API console logger.

Parameters

message

The warning message to log.

Property Documentation

Assets

BBPAssetLoader BBPGlue.API.BBP.Assets = new BBPAssetLoader()

staticget

Asset loading and management API (textures, audio, prefabs).

Authoring

BBPAuthoring BBPGlue.API.BBP.Authoring = new BBPAuthoring()

staticget

Authoring API for cloning and creating new prefabs (used for custom pickups, items, and NPCs).

Callbacks

BBPCallbacks BBPGlue.API.BBP.Callbacks = new BBPCallbacks()

staticget

Centralized callback groups for subscribing to game events.

Entities

BBPEntities BBPGlue.API.BBP.Entities = new BBPEntities()

staticget

Collection of runtime entity helpers and lookup functions.

Environment

BBPEnvironment BBPGlue.API.BBP.Environment = new BBPEnvironment()

staticget

Environment and world-related utilities and state.

Events

BBPEvents BBPGlue.API.BBP.Events = new BBPEvents()

staticget

Event dispatch surface exposing runtime events for mods to subscribe to.

Experimental

BBPExperimental BBPGlue.API.BBP.Experimental = new BBPExperimental()

staticget

Experimental API surfaces that may change between versions.

Game

BBPGame BBPGlue.API.BBP.Game = new BBPGame()

staticget

Provides access to game-wide state and controls.

Hud

BBPHud BBPGlue.API.BBP.Hud = new BBPHud()

staticget

HUD-related API surface for manipulating on-screen UI.

Items

BBPItems BBPGlue.API.BBP.Items = new BBPItems()

staticget

Item management and lookup utilities.

Player

BBPPlayer BBPGlue.API.BBP.Player = new BBPPlayer()

staticget

Provides access to player-related API surfaces and utilities.

Prefabs

BBPPrefabs BBPGlue.API.BBP.Prefabs = new BBPPrefabs()

staticget

Access to commonly used prefab objects exposed by the game.

Seed

BBPSeed BBPGlue.API.BBP.Seed = new BBPSeed()

staticget

Provides access to random seed and deterministic utilities.

---

The documentation for this class was generated from the following file:

• BBP.cs