Wraps the BB+ Principal NPC and exposes Principal-specific fields, sounds, detention behavior, and helper methods. More...

Inheritance diagram for BBPGlue.API.BBPPrincipal:

Public Member Functions
	BBPPrincipal (object? raw)
	Creates a new Principal wrapper around a raw Principal instance.
void	ClearDestination ()
	Clears the NPC's current destination.
void	ClearGuilt ()
	Clears the NPC's guilt state.
void	Despawn ()
	Despawns the NPC.
void	DestinationEmpty ()
	Notifies the NPC that its destination is empty.
float	DistanceCheck (float value)
	Calls the NPC distance check.
void	FindPath (Vector3 start, Vector3 target)
	Finds a path from a custom start position to a target position.
void	FindPath (Vector3 target)
	Finds a path to the target position.
void	FindPathAvoid (Vector3 target, Vector3 avoid)
	Finds a path to the target while avoiding a position.
void	Flip ()
	Flips the NPC entity.
void	Hear (GameObject source, Vector3 position, int value)
	Makes the NPC hear a sound.
void	Hear (Vector3 position, int value)
	Makes the NPC hear a sound without a source GameObject.
void	Initialize ()
	Initializes the NPC.
void	KillAllForces ()
	Clears all forces applied to the NPC entity.
void	LoseTrackOfPlayer (BBPPlayerRef player)
	Resets Principal's sight timer for the given player.
void	MadeNavigationDecision ()
	Notifies the NPC that it made a navigation decision.
void	ManuallyAppendDestinationPoint (Vector3 position)
	Appends a destination point to the NPC navigator.
void	ObservePlayer (BBPPlayerRef player)
	Makes Principal observe a player and possibly begin chasing if the player is guilty.
void	Scold (string brokenRule)
	Makes Principal scold the given rule.
void	SendToDetention (bool validCollision)
	Sends Principal's targeted player to detention.
void	SentToDetention ()
	Calls the NPC detention handler.
void	SetBlinded (bool blinded)
	Sets whether the NPC entity is blinded.
void	SetFrozen (bool frozen)
	Freezes or unfreezes the NPC entity.
void	SetHidden (bool hidden)
	Sets whether the NPC entity is hidden.
void	SetRoomAvoidance (bool value)
	Enables or disables room avoidance for NPC pathfinding.
void	SetSpeed (float speed)
	Sets the NPC navigator speed.
void	SetSprite (Sprite sprite)
	Sets the sprite used by all NPC sprite renderers.
void	SetSpriteBaseActive (bool active)
	Shows or hides the NPC sprite root object.
void	SetSpriteColor (Color color)
	Sets the color used by all NPC sprite renderers.
void	SetVerticalScale (float scale)
	Sets the NPC entity's vertical scale.
void	SetVisible (bool visible)
	Sets whether the NPC entity is visible.
void	Sighted ()
	Calls the NPC sighted handler.
void	SkipCurrentDestinationPoint ()
	Skips the NPC navigator's current destination point.
void	Squish (float time)
	Squishes the NPC entity for a duration.
void	SwitchToChaseSprite ()
	Switches Principal to his chasing sprite.
void	SwitchToNormalSprite ()
	Switches Principal to his normal sprite.
void	TargetPosition (Vector3 target)
	Sends a target position to the NPC.
void	Teleport (Vector3 position)
	Teleports the NPC to a position.
void	TeleportToPlayer ()
	Teleports the NPC to the player position.
void	Unsighted ()
	Calls the NPC unsighted handler.
void	Unsquish ()
	Removes the NPC entity's squished state.
void	WanderRandom ()
	Makes the NPC wander to a random destination.
void	WanderRounds ()
	Makes the NPC use its round-wandering behavior.
void	WhistleChance ()
	Runs Principal's random whistle chance behavior.
void	WhistleReached ()
	Restores Principal's speed after reaching a whistle target.
void	WhistleReact (Vector3 target)
	Makes Principal react to a whistle target position.

Properties
float	Acceleration `[get, set]`
	Gets or sets the NPC navigator's acceleration.
bool	AllKnowing `[get, set]`
	Gets or sets whether Principal immediately knows where guilty players are.
BBPAudioManager	Audio `[get]`
	Gets the audio manager used by Principal.
