Accessor for HUD elements and controls. More...

Public Member Functions
void	ActivateBaldicator (bool coming)
	Activates or deactivates the baldicator UI element.
void	CloseTooltip ()
	Closes any active tooltip.
void	Darken (bool darken)
	Darkens or undarkens the HUD.
void	ForceUpdateColor ()
	Forces a color update on HUD elements.
void	Hide (bool hidden)
	Hides or shows the HUD.
void	PlayHudAnimation (string stateName)
	Plays a HUD animator state.
void	PlayNotebookAnimation (string stateName)
	Plays a notebook animator state.
void	ReInit ()
	Reinitializes HUD internals.
void	SetAllDarkenableSpritesColor (Color color)
	Applies a color to all sprites that can be darkened.
void	SetItemBackgroundColor (int slot, Color color)
	Sets the background color for an item slot.
void	SetItemSelect (int slot, string key)
	Selects an item slot visually with the provided key.
void	SetItemSpriteRaw (int slot, Sprite sprite)
	Sets an item slot image directly.
void	SetItemTitleRaw (string text)
	Sets the raw item title text on the HUD.
void	SetNotebookDisplay (bool visible)
	Shows or hides the notebook display.
void	SetReticleImage (Sprite sprite)
	Replaces the reticle image with the provided sprite.
void	SetReticleSprites (Sprite offSprite, Sprite onSprite)
	Sets the reticle sprites for off and on states.
void	SetStamina (float value)
	Sets the displayed stamina value.
void	SetTextBoxRaw (int index, string text)
	Sets the text of a HUD text box by index.
void	SetTooltip (string key)
	Sets a tooltip key to display localized text.
void	ShowCollectedSticker (Sprite stickerSprite)
	Shows a collected sticker animation using the provided sprite.
void	StopStickerAnimation ()
	Stops any running sticker animation.
void	UpdateInventorySize (int size)
	Updates the inventory UI size.
void	UpdateItemIcon (int slot, Sprite sprite)
	Updates the icon for an inventory slot.
void	UpdateNotebookText (int index, string text, bool spin=false)
	Updates notebook text at the given index.
void	UpdateReticle (bool active)
	Enables or disables the reticle.

Properties
Animator?	Animator `[get]`
	Animator controlling general HUD animations.
BBPHudAnnouncements	Announcements = new BBPHudAnnouncements() `[get]`
	Announcement-related HUD helpers.
object?	BaldiTv `[get]`
	Object representing Baldi TV functionality.
Canvas?	Canvas `[get]`
	Root Canvas for HUD rendering.
CanvasScaler?	CanvasScaler `[get]`
	Canvas scaler used for HUD layout.
Color	DarkColor `[get, set]`
	Color used for darkening UI elements.
bool	Exists `[get]`
	Whether the HUD is present in the current scene.
object?	GaugeManager `[get]`
	Gauge manager for stamina/other gauges.
bool	Hidden `[get]`
	Whether the HUD is currently hidden.
object?	Inventory `[get]`
	The inventory UI controller object.
RawImage?[]	ItemBackgrounds `[get]`
	Array of background images for item slots.
Image?[]	ItemSprites `[get]`
	Array of item slot sprite images.
TMP_Text?	ItemTitle `[get]`
	Text field showing the currently selected item's title.
float	NeedleSpeed `[get, set]`
	Speed at which the stamina needle animates.
Animator?	NotebookAnimator `[get]`
	Animator used specifically for notebook UI animations.
GameObject?[]	NotebookDisplay `[get]`
	GameObjects used to display notebook pages.
object?	PointsAnimator `[get]`
	Animator or controller used for points display animations.
object?	Raw `[get]`
	The underlying HUD raw object from the game.
Image?	Reticle `[get]`
	Reticle image used for aiming/interaction.
Sprite?	ReticleOffSprite `[get, set]`
	Sprite used when the reticle is off.
Sprite?	ReticleOnSprite `[get, set]`
	Sprite used when the reticle is on.
Image?[]	SpritesToDarken `[get]`
	Sprites that are darkened when appropriate.
RectTransform?	StaminaNeedle `[get]`
	RectTransform for the stamina needle UI element.
TMP_Text?[]	TextBoxes `[get]`
	Text boxes used by the HUD for various messages.

Detailed Description

Accessor for HUD elements and controls.

Member Function Documentation

◆ ActivateBaldicator()

void BBPGlue.API.BBPHud.ActivateBaldicator ( bool coming )

Activates or deactivates the baldicator UI element.

Parameters

coming True when the baldicator is appearing; false when hiding.

◆ CloseTooltip()

void BBPGlue.API.BBPHud.CloseTooltip ( )

Closes any active tooltip.

◆ Darken()

