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

Wrapper for an item object providing access to metadata, sprites, and sounds. More...

Public Member Functions

 BBPItemObject (object? raw)
 Initializes a new instance of the BBPItemObject class wrapping a raw object.

Properties

bool AddToInventory [get, set]
 Gets or sets whether the item is added to the player's inventory when picked up.
string Description [get]
 Gets or sets the item's description.
string DescriptionKey [get, set]
 Gets or sets the localization key for the item's description.
bool Exists [get]
 Determines whether the underlying raw object exists.
object? Item [get, set]
 Gets or sets the raw item reference contained by this wrapper.
object? ItemType [get, set]
 Gets or sets the item type object associated with this item.
string ItemTypeName [get]
 Gets the name of the item type as a string, or "None" if not available.
Sprite? LargeSprite [get, set]
 Gets or sets the large sprite used to represent the item.
string Name [get]
 Gets or sets the item's name.
string NameKey [get, set]
 Gets or sets the localization key for the item's name.
bool OverrideDisabled [get, set]
 Gets or sets whether the item's override behavior is disabled.
BBPSoundObject PickupSoundOverride [get]
 Gets the sound object that overrides the default pickup sound, if any.
int Price [get, set]
 Gets or sets the purchase price of the item.
object? Raw [get]
 The raw underlying object wrapped by this API class, or null if none.
Sprite? SmallSprite [get, set]
 Gets or sets the small sprite used to represent the item.
string Type [get]
 Gets the name of the item type as a string, or "None" if not available.
int Value [get, set]
 Gets or sets the in-game value of the item.

Detailed Description

Wrapper for an item object providing access to metadata, sprites, and sounds.

Constructor & Destructor Documentation

◆ BBPItemObject()

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

Initializes a new instance of the BBPItemObject class wrapping a raw object.

Parameters
rawThe raw underlying object instance or null.

Property Documentation

◆ AddToInventory

bool BBPGlue.API.BBPItemObject.AddToInventory
getset

Gets or sets whether the item is added to the player's inventory when picked up.

Returns
True if added to inventory; otherwise false.

◆ Description

string BBPGlue.API.BBPItemObject.Description
get

Gets or sets the item's description.

Returns
The description as a string.

◆ DescriptionKey

string BBPGlue.API.BBPItemObject.DescriptionKey
getset

Gets or sets the localization key for the item's description.

Returns
The description key as a string.

◆ Exists

bool BBPGlue.API.BBPItemObject.Exists
get

Determines whether the underlying raw object exists.

◆ Item

object? BBPGlue.API.BBPItemObject.Item
getset

Gets or sets the raw item reference contained by this wrapper.

Returns
The raw item object or null.

◆ ItemType

object? BBPGlue.API.BBPItemObject.ItemType
getset

Gets or sets the item type object associated with this item.

Returns
The item type object or null.

◆ ItemTypeName

string BBPGlue.API.BBPItemObject.ItemTypeName
get

Gets the name of the item type as a string, or "None" if not available.

Returns
The item type name.

◆ LargeSprite

Sprite? BBPGlue.API.BBPItemObject.LargeSprite
getset

Gets or sets the large sprite used to represent the item.

Returns
The large Sprite or null.

◆ Name

string BBPGlue.API.BBPItemObject.Name
get

Gets or sets the item's name.

Returns
The name as a string.

◆ NameKey

string BBPGlue.API.BBPItemObject.NameKey
getset

Gets or sets the localization key for the item's name.

Returns
The name key as a string.

◆ OverrideDisabled

bool BBPGlue.API.BBPItemObject.OverrideDisabled
getset

Gets or sets whether the item's override behavior is disabled.

Returns
True if override is disabled; otherwise false.

◆ PickupSoundOverride

BBPSoundObject BBPGlue.API.BBPItemObject.PickupSoundOverride
get

Gets the sound object that overrides the default pickup sound, if any.

Returns
A BBPSoundObject instance.

◆ Price

int BBPGlue.API.BBPItemObject.Price
getset

Gets or sets the purchase price of the item.

Returns
The price as an integer.

◆ Raw

object? BBPGlue.API.BBPItemObject.Raw
get

The raw underlying object wrapped by this API class, or null if none.

◆ SmallSprite

Sprite? BBPGlue.API.BBPItemObject.SmallSprite
getset

Gets or sets the small sprite used to represent the item.

Returns
The small Sprite or null.

◆ Type

string BBPGlue.API.BBPItemObject.Type
get

Gets the name of the item type as a string, or "None" if not available.

Returns
The item type name.

◆ Value

int BBPGlue.API.BBPItemObject.Value
getset

Gets or sets the in-game value of the item.

Returns
The value as an integer.
The documentation for this class was generated from the following file: