Zone Event Handling

• Zone Spin Event Types
  • Zone Early Load Event
    • S4CLZoneEarlyLoadEvent
      • S4CLZoneEarlyLoadEvent.game_loaded
      • S4CLZoneEarlyLoadEvent.game_loading
      • S4CLZoneEarlyLoadEvent.zone
  • Zone Late Load Event
    • S4CLZoneLateLoadEvent
      • S4CLZoneLateLoadEvent.active_sim_id
      • S4CLZoneLateLoadEvent.game_loaded
      • S4CLZoneLateLoadEvent.game_loading
      • S4CLZoneLateLoadEvent.household_id
      • S4CLZoneLateLoadEvent.zone
  • Zone Save Event
    • S4CLZoneSaveEvent
      • S4CLZoneSaveEvent.game_loaded
      • S4CLZoneSaveEvent.game_loading
      • S4CLZoneSaveEvent.save_slot_data
      • S4CLZoneSaveEvent.zone
  • Zone Teardown Event
    • S4CLZoneTeardownEvent
      • S4CLZoneTeardownEvent.client
      • S4CLZoneTeardownEvent.game_loaded
      • S4CLZoneTeardownEvent.game_loading
      • S4CLZoneTeardownEvent.zone

Zone Spin Event Dispatcher

class CommonZoneSpinEventDispatcher

Bases: CommonService

A service that dispatches zone spin events (Teardown, Save, Early/Late Load).

Warning

Do not use this service directly to listen for events! Use the CommonEventRegistry to listen for dispatched events.

property game_loaded

Determine if the game has loaded.

Returns:

True, if the game has loaded. False, if the game has not loaded.

Return type:

bool

property game_loading

Determine if the game is loading.

Returns:

True, if the game is currently loading. False, if the game is not currently loading.

Return type:

bool