Wraps the active environment controller and exposes common level, spawning, lighting, and event controls. More...

Public Member Functions
void	AssignPlayers ()
	Assigns players to the environment.
void	BeginPlay ()
	Starts environment gameplay.
void	CloseSchool ()
	Closes the school.
bool	ContainsCoordinates (Vector3 position)
	Checks whether a position is inside the environment bounds.
int	DespawnAllNpcs ()
	Despawns all NPCs currently known by BBPGlue.
int	DespawnAllPickups ()
	Despawns all pickups in the environment item list.
bool	DespawnClosestNpc ()
	Despawns the closest NPC to the player.
bool	DespawnNpc (BBPNpc npc)
	Despawns an NPC.
bool	DespawnNpc (object rawNpc)
	Despawns a raw NPC object.
bool	DespawnPickup (object pickup)
	Despawns a pickup.
void	FlickerLights (bool enabled)
	Enables or disables light flickering.
void	FreezeNavigationUpdates (bool frozen)
	Freezes or unfreezes navigation updates.
BBPBaldi?	GetBaldi ()
	Gets Baldi from the environment controller.
BBPDoor?	GetClosestDoor ()
	Gets the closest door to the player.
BBPDoor?	GetClosestDoor (Vector3 position)
	Gets the closest door to a position.
BBPElevator?	GetClosestElevator ()
	Gets the closest elevator to the player.
BBPRoom?	GetClosestRoom ()
	Gets the closest room to the player.
BBPRoom?	GetClosestRoom (Vector3 position)
	Gets the closest room to a position.
string	GetDisplayTime ()
	Gets the formatted level timer text.
BBPRoom?	GetPlayerRoom ()
	Gets the room the player is currently in.
BBPRoom?	GetRoom (Vector3 position)
	Gets the room containing a position.
float	LightLevel (Vector3 position)
	Gets the light level at a position.
void	MakeNoise (Vector3 position, int value)
	Creates a noise at the specified position.
void	MakeNoise (Vector3 position, int value, bool hasSilentChance)
	Creates a noise at the specified position.
void	MakeSilent (float time)
	Makes the environment silent for a duration.
void	PauseEnvironment (bool paused)
	Pauses or unpauses the environment.
void	PauseEvents (bool paused)
	Pauses or unpauses random events.
void	RecalculateNavigation ()
	Recalculates environment navigation.
void	Refresh ()
	Refreshes cached environment state.
void	ResetEvents ()
	Resets random events.
void	SetAllLights (bool on)
	Turns all environment lights on or off.
void	SetSpawn (Vector3 position, Quaternion rotation)
	Sets the environment spawn position and rotation.
void	SetTimeLimit (float time)
	Sets the level time limit.
BBPNpc?	SpawnNpc (BBPNpc npc, int x, int z)
	Spawns an NPC prefab at the specified BB+ grid cell.
BBPNpc?	SpawnNpc (object npcPrefab, int x, int z)
	Spawns a raw NPC prefab at the specified BB+ grid cell.
BBPNpc?	SpawnNpcAtPlayer (object npcPrefab)
	Spawns an NPC at the player's position.
BBPNpc?	SpawnNpcAtWorld (object npcPrefab, Vector3 worldPosition)
	Spawns an NPC at a world position.
BBPNpc?	SpawnNpcByCharacter (string characterName)
	Finds an NPC prefab by character name and spawns it at the player's position.
BBPNpc?	SpawnNpcByCharacter (string characterName, Vector3 worldPosition)
	Finds an NPC prefab by character name and spawns it at a world position.
BBPNpc?	SpawnNpcByName (string nameContains)
	Finds an NPC prefab by name and spawns it at the player's position.
BBPNpc?	SpawnNpcByName (string nameContains, Vector3 worldPosition)
	Finds an NPC prefab by name and spawns it at a world position.
void	SpawnNPCs ()
	Spawns the level NPCs.
GameObject?	SpawnObject (GameObject prefab, Vector3 position)
	Spawns a GameObject at a position.
GameObject?	SpawnObject (GameObject prefab, Vector3 position, Quaternion rotation)
	Spawns a GameObject at a position and rotation.
GameObject?	SpawnObject (GameObject prefab, Vector3 position, Quaternion rotation, Transform? parent)
	Spawns a GameObject at a position, rotation, and optional parent.
T?	SpawnObject< T > (T prefab, Vector3 position)
	Spawns a Component at a position.
