IClientEvent | custom alt:V docs JS

Hierarchy

IClientEvent

Index

Properties

anyResourceError

anyResourceError: (resourceName: string) => void

Type declaration

- (resourceName: string): void
- Parameters
  - resourceName: string
  Returns void

anyResourceStart

anyResourceStart: (resourceName: string) => void

Type declaration

- (resourceName: string): void
- Parameters
  - resourceName: string
  Returns void

anyResourceStop

anyResourceStop: (resourceName: string) => void

Type declaration

- (resourceName: string): void
- Parameters
  - resourceName: string
  Returns void

baseObjectCreate

baseObjectCreate: (baseObject: BaseObject) => void

Type declaration

- (baseObject: BaseObject): void
- Parameters
  - baseObject: BaseObject
  Returns void

baseObjectRemove

baseObjectRemove: (baseObject: BaseObject) => void

Type declaration

- (baseObject: BaseObject): void
- Parameters
  - baseObject: BaseObject
  Returns void

changedVehicleSeat

changedVehicleSeat: (vehicle: Vehicle, oldSeat: number, seat: number) => void

remarks: The seat indexes start with 1 (driver seat).

Type declaration

- (vehicle: Vehicle, oldSeat: number, seat: number): void
- Parameters
  - vehicle: Vehicle
  - oldSeat: number
  - seat: number
  Returns void

connectionComplete

connectionComplete: () => void

Type declaration

- (): void
- Returns void

consoleCommand

consoleCommand: (name: string, ...args: string[]) => void

Type declaration

- (name: string, ...args: string[]): void
- Parameters
  - name: string
  - Rest ...args: string[]
  Returns void

disconnect

disconnect: () => void

Type declaration

- (): void
- Returns void

enteredVehicle

enteredVehicle: (vehicle: Vehicle, seat: number) => void

remarks: The seat indexes start with 1 (driver seat).

Type declaration

- (vehicle: Vehicle, seat: number): void
- Parameters
  - vehicle: Vehicle
  - seat: number
  Returns void

entityEnterColshape

entityEnterColshape: (colshape: Colshape, entity: Entity) => void

Type declaration

- (colshape: Colshape, entity: Entity): void
- Parameters
  - colshape: Colshape
  - entity: Entity
  Returns void

entityHitEntity

entityHitEntity: (damager: Entity, target: Entity, weaponHash: number) => void

Type declaration

- (damager: Entity, target: Entity, weaponHash: number): void
- Parameters
  - damager: Entity
  - target: Entity
  - weaponHash: number
  Returns void

entityLeaveColshape

entityLeaveColshape: (colshape: Colshape, entity: Entity) => void

Type declaration

- (colshape: Colshape, entity: Entity): void
- Parameters
  - colshape: Colshape
  - entity: Entity
  Returns void

gameEntityCreate

gameEntityCreate: (entity: Entity) => void

Type declaration

- (entity: Entity): void
- Parameters
  - entity: Entity
  Returns void

gameEntityDestroy

gameEntityDestroy: (entity: Entity) => void

Type declaration

- (entity: Entity): void
- Parameters
  - entity: Entity
  Returns void

globalMetaChange

globalMetaChange: (key: string, value: any, oldValue: any) => void

Type declaration

- (key: string, value: any, oldValue: any): void
- Parameters
  - key: string
  - value: any
  - oldValue: any
  Returns void

globalSyncedMetaChange

globalSyncedMetaChange: (key: string, value: any, oldValue: any) => void

Type declaration

- (key: string, value: any, oldValue: any): void
- Parameters
  - key: string
  - value: any
  - oldValue: any
  Returns void

keydown

keydown: (key: KeyCode) => void

Type declaration

- (key: KeyCode): void
- Parameters
  - key: KeyCode
  Returns void

keyup

keyup: (key: KeyCode) => void

Type declaration

- (key: KeyCode): void
- Parameters
  - key: KeyCode
  Returns void

leftVehicle

leftVehicle: (vehicle: Vehicle, seat: number) => void

remarks: The seat indexes start with 1 (driver seat).

Type declaration

