Skip to content
On this page

AthenaShared.interfaces.jobTrigger.JobTrigger

shared/interfaces/jobTrigger.JobTrigger

A unique interface to show the player. Has custom header, summary, and image support.

Interface

JobTrigger

Type parameters

NameType
T{}

Properties

acceptCallback

Optional acceptCallback: (player: T, amount?: number) => void

Type declaration

Usage

AthenaShared.interfaces.jobTrigger.JobTrigger.(player, amount?): void

A callback if the trigger is accepted.

Parameters
NameType
playerT
amount?number
Returns

void

Defined in

shared/interfaces/jobTrigger.ts:57


cancelCallback

Optional cancelCallback: (player: T) => void

Type declaration

Usage

AthenaShared.interfaces.jobTrigger.JobTrigger.(player): void

A callback if the trigger is declined.

Parameters
NameType
playerT
Returns

void

Defined in

shared/interfaces/jobTrigger.ts:64


cancelEvent

Optional cancelEvent: string

Event to trigger when the player declines this job. Completely optional.

Defined in

shared/interfaces/jobTrigger.ts:50


event

Optional event: string

Event to trigger when it is accepted. Recieve this event with 'alt.on'

Defined in

shared/interfaces/jobTrigger.ts:42


header: string

The header text of the job trigger.

Defined in

shared/interfaces/jobTrigger.ts:20


image

image: string

An external https:// based image to show for your job.

Defined in

shared/interfaces/jobTrigger.ts:13


maxAmount

Optional maxAmount: number

Maximum amount for quantity input.

Defined in

shared/interfaces/jobTrigger.ts:34


summary

summary: string

A summary describing what will be done during a job.

Defined in

shared/interfaces/jobTrigger.ts:27

Created by Stuyk | Est. 2020