T?	SpawnObject< T > (T prefab, Vector3 position, Quaternion rotation, Transform? parent=null)
	Spawns a Component at a position, rotation, and optional parent.
BBPPickup?	SpawnPickup (BBPItemId item)
	Spawns a pickup by item ID at the player's position.
BBPPickup?	SpawnPickup (BBPItemId item, Vector3 worldPosition)
	Spawns a pickup by item ID at a world position.
BBPPickup?	SpawnPickup (object room, BBPItemObject item, Vector2 position)
	Spawns a pickup in a room.
BBPPickup?	SpawnPickupAtPlayer (BBPItemObject item)
	Spawns a pickup at the player's position.
BBPPickup?	SpawnPickupAtWorld (BBPItemObject item, Vector3 worldPosition)
	Spawns a pickup at a world position.
BBPPickup?	SpawnPickupByName (string name)
	Spawns a pickup by item name at the player's position.
BBPPickup?	SpawnPickupByName (string name, Vector3 worldPosition)
	Spawns a pickup by item name at a world position.
object?	SpawnPickupRaw (object room, object itemObject, Vector2 position)
	Spawns a raw pickup in a room.
object?	SpawnPrefab (object prefab, Vector3 worldPosition)
	Spawns a supported prefab at a world position.
object?	SpawnPrefabAtPlayer (object prefab)
	Spawns a supported prefab at the player's position.
object?	SpawnRawObject (object prefab, Vector3 position)
	Spawns a raw GameObject or Component prefab with no custom rotation.
object?	SpawnRawObject (object prefab, Vector3 position, Quaternion rotation, Transform? parent=null)
	Spawns a raw GameObject or Component prefab.
void	StartEventTimers ()
	Starts random event timers.
void	StopEvents ()
	Stops active random events.
void	TempCloseBully ()
	Temporarily closes bully blockers.
void	TempCloseLockedStandardDoors ()
	Temporarily closes locked standard doors.
void	TempCloseWindows ()
	Temporarily closes windows.
void	TempOpenBreakableWindows ()
	Temporarily opens breakable windows.
void	TempOpenBully ()
	Temporarily opens bully blockers.
void	TempOpenLockedStandardDoors ()
	Temporarily opens locked standard doors.

Properties
bool	Active `[get, set]`
	Gets or sets whether the environment is active.
IList?	Activities `[get]`
	Gets the raw activity list.
BBPBaldi?	Baldi `[get]`
	Gets Baldi from the current environment.
List< BBPRandomEvent >	CurrentEvents `[get]`
	Gets the currently active random events.
System.Collections.Generic.List< BBPDoor >	Doors `[get]`
	Gets all door components currently found in the scene.
object?	ElevatorManager `[get]`
	Gets the raw elevator manager.
IList?	Elevators `[get]`
	Gets the raw elevator list.
System.Collections.Generic.List< BBPElevator >	ElevatorsList `[get]`
	Gets all elevator components currently found in the scene.
float	EnvironmentTimeScale `[get]`
	Gets the environment time scale.
int	EventsCount `[get]`
	Gets the number of random events available in the current level.
bool	EventsStarted `[get]`
	Gets whether random events have started.
bool	Exists `[get]`
	Gets whether an environment controller is available.
float	Height `[get]`
	Gets the environment height.
int	ItemCount `[get]`
	Gets the number of pickups in the environment.
IList?	Items `[get]`
	Gets the raw pickup list.
object?	Map `[get]`
	Gets the raw map object.
bool	NavigationUpdatesFrozen `[get]`
	Gets whether navigation updates are frozen.
int	NotebookCount `[get]`
	Gets the number of notebooks in the environment.
IList?	Notebooks `[get]`
	Gets the raw notebook list.
int	NotebookTotal `[get, set]`
	Gets or sets the total number of notebooks in the level.
int	NpcCount `[get]`
	Gets the number of NPCs in the environment.
IList?	Npcs `[get]`
	Gets the raw NPC list.
float	NpcTimeScale `[get]`
	Gets the NPC time scale.
int	PlayerCount `[get]`
	Gets the number of players in the environment.
IList?	Players `[get]`
	Gets the raw player list.
float	PlayerTimeScale `[get]`
	Gets the player time scale.
object?	Raw `[get]`
	Gets the raw environment controller instance.
int	RemainingTime `[get]`
	Gets the remaining level time.
