Wraps the BB+ Chalk Face NPC and exposes chalkboard, timer, room locking, laughter, and activation helpers. More...

Inheritance diagram for BBPGlue.API.BBPChalkFace:

Public Member Functions
void	Activate (BBPRoom room)
	Activates Chalk Face in the given room.
void	AdvanceLaughter (BBPRoom room, float acceleration)
	Advances Chalk Face's laughter movement around a room.
bool	AdvanceTimer ()
	Advances Chalk Face's charge timer.
	BBPChalkFace (object? raw)
	Creates a Chalk Face wrapper around a raw ChalkFace instance.
void	Cancel ()
	Cancels Chalk Face's current behavior.
void	Cancelled ()
	Runs Chalk Face's cancellation cleanup.
void	ClearDestination ()
	Clears the NPC's current destination.
void	ClearGuilt ()
	Clears the NPC's guilt state.
void	DecreaseTimer (float rate)
	Decreases Chalk Face's timer by a specific rate.
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	IdleUpdate ()
	Runs Chalk Face's idle update.
void	Initialize ()
	Initializes the NPC.
void	KillAllForces ()
	Clears all forces applied to the NPC entity.
void	MadeNavigationDecision ()
	Notifies the NPC that it made a navigation decision.
void	ManuallyAppendDestinationPoint (Vector3 position)
	Appends a destination point to the NPC navigator.
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	SpawnBoard (BBPRoom room)
	Spawns a chalkboard in the given room.
void	Squish (float time)
	Squishes the NPC entity for a duration.
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	UpdateSprite ()
	Updates Chalk Face's sprite visibility/charge state.
void	WanderRandom ()
	Makes the NPC wander to a random destination.
void	WanderRounds ()
	Makes the NPC use its round-wandering behavior.

Properties
float	Acceleration `[get, set]`
	Gets or sets the NPC navigator's acceleration.
float	ApproachAcceleration `[get]`
	Gets Chalk Face's approach acceleration.
float	ApproachSpeed `[get, set]`
	Gets or sets Chalk Face's approach speed.
BBPAudioManager	Audio `[get]`
	Gets Chalk Face's audio manager.
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.
SpriteRenderer?	ChalkRenderer `[get, set]`
	Gets or sets the chalk sprite renderer.
string	Character `[get]`
	Gets the NPC character identifier as text.
object?	CharacterRaw `[get, set]`
	Gets or sets the raw character value.
float	Charge `[get, set]`
	Gets or sets Chalk Face's internal charge amount.
Vector3	CurrentDestination `[get]`
	Gets the NPC navigator's current destination.
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.
SpriteRenderer?	FlyingRenderer `[get, set]`
	Gets or sets the flying sprite renderer.
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	LockTime `[get]`
	Gets Chalk Face's room lock time.
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.
int	NoiseValue `[get, set]`
	Gets or sets Chalk Face's noise value.
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.
float	SetTime `[get, set]`
	Gets or sets Chalk Face's set/charge time.
IList?	SpawnableRooms `[get]`
	Gets the rooms this NPC can spawn in.
float	SpinSpeed `[get, set]`
	Gets or sets Chalk Face's spin speed.
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.
float	TimeScale `[get]`
	Gets the NPC's current time scale.
float	UnchargeRate `[get, set]`
	Gets or sets Chalk Face's uncharge rate.
Vector3	Velocity `[get]`
	Gets the NPC navigator's current velocity.
bool	Wandering `[get]`
	Gets whether the NPC is currently wandering.

Detailed Description

Wraps the BB+ Chalk Face NPC and exposes chalkboard, timer, room locking, laughter, and activation helpers.

Constructor & Destructor Documentation

◆ BBPChalkFace()

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

Creates a Chalk Face wrapper around a raw ChalkFace instance.

Parameters

raw	The raw ChalkFace object or component.

Member Function Documentation

◆ Activate()

void BBPGlue.API.BBPChalkFace.Activate ( BBPRoom room )

Activates Chalk Face in the given room.

Parameters

room	The room to lock and haunt.

◆ AdvanceLaughter()

void BBPGlue.API.BBPChalkFace.AdvanceLaughter	(	BBPRoom	room,
		float	acceleration )

Advances Chalk Face's laughter movement around a room.

Parameters

room	The target room.
acceleration	Extra acceleration.

◆ AdvanceTimer()

bool BBPGlue.API.BBPChalkFace.AdvanceTimer ( )

Advances Chalk Face's charge timer.

Returns: True if the timer reached the activation threshold.

◆ Cancel()

void BBPGlue.API.BBPChalkFace.Cancel ( )

Cancels Chalk Face's current behavior.

◆ Cancelled()

void BBPGlue.API.BBPChalkFace.Cancelled ( )

Runs Chalk Face's cancellation cleanup.

◆ 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.

◆ DecreaseTimer()

void BBPGlue.API.BBPChalkFace.DecreaseTimer ( float rate )

Decreases Chalk Face's timer by a specific rate.

Parameters

rate	Amount to decrease.

◆ 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.

◆ IdleUpdate()

void BBPGlue.API.BBPChalkFace.IdleUpdate ( )

