Artemis Artemis
Artemis Artemis

Search Results for

    Interface IDataModelEvent

    Represents an event that is part of a data model

    Namespace: Artemis.Core
    Assembly: Artemis.Core.dll
    Syntax
    public interface IDataModelEvent

    Properties

    ArgumentsType

    Gets the type of arguments this event contains

    Declaration
    Type ArgumentsType { get; }
    Property Value
    Type Description
    Type

    EventArgumentsHistoryUntyped

    Gets a list of the last 20 event arguments by their base type.

    Always empty if TrackHistory is false

    Declaration
    List<DataModelEventArgs> EventArgumentsHistoryUntyped { get; }
    Property Value
    Type Description
    List<DataModelEventArgs>

    LastEventArgumentsUntyped

    Gets the event arguments of the last time the event was triggered by its base type

    Declaration
    DataModelEventArgs? LastEventArgumentsUntyped { get; }
    Property Value
    Type Description
    DataModelEventArgs

    LastTrigger

    Gets the last time the event was triggered

    Declaration
    DateTime LastTrigger { get; }
    Property Value
    Type Description
    DateTime

    TimeSinceLastTrigger

    Gets the time that has passed since the last trigger

    Declaration
    TimeSpan TimeSinceLastTrigger { get; }
    Property Value
    Type Description
    TimeSpan

    TrackHistory

    Gets or sets a boolean indicating whether the last 20 events should be tracked

    Note: setting this to false will clear the current history

    Declaration
    bool TrackHistory { get; set; }
    Property Value
    Type Description
    bool

    TriggerCount

    Gets the amount of times the event was triggered

    Declaration
    int TriggerCount { get; }
    Property Value
    Type Description
    int

    TriggerPastParticiple

    Gets the past participle for this event shown in the UI

    Declaration
    string TriggerPastParticiple { get; }
    Property Value
    Type Description
    string

    Methods

    Reset()

    Resets the trigger count and history of this data model event

    Declaration
    void Reset()

    Update()

    Updates the event, not required for standard events but included in case your custom event needs to update every tick

    Declaration
    void Update()

    Events

    EventTriggered

    Fires when the event is triggered

    Declaration
    event EventHandler EventTriggered
    Event Type
    Type Description
    EventHandler
    Content is available under the PolyForm Noncommercial License, by Artemis RGB.