int	RoomCount `[get]`
	Gets the number of rooms in the environment.
System.Collections.Generic.List< BBPRoom >	RoomList `[get]`
	Gets all room components currently found in the scene.
IList?	Rooms `[get]`
	Gets the raw room list.
Vector3	SpawnPoint `[get, set]`
	Gets or sets the level spawn position.
Quaternion	SpawnRotation `[get, set]`
	Gets or sets the level spawn rotation.
float	SurpassedGameTime `[get]`
	Gets the elapsed game time.
float	SurpassedRealTime `[get]`
	Gets the elapsed real time.
bool	TimeOut `[get]`
	Gets whether the level timer has run out.

Detailed Description

Wraps the active environment controller and exposes common level, spawning, lighting, and event controls.

Member Function Documentation

◆ AssignPlayers()

void BBPGlue.API.BBPEnvironment.AssignPlayers ( )

Assigns players to the environment.

◆ BeginPlay()

void BBPGlue.API.BBPEnvironment.BeginPlay ( )

Starts environment gameplay.

◆ CloseSchool()

void BBPGlue.API.BBPEnvironment.CloseSchool ( )

Closes the school.

◆ ContainsCoordinates()

bool BBPGlue.API.BBPEnvironment.ContainsCoordinates ( Vector3 position )

Checks whether a position is inside the environment bounds.

Parameters

position The position to check.

Returns: True if the position is inside the environment bounds; otherwise, false.

◆ DespawnAllNpcs()

int BBPGlue.API.BBPEnvironment.DespawnAllNpcs ( )

Despawns all NPCs currently known by BBPGlue.

Returns: The number of NPCs despawned.

◆ DespawnAllPickups()

int BBPGlue.API.BBPEnvironment.DespawnAllPickups ( )

Despawns all pickups in the environment item list.

Returns: The number of pickups despawned.

◆ DespawnClosestNpc()

bool BBPGlue.API.BBPEnvironment.DespawnClosestNpc ( )

Despawns the closest NPC to the player.

Returns: True if an NPC was found and despawned; otherwise, false.

◆ DespawnNpc() [1/2]

bool BBPGlue.API.BBPEnvironment.DespawnNpc ( BBPNpc npc )

Despawns an NPC.

Parameters

npc	The NPC to despawn.

Returns: True if the despawn call was sent; otherwise, false.

◆ DespawnNpc() [2/2]

bool BBPGlue.API.BBPEnvironment.DespawnNpc ( object rawNpc )

Despawns a raw NPC object.

Parameters

rawNpc The raw NPC object to despawn.

Returns: True if the despawn call was sent; otherwise, false.

◆ DespawnPickup()

bool BBPGlue.API.BBPEnvironment.DespawnPickup ( object pickup )

Despawns a pickup.

Parameters

pickup The raw pickup object to despawn.

Returns: True if the pickup was removed or destroyed; otherwise, false.

◆ FlickerLights()

void BBPGlue.API.BBPEnvironment.FlickerLights ( bool enabled )

Enables or disables light flickering.

Parameters

enabled True to enable flickering; false to disable it.

◆ FreezeNavigationUpdates()

void BBPGlue.API.BBPEnvironment.FreezeNavigationUpdates ( bool frozen )

Freezes or unfreezes navigation updates.

Parameters

frozen True to freeze updates; false to unfreeze them.

◆ GetBaldi()

BBPBaldi? BBPGlue.API.BBPEnvironment.GetBaldi ( )

Gets Baldi from the environment controller.

Returns: Baldi, or null if he is not available.

◆ GetClosestDoor() [1/2]

BBPDoor? BBPGlue.API.BBPEnvironment.GetClosestDoor ( )

Gets the closest door to the player.

Returns: The closest door, or null if none are found.

◆ GetClosestDoor() [2/2]

BBPDoor? BBPGlue.API.BBPEnvironment.GetClosestDoor ( Vector3 position )

Gets the closest door to a position.

Parameters

position The position to search from.

Returns: The closest door, or null if none are found.

◆ GetClosestElevator()

BBPElevator? BBPGlue.API.BBPEnvironment.GetClosestElevator ( )

Gets the closest elevator to the player.

Returns: The closest elevator, or null if none are found.

◆ GetClosestRoom() [1/2]

BBPRoom? BBPGlue.API.BBPEnvironment.GetClosestRoom ( )