- (vehicle: Vehicle, seat: number): void
- Parameters
  - vehicle: Vehicle
  - seat: number
  Returns void

localMetaChange

localMetaChange: (key: string, newValue: any, oldValue: any) => void

Type declaration

- (key: string, newValue: any, oldValue: any): void
- Parameters
  - key: string
  - newValue: any
  - oldValue: any
  Returns void

metaChange

metaChange: (target: BaseObject, key: string, value: any, oldValue: any) => void

Type declaration

- (target: BaseObject, key: string, value: any, oldValue: any): void
- Parameters
  - target: BaseObject
  - key: string
  - value: any
  - oldValue: any
  Returns void

netOwnerChange

netOwnerChange: (entity: Entity, owner: Player | null, oldOwner: Player | null) => void

remarks: Triggers only if the old or new owner is the local player.

Type declaration

- (entity: Entity, owner: Player | null, oldOwner: Player | null): void
- Parameters
  - entity: Entity
  - owner: Player | null
  - oldOwner: Player | null
  Returns void

playerAnimationChange

playerAnimationChange: (target: Player, oldAnimDict: number, newAnimDict: number, oldAnimName: number, newAnimName: number) => void

Type declaration

- (target: Player, oldAnimDict: number, newAnimDict: number, oldAnimName: number, newAnimName: number): void
- Parameters
  - target: Player
  - oldAnimDict: number
  - newAnimDict: number
  - oldAnimName: number
  - newAnimName: number
  Returns void

playerBulletHit

playerBulletHit: (weaponHash: number, victim: Entity, position: Vector3) => void

Type declaration

- (weaponHash: number, victim: Entity, position: Vector3): void
- Parameters
  - weaponHash: number
  - victim: Entity
  - position: Vector3
  Returns void

playerStartTalking

playerStartTalking: (target: Player) => void

Type declaration

- (target: Player): void
- Parameters
  - target: Player
  Returns void

playerStopTalking

playerStopTalking: (target: Player) => void

Type declaration

- (target: Player): void
- Parameters
  - target: Player
  Returns void

playerWeaponChange

playerWeaponChange: (oldWeapon: number, newWeapon: number) => void

Type declaration

- (oldWeapon: number, newWeapon: number): void
- Parameters
  - oldWeapon: number
  - newWeapon: number
  Returns void

playerWeaponShoot

playerWeaponShoot: (weaponHash: number, totalAmmo: number, ammoInClip: number) => void

Type declaration

- (weaponHash: number, totalAmmo: number, ammoInClip: number): void
- Parameters
  - weaponHash: number
  - totalAmmo: number
  - ammoInClip: number
  Returns void

removeEntity

removeEntity: (object: Entity) => void

Type declaration

- (object: Entity): void
- Parameters
  - object: Entity
  Returns void

resourceError

resourceError: (error: Error, file: string, line: number, stackTrace: string) => void

Type declaration

- (error: Error, file: string, line: number, stackTrace: string): void
- Parameters
  - error: Error
  - file: string
  - line: number
  - stackTrace: string
  Returns void

resourceStart

resourceStart: (errored: boolean) => void

Type declaration

- (errored: boolean): void
- Parameters
  - errored: boolean
  Returns void

resourceStop

resourceStop: () => void

Type declaration

- (): void
- Returns void

spawned

spawned: () => void

Type declaration

- (): void
- Returns void

startEnteringVehicle

startEnteringVehicle: (vehicle: Vehicle, seat: number, player: Player) => boolean | void

remarks: The seat indexes start with 1 (driver seat).

Type declaration

- (vehicle: Vehicle, seat: number, player: Player): boolean | void
- Parameters
  - vehicle: Vehicle
  - seat: number
  - player: Player
  Returns boolean | void

startLeavingVehicle

startLeavingVehicle: (vehicle: Vehicle, seat: number, player: Player) => boolean | void

remarks: The seat indexes start with 1 (driver seat).

Type declaration

- (vehicle: Vehicle, seat: number, player: Player): boolean | void
- Parameters
  - vehicle: Vehicle
  - seat: number
  - player: Player
  Returns boolean | void

streamSyncedMetaChange

