Athena.player.emit ​

Functions ​

acceptDeclineEvent ​

Prompt the user to accept / decline something.

They must react by holding up arrow to open the menu.

Example ​

function doSomething(player: alt.Player) {
    Athena.player.emit.acceptDeclineEvent(somePlayer, {
        question: 'Would you like to teleport to the beach?',
        onClientEvents: {
            accept: 'from-client-event-doSomething',
            decline: 'from-client-event-doNothing',
        },
    });
}

alt.onClient('from-client-event-doSomething', (player: alt.Player) => {
    //
});
alt.onClient('from-client-event-doNothing', (player: alt.Player) => {
    //
});

Parameters ​

Returns ​

any

Defined in ​

server/player/emit.ts:724

animation ​

Play an animation on this player.

Parameters ​

Returns ​

void

Defined in ​

server/player/emit.ts:85

clearAnimation ​

Used to clear an animation or a task. Does not trigger if the player is in a vehicle.

Parameters ​

Returns ​

any

Defined in ​

server/player/emit.ts:111

clearCredits ​

Clears a 'credits' display.

Example ​

const uidFromAttachment = Athena.player.emit.clearCredits(somePlayer);

Parameters ​

Returns ​

any

Defined in ​

server/player/emit.ts:522

clearErrorScreen ​

Clear a full-screen message.

Example ​

Athena.player.emit.clearErrorScreen(somePlayer)

Parameters ​

Returns ​

any

Defined in ​

server/player/emit.ts:446

clearShard ​

Clear a shard.

Example ​

Athena.player.emit.clearShard(somePlayer);

Parameters ​

Returns ​

any

Defined in ​

server/player/emit.ts:483

clearSpinner ​

Clear a spinner in the bottom-right corner.

No UID necessary since it can only have one spinner at a time.

Example ​

Athena.player.emit.clearSpinner(somePlayer);

Parameters ​

Returns ​

any

Defined in ​

server/player/emit.ts:409

clearTimeCycleEffect ​

Used to clear a screen effect from a player.

Example ​

Athena.player.emit.clearTimeCycleEffect(somePlayer);

Parameters ​

Returns ​

void

Defined in ​

server/player/emit.ts:794

createCredits ​

Create a 'credits' text aligned to a certain side of the screen.

Automatically clear(s) over-time.

Example ​

Athena.player.emit.createCredits(somePlayer, { name: 'Big Text', role: 'Small Text', duration: 2000 });

Parameters ​

Returns ​

any

Defined in ​

server/player/emit.ts:504

createErrorScreen ​

Create a full-screen message. Cannot be cleared by the player.

Example ​

Athena.player.emit.createErrorScreen(somePlayer, { title: 'Oh No!', text: 'Something Happened', text2: 'Maybe a suggestion', duration: 5000})

Parameters ​

Returns ​

any

Defined in ​

server/player/emit.ts:428

createMissionText ​

Create a subtitle on the bottom of the screen with optional duration.

Parameters ​

Returns ​

any

Defined in ​

server/player/emit.ts:215

createProgressBar ​

Create a progress bar that eventually ends itself.

Example ​

const someUid = Athena.player.emit.createProgressBar(somePlayer, {
     color: new alt.RGBA(255, 0, 0, 200),
     distance: 10,
     milliseconds: 30000,
     position: new alt.Vector3(somePlayer.pos.x, somePlayer.pos.y, somePlayer.pos.z)
});

Parameters ​

Returns ​

string

A unique identifier to remove the progress bar.

Defined in ​

server/player/emit.ts:240

createShard ​

Create a full-screen shard. Similar to 'mission-passed' or 'wasted'.

Example ​

Athena.player.emit.createShard(somePlayer, { title: 'Big Text', text: 'Small Text', duration: 5000 })

Parameters ​

Returns ​

any

Defined in ​

server/player/emit.ts:465

createSpinner ​

Create a spinner in the bottom-right corner.

Example ​

Athena.player.emit.createSpinner(somePlayer, { text: 'Doing Something With Spinners', duration: 5000, type: 4 })

Parameters ​

Returns ​

any

Defined in ​

server/player/emit.ts:389

fadeScreenFromBlack ​

Removes the black filter over the screen over time.

Example ​

Athena.player.emit.fadeScreenFromBlack(somePlayer, 5000);

Parameters ​

Returns ​

void

Defined in ​

server/player/emit.ts:759

fadeScreenToBlack ​

Turns the player's screen black over time.

Example ​

Athena.player.emit.fadeScreenToBlack(somePlayer, 5000);

Parameters ​

Returns ​

void

Defined in ​

server/player/emit.ts:744

message ​

Emit a message to a given player.

Example ​

Athena.player.emit.message(somePlayer, '{FF0000} Hello there! This text is Red :)');

Parameters ​

Returns ​

any

Defined in ​

server/player/emit.ts:687

meta ​

Synchronize a local variable to access locally for this player.

Parameters ​

Returns ​

void

Defined in ​

server/player/emit.ts:157

notification ​