Gets the closest room to the player.

Returns: The closest room, or null if none are found.

◆ GetClosestRoom() [2/2]

BBPRoom? BBPGlue.API.BBPEnvironment.GetClosestRoom ( Vector3 position )

Gets the closest room to a position.

Parameters

position The position to search from.

Returns: The closest room, or null if none are found.

◆ GetDisplayTime()

string BBPGlue.API.BBPEnvironment.GetDisplayTime ( )

Gets the formatted level timer text.

Returns: The formatted display time.

◆ GetPlayerRoom()

BBPRoom? BBPGlue.API.BBPEnvironment.GetPlayerRoom ( )

Gets the room the player is currently in.

Returns: The player room, or null if no room is found.

◆ GetRoom()

BBPRoom? BBPGlue.API.BBPEnvironment.GetRoom ( Vector3 position )

Gets the room containing a position.

Parameters

position The position to check.

Returns: The containing room, or null if no room contains the position.

◆ LightLevel()

float BBPGlue.API.BBPEnvironment.LightLevel ( Vector3 position )

Gets the light level at a position.

Parameters

position The position to check.

Returns: The light level returned by the game.

◆ MakeNoise() [1/2]

void BBPGlue.API.BBPEnvironment.MakeNoise	(	Vector3	position,
		int	value )

Creates a noise at the specified position.

Parameters

position	The noise position.
value	The noise value used by the game.

◆ MakeNoise() [2/2]

void BBPGlue.API.BBPEnvironment.MakeNoise	(	Vector3	position,
		int	value,
		bool	hasSilentChance )

Creates a noise at the specified position.

Parameters

position	The noise position.
value	The noise value used by the game.
hasSilentChance	Whether silent chance should be applied.

◆ MakeSilent()

void BBPGlue.API.BBPEnvironment.MakeSilent ( float time )

Makes the environment silent for a duration.

Parameters

time	The duration in seconds.

◆ PauseEnvironment()

void BBPGlue.API.BBPEnvironment.PauseEnvironment ( bool paused )

Pauses or unpauses the environment.

Parameters

paused True to pause; false to unpause.

◆ PauseEvents()

void BBPGlue.API.BBPEnvironment.PauseEvents ( bool paused )

Pauses or unpauses random events.

Parameters

paused True to pause; false to unpause.

◆ RecalculateNavigation()

void BBPGlue.API.BBPEnvironment.RecalculateNavigation ( )

Recalculates environment navigation.

◆ Refresh()

void BBPGlue.API.BBPEnvironment.Refresh ( )

Refreshes cached environment state.

◆ ResetEvents()

void BBPGlue.API.BBPEnvironment.ResetEvents ( )

Resets random events.

◆ SetAllLights()

void BBPGlue.API.BBPEnvironment.SetAllLights ( bool on )

Turns all environment lights on or off.

Parameters

on	True to turn lights on; false to turn them off.

◆ SetSpawn()

void BBPGlue.API.BBPEnvironment.SetSpawn	(	Vector3	position,
		Quaternion	rotation )

Sets the environment spawn position and rotation.

Parameters

position	The spawn position.
rotation	The spawn rotation.

◆ SetTimeLimit()

void BBPGlue.API.BBPEnvironment.SetTimeLimit ( float time )

Sets the level time limit.

Parameters

time	The time limit in seconds.

◆ SpawnNpc() [1/2]

BBPNpc? BBPGlue.API.BBPEnvironment.SpawnNpc	(	BBPNpc	npc,
		int	x,
		int	z )

Spawns an NPC prefab at the specified BB+ grid cell.

Parameters

npc	The NPC prefab wrapper.
x	Grid X coordinate.
z	Grid Z coordinate.

Returns: The spawned NPC, or null if spawning fails.

◆ SpawnNpc() [2/2]

BBPNpc? BBPGlue.API.BBPEnvironment.SpawnNpc	(	object	npcPrefab,
		int	x,
		int	z )

Spawns a raw NPC prefab at the specified BB+ grid cell.

Parameters

npcPrefab	The raw NPC prefab.
x	Grid X coordinate.
z	Grid Z coordinate.

Returns: The spawned NPC, or null if spawning fails.

◆ SpawnNpcAtPlayer()

BBPNpc? BBPGlue.API.BBPEnvironment.SpawnNpcAtPlayer ( object npcPrefab )

Spawns an NPC at the player's position.