Collider?[]	BaseTriggers `[get, set]`
	Gets or sets the NPC base trigger colliders.
object?	BehaviorStateMachine `[get]`
	Gets the NPC behavior state machine.
bool	Blinded `[get]`
	Gets whether the NPC is blinded.
string	BrokenRule `[get]`
	Gets the rule currently associated with this NPC.
float	CalculatedSpeed `[get]`
	Gets the NPC's calculated speed from the game object.
string	Character `[get]`
	Gets the NPC character identifier as text.
object?	CharacterRaw `[get, set]`
	Gets or sets the raw character value.
Sprite?	ChasingSprite `[get, set]`
	Gets or sets Principal's chasing sprite.
BBPSoundObject	ComingSound `[get, set]`
	Gets or sets Principal's "coming" sound after reacting to a whistle target.
Vector3	CurrentDestination `[get]`
	Gets the NPC navigator's current destination.
float	DefaultSpeed `[get, set]`
	Gets or sets Principal's default movement speed.
float	DetentionIncrement `[get, set]`
	Gets or sets how much detention time increases after each detention.
float	DetentionInitialTime `[get, set]`
	Gets or sets the initial detention duration.
int	DetentionLevel `[get, set]`
	Gets or sets the current detention level.
int	DetentionNoise `[get, set]`
	Gets or sets the noise value made when Principal sends the player to detention.
BBPSoundObject	DetentionSound `[get, set]`
	Gets or sets Principal's detention announcement sound.
object?	DetentionTimeSounds `[get, set]`
	Gets or sets Principal's detention time voice lines.
bool	Disobeying `[get]`
	Gets whether the NPC is currently disobeying.
BBPEntity	Entity `[get]`
	Gets the entity component associated with this NPC.
object?	EnvironmentController `[get, set]`
	Gets or sets the environment controller associated with this NPC.
bool	Exists `[get]`
	Gets whether the wrapped NPC instance exists.
bool	HasDestination `[get]`
	Gets whether the NPC navigator has a destination.
bool	HasDetour `[get]`
	Gets whether the NPC currently has a detour.
bool	IgnorePlayerOnSpawn `[get, set]`
	Gets or sets whether the NPC ignores the player immediately after spawning.
float	KnockPauseTime `[get, set]`
	Gets or sets how long Principal pauses after knocking on a faculty door.
object?	Looker `[get, set]`
	Gets or sets the NPC looker component.
float	MaxSpeed `[get, set]`
	Gets or sets the NPC navigator's maximum speed.
string	Name `[get, set]`
	Gets or sets the NPC GameObject name.
object?	NavigationStateMachine `[get]`
	Gets the NPC navigation state machine.
object?	Navigator `[get]`
	Gets the NPC navigator.
Vector3	NextPoint `[get]`
	Gets the next point in the NPC navigator's path.
BBPSoundObject	NoAfterHoursSound `[get, set]`
	Gets or sets Principal's "no after hours" sound.
BBPSoundObject	NoBullyingSound `[get, set]`
	Gets or sets Principal's "no bullying" sound.
BBPSoundObject	NoDrinkingSound `[get, set]`
	Gets or sets Principal's "no drinking" sound.
BBPSoundObject	NoEatingSound `[get, set]`
	Gets or sets Principal's "no eating" sound.
BBPSoundObject	NoEscapingSound `[get, set]`
	Gets or sets Principal's "no escaping" sound.
BBPSoundObject	NoFacultySound `[get, set]`
	Gets or sets Principal's "no faculty" sound.
BBPSoundObject	NoLockersSound `[get, set]`
	Gets or sets Principal's "no lockers" sound.
Sprite?	NormalSprite `[get, set]`
	Gets or sets Principal's normal sprite.
BBPSoundObject	NoRunningSound `[get, set]`
	Gets or sets Principal's "no running" sound.
BBPSoundObject	NoStabbingSound `[get, set]`
	Gets or sets Principal's "no stabbing" sound.
Vector3	Position `[get, set]`
	Gets or sets the NPC position in world space.
object?	Poster `[get, set]`
	Gets or sets the NPC poster object.
object?	PotentialRoomAssets `[get, set]`
	Gets or sets the NPC potential room assets.
float	Radius `[get, set]`
	Gets or sets the NPC navigator radius.
object?	Raw `[get]`
	Gets the raw underlying NPC instance.
