Interface IHookJobData

interface IHookJobData {
    domainId: string;
    eventData: BaseEvent<any>;
    functionId: string;
    gameServerId: string;
    itemId: string;
    module: ModuleInstallationOutputDTO;
    player?: PlayerOutputWithRolesDTO;
    pog?: PlayerOnGameserverOutputWithRolesDTO;
    [key: string]: unknown;
}

Hierarchy (View Summary)

IJobData
- IHookJobData

Indexable

[key: string]: unknown

Index

Properties

domainId eventData functionId gameServerId itemId module player? pog?

Properties

domainId

domainId: string

eventData

eventData: BaseEvent<any>

functionId

functionId: string

gameServerId

gameServerId: string

The id of the gameserver that triggered this job

itemId

itemId: string

The id of the item that triggered this job (cronjobId, commandId or hookId)

module

module: ModuleInstallationOutputDTO

The module installation object, including the configs

`Optional`player

player?: PlayerOutputWithRolesDTO

`Optional`pog

pog?: PlayerOnGameserverOutputWithRolesDTO