void BBPGlue.API.BBPHud.Darken ( bool darken )

Darkens or undarkens the HUD.

Parameters

darken True to darken; false to restore.

◆ ForceUpdateColor()

void BBPGlue.API.BBPHud.ForceUpdateColor ( )

Forces a color update on HUD elements.

◆ Hide()

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

Hides or shows the HUD.

Parameters

hidden True to hide; false to show.

◆ PlayHudAnimation()

void BBPGlue.API.BBPHud.PlayHudAnimation ( string stateName )

Plays a HUD animator state.

Parameters

stateName Animator state name.

◆ PlayNotebookAnimation()

void BBPGlue.API.BBPHud.PlayNotebookAnimation ( string stateName )

Plays a notebook animator state.

Parameters

stateName Animator state name.

◆ ReInit()

void BBPGlue.API.BBPHud.ReInit ( )

Reinitializes HUD internals.

◆ SetAllDarkenableSpritesColor()

void BBPGlue.API.BBPHud.SetAllDarkenableSpritesColor ( Color color )

Applies a color to all sprites that can be darkened.

Parameters

color Color to set.

◆ SetItemBackgroundColor()

void BBPGlue.API.BBPHud.SetItemBackgroundColor	(	int	slot,
		Color	color )

Sets the background color for an item slot.

Parameters

slot	Slot index.
color	Color to apply.

◆ SetItemSelect()

void BBPGlue.API.BBPHud.SetItemSelect	(	int	slot,
		string	key )

Selects an item slot visually with the provided key.

Parameters

slot	Slot index.
key	Localization key for the selection.

◆ SetItemSpriteRaw()

void BBPGlue.API.BBPHud.SetItemSpriteRaw	(	int	slot,
		Sprite	sprite )

Sets an item slot image directly.

Parameters

slot	Slot index.
sprite	Sprite to assign.

◆ SetItemTitleRaw()

void BBPGlue.API.BBPHud.SetItemTitleRaw ( string text )

Sets the raw item title text on the HUD.

Parameters

text	Text to set.

◆ SetNotebookDisplay()

void BBPGlue.API.BBPHud.SetNotebookDisplay ( bool visible )

Shows or hides the notebook display.

Parameters

visible True to show; false to hide.

◆ SetReticleImage()

void BBPGlue.API.BBPHud.SetReticleImage ( Sprite sprite )

Replaces the reticle image with the provided sprite.

Parameters

sprite Sprite to set as the reticle.

◆ SetReticleSprites()

void BBPGlue.API.BBPHud.SetReticleSprites	(	Sprite	offSprite,
		Sprite	onSprite )

Sets the reticle sprites for off and on states.

Parameters

offSprite	Sprite used when reticle is off.
onSprite	Sprite used when reticle is on.

◆ SetStamina()

void BBPGlue.API.BBPHud.SetStamina ( float value )

Sets the displayed stamina value.

Parameters

value Stamina value to display.

◆ SetTextBoxRaw()

void BBPGlue.API.BBPHud.SetTextBoxRaw	(	int	index,
		string	text )

Sets the text of a HUD text box by index.

Parameters

index	Index of the text box.
text	Text to set.

◆ SetTooltip()

void BBPGlue.API.BBPHud.SetTooltip ( string key )

Sets a tooltip key to display localized text.

Parameters

key	Tooltip localization key.

◆ ShowCollectedSticker()

void BBPGlue.API.BBPHud.ShowCollectedSticker ( Sprite stickerSprite )

Shows a collected sticker animation using the provided sprite.

Parameters

stickerSprite Sprite to display as a sticker.

◆ StopStickerAnimation()

void BBPGlue.API.BBPHud.StopStickerAnimation ( )

Stops any running sticker animation.

◆ UpdateInventorySize()

void BBPGlue.API.BBPHud.UpdateInventorySize ( int size )

Updates the inventory UI size.

Parameters

size	New inventory size.

◆ UpdateItemIcon()

void BBPGlue.API.BBPHud.UpdateItemIcon	(	int	slot,
		Sprite	sprite )

Updates the icon for an inventory slot.

Parameters

slot	Slot index.
sprite	Icon sprite to set.

◆ UpdateNotebookText()

void BBPGlue.API.BBPHud.UpdateNotebookText	(	int	index,
		string	text,
		bool	spin = false )

Updates notebook text at the given index.

Parameters

index	Notebook line index.
text	Text to set.
spin	Whether to apply a spinning animation.

◆ UpdateReticle()

void BBPGlue.API.BBPHud.UpdateReticle ( bool active )

Enables or disables the reticle.

Parameters

active True to enable; false to disable.

Property Documentation

◆ Animator

Animator? BBPGlue.API.BBPHud.Animator

get