Parameters

npcPrefab The raw NPC prefab.

Returns: The spawned NPC, or null if spawning fails.

◆ SpawnNpcAtWorld()

BBPNpc? BBPGlue.API.BBPEnvironment.SpawnNpcAtWorld	(	object	npcPrefab,
		Vector3	worldPosition )

Spawns an NPC at a world position.

Parameters

npcPrefab	The raw NPC prefab.
worldPosition	The target world position.

Returns: The spawned NPC, or null if spawning fails.

◆ SpawnNpcByCharacter() [1/2]

BBPNpc? BBPGlue.API.BBPEnvironment.SpawnNpcByCharacter ( string characterName )

Finds an NPC prefab by character name and spawns it at the player's position.

Parameters

characterName The character name to look up.

Returns: The spawned NPC, or null if no matching prefab is found.

◆ SpawnNpcByCharacter() [2/2]

BBPNpc? BBPGlue.API.BBPEnvironment.SpawnNpcByCharacter	(	string	characterName,
		Vector3	worldPosition )

Finds an NPC prefab by character name and spawns it at a world position.

Parameters

characterName	The character name to look up.
worldPosition	The target world position.

Returns: The spawned NPC, or null if no matching prefab is found.

◆ SpawnNpcByName() [1/2]

BBPNpc? BBPGlue.API.BBPEnvironment.SpawnNpcByName ( string nameContains )

Finds an NPC prefab by name and spawns it at the player's position.

Parameters

nameContains The NPC prefab name to look up.

Returns: The spawned NPC, or null if no matching prefab is found.

◆ SpawnNpcByName() [2/2]

BBPNpc? BBPGlue.API.BBPEnvironment.SpawnNpcByName	(	string	nameContains,
		Vector3	worldPosition )

Finds an NPC prefab by name and spawns it at a world position.

Parameters

nameContains	The NPC prefab name to look up.
worldPosition	The target world position.

Returns: The spawned NPC, or null if no matching prefab is found.

◆ SpawnNPCs()

void BBPGlue.API.BBPEnvironment.SpawnNPCs ( )

Spawns the level NPCs.

◆ SpawnObject() [1/3]

GameObject? BBPGlue.API.BBPEnvironment.SpawnObject	(	GameObject	prefab,
		Vector3	position )

Spawns a GameObject at a position.

Parameters

prefab	The GameObject prefab to instantiate.
position	The spawn position.

Returns: The spawned GameObject, or null if the prefab is null.

◆ SpawnObject() [2/3]

GameObject? BBPGlue.API.BBPEnvironment.SpawnObject	(	GameObject	prefab,
		Vector3	position,
		Quaternion	rotation )

Spawns a GameObject at a position and rotation.

Parameters

prefab	The GameObject prefab to instantiate.
position	The spawn position.
rotation	The spawn rotation.

Returns: The spawned GameObject, or null if the prefab is null.

◆ SpawnObject() [3/3]

GameObject? BBPGlue.API.BBPEnvironment.SpawnObject	(	GameObject	prefab,
		Vector3	position,
		Quaternion	rotation,
		Transform?	parent )

Spawns a GameObject at a position, rotation, and optional parent.

Parameters

prefab	The GameObject prefab to instantiate.
position	The spawn position.
rotation	The spawn rotation.
parent	The optional parent transform.

Returns: The spawned GameObject, or null if the prefab is null.

◆ SpawnObject< T >() [1/2]

T? BBPGlue.API.BBPEnvironment.SpawnObject< T >	(	T	prefab,
		Vector3	position )

Spawns a Component at a position.

Template Parameters

T	The component type.

Parameters

prefab	The component prefab to instantiate.
position	The spawn position.

Returns: The spawned component, or null if the prefab is null.

Type Constraints

T

:

Component

◆ SpawnObject< T >() [2/2]

T? BBPGlue.API.BBPEnvironment.SpawnObject< T >	(	T	prefab,
		Vector3	position,
		Quaternion	rotation,
		Transform?	parent = null )

Spawns a Component at a position, rotation, and optional parent.

Template Parameters

T	The component type.

Parameters

prefab	The component prefab to instantiate.
position	The spawn position.
rotation	The spawn rotation.
parent	The optional parent transform.

Returns: The spawned component, or null if the prefab is null.

Type Constraints

T

:

Component

◆ SpawnPickup() [1/3]

