V5 DocsAthena.player.safe ​
Functions ​
addArmour ​
Usage
Athena.player.safe.addArmour(player, value, exactValue?, doNotInvokeEventCall?): void
Safely add armour to this player.
Parameters ​
| Name | Type | Default value | Description |
|---|---|---|---|
player | Player | undefined | - |
value | number | undefined | 1-100 |
exactValue | boolean | false | |
doNotInvokeEventCall | boolean | false | - |
Returns ​
void
Defined in ​
addHealth ​
Usage
Athena.player.safe.addHealth(player, value, exactValue?, doNotInvokeEventCall?): any
Safely add health to this player.
Parameters ​
| Name | Type | Default value | Description |
|---|---|---|---|
player | Player | undefined | An alt:V Player Entity |
value | number | undefined | 99-199 |
exactValue | boolean | false | |
doNotInvokeEventCall | boolean | false | - |
Returns ​
any
Defined in ​
override ​
Usage
Athena.player.safe.override(functionName, callback): any
Used to override any internal safe setter functions
Parameters ​
| Name | Type |
|---|---|
functionName | "setPosition" |
callback | (player: Player, x: number, y: number, z: number, doNotInvokeEventCall: boolean) => void |
Returns ​
any
Defined in ​
Usage
Athena.player.safe.override(functionName, callback): any
Used to override any internal safe setter functions
Parameters ​
| Name | Type |
|---|---|
functionName | "addHealth" |
callback | (player: Player, value: number, exactValue: boolean, doNotInvokeEventCall: boolean) => any |
Returns ​
any
Defined in ​
Usage
Athena.player.safe.override(functionName, callback): any
Used to override any internal safe setter functions
Parameters ​
| Name | Type |
|---|---|
functionName | "subHealth" |
callback | (player: Player, value: number, exactValue: boolean, doNotInvokeEventCall: boolean) => any |
Returns ​
any
Defined in ​
Usage
Athena.player.safe.override(functionName, callback): any
Used to override any internal safe setter functions
Parameters ​
| Name | Type |
|---|---|
functionName | "addArmour" |
callback | (player: Player, value: number, exactValue: boolean, doNotInvokeEventCall: boolean) => void |
Returns ​
any
Defined in ​
Usage
Athena.player.safe.override(functionName, callback): any
Used to override any internal safe setter functions
Parameters ​
| Name | Type |
|---|---|
functionName | "subArmour" |
callback | (player: Player, value: number, exactValue: boolean, doNotInvokeEventCall: boolean) => void |
Returns ​
any
Defined in ​
Usage
Athena.player.safe.override(functionName, callback): any
Used to override any internal safe setter functions
Parameters ​
| Name | Type |
|---|---|
functionName | "setDimension" |
callback | (player: Player, value: number) => any |
Returns ​
any
Defined in ​
setDimension ​
Usage
Athena.player.safe.setDimension(player, value): any
Set the player's dimension safely.
Parameters ​
| Name | Type | Description |
|---|---|---|
player | Player | An alt:V Player Entity |
value | number |
Returns ​
any
Defined in ​
setPosition ​
Usage
Athena.player.safe.setPosition(player, x, y, z, doNotInvokeEventCall?): void
Safely set a player's position.
Parameters ​
| Name | Type | Default value |
|---|---|---|
player | Player | undefined |
x | number | undefined |
y | number | undefined |
z | number | undefined |
doNotInvokeEventCall | boolean | false |
Returns ​
void
Defined in ​
subArmour ​
Usage
Athena.player.safe.subArmour(player, value, exactValue?, doNotInvokeEventCall?): void
Safely subtracts armour to this player.
Parameters ​
| Name | Type | Default value | Description |
|---|---|---|---|
player | Player | undefined | - |
value | number | undefined | 1-100 |
exactValue | boolean | false | |
doNotInvokeEventCall | boolean | false | - |
Returns ​
void
Defined in ​
subHealth ​
Usage
Athena.player.safe.subHealth(player, value, exactValue?, doNotInvokeEventCall?): any
Safely subtract health to this player.
Parameters ​
| Name | Type | Default value | Description |
|---|---|---|---|
player | Player | undefined | An alt:V Player Entity |
value | number | undefined | 99-199 |
exactValue | boolean | false | |
doNotInvokeEventCall | boolean | false | - |
Returns ​
any