Send a notification to this player.

Example ​

Athena.player.emit.notification(somePlayer, '~y~Hello There~');

Parameters ​

Returns ​

void

Defined in ​

server/player/emit.ts:177

objectAttach ​

Attach an object to a player.

Automatically synchronized and handled client-side.

Last parameter is when to remove the object. Automatically set to infinite.

Example ​

const uidFromAttachment = Athena.player.emit.objectAttach(somePlayer, {
     model: 'prop_box_ammo01a',
     bone: 127,
     pos: { x: 0, y: 0, z: 0},
     rot: { x: 0, y: 0, z: 0 }
});

Parameters ​

Returns ​

string | null

UID for attachable object

Defined in ​

server/player/emit.ts:552

objectRemove ​

Remove an attachment object from the player.

Example ​

const uidFromAttachment = Athena.player.emit.objectAttach(somePlayer, {
     model: 'prop_box_ammo01a',
     bone: 127,
     pos: { x: 0, y: 0, z: 0},
     rot: { x: 0, y: 0, z: 0 }
});

Athena.player.emit.objectRemove(somePlayer, uidFromAttachment);

Parameters ​

Returns ​

any

Defined in ​

server/player/emit.ts:612

particle ​

Play a particle effect at a specific coordinate.

Parameters ​

Returns ​

void

Defined in ​

server/player/emit.ts:192

removeProgressBar ​

Remove a progress bar based on its unique identifier.

Example ​

const someUid = Athena.player.emit.createProgressBar(somePlayer, {
     color: new alt.RGBA(255, 0, 0, 200),
     distance: 10,
     milliseconds: 30000,
     position: new alt.Vector3(somePlayer.pos.x, somePlayer.pos.y, somePlayer.pos.z)
});

Athena.player.emit.removeProgressBar(somePlayer, someUid);

Parameters ​

Returns ​

any

Defined in ​

server/player/emit.ts:271

scenario ​

Play an animation on this player.

Parameters ​

Returns ​

void

Defined in ​

server/player/emit.ts:138

setTimeCycleEffect ​

Used to apply on-screen effects to a given player.

Think of like screen wobbling, drunkness, etc.

Example ​

Athena.player.emit.setTimeCycleEffect(somePlayer, 'REDMIST', 30000);

Export

Parameters ​

Returns ​

any

Defined in ​

server/player/emit.ts:763

Used to apply on-screen effects to a given player.

Think of like screen wobbling, drunkness, etc.

Example ​

Athena.player.emit.setTimeCycleEffect(somePlayer, 'REDMIST', 30000);

Export

Parameters ​

Returns ​

any

Defined in ​

server/player/emit.ts:764

setWeather ​

Cleanly transition weather from current weather to a new weather type.

Does not use alt:V functionality. Only uses natives.

Example ​

Athena.player.emit.setWeather(somePlayer, 'Thunder', 30);

Parameters ​

Returns ​

void

Defined in ​

server/player/emit.ts:811

sound2D ​

Play a custom sound without any positional data.

Example ​

Athena.player.emit.sound3D(somePlayer, 'error.ogg');

Parameters ​

Returns ​

any

Defined in ​

server/player/emit.ts:292

sound3D ​

Play a sound from at a target's location for this player.

Example ​

Athena.player.emit.sound3D(somePlayer, 'car_lock.ogg', someVehicle);

Parameters ​

Returns ​

void

Defined in ​

server/player/emit.ts:313

soundFrontend ​

Play a frontend sound for this player.

Frontend Audio List

Example ​

Athena.player.emit.soundFrontend(somePlayer, 'HUD_FRONTEND_DEFAULT_SOUNDSET', 'BACK');

Parameters ​

Returns ​

void

Defined in ​

server/player/emit.ts:358

soundStop ​

Stop all custom sounds that may be playing.

This does not stop frontend sounds.

Example ​

Athena.player.emit.soundStop(somePlayer);

Parameters ​

Returns ​

void

Defined in ​

server/player/emit.ts:336

startAlarm ​

Play an alarm on this player. List of all alarms: https://github.com/DurtyFree/gta-v-data-dumps/blob/master/alarmSounds.json

Parameters ​

Returns ​

void

Defined in ​

server/player/emit.ts:29

stopAlarm ​

Stop an alarm for this player.

Parameters ​

Returns ​

any

Defined in ​

server/player/emit.ts:48

stopAllAlarms ​

Stop all alarms for this player.

Parameters ​

Returns ​

any

Defined in ​

server/player/emit.ts:64

taskTimeline ​

Force the player to perform an uncancellable task timeline.

Parameters ​

Returns ​

any

Defined in ​

server/player/emit.ts:370

tempObjectLerp ​

Allows a temporary object to be created and moved. The object is only seen by this one player.

Parameters ​

Returns ​

any

Defined in ​

server/player/emit.ts:646

wheelMenu ​

Create a wheel menu and emit it to the player. Can emit events to client or server-side.

Parameters ​

Returns ​

any

Defined in ​

server/player/emit.ts:668