BBPPickup? BBPGlue.API.BBPEnvironment.SpawnPickup ( BBPItemId item )

Spawns a pickup by item ID at the player's position.

Parameters

item	The item ID to spawn.

Returns: The spawned pickup, or null if the item cannot be found.

◆ SpawnPickup() [2/3]

BBPPickup? BBPGlue.API.BBPEnvironment.SpawnPickup	(	BBPItemId	item,
		Vector3	worldPosition )

Spawns a pickup by item ID at a world position.

Parameters

item	The item ID to spawn.
worldPosition	The target world position.

Returns: The spawned pickup, or null if the item cannot be found.

◆ SpawnPickup() [3/3]

BBPPickup? BBPGlue.API.BBPEnvironment.SpawnPickup	(	object	room,
		BBPItemObject	item,
		Vector2	position )

Spawns a pickup in a room.

Parameters

room	The raw room object.
item	The item object to spawn.
position	The pickup position.

Returns: The spawned pickup, or null if spawning fails.

◆ SpawnPickupAtPlayer()

BBPPickup? BBPGlue.API.BBPEnvironment.SpawnPickupAtPlayer ( BBPItemObject item )

Spawns a pickup at the player's position.

Parameters

item	The item object to spawn.

Returns: The spawned pickup, or null if spawning fails.

◆ SpawnPickupAtWorld()

BBPPickup? BBPGlue.API.BBPEnvironment.SpawnPickupAtWorld	(	BBPItemObject	item,
		Vector3	worldPosition )

Spawns a pickup at a world position.

Parameters

item	The item object to spawn.
worldPosition	The target world position.

Returns: The spawned pickup, or null if spawning fails.

◆ SpawnPickupByName() [1/2]

BBPPickup? BBPGlue.API.BBPEnvironment.SpawnPickupByName ( string name )

Spawns a pickup by item name at the player's position.

Parameters

name	The item name to look up.

Returns: The spawned pickup, or null if the item cannot be found.

◆ SpawnPickupByName() [2/2]

BBPPickup? BBPGlue.API.BBPEnvironment.SpawnPickupByName	(	string	name,
		Vector3	worldPosition )

Spawns a pickup by item name at a world position.

Parameters

name	The item name to look up.
worldPosition	The target world position.

Returns: The spawned pickup, or null if the item cannot be found.

◆ SpawnPickupRaw()

object? BBPGlue.API.BBPEnvironment.SpawnPickupRaw	(	object	room,
		object	itemObject,
		Vector2	position )

Spawns a raw pickup in a room.

Parameters

room	The raw room object.
itemObject	The raw item object.
position	The pickup position.

Returns: The raw spawned pickup, or null if spawning fails.

◆ SpawnPrefab()

object? BBPGlue.API.BBPEnvironment.SpawnPrefab	(	object	prefab,
		Vector3	worldPosition )

Spawns a supported prefab at a world position.

Parameters

prefab	An NPC prefab, item object, GameObject, or Component prefab.
worldPosition	The target world position.

Returns: The spawned object or wrapper, or null if the prefab type is unsupported.

◆ SpawnPrefabAtPlayer()

object? BBPGlue.API.BBPEnvironment.SpawnPrefabAtPlayer ( object prefab )

Spawns a supported prefab at the player's position.

Parameters

prefab An NPC prefab, item object, GameObject, or Component prefab.

Returns: The spawned object or wrapper, or null if the prefab type is unsupported.

◆ SpawnRawObject() [1/2]

object? BBPGlue.API.BBPEnvironment.SpawnRawObject	(	object	prefab,
		Vector3	position )

Spawns a raw GameObject or Component prefab with no custom rotation.

Parameters

prefab	The raw prefab to instantiate.
position	The spawn position.

Returns: The spawned object, or null if the prefab type is unsupported.

◆ SpawnRawObject() [2/2]

object? BBPGlue.API.BBPEnvironment.SpawnRawObject	(	object	prefab,
		Vector3	position,
		Quaternion	rotation,
		Transform?	parent = null )

Spawns a raw GameObject or Component prefab.

Parameters

prefab	The raw prefab to instantiate.
position	The spawn position.
rotation	The spawn rotation.
parent	The optional parent transform.

Returns: The spawned object, or null if the prefab type is unsupported.

◆ StartEventTimers()

void BBPGlue.API.BBPEnvironment.StartEventTimers ( )