Quaternion	Rotation `[get, set]`
	Gets or sets the NPC rotation in world space.
object?	ScoldSounds `[get, set]`
	Gets or sets Principal's detention scold voice lines.
IList?	SpawnableRooms `[get]`
	Gets the rooms this NPC can spawn in.
GameObject?	SpriteBase `[get, set]`
	Gets or sets the root GameObject for the NPC sprites.
SpriteRenderer?[]	SpriteRenderers `[get, set]`
	Gets or sets the NPC sprite renderers.
object?	TargetedPlayer `[get, set]`
	Gets or sets the player currently targeted by Principal.
float	TimeScale `[get]`
	Gets the NPC's current time scale.
Vector3	Velocity `[get]`
	Gets the NPC navigator's current velocity.
bool	Wandering `[get]`
	Gets whether the NPC is currently wandering.
float	WhistleChanceValue `[get, set]`
	Gets or sets Principal's whistle chance.
BBPSoundObject	WhistleSound `[get, set]`
	Gets or sets Principal's whistle sound.
float	WhistleSpeed `[get, set]`
	Gets or sets Principal's whistle approach speed.

Detailed Description

Wraps the BB+ Principal NPC and exposes Principal-specific fields, sounds, detention behavior, and helper methods.

Constructor & Destructor Documentation

◆ BBPPrincipal()

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

Creates a new Principal wrapper around a raw Principal instance.

Parameters

raw	The raw Principal object or component.

Member Function Documentation

◆ ClearDestination()

void BBPGlue.API.BBPNpc.ClearDestination ( )

inherited

Clears the NPC's current destination.

◆ ClearGuilt()

void BBPGlue.API.BBPNpc.ClearGuilt ( )

inherited

Clears the NPC's guilt state.

◆ Despawn()

void BBPGlue.API.BBPNpc.Despawn ( )

inherited

Despawns the NPC.

◆ DestinationEmpty()

void BBPGlue.API.BBPNpc.DestinationEmpty ( )

inherited

Notifies the NPC that its destination is empty.

◆ DistanceCheck()

float BBPGlue.API.BBPNpc.DistanceCheck ( float value )

inherited

Calls the NPC distance check.

Parameters

value The value to pass to the game method.

Returns: The value returned by the game method.

◆ FindPath() [1/2]

void BBPGlue.API.BBPNpc.FindPath	(	Vector3	start,
		Vector3	target )

inherited

Finds a path from a custom start position to a target position.

Parameters

start	The start position.
target	The target position.

◆ FindPath() [2/2]

void BBPGlue.API.BBPNpc.FindPath ( Vector3 target )

inherited

Finds a path to the target position.

Parameters

target The target position.

◆ FindPathAvoid()

void BBPGlue.API.BBPNpc.FindPathAvoid	(	Vector3	target,
		Vector3	avoid )

inherited

Finds a path to the target while avoiding a position.

Parameters

target	The target position.
avoid	The position to avoid.

◆ Flip()

void BBPGlue.API.BBPNpc.Flip ( )

inherited

Flips the NPC entity.

◆ Hear() [1/2]

void BBPGlue.API.BBPNpc.Hear	(	GameObject	source,
		Vector3	position,
		int	value )

inherited

Makes the NPC hear a sound.

Parameters

source	The sound source GameObject.
position	The sound position.
value	The sound value used by the game.

◆ Hear() [2/2]

void BBPGlue.API.BBPNpc.Hear	(	Vector3	position,
		int	value )

inherited

Makes the NPC hear a sound without a source GameObject.

Parameters

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

◆ Initialize()

void BBPGlue.API.BBPNpc.Initialize ( )

inherited

Initializes the NPC.

◆ KillAllForces()

void BBPGlue.API.BBPNpc.KillAllForces ( )

inherited

Clears all forces applied to the NPC entity.

◆ LoseTrackOfPlayer()

void BBPGlue.API.BBPPrincipal.LoseTrackOfPlayer ( BBPPlayerRef player )

Resets Principal's sight timer for the given player.

Parameters

player Player reference.

◆ MadeNavigationDecision()

void BBPGlue.API.BBPNpc.MadeNavigationDecision ( )

inherited

Notifies the NPC that it made a navigation decision.

◆ ManuallyAppendDestinationPoint()

