The RpgLogs Scripting API
    Preparing search index...

    Interface BeginCastEvent

    interface BeginCastEvent {
        ability: null | Ability;
        duration: number;
        isFake: boolean;
        isMelee: boolean;
        source: null | ActorInstance;
        sourceDisposition: ActorDisposition;
        sourceInstanceId: number;
        sourceRaidMarker: number;
        sourceResources: null | ResourceData;
        target: null | ActorInstance;
        targetDisposition: ActorDisposition;
        targetInstanceId: number;
        targetRaidMarker: number;
        targetResources: null | ResourceData;
        timestamp: number;
        type: "begincast";
    }

    Hierarchy (View Summary)

    Index

    Properties

    ability duration isFake isMelee source sourceDisposition sourceInstanceId sourceRaidMarker sourceResources target targetDisposition targetInstanceId targetRaidMarker targetResources timestamp type

    Properties

    ability: null | Ability

    The ability used by the source on the target. Null if no ability is set.

    duration: number

    For games that support including the duration in the begin cast event, it will appear here. Currently, the only game that supports this field is FFXIV. It will be 0 for all other games.

    isFake: boolean

    Whether or not the cast is fake, i.e., not the result of a user action, but just made up by the game.

    isMelee: boolean

    Whether or not the cast is a melee swing/auto-attack.

    source: null | ActorInstance

    The source actor. Null if no source is set.

    sourceDisposition: ActorDisposition

    The raw disposition of the source. Use the isFriendlyParticipant and isEnemyParticipant methods to obtain the overall single disposition for this actor. This field should be used with caution as it could flip if the logger or the unit get mind controlled.

    sourceInstanceId: number

    The instance id of the source.

    sourceRaidMarker: number

    The raid marker on this source unit. 0 if no raid marker is set.

    sourceResources: null | ResourceData

    Resource data for the source. Null if no resource information is available.

    target: null | ActorInstance

    The target actor. Null if no target is set.

    targetDisposition: ActorDisposition

    The raw disposition of the target. Use the isFriendlyParticipant and isEnemyParticipant methods on Fight to obtain the overall single disposition for this actor. This field should be used with caution as it could flip if the logger or the unit get mind controlled.

    targetInstanceId: number

    The instance id of the target.

    targetRaidMarker: number

    The raid marker on this source unit. 0 if no raid marker is set.

    targetResources: null | ResourceData

    Resource data for the target. Null if no resource information is available.

    timestamp: number

    The time offset of the event in milliseconds from the start of the report.

    type: "begincast"

    The type of the event.

    Settings

    Member Visibility

    On This Page

    Properties