Skip to content
On this page

AthenaShared.interfaces.job.Objective

shared/interfaces/job.Objective

Used to pass objective information from server to client.

Interface

Objective

Properties

animation

Optional animation: JobAnimation

An animation to associate with this objective.

Defined in

shared/interfaces/job.ts:143


attachable

Optional attachable: JobAttachable

An object to associate with this objective.

Defined in

shared/interfaces/job.ts:150


blip

Optional blip: Blip

A local blip to associate with this objective.

Defined in

shared/interfaces/job.ts:136


callbackOnCheck

Optional callbackOnCheck: (player: any) => Promise<boolean>

Type declaration

Usage

AthenaShared.interfaces.job.Objective.(player): Promise<boolean>

Parameters
NameType
playerany
Returns

Promise<boolean>

Defined in

shared/interfaces/job.ts:195


callbackOnFinish

Optional callbackOnFinish: (player: any) => void

Type declaration

Usage

AthenaShared.interfaces.job.Objective.(player): void

Server-side callback when objective is completed.

Parameters
NameType
playerany
Returns

void

Defined in

shared/interfaces/job.ts:201


callbackOnStart

Optional callbackOnStart: (player: any) => void

Type declaration

Usage

AthenaShared.interfaces.job.Objective.(player): void

Server-side callback when objective is started.

Parameters
NameType
playerany
Returns

void

Defined in

shared/interfaces/job.ts:189


captureMaximum

Optional captureMaximum: number

An optional internal tracker for how much progress needs to be done to complete it.

Defined in

shared/interfaces/job.ts:108


captureProgress

Optional captureProgress: number

An optional internal tracker for how far this objective is along.

Defined in

shared/interfaces/job.ts:101


criteria

criteria: ObjectiveCriteria

The criteria necessary to complete this Objective.

Defined in

shared/interfaces/job.ts:65


data

Optional data: Object

Data to put on this objective. Do not add callbacks.

Index signature

▪ [key: string]: any

Defined in

shared/interfaces/job.ts:183


description

description: string

A description of what to do to complete this objective.

Defined in

shared/interfaces/job.ts:94


eventCall

Optional eventCall: EventCall

An event that can be triggered when the objective is started, completed, etc. Useful for adding custom functionality to an objective.

Defined in

shared/interfaces/job.ts:158


marker

Optional marker: Marker

A local marker to associate with this objective.

Defined in

shared/interfaces/job.ts:122


nextCaptureTime

Optional nextCaptureTime: number

The time between captures. This should be left alone.

Defined in

shared/interfaces/job.ts:115


onlyCallbackCheck

Optional onlyCallbackCheck: boolean

Turns off all other objective checks, and only does the callbackOnCheck callback provided.

Defined in

shared/interfaces/job.ts:174


particle

Optional particle: Particle

Particles to show in the area of the objective. Useful to add some 'flavor' to your objective.

Defined in

shared/interfaces/job.ts:166


pos

pos: IVector3

The 3D Position of this objective.

Defined in

shared/interfaces/job.ts:79


range

range: number

The range which this objective can be completed in. Usually set to around 2.

Defined in

shared/interfaces/job.ts:87


textLabel

Optional textLabel: TextLabel

A local text label to associate with this objective.

Defined in

shared/interfaces/job.ts:129


type

type: ObjectiveType

An objective type that is unique to this objective.

Defined in

shared/interfaces/job.ts:72


uid

Optional uid: string

A unique identifier that can be assigned to an objective to help identify it easily.

Defined in

shared/interfaces/job.ts:58

Created by Stuyk | Est. 2020