The RpgLogs Scripting API
    Preparing search index...

    Interface ReportComponentContext

    interface ReportComponentContext {
        anonymizePlayerNames: boolean;
        apiVersion: string;
        eventFilters: EventFilters;
        fightFilters: FightFilters;
        getComponent: (context: ReportComponentContext) => Component;
        initializePinForFight: (fight: Fight) => void;
        pinMatchesFightEvent: (event: AnyEvent, fight: Fight) => boolean;
        reportGroup: ReportGroup;
        styles: Styles;
        translatedLanguage: null | string;
    }
    Index

    Properties

    anonymizePlayerNames apiVersion eventFilters fightFilters getComponent initializePinForFight pinMatchesFightEvent reportGroup styles translatedLanguage

    Properties

    anonymizePlayerNames: boolean

    Whether or not player names should be anonymized. You will not have access to the real names of the players if this is set.

    apiVersion: string

    The current API version. Used to see if a report component is out of date.

    eventFilters: EventFilters

    The filters in effect for the fight.

    fightFilters: FightFilters

    The filters in effect for the fight.

    getComponent: (context: ReportComponentContext) => Component

    Type declaration

    initializePinForFight: (fight: Fight) => void

    The initializePinForFight function lets you initialize fight-specific data before doing a new loop through a fight's events. You should discard any previous fight data.

    pinMatchesFightEvent: (event: AnyEvent, fight: Fight) => boolean

    The pinMatchesFightEvent function returns true for script pins that match the passed in event.

    reportGroup: ReportGroup

    The current report group.

    styles: Styles

    The styles object that can be used to obtain actor and ability colors for charts and tables.

    translatedLanguage: null | string

    The translated language. Null if no language is set. This is only set if the user is forcing all logs to be translated to a specific language.

    Settings

    Member Visibility

    On This Page

    Properties