void BBPGlue.API.BBPNpc.ManuallyAppendDestinationPoint ( Vector3 position )

inherited

Appends a destination point to the NPC navigator.

Parameters

position The point to append.

◆ ObservePlayer()

void BBPGlue.API.BBPPrincipal.ObservePlayer ( BBPPlayerRef player )

Makes Principal observe a player and possibly begin chasing if the player is guilty.

Parameters

player Player reference.

◆ Scold()

void BBPGlue.API.BBPPrincipal.Scold ( string brokenRule )

Makes Principal scold the given rule.

Parameters

brokenRule Rule name, such as Running, Faculty, Drinking, Escaping, Lockers, AfterHours, or Bullying.

◆ SendToDetention()

void BBPGlue.API.BBPPrincipal.SendToDetention ( bool validCollision )

Sends Principal's targeted player to detention.

Parameters

validCollision True when Principal caught the player through a valid collision; false when detention is triggered as an escaping penalty.

◆ SentToDetention()

void BBPGlue.API.BBPNpc.SentToDetention ( )

inherited

Calls the NPC detention handler.

◆ SetBlinded()

void BBPGlue.API.BBPNpc.SetBlinded ( bool blinded )

inherited

Sets whether the NPC entity is blinded.

Parameters

blinded True to blind the NPC; false to restore sight.

◆ SetFrozen()

void BBPGlue.API.BBPNpc.SetFrozen ( bool frozen )

inherited

Freezes or unfreezes the NPC entity.

Parameters

frozen True to freeze the NPC; false to unfreeze it.

◆ SetHidden()

void BBPGlue.API.BBPNpc.SetHidden ( bool hidden )

inherited

Sets whether the NPC entity is hidden.

Parameters

hidden True to hide the NPC; false to show it.

◆ SetRoomAvoidance()

void BBPGlue.API.BBPNpc.SetRoomAvoidance ( bool value )

inherited

Enables or disables room avoidance for NPC pathfinding.

Parameters

value True to avoid rooms; otherwise, false.

◆ SetSpeed()

void BBPGlue.API.BBPNpc.SetSpeed ( float speed )

inherited

Sets the NPC navigator speed.

Parameters

speed The speed to set.

◆ SetSprite()

void BBPGlue.API.BBPNpc.SetSprite ( Sprite sprite )

inherited

Sets the sprite used by all NPC sprite renderers.

Parameters

sprite The sprite to use.

◆ SetSpriteBaseActive()

void BBPGlue.API.BBPNpc.SetSpriteBaseActive ( bool active )

inherited

Shows or hides the NPC sprite root object.

Parameters

active True to show the sprite root; false to hide it.

◆ SetSpriteColor()

void BBPGlue.API.BBPNpc.SetSpriteColor ( Color color )

inherited

Sets the color used by all NPC sprite renderers.

Parameters

color The color to apply.

◆ SetVerticalScale()

void BBPGlue.API.BBPNpc.SetVerticalScale ( float scale )

inherited

Sets the NPC entity's vertical scale.

Parameters

scale The vertical scale value.

◆ SetVisible()

void BBPGlue.API.BBPNpc.SetVisible ( bool visible )

inherited

Sets whether the NPC entity is visible.

Parameters

visible True to make the NPC visible; false to hide it.

◆ Sighted()

void BBPGlue.API.BBPNpc.Sighted ( )

inherited

Calls the NPC sighted handler.

◆ SkipCurrentDestinationPoint()

void BBPGlue.API.BBPNpc.SkipCurrentDestinationPoint ( )

inherited

Skips the NPC navigator's current destination point.

◆ Squish()

void BBPGlue.API.BBPNpc.Squish ( float time )

inherited

Squishes the NPC entity for a duration.

Parameters

time	The duration in seconds.

◆ SwitchToChaseSprite()

void BBPGlue.API.BBPPrincipal.SwitchToChaseSprite ( )

Switches Principal to his chasing sprite.

◆ SwitchToNormalSprite()

void BBPGlue.API.BBPPrincipal.SwitchToNormalSprite ( )

Switches Principal to his normal sprite.

◆ TargetPosition()

void BBPGlue.API.BBPNpc.TargetPosition ( Vector3 target )

inherited

Sends a target position to the NPC.

Parameters

target The target position.

◆ Teleport()

void BBPGlue.API.BBPNpc.Teleport ( Vector3 position )