Starts random event timers.

◆ StopEvents()

void BBPGlue.API.BBPEnvironment.StopEvents ( )

Stops active random events.

◆ TempCloseBully()

void BBPGlue.API.BBPEnvironment.TempCloseBully ( )

Temporarily closes bully blockers.

◆ TempCloseLockedStandardDoors()

void BBPGlue.API.BBPEnvironment.TempCloseLockedStandardDoors ( )

Temporarily closes locked standard doors.

◆ TempCloseWindows()

void BBPGlue.API.BBPEnvironment.TempCloseWindows ( )

Temporarily closes windows.

◆ TempOpenBreakableWindows()

void BBPGlue.API.BBPEnvironment.TempOpenBreakableWindows ( )

Temporarily opens breakable windows.

◆ TempOpenBully()

void BBPGlue.API.BBPEnvironment.TempOpenBully ( )

Temporarily opens bully blockers.

◆ TempOpenLockedStandardDoors()

void BBPGlue.API.BBPEnvironment.TempOpenLockedStandardDoors ( )

Temporarily opens locked standard doors.

Property Documentation

◆ Active

bool BBPGlue.API.BBPEnvironment.Active

getset

Gets or sets whether the environment is active.

◆ Activities

IList? BBPGlue.API.BBPEnvironment.Activities

get

Gets the raw activity list.

◆ Baldi

BBPBaldi? BBPGlue.API.BBPEnvironment.Baldi

get

Gets Baldi from the current environment.

◆ CurrentEvents

List<BBPRandomEvent> BBPGlue.API.BBPEnvironment.CurrentEvents

get

Gets the currently active random events.

◆ Doors

System.Collections.Generic.List<BBPDoor> BBPGlue.API.BBPEnvironment.Doors

get

Gets all door components currently found in the scene.

◆ ElevatorManager

object? BBPGlue.API.BBPEnvironment.ElevatorManager

get

Gets the raw elevator manager.

◆ Elevators

IList? BBPGlue.API.BBPEnvironment.Elevators

get

Gets the raw elevator list.

◆ ElevatorsList

System.Collections.Generic.List<BBPElevator> BBPGlue.API.BBPEnvironment.ElevatorsList

get

Gets all elevator components currently found in the scene.

◆ EnvironmentTimeScale

float BBPGlue.API.BBPEnvironment.EnvironmentTimeScale

get

Gets the environment time scale.

◆ EventsCount

int BBPGlue.API.BBPEnvironment.EventsCount

get

Gets the number of random events available in the current level.

◆ EventsStarted

bool BBPGlue.API.BBPEnvironment.EventsStarted

get

Gets whether random events have started.

◆ Exists

bool BBPGlue.API.BBPEnvironment.Exists

get

Gets whether an environment controller is available.

◆ Height

float BBPGlue.API.BBPEnvironment.Height

get

Gets the environment height.

◆ ItemCount

int BBPGlue.API.BBPEnvironment.ItemCount

get

Gets the number of pickups in the environment.

◆ Items

IList? BBPGlue.API.BBPEnvironment.Items

get

Gets the raw pickup list.

◆ Map

object? BBPGlue.API.BBPEnvironment.Map

get

Gets the raw map object.

◆ NavigationUpdatesFrozen

bool BBPGlue.API.BBPEnvironment.NavigationUpdatesFrozen

get

Gets whether navigation updates are frozen.

◆ NotebookCount

int BBPGlue.API.BBPEnvironment.NotebookCount

get

Gets the number of notebooks in the environment.

◆ Notebooks

IList? BBPGlue.API.BBPEnvironment.Notebooks

get

Gets the raw notebook list.

◆ NotebookTotal

int BBPGlue.API.BBPEnvironment.NotebookTotal

getset

Gets or sets the total number of notebooks in the level.

◆ NpcCount

int BBPGlue.API.BBPEnvironment.NpcCount

get

Gets the number of NPCs in the environment.

◆ Npcs

IList? BBPGlue.API.BBPEnvironment.Npcs

get

Gets the raw NPC list.

◆ NpcTimeScale

float BBPGlue.API.BBPEnvironment.NpcTimeScale

get

Gets the NPC time scale.

◆ PlayerCount

int BBPGlue.API.BBPEnvironment.PlayerCount

get

Gets the number of players in the environment.

◆ Players

IList? BBPGlue.API.BBPEnvironment.Players

get

