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

Wraps the HUD announcement display, also known as BaldiTV. More...

Public Member Functions

void AnnounceEvent (object soundObject)
 Announces an event through BaldiTV.
void PlayAnimation (string stateName)
 Plays a BaldiTV animation state.
void ReInit ()
 Reinitializes BaldiTV.
void ResetVisuals ()
 Hides all BaldiTV visual elements controlled by this wrapper.
void SetActiveAnimation (bool active)
 Sets the BaldiTV Active animator parameter.
void SetBaldiSprite (Sprite sprite)
 Sets and shows the Baldi sprite.
void SetBaldiVisible (bool visible)
 Shows or hides the Baldi image.
void SetExclamationVisible (bool visible)
 Shows or hides the exclamation mark.
void SetStaticSprites (Sprite sprite1, Sprite sprite2)
 Sets the static animation sprites.
void SetStaticVisible (bool visible)
 Shows or hides the static overlay.
void SetTimeTextRaw (string text)
 Sets the time text directly.
void SetTimeTextVisible (bool visible)
 Shows or hides the time text.
void ShowLevelTimeWarning ()
 Shows the level time warning.
void Speak (object soundObject)
 Plays a BaldiTV speech sound.

Properties

Animator? Animator [get]
 Gets the BaldiTV animator.
object? AudioManager [get]
 Gets the BaldiTV audio manager.
Image? BaldiImage [get]
 Gets the Baldi image component.
bool Busy [get]
 Gets whether BaldiTV is currently busy.
GameObject? ExclamationObject [get]
 Gets the exclamation mark object.
bool Exists [get]
 Gets whether the BaldiTV object exists.
bool Moves [get, set]
 Gets or sets whether BaldiTV is allowed to move.
Image? StaticImage [get]
 Gets the static image component.
GameObject? StaticObject [get]
 Gets the static overlay object.
Sprite? StaticSprite1 [get, set]
 Gets or sets the first static sprite.
Sprite? StaticSprite2 [get, set]
 Gets or sets the second static sprite.
object? TimeLimitTickingSound [get, set]
 Gets or sets the time-limit ticking sound.
TMP_Text? TimeText [get]
 Gets the time text component.

Detailed Description

Wraps the HUD announcement display, also known as BaldiTV.

Member Function Documentation

◆ AnnounceEvent()

void BBPGlue.API.HUD.BBPHudAnnouncements.AnnounceEvent ( object soundObject)

Announces an event through BaldiTV.

Parameters
soundObjectThe event announcement sound.

◆ PlayAnimation()

void BBPGlue.API.HUD.BBPHudAnnouncements.PlayAnimation ( string stateName)

Plays a BaldiTV animation state.

Parameters
stateNameThe animation state name.

◆ ReInit()

void BBPGlue.API.HUD.BBPHudAnnouncements.ReInit ( )

Reinitializes BaldiTV.

◆ ResetVisuals()

void BBPGlue.API.HUD.BBPHudAnnouncements.ResetVisuals ( )

Hides all BaldiTV visual elements controlled by this wrapper.

◆ SetActiveAnimation()

void BBPGlue.API.HUD.BBPHudAnnouncements.SetActiveAnimation ( bool active)

Sets the BaldiTV Active animator parameter.

Parameters
activeThe value to assign.

◆ SetBaldiSprite()

void BBPGlue.API.HUD.BBPHudAnnouncements.SetBaldiSprite ( Sprite sprite)

Sets and shows the Baldi sprite.

Parameters
spriteThe sprite to display.

◆ SetBaldiVisible()

void BBPGlue.API.HUD.BBPHudAnnouncements.SetBaldiVisible ( bool visible)

Shows or hides the Baldi image.

Parameters
visibleTrue to show the image; false to hide it.

◆ SetExclamationVisible()

void BBPGlue.API.HUD.BBPHudAnnouncements.SetExclamationVisible ( bool visible)

Shows or hides the exclamation mark.

Parameters
visibleTrue to show the exclamation mark; false to hide it.

◆ SetStaticSprites()

void BBPGlue.API.HUD.BBPHudAnnouncements.SetStaticSprites ( Sprite sprite1,
Sprite sprite2 )

Sets the static animation sprites.

Parameters
sprite1The first static sprite.
sprite2The second static sprite.

◆ SetStaticVisible()

void BBPGlue.API.HUD.BBPHudAnnouncements.SetStaticVisible ( bool visible)

Shows or hides the static overlay.

Parameters
visibleTrue to show the static overlay; false to hide it.

◆ SetTimeTextRaw()

void BBPGlue.API.HUD.BBPHudAnnouncements.SetTimeTextRaw ( string text)

Sets the time text directly.

Parameters
textThe text to display.

◆ SetTimeTextVisible()

void BBPGlue.API.HUD.BBPHudAnnouncements.SetTimeTextVisible ( bool visible)

Shows or hides the time text.

Parameters
visibleTrue to show the time text; false to hide it.

◆ ShowLevelTimeWarning()

void BBPGlue.API.HUD.BBPHudAnnouncements.ShowLevelTimeWarning ( )

Shows the level time warning.

◆ Speak()

void BBPGlue.API.HUD.BBPHudAnnouncements.Speak ( object soundObject)

Plays a BaldiTV speech sound.

Parameters
soundObjectThe sound object to play.

Property Documentation

◆ Animator

Animator? BBPGlue.API.HUD.BBPHudAnnouncements.Animator
get

Gets the BaldiTV animator.

◆ AudioManager

object? BBPGlue.API.HUD.BBPHudAnnouncements.AudioManager
get

Gets the BaldiTV audio manager.

◆ BaldiImage

Image? BBPGlue.API.HUD.BBPHudAnnouncements.BaldiImage
get

Gets the Baldi image component.

◆ Busy

bool BBPGlue.API.HUD.BBPHudAnnouncements.Busy
get

Gets whether BaldiTV is currently busy.

◆ ExclamationObject

GameObject? BBPGlue.API.HUD.BBPHudAnnouncements.ExclamationObject
get

Gets the exclamation mark object.

◆ Exists

bool BBPGlue.API.HUD.BBPHudAnnouncements.Exists
get

Gets whether the BaldiTV object exists.

◆ Moves

bool BBPGlue.API.HUD.BBPHudAnnouncements.Moves
getset

Gets or sets whether BaldiTV is allowed to move.

◆ StaticImage

Image? BBPGlue.API.HUD.BBPHudAnnouncements.StaticImage
get

Gets the static image component.

◆ StaticObject

GameObject? BBPGlue.API.HUD.BBPHudAnnouncements.StaticObject
get

Gets the static overlay object.

◆ StaticSprite1

Sprite? BBPGlue.API.HUD.BBPHudAnnouncements.StaticSprite1
getset

Gets or sets the first static sprite.

◆ StaticSprite2

Sprite? BBPGlue.API.HUD.BBPHudAnnouncements.StaticSprite2
getset

Gets or sets the second static sprite.

◆ TimeLimitTickingSound

object? BBPGlue.API.HUD.BBPHudAnnouncements.TimeLimitTickingSound
getset

Gets or sets the time-limit ticking sound.

◆ TimeText

TMP_Text? BBPGlue.API.HUD.BBPHudAnnouncements.TimeText
get

Gets the time text component.

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