inherited

Teleports the NPC to a position.

Parameters

position The target position.

◆ TeleportToPlayer()

void BBPGlue.API.BBPNpc.TeleportToPlayer ( )

inherited

Teleports the NPC to the player position.

◆ Unsighted()

void BBPGlue.API.BBPNpc.Unsighted ( )

inherited

Calls the NPC unsighted handler.

◆ Unsquish()

void BBPGlue.API.BBPNpc.Unsquish ( )

inherited

Removes the NPC entity's squished state.

◆ WanderRandom()

void BBPGlue.API.BBPNpc.WanderRandom ( )

inherited

Makes the NPC wander to a random destination.

◆ WanderRounds()

void BBPGlue.API.BBPNpc.WanderRounds ( )

inherited

Makes the NPC use its round-wandering behavior.

◆ WhistleChance()

void BBPGlue.API.BBPPrincipal.WhistleChance ( )

Runs Principal's random whistle chance behavior.

◆ WhistleReached()

void BBPGlue.API.BBPPrincipal.WhistleReached ( )

Restores Principal's speed after reaching a whistle target.

◆ WhistleReact()

void BBPGlue.API.BBPPrincipal.WhistleReact ( Vector3 target )

Makes Principal react to a whistle target position.

Parameters

target Target position.

Property Documentation

◆ Acceleration

float BBPGlue.API.BBPNpc.Acceleration

getsetinherited

Gets or sets the NPC navigator's acceleration.

◆ AllKnowing

bool BBPGlue.API.BBPPrincipal.AllKnowing

getset

Gets or sets whether Principal immediately knows where guilty players are.

◆ Audio

BBPAudioManager BBPGlue.API.BBPPrincipal.Audio

get

Gets the audio manager used by Principal.

◆ BaseTriggers

Collider? [] BBPGlue.API.BBPNpc.BaseTriggers

getsetinherited

Gets or sets the NPC base trigger colliders.

◆ BehaviorStateMachine

object? BBPGlue.API.BBPNpc.BehaviorStateMachine

getinherited

Gets the NPC behavior state machine.

◆ Blinded

bool BBPGlue.API.BBPNpc.Blinded

getinherited

Gets whether the NPC is blinded.

◆ BrokenRule

string BBPGlue.API.BBPNpc.BrokenRule

getinherited

Gets the rule currently associated with this NPC.

◆ CalculatedSpeed

float BBPGlue.API.BBPNpc.CalculatedSpeed

getinherited

Gets the NPC's calculated speed from the game object.

◆ Character

string BBPGlue.API.BBPNpc.Character

getinherited

Gets the NPC character identifier as text.

◆ CharacterRaw

object? BBPGlue.API.BBPNpc.CharacterRaw

getsetinherited

Gets or sets the raw character value.

◆ ChasingSprite

Sprite? BBPGlue.API.BBPPrincipal.ChasingSprite

getset

Gets or sets Principal's chasing sprite.

◆ ComingSound

BBPSoundObject BBPGlue.API.BBPPrincipal.ComingSound

getset

Gets or sets Principal's "coming" sound after reacting to a whistle target.

◆ CurrentDestination

Vector3 BBPGlue.API.BBPNpc.CurrentDestination

getinherited

Gets the NPC navigator's current destination.

◆ DefaultSpeed

float BBPGlue.API.BBPPrincipal.DefaultSpeed

getset

Gets or sets Principal's default movement speed.

◆ DetentionIncrement

float BBPGlue.API.BBPPrincipal.DetentionIncrement

getset

Gets or sets how much detention time increases after each detention.

◆ DetentionInitialTime

float BBPGlue.API.BBPPrincipal.DetentionInitialTime

getset

Gets or sets the initial detention duration.

◆ DetentionLevel

int BBPGlue.API.BBPPrincipal.DetentionLevel

getset

Gets or sets the current detention level.

◆ DetentionNoise

int BBPGlue.API.BBPPrincipal.DetentionNoise

getset

Gets or sets the noise value made when Principal sends the player to detention.

◆ DetentionSound

BBPSoundObject BBPGlue.API.BBPPrincipal.DetentionSound

getset

Gets or sets Principal's detention announcement sound.

◆ DetentionTimeSounds

object? BBPGlue.API.BBPPrincipal.DetentionTimeSounds

