Sim Events

Sim Spawned Event

class BBOnSimSpawnedEvent(mod_identity, sim_info)

Bases: BBEvent

An event that occurs when a Sim spawns

Usage:: @BBEventHandlerRegistry.register(ModIdentity(), BBOnSimSpawnedEvent) def _bbl_handle_on_sim_spawned(event: BBOnSimSpawnedEvent):

Example usage:

from bluuberrylibrary.events.event_handling.bb_event_handler_registry import BBEventHandlerRegistry
from bluuberrylibrary.classes.bb_test_result import BBTestResult

@BBEventHandlerRegistry.register(ModIdentity(), BBOnSimSpawnedEvent)
def _bbl_handle_on_sim_spawned(event: BBOnSimSpawnedEvent) -> BBRunResult:
    return BBRunResult.TRUE

Parameters:

mod_identity (BBModIdentity) – The identity of the mod that owns this event.
sim_info (SimInfo) – The info of a Sim.

property sim_info: The Sim that spawned.

Sim Despawned Event

class BBOnSimDespawnedEvent(mod_identity, sim_info)

Bases: BBEvent

An event that occurs when a Sim is despawned

Usage:: @BBEventHandlerRegistry.register(ModIdentity(), BBOnSimDespawnedEvent) def _bbl_handle_on_sim_despawned(event: BBOnSimDespawnedEvent):

Example usage:

from bluuberrylibrary.events.event_handling.bb_event_handler_registry import BBEventHandlerRegistry
from bluuberrylibrary.classes.bb_test_result import BBTestResult

@BBEventHandlerRegistry.register(ModIdentity(), BBOnSimDespawnedEvent)
def _bbl_handle_on_sim_despawned(event: BBOnSimDespawnedEvent) -> BBRunResult:
    return BBRunResult.TRUE

Parameters:

mod_identity (BBModIdentity) – The identity of the mod that owns this event.
sim_info (SimInfo) – The info of a Sim.

property sim_info: The Sim that despawned.

Sim Died Event

class BBOnSimDiedEvent(mod_identity, sim_info)

Bases: BBEvent

An event that occurs when a Sim dies

Usage:: @BBEventHandlerRegistry.register(ModIdentity(), BBOnSimDiedEvent) def _bbl_handle_on_sim_died(event: BBOnSimDiedEvent):

Example usage:

from bluuberrylibrary.events.event_handling.bb_event_handler_registry import BBEventHandlerRegistry
from bluuberrylibrary.classes.bb_test_result import BBTestResult

@BBEventHandlerRegistry.register(ModIdentity(), BBOnSimDiedEvent)
def _bbl_handle_on_sim_died(event: BBOnSimDiedEvent) -> BBRunResult:
    return BBRunResult.TRUE

Parameters:

mod_identity (BBModIdentity) – The identity of the mod that owns this event.
sim_info (SimInfo) – The info of a Sim.

property sim_info: The Sim that died.

Sim Resurrected Event

class BBOnSimResurrectedEvent(mod_identity, sim_info)

Bases: BBEvent

An event that occurs when a Sim is resurrected.

Usage:: @BBEventHandlerRegistry.register(ModIdentity(), BBOnSimResurrectedEvent) def _bbl_handle_on_sim_resurrected(event: BBOnSimResurrectedEvent):

Example usage:

from bluuberrylibrary.events.event_handling.bb_event_handler_registry import BBEventHandlerRegistry
from bluuberrylibrary.classes.bb_test_result import BBTestResult

@BBEventHandlerRegistry.register(ModIdentity(), BBOnSimResurrectedEvent)
def _bbl_handle_on_sim_resurrected(event: BBOnSimResurrectedEvent) -> BBRunResult:
    return BBRunResult.TRUE

Parameters:

mod_identity (BBModIdentity) – The identity of the mod that owns this event.
sim_info (SimInfo) – The info of a Sim.

property sim_info: The Sim that was resurrected.