Gets the raw player list.

◆ PlayerTimeScale

float BBPGlue.API.BBPEnvironment.PlayerTimeScale

get

Gets the player time scale.

◆ Raw

object? BBPGlue.API.BBPEnvironment.Raw

get

Gets the raw environment controller instance.

◆ RemainingTime

int BBPGlue.API.BBPEnvironment.RemainingTime

get

Gets the remaining level time.

◆ RoomCount

int BBPGlue.API.BBPEnvironment.RoomCount

get

Gets the number of rooms in the environment.

◆ RoomList

System.Collections.Generic.List<BBPRoom> BBPGlue.API.BBPEnvironment.RoomList

get

Gets all room components currently found in the scene.

◆ Rooms

IList? BBPGlue.API.BBPEnvironment.Rooms

get

Gets the raw room list.

◆ SpawnPoint

Vector3 BBPGlue.API.BBPEnvironment.SpawnPoint

getset

Gets or sets the level spawn position.

◆ SpawnRotation

Quaternion BBPGlue.API.BBPEnvironment.SpawnRotation

getset

Gets or sets the level spawn rotation.

◆ SurpassedGameTime

float BBPGlue.API.BBPEnvironment.SurpassedGameTime

get

Gets the elapsed game time.

◆ SurpassedRealTime

float BBPGlue.API.BBPEnvironment.SurpassedRealTime

get

Gets the elapsed real time.

◆ TimeOut

bool BBPGlue.API.BBPEnvironment.TimeOut

get

Gets whether the level timer has run out.

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

BBPEnvironment.cs

Public Member Functions

Properties

Detailed Description

Member Function Documentation

◆ AssignPlayers()

◆ BeginPlay()

◆ CloseSchool()

◆ ContainsCoordinates()

◆ DespawnAllNpcs()

◆ DespawnAllPickups()

◆ DespawnClosestNpc()

◆ DespawnNpc() [1/2]

◆ DespawnNpc() [2/2]

◆ DespawnPickup()

◆ FlickerLights()

◆ FreezeNavigationUpdates()

◆ GetBaldi()

◆ GetClosestDoor() [1/2]

◆ GetClosestDoor() [2/2]

◆ GetClosestElevator()

◆ GetClosestRoom() [1/2]

◆ GetClosestRoom() [2/2]

◆ GetDisplayTime()

◆ GetPlayerRoom()

◆ GetRoom()

◆ LightLevel()

◆ MakeNoise() [1/2]

◆ MakeNoise() [2/2]

◆ MakeSilent()

◆ PauseEnvironment()

◆ PauseEvents()

◆ RecalculateNavigation()

◆ Refresh()

◆ ResetEvents()

◆ SetAllLights()

◆ SetSpawn()

◆ SetTimeLimit()

◆ SpawnNpc() [1/2]

◆ SpawnNpc() [2/2]

◆ SpawnNpcAtPlayer()

◆ SpawnNpcAtWorld()

◆ SpawnNpcByCharacter() [1/2]

◆ SpawnNpcByCharacter() [2/2]

◆ SpawnNpcByName() [1/2]

◆ SpawnNpcByName() [2/2]

◆ SpawnNPCs()

◆ SpawnObject() [1/3]

◆ SpawnObject() [2/3]

◆ SpawnObject() [3/3]

◆ SpawnObject< T >() [1/2]

◆ SpawnObject< T >() [2/2]

◆ SpawnPickup() [1/3]

◆ SpawnPickup() [2/3]

◆ SpawnPickup() [3/3]

◆ SpawnPickupAtPlayer()

◆ SpawnPickupAtWorld()

◆ SpawnPickupByName() [1/2]

◆ SpawnPickupByName() [2/2]

◆ SpawnPickupRaw()

◆ SpawnPrefab()

◆ SpawnPrefabAtPlayer()

◆ SpawnRawObject() [1/2]

◆ SpawnRawObject() [2/2]

◆ StartEventTimers()

◆ StopEvents()

◆ TempCloseBully()

◆ TempCloseLockedStandardDoors()

◆ TempCloseWindows()

◆ TempOpenBreakableWindows()

◆ TempOpenBully()

◆ TempOpenLockedStandardDoors()

Property Documentation

◆ Active

◆ Activities

◆ Baldi

◆ CurrentEvents

◆ Doors

◆ ElevatorManager

◆ Elevators

◆ ElevatorsList