getset

Gets or sets Principal's detention time voice lines.

◆ Disobeying

bool BBPGlue.API.BBPNpc.Disobeying

getinherited

Gets whether the NPC is currently disobeying.

◆ Entity

BBPEntity BBPGlue.API.BBPNpc.Entity

getinherited

Gets the entity component associated with this NPC.

◆ EnvironmentController

object? BBPGlue.API.BBPNpc.EnvironmentController

getsetinherited

Gets or sets the environment controller associated with this NPC.

◆ Exists

bool BBPGlue.API.BBPNpc.Exists

getinherited

Gets whether the wrapped NPC instance exists.

◆ HasDestination

bool BBPGlue.API.BBPNpc.HasDestination

getinherited

Gets whether the NPC navigator has a destination.

◆ HasDetour

bool BBPGlue.API.BBPNpc.HasDetour

getinherited

Gets whether the NPC currently has a detour.

◆ IgnorePlayerOnSpawn

bool BBPGlue.API.BBPNpc.IgnorePlayerOnSpawn

getsetinherited

Gets or sets whether the NPC ignores the player immediately after spawning.

◆ KnockPauseTime

float BBPGlue.API.BBPPrincipal.KnockPauseTime

getset

Gets or sets how long Principal pauses after knocking on a faculty door.

◆ Looker

object? BBPGlue.API.BBPNpc.Looker

getsetinherited

Gets or sets the NPC looker component.

◆ MaxSpeed

float BBPGlue.API.BBPNpc.MaxSpeed

getsetinherited

Gets or sets the NPC navigator's maximum speed.

◆ Name

string BBPGlue.API.BBPNpc.Name

getsetinherited

Gets or sets the NPC GameObject name.

◆ NavigationStateMachine

object? BBPGlue.API.BBPNpc.NavigationStateMachine

getinherited

Gets the NPC navigation state machine.

◆ Navigator

object? BBPGlue.API.BBPNpc.Navigator

getinherited

Gets the NPC navigator.

◆ NextPoint

Vector3 BBPGlue.API.BBPNpc.NextPoint

getinherited

Gets the next point in the NPC navigator's path.

◆ NoAfterHoursSound

BBPSoundObject BBPGlue.API.BBPPrincipal.NoAfterHoursSound

getset

Gets or sets Principal's "no after hours" sound.

◆ NoBullyingSound

BBPSoundObject BBPGlue.API.BBPPrincipal.NoBullyingSound

getset

Gets or sets Principal's "no bullying" sound.

◆ NoDrinkingSound

BBPSoundObject BBPGlue.API.BBPPrincipal.NoDrinkingSound

getset

Gets or sets Principal's "no drinking" sound.

◆ NoEatingSound

BBPSoundObject BBPGlue.API.BBPPrincipal.NoEatingSound

getset

Gets or sets Principal's "no eating" sound.

◆ NoEscapingSound

BBPSoundObject BBPGlue.API.BBPPrincipal.NoEscapingSound

getset

Gets or sets Principal's "no escaping" sound.

◆ NoFacultySound

BBPSoundObject BBPGlue.API.BBPPrincipal.NoFacultySound

getset

Gets or sets Principal's "no faculty" sound.

◆ NoLockersSound

BBPSoundObject BBPGlue.API.BBPPrincipal.NoLockersSound

getset

Gets or sets Principal's "no lockers" sound.

◆ NormalSprite

Sprite? BBPGlue.API.BBPPrincipal.NormalSprite

getset

Gets or sets Principal's normal sprite.

◆ NoRunningSound

BBPSoundObject BBPGlue.API.BBPPrincipal.NoRunningSound

getset

Gets or sets Principal's "no running" sound.

◆ NoStabbingSound

BBPSoundObject BBPGlue.API.BBPPrincipal.NoStabbingSound

getset

Gets or sets Principal's "no stabbing" sound.

◆ Position

Vector3 BBPGlue.API.BBPNpc.Position

getsetinherited

Gets or sets the NPC position in world space.

◆ Poster

object? BBPGlue.API.BBPNpc.Poster

getsetinherited

Gets or sets the NPC poster object.

◆ PotentialRoomAssets

object? BBPGlue.API.BBPNpc.PotentialRoomAssets

getsetinherited

Gets or sets the NPC potential room assets.

