Interaction Event Handling

• Interaction Event Types
  • Interaction Outcome Event
    • S4CLInteractionOutcomeEvent
      • S4CLInteractionOutcomeEvent.interaction
      • S4CLInteractionOutcomeEvent.is_failure()
      • S4CLInteractionOutcomeEvent.is_success()
      • S4CLInteractionOutcomeEvent.outcome
      • S4CLInteractionOutcomeEvent.outcome_result
  • Interaction Queued Event
    • S4CLInteractionQueuedEvent
      • S4CLInteractionQueuedEvent.interaction
      • S4CLInteractionQueuedEvent.interaction_queue
      • S4CLInteractionQueuedEvent.queuing_sim
      • S4CLInteractionQueuedEvent.queuing_sim_info
  • Interaction Post Queued Event
    • S4CLInteractionPostQueuedEvent
      • S4CLInteractionPostQueuedEvent.interaction
      • S4CLInteractionPostQueuedEvent.interaction_queue
      • S4CLInteractionPostQueuedEvent.queue_result
  • Interaction Started Event
    • S4CLInteractionStartedEvent
      • S4CLInteractionStartedEvent.interaction
      • S4CLInteractionStartedEvent.sim_info
      • S4CLInteractionStartedEvent.target
  • Interaction Pre Run Event
    • S4CLInteractionPreRunEvent
      • S4CLInteractionPreRunEvent.interaction
      • S4CLInteractionPreRunEvent.interaction_queue
      • S4CLInteractionPreRunEvent.timeline
  • Interaction Run Event
    • S4CLInteractionRunEvent
      • S4CLInteractionRunEvent.interaction
      • S4CLInteractionRunEvent.interaction_queue
      • S4CLInteractionRunEvent.run_result
  • Interaction Cancelled Event
    • S4CLInteractionCancelledEvent
      • S4CLInteractionCancelledEvent.cancel_reason
      • S4CLInteractionCancelledEvent.finishing_type
      • S4CLInteractionCancelledEvent.ignore_must_run
      • S4CLInteractionCancelledEvent.interaction
      • S4CLInteractionCancelledEvent.keyword_arguments
  • Super Interaction Cancelled Event
    • S4CLSuperInteractionCancelledEvent
      • S4CLSuperInteractionCancelledEvent.cancel_reason
      • S4CLSuperInteractionCancelledEvent.finishing_type
      • S4CLSuperInteractionCancelledEvent.interaction
      • S4CLSuperInteractionCancelledEvent.keyword_arguments
  • Mixer Interaction Cancelled Event
    • S4CLMixerInteractionCancelledEvent
      • S4CLMixerInteractionCancelledEvent.cancel_reason
      • S4CLMixerInteractionCancelledEvent.finishing_type
      • S4CLMixerInteractionCancelledEvent.interaction
      • S4CLMixerInteractionCancelledEvent.keyword_arguments

Interaction Event Dispatcher

class CommonInteractionEventDispatcherService

Bases: CommonService, HasLog

A service that dispatches interaction events (Run, Queued, Performed, etc.).

Warning

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

property mod_identity

The identity of the mod that owns this property

Warning

Override this property with the CommonModIdentity of your mod.

This is a MUST override to allow for proper Exception Handling and Logging!

Returns:

An instance of CommonModIdentity

Return type:

CommonModIdentity

Raises:

NotImplementedError – Thrown when the property is not implemented.