Runs Chalk Face's idle update.

◆ 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.

◆ 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.

◆ 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.

◆ SpawnBoard()

void BBPGlue.API.BBPChalkFace.SpawnBoard ( BBPRoom room )

Spawns a chalkboard in the given room.

Parameters

room	The room to spawn a board in.

◆ Squish()

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

inherited

Squishes the NPC entity for a duration.

Parameters

time	The duration in seconds.

◆ 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.

◆ UpdateSprite()

void BBPGlue.API.BBPChalkFace.UpdateSprite ( )

Updates Chalk Face's sprite visibility/charge 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.

Property Documentation

◆ Acceleration

float BBPGlue.API.BBPNpc.Acceleration

getsetinherited

Gets or sets the NPC navigator's acceleration.

◆ ApproachAcceleration

float BBPGlue.API.BBPChalkFace.ApproachAcceleration

get

Gets Chalk Face's approach acceleration.

◆ ApproachSpeed

float BBPGlue.API.BBPChalkFace.ApproachSpeed

getset

Gets or sets Chalk Face's approach speed.

◆ Audio

BBPAudioManager BBPGlue.API.BBPChalkFace.Audio

get

Gets Chalk Face's audio manager.

◆ 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.

◆ ChalkRenderer

SpriteRenderer? BBPGlue.API.BBPChalkFace.ChalkRenderer

getset

Gets or sets the chalk sprite renderer.

◆ 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.

◆ Charge

float BBPGlue.API.BBPChalkFace.Charge

getset

Gets or sets Chalk Face's internal charge amount.

◆ CurrentDestination

Vector3 BBPGlue.API.BBPNpc.CurrentDestination

getinherited

Gets the NPC navigator's current destination.

◆ 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.

◆ FlyingRenderer

SpriteRenderer? BBPGlue.API.BBPChalkFace.FlyingRenderer

getset

Gets or sets the flying sprite renderer.

◆ 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.

◆ LockTime

float BBPGlue.API.BBPChalkFace.LockTime

get

Gets Chalk Face's room lock time.

◆ 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.

◆ NoiseValue

int BBPGlue.API.BBPChalkFace.NoiseValue

getset

Gets or sets Chalk Face's noise value.

◆ 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.

◆ SetTime

float BBPGlue.API.BBPChalkFace.SetTime

getset

Gets or sets Chalk Face's set/charge time.

◆ SpawnableRooms

IList? BBPGlue.API.BBPNpc.SpawnableRooms

getinherited

Gets the rooms this NPC can spawn in.

◆ SpinSpeed

float BBPGlue.API.BBPChalkFace.SpinSpeed

getset

Gets or sets Chalk Face's spin speed.

◆ 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.

◆ TimeScale

float BBPGlue.API.BBPNpc.TimeScale

getinherited

Gets the NPC's current time scale.

◆ UnchargeRate

float BBPGlue.API.BBPChalkFace.UnchargeRate

getset

Gets or sets Chalk Face's uncharge rate.

◆ 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.

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

ChalkFace.cs

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ BBPChalkFace()

Member Function Documentation

◆ Activate()

◆ AdvanceLaughter()

◆ AdvanceTimer()

◆ Cancel()

◆ Cancelled()

◆ ClearDestination()

◆ ClearGuilt()

◆ DecreaseTimer()

◆ Despawn()

◆ DestinationEmpty()

◆ DistanceCheck()

◆ FindPath() [1/2]

◆ FindPath() [2/2]

◆ FindPathAvoid()

◆ Flip()

◆ Hear() [1/2]

◆ Hear() [2/2]

◆ IdleUpdate()

◆ Initialize()

◆ KillAllForces()

◆ MadeNavigationDecision()

◆ ManuallyAppendDestinationPoint()

◆ SentToDetention()

◆ SetBlinded()

◆ SetFrozen()

◆ SetHidden()

◆ SetRoomAvoidance()

◆ SetSpeed()

◆ SetSprite()

◆ SetSpriteBaseActive()

◆ SetSpriteColor()

◆ SetVerticalScale()

◆ SetVisible()

◆ Sighted()

◆ SkipCurrentDestinationPoint()

◆ SpawnBoard()

◆ Squish()

◆ TargetPosition()

◆ Teleport()

◆ TeleportToPlayer()

◆ Unsighted()

◆ Unsquish()

◆ UpdateSprite()

◆ WanderRandom()

◆ WanderRounds()

Property Documentation

◆ Acceleration

◆ ApproachAcceleration

◆ ApproachSpeed

◆ Audio

◆ BaseTriggers

◆ BehaviorStateMachine

◆ Blinded

◆ BrokenRule

◆ CalculatedSpeed

◆ ChalkRenderer

◆ Character

◆ CharacterRaw

◆ Charge

◆ CurrentDestination

◆ Disobeying

◆ Entity

◆ EnvironmentController

◆ Exists

◆ FlyingRenderer

◆ HasDestination

◆ HasDetour

◆ IgnorePlayerOnSpawn

◆ LockTime

◆ Looker

◆ MaxSpeed

◆ Name

◆ NavigationStateMachine

◆ Navigator