◆ Radius

float BBPGlue.API.BBPNpc.Radius

getsetinherited

Gets or sets the NPC navigator radius.

◆ Raw

object? BBPGlue.API.BBPNpc.Raw

getinherited

Gets the raw underlying NPC instance.

◆ Rotation

Quaternion BBPGlue.API.BBPNpc.Rotation

getsetinherited

Gets or sets the NPC rotation in world space.

◆ ScoldSounds

object? BBPGlue.API.BBPPrincipal.ScoldSounds

getset

Gets or sets Principal's detention scold voice lines.

◆ SpawnableRooms

IList? BBPGlue.API.BBPNpc.SpawnableRooms

getinherited

Gets the rooms this NPC can spawn in.

◆ SpriteBase

GameObject? BBPGlue.API.BBPNpc.SpriteBase

getsetinherited

Gets or sets the root GameObject for the NPC sprites.

◆ SpriteRenderers

SpriteRenderer? [] BBPGlue.API.BBPNpc.SpriteRenderers

getsetinherited

Gets or sets the NPC sprite renderers.

◆ TargetedPlayer

object? BBPGlue.API.BBPPrincipal.TargetedPlayer

getset

Gets or sets the player currently targeted by Principal.

◆ TimeScale

float BBPGlue.API.BBPNpc.TimeScale

getinherited

Gets the NPC's current time scale.

◆ Velocity

Vector3 BBPGlue.API.BBPNpc.Velocity

getinherited

Gets the NPC navigator's current velocity.

◆ Wandering

bool BBPGlue.API.BBPNpc.Wandering

getinherited

Gets whether the NPC is currently wandering.

◆ WhistleChanceValue

float BBPGlue.API.BBPPrincipal.WhistleChanceValue

getset

Gets or sets Principal's whistle chance.

◆ WhistleSound

BBPSoundObject BBPGlue.API.BBPPrincipal.WhistleSound

getset

Gets or sets Principal's whistle sound.

◆ WhistleSpeed

float BBPGlue.API.BBPPrincipal.WhistleSpeed

getset

Gets or sets Principal's whistle approach speed.

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

Principal.cs

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ BBPPrincipal()

Member Function Documentation

◆ ClearDestination()

◆ ClearGuilt()

◆ Despawn()

◆ DestinationEmpty()

◆ DistanceCheck()

◆ FindPath() [1/2]

◆ FindPath() [2/2]

◆ FindPathAvoid()

◆ Flip()

◆ Hear() [1/2]

◆ Hear() [2/2]

◆ Initialize()

◆ KillAllForces()

◆ LoseTrackOfPlayer()

◆ MadeNavigationDecision()

◆ ManuallyAppendDestinationPoint()

◆ ObservePlayer()

◆ Scold()

◆ SendToDetention()

◆ SentToDetention()

◆ SetBlinded()

◆ SetFrozen()

◆ SetHidden()

◆ SetRoomAvoidance()

◆ SetSpeed()

◆ SetSprite()

◆ SetSpriteBaseActive()

◆ SetSpriteColor()

◆ SetVerticalScale()

◆ SetVisible()

◆ Sighted()

◆ SkipCurrentDestinationPoint()

◆ Squish()

◆ SwitchToChaseSprite()

◆ SwitchToNormalSprite()

◆ TargetPosition()

◆ Teleport()

◆ TeleportToPlayer()

◆ Unsighted()

◆ Unsquish()

◆ WanderRandom()

◆ WanderRounds()

◆ WhistleChance()

◆ WhistleReached()

◆ WhistleReact()

Property Documentation

◆ Acceleration

◆ AllKnowing

◆ Audio

◆ BaseTriggers

◆ BehaviorStateMachine

◆ Blinded

◆ BrokenRule

◆ CalculatedSpeed

◆ Character

◆ CharacterRaw

◆ ChasingSprite

◆ ComingSound

◆ CurrentDestination

◆ DefaultSpeed

◆ DetentionIncrement

◆ DetentionInitialTime

◆ DetentionLevel

◆ DetentionNoise

◆ DetentionSound

◆ DetentionTimeSounds

◆ Disobeying

◆ Entity

◆ EnvironmentController

◆ Exists

◆ HasDestination

◆ HasDetour

◆ IgnorePlayerOnSpawn

◆ KnockPauseTime