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

Wraps the BB+ Arts And Crafters NPC and exposes anger, hiding, attacking, teleporting, and audio helpers. More...

Inheritance diagram for BBPGlue.API.BBPArtsAndCrafters:

Public Member Functions

void Attack (BBPPlayerRef player)
 Starts Arts And Crafters' attack behavior against a player.
 BBPArtsAndCrafters (object? raw)
 Creates an Arts And Crafters wrapper around a raw 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.
void DisappearForever ()
 Makes Arts And Crafters disappear permanently.
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 GetAngry (BBPPlayerRef player)
 Makes Arts And Crafters angry at the given player.
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 Hide (bool hidden)
 Hides or reveals Arts And Crafters.
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 RunAway ()
 Makes Arts And Crafters run away.
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 SpawnAt (object position)
 Spawns Arts And Crafters at a raw IntVector2 grid position.
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 TeleportGrid (object position)
 Teleports Arts And Crafters to a raw IntVector2 grid position.
void TeleportPlayer (BBPPlayerRef player)
 Triggers Arts And Crafters' player teleport behavior.
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 UpdateEcho ()
 Updates Arts And Crafters' echo visuals.
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.
bool Angry [get]
 Gets whether Arts And Crafters is angry.
Sprite? AngrySprite [get, set]
 Gets or sets Arts And Crafters' angry sprite.
float AngryTime [get]
 Gets Arts And Crafters' anger time.
BBPAudioManager AttackAudio [get]
 Gets Arts And Crafters' attack audio manager.
bool Attacking [get]
 Gets whether Arts And Crafters is attacking.
float AttackSpinAccel [get]
 Gets Arts And Crafters' attack spin acceleration.
float AttackSpinSpeed [get]
 Gets Arts And Crafters' attack spin speed.
float AttackTime [get]
 Gets Arts And Crafters' attack duration.
BBPAudioManager Audio [get]
 Gets Arts And Crafters' primary 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.
string Character [get]
 Gets the NPC character identifier as text.
object? CharacterRaw [get, set]
 Gets or sets the raw character value.
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.
bool HasDestination [get]
 Gets whether the NPC navigator has a destination.
bool HasDetour [get]
 Gets whether the NPC currently has a detour.
bool Hidden [get]
 Gets whether Arts And Crafters is hidden.
bool IgnorePlayerOnSpawn [get, set]
 Gets or sets whether the NPC ignores the player immediately after spawning.
bool Jealous [get]
 Gets whether Arts And Crafters is jealous.
object? Looker [get, set]
 Gets or sets the NPC looker component.
float MaxSightTime [get, set]
 Gets or sets the maximum time the player must look at Arts And Crafters.
float MaxSpeed [get, set]
 Gets or sets the NPC navigator's maximum speed.
float MinSightTime [get, set]
 Gets or sets the minimum time the player must look at Arts And Crafters.
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.
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.
bool Running [get]
 Gets whether Arts And Crafters is running.
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.
float TimeScale [get]
 Gets the NPC's current time scale.
Vector3 Velocity [get]
 Gets the NPC navigator's current velocity.
SpriteRenderer? VisibleRenderer [get, set]
 Gets or sets Arts And Crafters' visible sprite renderer.
bool Wandering [get]
 Gets whether the NPC is currently wandering.

Detailed Description

Wraps the BB+ Arts And Crafters NPC and exposes anger, hiding, attacking, teleporting, and audio helpers.

Constructor & Destructor Documentation

◆ BBPArtsAndCrafters()

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

Creates an Arts And Crafters wrapper around a raw instance.

Parameters
rawThe raw ArtsAndCrafters object or component.

Member Function Documentation

◆ Attack()

void BBPGlue.API.BBPArtsAndCrafters.Attack ( BBPPlayerRef player)

Starts Arts And Crafters' attack behavior against a player.

Parameters
playerThe target player.

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

◆ DisappearForever()

void BBPGlue.API.BBPArtsAndCrafters.DisappearForever ( )

Makes Arts And Crafters disappear permanently.

◆ DistanceCheck()

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

Calls the NPC distance check.

Parameters
valueThe 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
startThe start position.
targetThe target position.

◆ FindPath() [2/2]

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

Finds a path to the target position.

Parameters
targetThe target position.

◆ FindPathAvoid()

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

Finds a path to the target while avoiding a position.

Parameters
targetThe target position.
avoidThe position to avoid.

◆ Flip()

void BBPGlue.API.BBPNpc.Flip ( )
inherited

Flips the NPC entity.

◆ GetAngry()

void BBPGlue.API.BBPArtsAndCrafters.GetAngry ( BBPPlayerRef player)

Makes Arts And Crafters angry at the given player.

Parameters
playerThe target player.

◆ Hear() [1/2]

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

Makes the NPC hear a sound.

Parameters
sourceThe sound source GameObject.
positionThe sound position.
valueThe 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
positionThe sound position.
valueThe sound value used by the game.

◆ Hide()

void BBPGlue.API.BBPArtsAndCrafters.Hide ( bool hidden)

Hides or reveals Arts And Crafters.

Parameters
hiddenTrue to hide; false to show.

◆ 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
positionThe point to append.

◆ RunAway()

void BBPGlue.API.BBPArtsAndCrafters.RunAway ( )

Makes Arts And Crafters run away.

◆ 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
blindedTrue to blind the NPC; false to restore sight.

◆ SetFrozen()

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

Freezes or unfreezes the NPC entity.

Parameters
frozenTrue 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
hiddenTrue 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
valueTrue to avoid rooms; otherwise, false.

◆ SetSpeed()

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

Sets the NPC navigator speed.

Parameters
speedThe speed to set.

◆ SetSprite()

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

Sets the sprite used by all NPC sprite renderers.

Parameters
spriteThe sprite to use.

◆ SetSpriteBaseActive()

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

Shows or hides the NPC sprite root object.

Parameters
activeTrue 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
colorThe color to apply.

◆ SetVerticalScale()

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

Sets the NPC entity's vertical scale.

Parameters
scaleThe vertical scale value.

◆ SetVisible()

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

Sets whether the NPC entity is visible.

Parameters
visibleTrue 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.

◆ SpawnAt()

void BBPGlue.API.BBPArtsAndCrafters.SpawnAt ( object position)

Spawns Arts And Crafters at a raw IntVector2 grid position.

Parameters
positionRaw BB+ IntVector2 position.

◆ Squish()

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

Squishes the NPC entity for a duration.

Parameters
timeThe duration in seconds.

◆ TargetPosition()

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

Sends a target position to the NPC.

Parameters
targetThe target position.

◆ Teleport()

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

Teleports the NPC to a position.

Parameters
positionThe target position.

◆ TeleportGrid()

void BBPGlue.API.BBPArtsAndCrafters.TeleportGrid ( object position)

Teleports Arts And Crafters to a raw IntVector2 grid position.

Parameters
positionRaw BB+ IntVector2 position.

◆ TeleportPlayer()

void BBPGlue.API.BBPArtsAndCrafters.TeleportPlayer ( BBPPlayerRef player)

Triggers Arts And Crafters' player teleport behavior.

Parameters
playerThe player to teleport.

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

◆ UpdateEcho()

void BBPGlue.API.BBPArtsAndCrafters.UpdateEcho ( )

Updates Arts And Crafters' echo visuals.

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

◆ Angry

bool BBPGlue.API.BBPArtsAndCrafters.Angry
get

Gets whether Arts And Crafters is angry.

◆ AngrySprite

Sprite? BBPGlue.API.BBPArtsAndCrafters.AngrySprite
getset

Gets or sets Arts And Crafters' angry sprite.

◆ AngryTime

float BBPGlue.API.BBPArtsAndCrafters.AngryTime
get

Gets Arts And Crafters' anger time.

◆ AttackAudio

BBPAudioManager BBPGlue.API.BBPArtsAndCrafters.AttackAudio
get

Gets Arts And Crafters' attack audio manager.

◆ Attacking

bool BBPGlue.API.BBPArtsAndCrafters.Attacking
get

Gets whether Arts And Crafters is attacking.

◆ AttackSpinAccel

float BBPGlue.API.BBPArtsAndCrafters.AttackSpinAccel
get

Gets Arts And Crafters' attack spin acceleration.

◆ AttackSpinSpeed

float BBPGlue.API.BBPArtsAndCrafters.AttackSpinSpeed
get

Gets Arts And Crafters' attack spin speed.

◆ AttackTime

float BBPGlue.API.BBPArtsAndCrafters.AttackTime
get

Gets Arts And Crafters' attack duration.

◆ Audio

BBPAudioManager BBPGlue.API.BBPArtsAndCrafters.Audio
get

Gets Arts And Crafters' primary 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.

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

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

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

◆ Hidden

bool BBPGlue.API.BBPArtsAndCrafters.Hidden
get

Gets whether Arts And Crafters is hidden.

◆ IgnorePlayerOnSpawn

bool BBPGlue.API.BBPNpc.IgnorePlayerOnSpawn
getsetinherited

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

◆ Jealous

bool BBPGlue.API.BBPArtsAndCrafters.Jealous
get

Gets whether Arts And Crafters is jealous.

◆ Looker

object? BBPGlue.API.BBPNpc.Looker
getsetinherited

Gets or sets the NPC looker component.

◆ MaxSightTime

float BBPGlue.API.BBPArtsAndCrafters.MaxSightTime
getset

Gets or sets the maximum time the player must look at Arts And Crafters.

◆ MaxSpeed

float BBPGlue.API.BBPNpc.MaxSpeed
getsetinherited

Gets or sets the NPC navigator's maximum speed.

◆ MinSightTime

float BBPGlue.API.BBPArtsAndCrafters.MinSightTime
getset

Gets or sets the minimum time the player must look at Arts And Crafters.

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

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

◆ Running

bool BBPGlue.API.BBPArtsAndCrafters.Running
get

Gets whether Arts And Crafters is running.

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

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

◆ VisibleRenderer

SpriteRenderer? BBPGlue.API.BBPArtsAndCrafters.VisibleRenderer
getset

Gets or sets Arts And Crafters' visible sprite renderer.

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