streamSyncedMetaChange: (object: BaseObject, key: string, value: any, oldValue: any) => void

Type declaration

- (object: BaseObject, key: string, value: any, oldValue: any): void
- Parameters
  - object: BaseObject
  - key: string
  - value: any
  - oldValue: any
  Returns void

syncedMetaChange

syncedMetaChange: (entity: Entity, key: string, value: any, oldValue: any) => void

Type declaration

- (entity: Entity, key: string, value: any, oldValue: any): void
- Parameters
  - entity: Entity
  - key: string
  - value: any
  - oldValue: any
  Returns void

taskChange

taskChange: (oldTask: number, newTask: number) => boolean | void

remarks: See https://alloc8or.re/gta5/doc/enums/eTaskTypeIndex.txt for task ids.

Type declaration

- (oldTask: number, newTask: number): boolean | void
- Parameters
  - oldTask: number
  - newTask: number
  Returns boolean | void

voiceConnection

voiceConnection: (state: VoiceConnectionState) => void

Type declaration

- (state: VoiceConnectionState): void
- Parameters
  - state: VoiceConnectionState
  Returns void

weaponDamage

weaponDamage: (target: Entity, weaponHash: number, damage: number, offset: Vector3, bodyPart: BodyPart, sourceEntity: Entity) => number | boolean | void

Type declaration

- (target: Entity, weaponHash: number, damage: number, offset: Vector3, bodyPart: BodyPart, sourceEntity: Entity): number | boolean | void
- Parameters
  - target: Entity
  - weaponHash: number
  - damage: number
  - offset: Vector3
  - bodyPart: BodyPart
  - sourceEntity: Entity
  Returns number | boolean | void

windowFocusChange

windowFocusChange: (isFocused: boolean) => void

Type declaration

- (isFocused: boolean): void
- Parameters
  - isFocused: boolean
  Returns void

windowResolutionChange

windowResolutionChange: (oldResolution: Vector2, newResolution: Vector2) => void

Type declaration

- (oldResolution: Vector2, newResolution: Vector2): void
- Parameters
  - oldResolution: Vector2
  - newResolution: Vector2
  Returns void

worldObjectPositionChange

worldObjectPositionChange: (object: WorldObject, oldPosition: Vector3) => void

Triggers when an Virtual Entity position is changed

Type declaration

- (object: WorldObject, oldPosition: Vector3): void
- Parameters
  - object: WorldObject
  - oldPosition: Vector3
  Returns void

worldObjectStreamIn

worldObjectStreamIn: (object: WorldObject) => void

Type declaration

- (object: WorldObject): void
- Parameters
  - object: WorldObject
  Returns void

worldObjectStreamOut

worldObjectStreamOut: (object: WorldObject) => void

Type declaration

- (object: WorldObject): void
- Parameters
  - object: WorldObject
  Returns void

Hierarchy

Index

Properties

Properties

anyResourceError

Type declaration

Parameters

resourceName: string

Returns void

anyResourceStart

Type declaration

Parameters

resourceName: string

Returns void

anyResourceStop

Type declaration

Parameters

resourceName: string

Returns void

baseObjectCreate

Type declaration

Parameters

baseObject: BaseObject

Returns void

baseObjectRemove

Type declaration

Parameters

baseObject: BaseObject

Returns void

changedVehicleSeat

Type declaration

Parameters

vehicle: Vehicle

oldSeat: number

seat: number

Returns void

connectionComplete

Type declaration

Returns void

consoleCommand

Type declaration

Parameters

name: string

Rest ...args: string[]

Returns void

disconnect

Type declaration

Returns void

enteredVehicle

Type declaration

Parameters

vehicle: Vehicle

seat: number

Returns void

entityEnterColshape

Type declaration

Parameters

colshape: Colshape

entity: Entity

Returns void

entityHitEntity

Type declaration

Parameters

damager: Entity

target: Entity

weaponHash: number

Returns void

entityLeaveColshape

Type declaration

Parameters

colshape: Colshape

entity: Entity

Returns void

gameEntityCreate

Type declaration

Parameters

entity: Entity

Returns void

gameEntityDestroy

Type declaration