Data shapeClient API

EventMap

Native events dispatched through Core.Events.on. Each property is the exact callback argument tuple for that event.

interface EventMap {
    chatMessage: [message: ChatMessageEvent];
    cityPartChanged: [change: CityPartChangeEvent];
    playerDamage: [damage: PlayerDamageEvent];
    radioPowerChange: [change: RadioPowerChangeEvent];
    radioStationChange: [change: RadioStationChangeEvent];
    resourceStart: [resourceName: string];
    resourceStop: [resourceName: string];
}

Properties

chatMessage: [message: ChatMessageEvent]

Dispatched when the client receives a framework chat-message RPC, before the built-in chat overlay is updated.

cityPartChanged: [change: CityPartChangeEvent]

Dispatched when the local player crosses into a different city district.

playerDamage: [damage: PlayerDamageEvent]

Dispatched immediately after the local player receives native damage.

radioPowerChange: [change: RadioPowerChangeEvent]

Dispatched after the local player's vehicle radio is turned on or off.

radioStationChange: [change: RadioStationChangeEvent]

Dispatched after the local player's vehicle radio changes station.

resourceStart: [resourceName: string]

Dispatched after a resource entry point has run and immediately before the resource becomes running.

resourceStop: [resourceName: string]

Dispatched while a resource is stopping, before its stop callback, timers, exports, and event handlers are cleaned up.