BBPGlue.API.BBPEvents Class Reference

Helper for discovering, mapping, and triggering level random events. More...

Public Member Functions
bool	MapCurrentLevel ()
	Scans the current scene and environment to map available random events.
void	Refresh ()
	Refreshes internal state; currently a no-op placeholder.
bool	Trigger (BBPRandomEvent ev)
	Triggers a BBPRandomEvent instance.
bool	Trigger (int index)
	Triggers a mapped event by index.
bool	Trigger (string eventName)
	Triggers an event by matching a name or type.
bool	TriggerRaw (object rawEvent)
	Triggers a raw event object by wrapping it in a BBPRandomEvent.

Properties
int	Count [get]
	Number of mapped events.
IReadOnlyList< string >	EventNames [get]
	Human-readable names for the mapped events.
IReadOnlyList< BBPRandomEvent >	Events [get]
	Collection of mapped random events for the current level.
string	Status = "Not mapped." [get]
	Status message describing the last mapping/trigger operation.

Detailed Description

Helper for discovering, mapping, and triggering level random events.

Member Function Documentation

MapCurrentLevel()

bool BBPGlue.API.BBPEvents.MapCurrentLevel

(

)

Scans the current scene and environment to map available random events.

Returns

True if mapping succeeded and events were found; otherwise false.

Refresh()

void BBPGlue.API.BBPEvents.Refresh

(

)

Refreshes internal state; currently a no-op placeholder.

Trigger() [1/3]

bool BBPGlue.API.BBPEvents.Trigger

(

BBPRandomEvent

ev

)

Triggers a BBPRandomEvent instance.

Parameters

ev	The event wrapper to trigger.

Returns

True if triggered successfully; otherwise false.

Trigger() [2/3]

bool BBPGlue.API.BBPEvents.Trigger

(

int

index

)

Triggers a mapped event by index.

Parameters

index

Index into the mapped event list.

Returns

True if the event was triggered; otherwise false.

Trigger() [3/3]

bool BBPGlue.API.BBPEvents.Trigger

(

string

eventName

)

Triggers an event by matching a name or type.

Parameters

eventName

Name or type string to search for.

Returns

True if the event was found and triggered; otherwise false.

TriggerRaw()

bool BBPGlue.API.BBPEvents.TriggerRaw

(

object

rawEvent

)

Triggers a raw event object by wrapping it in a BBPRandomEvent.

Parameters

rawEvent

The raw event instance from the game.

Returns

True if the event was triggered; otherwise false.

Property Documentation

Count

int BBPGlue.API.BBPEvents.Count

get

Number of mapped events.

EventNames

IReadOnlyList<string> BBPGlue.API.BBPEvents.EventNames

get

Human-readable names for the mapped events.

Events

IReadOnlyList<BBPRandomEvent> BBPGlue.API.BBPEvents.Events

get

Collection of mapped random events for the current level.

Status

string BBPGlue.API.BBPEvents.Status = "Not mapped."

get

Status message describing the last mapping/trigger operation.

---

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

• BBPEvents.cs