|
Baldi's Basics Plus Glue API
Modding API for Baldi's Basics Plus
|
Wraps the BB+ Dr. More...
Public Member Functions | |
| BBPDrReflex (object? raw) | |
| Creates a Dr. | |
| bool | CalloutChance (bool happy) |
| Runs Dr. | |
| 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 | EndTest (bool success, BBPPlayerRef player) |
| Ends the current reflex test. | |
| void | FaceEntity (BBPEntity entity) |
| Faces Dr. | |
| bool | FacingNextPoint () |
| Gets whether Dr. | |
| bool | FacingPlayer (BBPPlayerRef player) |
| Gets whether Dr. | |
| 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 | GetHammer () |
| Triggers Dr. | |
| void | Hammer (BBPEntity entity) |
| Makes Dr. | |
| void | HammerCheck (BBPPlayerRef player) |
| Runs Dr. | |
| void | HammerSound () |
| Plays Dr. | |
| void | HeadToOffice () |
| Sends Dr. | |
| 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 | HotspotClicked (object side) |
| Handles a clicked reflex hotspot. | |
| void | IncreasePitch () |
| Increases Dr. | |
| 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 | PauseAndTurn () |
| Pauses and turns Dr. | |
| void | PauseAndTurn (BBPPlayerRef player) |
| Pauses and turns Dr. | |
| bool | PlayerLeft (BBPPlayerRef player) |
| Returns true if the player left the reflex test range. | |
| void | Reset () |
| Resets Dr. | |
| void | ResetAnimationTriggers () |
| Resets Dr. | |
| void | ResetTest () |
| Resets the current reflex test. | |
| 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 | 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. | |
Properties | |
| float | Acceleration [get, set] |
| Gets or sets the NPC navigator's acceleration. | |
| Animator? | Animator [get] |
| Gets Dr. | |
| BBPAudioManager | Audio [get] |
| Gets Dr. | |
| 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. | |
| float | ChargeSpeed [get, set] |
| Gets or sets Dr. | |
| float | Cooldown [get, set] |
| Gets or sets Dr. | |
| 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. | |
| float | HuntSpeed [get, set] |
| Gets or sets Dr. | |
| bool | IgnorePlayerOnSpawn [get, set] |
| Gets or sets whether the NPC ignores the player immediately after spawning. | |
| bool | IsInOffice [get] |
| Gets whether Dr. | |
| Vector3 | LastSightedPlayerLocation [get] |
| Gets Dr. | |
| object? | Looker [get, set] |
| Gets or sets the NPC looker component. | |
| float | MaxSpeed [get, set] |
| Gets or sets the NPC navigator's maximum speed. | |
| float | MaxTestDistance [get, set] |
| Gets or sets Dr. | |
| 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 Dr. | |
| 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. | |
| float | RoomWanderCycle [get] |
| Gets Dr. | |
| Quaternion | Rotation [get, set] |
| Gets or sets the NPC rotation in world space. | |
| 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 | SquishTime [get, set] |
| Gets or sets the squish duration applied by Dr. | |
| float | TimeScale [get] |
| Gets the NPC's current time scale. | |
| bool | Turning [get] |
| Gets whether Dr. | |
| float | TurnSpeed [get, set] |
| Gets or sets Dr. | |
| Vector3 | Velocity [get] |
| Gets the NPC navigator's current velocity. | |
| bool | Wandering [get] |
| Gets whether the NPC is currently wandering. | |
| float | WanderSpeed [get, set] |
| Gets or sets Dr. | |
Wraps the BB+ Dr.
Reflex NPC and exposes reflex test, hammer, animation, audio, and movement helpers.
| BBPGlue.API.BBPDrReflex.BBPDrReflex | ( | object? | raw | ) |
Creates a Dr.
Reflex wrapper around a raw DrReflex instance.
| raw | The raw DrReflex object or component. |
| bool BBPGlue.API.BBPDrReflex.CalloutChance | ( | bool | happy | ) |
Runs Dr.
Reflex's callout chance.
| happy | True for happy callouts; false for angry callouts. |
|
inherited |
Clears the NPC's current destination.
|
inherited |
Clears the NPC's guilt state.
|
inherited |
Despawns the NPC.
|
inherited |
Notifies the NPC that its destination is empty.
|
inherited |
Calls the NPC distance check.
| value | The value to pass to the game method. |
| void BBPGlue.API.BBPDrReflex.EndTest | ( | bool | success, |
| BBPPlayerRef | player ) |
Ends the current reflex test.
| success | True if the player succeeded. |
| player | The tested player. |
| void BBPGlue.API.BBPDrReflex.FaceEntity | ( | BBPEntity | entity | ) |
Faces Dr.
Reflex toward an entity.
| entity | The entity to face. |
| bool BBPGlue.API.BBPDrReflex.FacingNextPoint | ( | ) |
Gets whether Dr.
Reflex is facing his next navigation point.
| bool BBPGlue.API.BBPDrReflex.FacingPlayer | ( | BBPPlayerRef | player | ) |
Gets whether Dr.
Reflex is facing the given player.
| player | The player to check. |
|
inherited |
Finds a path from a custom start position to a target position.
| start | The start position. |
| target | The target position. |
|
inherited |
Finds a path to the target position.
| target | The target position. |
|
inherited |
Finds a path to the target while avoiding a position.
| target | The target position. |
| avoid | The position to avoid. |
|
inherited |
Flips the NPC entity.
| void BBPGlue.API.BBPDrReflex.GetHammer | ( | ) |
Triggers Dr.
Reflex's hammer acquired animation.
| void BBPGlue.API.BBPDrReflex.Hammer | ( | BBPEntity | entity | ) |
Makes Dr.
Reflex hammer an entity.
| entity | The entity to hammer. |
| void BBPGlue.API.BBPDrReflex.HammerCheck | ( | BBPPlayerRef | player | ) |
Runs Dr.
Reflex's hammer collision check against a player.
| player | The target player. |
| void BBPGlue.API.BBPDrReflex.HammerSound | ( | ) |
Plays Dr.
Reflex's hammer sound.
| void BBPGlue.API.BBPDrReflex.HeadToOffice | ( | ) |
Sends Dr.
Reflex back to his office.
|
inherited |
Makes the NPC hear a sound.
| source | The sound source GameObject. |
| position | The sound position. |
| value | The sound value used by the game. |
|
inherited |
Makes the NPC hear a sound without a source GameObject.
| position | The sound position. |
| value | The sound value used by the game. |
| void BBPGlue.API.BBPDrReflex.HotspotClicked | ( | object | side | ) |
Handles a clicked reflex hotspot.
| side | Raw BB+ Direction enum value. |
| void BBPGlue.API.BBPDrReflex.IncreasePitch | ( | ) |
Increases Dr.
Reflex's audio pitch during thinking.
|
inherited |
Initializes the NPC.
|
inherited |
Clears all forces applied to the NPC entity.
|
inherited |
Notifies the NPC that it made a navigation decision.
|
inherited |
Appends a destination point to the NPC navigator.
| position | The point to append. |
| void BBPGlue.API.BBPDrReflex.PauseAndTurn | ( | ) |
Pauses and turns Dr.
Reflex toward his navigation target.
| void BBPGlue.API.BBPDrReflex.PauseAndTurn | ( | BBPPlayerRef | player | ) |
Pauses and turns Dr.
Reflex toward a player.
| player | The player to face. |
| bool BBPGlue.API.BBPDrReflex.PlayerLeft | ( | BBPPlayerRef | player | ) |
Returns true if the player left the reflex test range.
| player | The tested player. |
| void BBPGlue.API.BBPDrReflex.Reset | ( | ) |
Resets Dr.
Reflex to his base wandering/test state.
| void BBPGlue.API.BBPDrReflex.ResetAnimationTriggers | ( | ) |
Resets Dr.
Reflex's animator triggers.
| void BBPGlue.API.BBPDrReflex.ResetTest | ( | ) |
Resets the current reflex test.
|
inherited |
Calls the NPC detention handler.
|
inherited |
Sets whether the NPC entity is blinded.
| blinded | True to blind the NPC; false to restore sight. |
|
inherited |
Freezes or unfreezes the NPC entity.
| frozen | True to freeze the NPC; false to unfreeze it. |
|
inherited |
Sets whether the NPC entity is hidden.
| hidden | True to hide the NPC; false to show it. |
|
inherited |
Enables or disables room avoidance for NPC pathfinding.
| value | True to avoid rooms; otherwise, false. |
|
inherited |
Sets the NPC navigator speed.
| speed | The speed to set. |
|
inherited |
Sets the sprite used by all NPC sprite renderers.
| sprite | The sprite to use. |
|
inherited |
Shows or hides the NPC sprite root object.
| active | True to show the sprite root; false to hide it. |
|
inherited |
Sets the color used by all NPC sprite renderers.
| color | The color to apply. |
|
inherited |
Sets the NPC entity's vertical scale.
| scale | The vertical scale value. |
|
inherited |
Sets whether the NPC entity is visible.
| visible | True to make the NPC visible; false to hide it. |
|
inherited |
Calls the NPC sighted handler.
|
inherited |
Skips the NPC navigator's current destination point.
|
inherited |
Squishes the NPC entity for a duration.
| time | The duration in seconds. |
|
inherited |
Sends a target position to the NPC.
| target | The target position. |
|
inherited |
Teleports the NPC to a position.
| position | The target position. |
|
inherited |
Teleports the NPC to the player position.
|
inherited |
Calls the NPC unsighted handler.
|
inherited |
Removes the NPC entity's squished state.
|
inherited |
Makes the NPC wander to a random destination.
|
inherited |
Makes the NPC use its round-wandering behavior.
|
getsetinherited |
Gets or sets the NPC navigator's acceleration.
|
get |
Gets Dr.
Reflex's animator.
|
get |
Gets Dr.
Reflex's audio manager.
|
getsetinherited |
Gets or sets the NPC base trigger colliders.
|
getinherited |
Gets the NPC behavior state machine.
|
getinherited |
Gets whether the NPC is blinded.
|
getinherited |
Gets the rule currently associated with this NPC.
|
getinherited |
Gets the NPC's calculated speed from the game object.
|
getinherited |
Gets the NPC character identifier as text.
|
getsetinherited |
Gets or sets the raw character value.
|
getset |
Gets or sets Dr.
Reflex's charge speed.
|
getset |
Gets or sets Dr.
Reflex's cooldown.
|
getinherited |
Gets the NPC navigator's current destination.
|
getinherited |
Gets whether the NPC is currently disobeying.
|
getinherited |
Gets the entity component associated with this NPC.
|
getsetinherited |
Gets or sets the environment controller associated with this NPC.
|
getinherited |
Gets whether the wrapped NPC instance exists.
|
getinherited |
Gets whether the NPC navigator has a destination.
|
getinherited |
Gets whether the NPC currently has a detour.
|
getset |
Gets or sets Dr.
Reflex's hunt speed.
|
getsetinherited |
Gets or sets whether the NPC ignores the player immediately after spawning.
|
get |
Gets whether Dr.
Reflex is currently in his office.
|
get |
Gets Dr.
Reflex's last sighted player location.
|
getsetinherited |
Gets or sets the NPC looker component.
|
getsetinherited |
Gets or sets the NPC navigator's maximum speed.
|
getset |
Gets or sets Dr.
Reflex's maximum test distance.
|
getsetinherited |
Gets or sets the NPC GameObject name.
|
getinherited |
Gets the NPC navigation state machine.
|
getinherited |
Gets the NPC navigator.
|
getinherited |
Gets the next point in the NPC navigator's path.
|
getset |
Gets or sets Dr.
Reflex's noise value.
|
getsetinherited |
Gets or sets the NPC position in world space.
|
getsetinherited |
Gets or sets the NPC poster object.
|
getsetinherited |
Gets or sets the NPC potential room assets.
|
getsetinherited |
Gets or sets the NPC navigator radius.
|
getinherited |
Gets the raw underlying NPC instance.
|
get |
Gets Dr.
Reflex's room wander cycle duration.
|
getsetinherited |
Gets or sets the NPC rotation in world space.
|
getinherited |
Gets the rooms this NPC can spawn in.
|
getsetinherited |
Gets or sets the root GameObject for the NPC sprites.
|
getsetinherited |
Gets or sets the NPC sprite renderers.
|
getset |
Gets or sets the squish duration applied by Dr.
Reflex's hammer.
|
getinherited |
Gets the NPC's current time scale.
|
get |
Gets whether Dr.
Reflex is currently turning.
|
getset |
Gets or sets Dr.
Reflex's turn speed.
|
getinherited |
Gets the NPC navigator's current velocity.
|
getinherited |
Gets whether the NPC is currently wandering.
|
getset |
Gets or sets Dr.
Reflex's wander speed.