Skip to content
On this page

Athena.systems.job.objective

Interfaces

Functions

buildCriteria

Usage

Athena.systems.job.objective.buildCriteria(criteria): number

Builds a numerical representation of the flags used to check job criteria.

Parameters

NameType
criteriaDefaultCriteriaOptions

Returns

number

Defined in

server/systems/job/objective.ts:98


createAndAdd

Usage

Athena.systems.job.objective.createAndAdd(job, objective): player

Cleanly creates an objective to add to a job.

Removes all deep refs.

Parameters

NameType
jobJob
objectiveObjective

Returns

player

Returns the objective instance; does not need to be added.

Defined in

server/systems/job/objective.ts:81


getType

Usage

Athena.systems.job.objective.getType(type): number

Returns the numerical representation of a default objective type.

Parameters

NameType
typestring | number | symbol

Returns

number

Defined in

server/systems/job/objective.ts:127


override

Usage

Athena.systems.job.objective.override(functionName, callback): any

Used to override job objective creation functionality

Parameters

NameType
functionName"createAndAdd"
callback(job: Job, objective: Objective) => player

Returns

any

Defined in

server/systems/job/objective.ts:143

Usage

Athena.systems.job.objective.override(functionName, callback): any

Used to override job objective creation functionality

Parameters

NameType
functionName"buildCriteria"
callback(criteria: DefaultCriteriaOptions) => number

Returns

any

Defined in

server/systems/job/objective.ts:144

Usage

Athena.systems.job.objective.override(functionName, callback): any

Used to override job objective creation functionality

Parameters

NameType
functionName"getType"
callback(type: string | number | symbol) => number

Returns

any

Defined in

server/systems/job/objective.ts:145

Created by Stuyk | Est. 2020