V5 DocsAthena.vehicle.asPlayer ​
Functions ​
override ​
Usage
Athena.vehicle.asPlayer.override(functionName, callback): any
Used to override vehicle control as a player functionality
Parameters ​
| Name | Type |
|---|---|
functionName | "toggleLock" |
callback | (player: Player, vehicle: Vehicle) => any |
Returns ​
any
Defined in ​
server/vehicle/asPlayer.ts:129
Usage
Athena.vehicle.asPlayer.override(functionName, callback): any
Used to override vehicle control as a player functionality
Parameters ​
| Name | Type |
|---|---|
functionName | "toggleDoor" |
callback | (player: Player, vehicle: Vehicle, door: 0 | 3 | 2 | 1 | 4 | 5) => any |
Returns ​
any
Defined in ​
server/vehicle/asPlayer.ts:130
Usage
Athena.vehicle.asPlayer.override(functionName, callback): any
Used to override vehicle control as a player functionality
Parameters ​
| Name | Type |
|---|---|
functionName | "toggleEngine" |
callback | (player: Player, vehicle: Vehicle) => any |
Returns ​
any
Defined in ​
server/vehicle/asPlayer.ts:131
toggleDoor ​
Usage
Athena.vehicle.asPlayer.toggleDoor(player, vehicle, door): any
Toggles a door lock as if a player toggled it.
Parameters ​
| Name | Type | Description |
|---|---|---|
player | Player | An alt:V Player Entity |
vehicle | Vehicle | An alt:V Vehicle Entity |
door | 0 | 3 | 2 | 1 | 4 | 5 |
Returns ​
any
Defined in ​
toggleEngine ​
Usage
Athena.vehicle.asPlayer.toggleEngine(player, vehicle): any
Toggles an engine lock as if a player toggled it.
Parameters ​
| Name | Type | Description |
|---|---|---|
player | Player | An alt:V Player Entity |
vehicle | Vehicle | An alt:V Vehicle Entity |
Returns ​
any
Defined in ​
toggleLock ​
Usage
Athena.vehicle.asPlayer.toggleLock(player, vehicle): any
Toggles a vehicle lock as if a player toggled it.
Parameters ​
| Name | Type | Description |
|---|---|---|
player | Player | An alt:V Player Entity |
vehicle | Vehicle | An alt:V Vehicle Entity |
Returns ​
any