Athena.systems.job.system.Job ​

server/systems/job/system.Job

Create a Job Instance

A job can be specified as a series of tasks to complete with specific criteria.

The complexity of a job is limited to your programming knowledge.

ie. Go to this location, interact with this thing, ensure you have this item, etc.

Example ​

// Never recycle the same job instance
const someJob = new Job();

// Never recycle objectives between job instances
Athena.systems.job.objective.createAndAdd(someJob, {
    description: 'Go to a position.',
    pos: {
        x: 0,
        y: 0,
        z: 0 - 1, // Always subtract 1 from a player position
    },
    criteria: Athena.systems.job.objective.buildCriteria({
        NO_VEHICLE: true,
        NO_WEAPON: true,
    }),
    range: 3,
    type: Athena.systems.job.objective.getType('WAYPOINT'),
});

// Adding a player to this job instance starts it
someJob.addPlayer(somePlayer);

Constructors ​

constructor ​

• new Job()

Creates an instance of a job handler.

Used to build a Job for usage.

This instance should be called each time to create new job instances.

Defined in ​

server/systems/job/system.ts:68

Properties ​

completedCallback ​

• Private completedCallback: (job: Job) => Promise<void>

Type declaration ​

Parameters ​

Returns ​

Promise<void>

Defined in ​

server/systems/job/system.ts:56

id ​

• Private id: number

The ID of the player.

Defined in ​

server/systems/job/system.ts:51

objectives ​

• Private objectives: Objective[] = []

Defined in ​

server/systems/job/system.ts:53

player ​

• Private player: Player

Defined in ​

server/systems/job/system.ts:52

quitCallback ​

• Private quitCallback: (job: Job, reason: string) => void

Type declaration ​

Parameters ​

Returns ​

void

Defined in ​

server/systems/job/system.ts:57

startTime ​

• Private startTime: number

Defined in ​

server/systems/job/system.ts:55

vehicles ​

• Private vehicles: { uid: string ; vehicle: Vehicle }[] = []

Defined in ​

server/systems/job/system.ts:54

Methods ​

addNextObjective ​

Inserts an objective to the beginning of the objectives array.

Parameters ​

Returns ​

void

Defined in ​

server/systems/job/system.ts:333

addObjective ​

Add an objective to this job. Use the objective interface to generate the objective information.

Parameters ​

Returns ​

void

Defined in ​

server/systems/job/system.ts:92

addPlayer ​

Add the player to the job this job and start it.

Ensure that this Job is initialized with new Job first.

Parameters ​

Returns ​

void

Defined in ​

server/systems/job/system.ts:78

addVehicle ​

Create a unique vehicle for this job.

Objective eventually removes the job vehicle.

This unique job vehicle is temporarily assinged to the player.

Returns a vehicle with a 'uid'.

Parameters ​

Returns ​

Vehicle

Defined in ​

server/systems/job/system.ts:108

getCurrentObjective ​

Get the current objective the player is completing.

Returns ​

any

Defined in ​

server/systems/job/system.ts:313

getElapsedMilliseconds ​

Get the time since this job has started.

Returns ​

number

Defined in ​

server/systems/job/system.ts:323

getPlayer ​

Get the current player that is utilizing this job instance.

Returns ​

Player

Defined in ​

server/systems/job/system.ts:263

getVehicles ​

Return job instance vehicles

Memberof

Job

Returns ​

{ uid: string ; vehicle: Vehicle }[]

Defined in ​

server/systems/job/system.ts:174

goToNextObjective ​

Remove the first element of the objective list and move on to the next.

Returns ​

Promise<void>

Defined in ​

server/systems/job/system.ts:231

loadObjectives ​

Appends a list of objectives into the Job Framework.

Parameters ​

Returns ​

void

Defined in ​

server/systems/job/system.ts:183

quit ​

Call this to cleanup a job.

Parameters ​

Returns ​

void

Defined in ​

server/systems/job/system.ts:208

removeAllVehicles ​

Remove all vehicles from this job.

Returns ​

void

Defined in ​

server/systems/job/system.ts:138

removeAttachable ​

Remove the current job attachable.

Returns ​

void

Defined in ​

server/systems/job/system.ts:272

removeVehicle ​

Remove a vehicle by unique identifier assigned when adding a vehicle.

Parameters ​

Returns ​

void

Defined in ​

server/systems/job/system.ts:153

setCompletedCallback ​

Set the async callback that is called when a user completed a job.

Parameters ​

Returns ​

void

Defined in ​

server/systems/job/system.ts:345

setQuitCallback ​

Set the callback that is called when a user quits a job.

Parameters ​

Returns ​

void

Defined in ​

server/systems/job/system.ts:355

syncObjective ​

Emits data down to the player to start handling job information.

Returns ​

void

Defined in ​

server/systems/job/system.ts:286