Animator controlling general HUD animations.

◆ Announcements

BBPHudAnnouncements BBPGlue.API.BBPHud.Announcements = new BBPHudAnnouncements()

get

Announcement-related HUD helpers.

◆ BaldiTv

object? BBPGlue.API.BBPHud.BaldiTv

get

Object representing Baldi TV functionality.

◆ Canvas

Canvas? BBPGlue.API.BBPHud.Canvas

get

Root Canvas for HUD rendering.

◆ CanvasScaler

CanvasScaler? BBPGlue.API.BBPHud.CanvasScaler

get

Canvas scaler used for HUD layout.

◆ DarkColor

Color BBPGlue.API.BBPHud.DarkColor

getset

Color used for darkening UI elements.

◆ Exists

bool BBPGlue.API.BBPHud.Exists

get

Whether the HUD is present in the current scene.

◆ GaugeManager

object? BBPGlue.API.BBPHud.GaugeManager

get

Gauge manager for stamina/other gauges.

◆ Hidden

bool BBPGlue.API.BBPHud.Hidden

get

Whether the HUD is currently hidden.

◆ Inventory

object? BBPGlue.API.BBPHud.Inventory

get

The inventory UI controller object.

◆ ItemBackgrounds

RawImage? [] BBPGlue.API.BBPHud.ItemBackgrounds

get

Array of background images for item slots.

◆ ItemSprites

Image? [] BBPGlue.API.BBPHud.ItemSprites

get

Array of item slot sprite images.

◆ ItemTitle

TMP_Text? BBPGlue.API.BBPHud.ItemTitle

get

Text field showing the currently selected item's title.

◆ NeedleSpeed

float BBPGlue.API.BBPHud.NeedleSpeed

getset

Speed at which the stamina needle animates.

◆ NotebookAnimator

Animator? BBPGlue.API.BBPHud.NotebookAnimator

get

Animator used specifically for notebook UI animations.

◆ NotebookDisplay

GameObject? [] BBPGlue.API.BBPHud.NotebookDisplay

get

GameObjects used to display notebook pages.

◆ PointsAnimator

object? BBPGlue.API.BBPHud.PointsAnimator

get

Animator or controller used for points display animations.

◆ Raw

object? BBPGlue.API.BBPHud.Raw

get

The underlying HUD raw object from the game.

◆ Reticle

Image? BBPGlue.API.BBPHud.Reticle

get

Reticle image used for aiming/interaction.

◆ ReticleOffSprite

Sprite? BBPGlue.API.BBPHud.ReticleOffSprite

getset

Sprite used when the reticle is off.

◆ ReticleOnSprite

Sprite? BBPGlue.API.BBPHud.ReticleOnSprite

getset

Sprite used when the reticle is on.

◆ SpritesToDarken

Image? [] BBPGlue.API.BBPHud.SpritesToDarken

get

Sprites that are darkened when appropriate.

◆ StaminaNeedle

RectTransform? BBPGlue.API.BBPHud.StaminaNeedle

get

RectTransform for the stamina needle UI element.

◆ TextBoxes

TMP_Text? [] BBPGlue.API.BBPHud.TextBoxes

get

Text boxes used by the HUD for various messages.

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

BBPHud.cs

Public Member Functions

Properties

Detailed Description

Member Function Documentation

◆ ActivateBaldicator()

◆ CloseTooltip()

◆ Darken()

◆ ForceUpdateColor()

◆ Hide()

◆ PlayHudAnimation()

◆ PlayNotebookAnimation()

◆ ReInit()

◆ SetAllDarkenableSpritesColor()

◆ SetItemBackgroundColor()

◆ SetItemSelect()

◆ SetItemSpriteRaw()

◆ SetItemTitleRaw()

◆ SetNotebookDisplay()

◆ SetReticleImage()

◆ SetReticleSprites()

◆ SetStamina()

◆ SetTextBoxRaw()

◆ SetTooltip()

◆ ShowCollectedSticker()

◆ StopStickerAnimation()

◆ UpdateInventorySize()

◆ UpdateItemIcon()

◆ UpdateNotebookText()

◆ UpdateReticle()

Property Documentation

◆ Animator

◆ Announcements

◆ BaldiTv

◆ Canvas

◆ CanvasScaler

◆ DarkColor

◆ Exists

◆ GaugeManager

◆ Hidden

◆ Inventory

◆ ItemBackgrounds

◆ ItemSprites

◆ ItemTitle

◆ NeedleSpeed

◆ NotebookAnimator

◆ NotebookDisplay

◆ PointsAnimator

◆ Raw

◆ Reticle

◆ ReticleOffSprite

◆ ReticleOnSprite

◆ SpritesToDarken

◆ StaminaNeedle

◆ TextBoxes