V5 DocsAthena.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 ​
| Name | Type |
|---|---|
criteria | DefaultCriteriaOptions |
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 ​
| Name | Type |
|---|---|
job | Job |
objective | Objective |
Returns ​
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 ​
| Name | Type |
|---|---|
type | string | 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 ​
| Name | Type |
|---|---|
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 ​
| Name | Type |
|---|---|
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 ​
| Name | Type |
|---|---|
functionName | "getType" |
callback | (type: string | number | symbol) => number |
Returns ​
any