V5 DocsAthena.systems.job.instance ​
Functions ​
clear ​
Usage
Athena.systems.job.instance.clear(player): any
Clear the job instance.
Parameters ​
| Name | Type |
|---|---|
player | any |
Returns ​
any
Defined in ​
server/systems/job/instance.ts:52
get ​
Usage
Athena.systems.job.instance.get(player): Job | undefined
Get the current job instance for a player, or player id.
Parameters ​
| Name | Type |
|---|---|
player | any |
Returns ​
Job | undefined
Defined in ​
server/systems/job/instance.ts:13
override ​
Usage
Athena.systems.job.instance.override(functionName, callback): any
Used to override job instancing functionality
Parameters ​
| Name | Type |
|---|---|
functionName | "get" |
callback | (player: any) => Job | undefined |
Returns ​
any
Defined in ​
server/systems/job/instance.ts:84
Usage
Athena.systems.job.instance.override(functionName, callback): any
Used to override job instancing functionality
Parameters ​
| Name | Type |
|---|---|
functionName | "set" |
callback | (player: Player, newJob: Job) => any |
Returns ​
any
Defined in ​
server/systems/job/instance.ts:85
Usage
Athena.systems.job.instance.override(functionName, callback): any
Used to override job instancing functionality
Parameters ​
| Name | Type |
|---|---|
functionName | "clear" |
callback | (player: any) => any |
Returns ​
any
Defined in ​
server/systems/job/instance.ts:86
set ​
Usage
Athena.systems.job.instance.set(player, newJob): any
Set the current job instance for a player.
Parameters ​
| Name | Type | Description |
|---|---|---|
player | Player | An alt:V Player Entity |
newJob | Job |
Returns ​
any