Athena.controllers.staticPed ​

Functions ​

addToPlayer ​

Add a single ped that only a single player can see

Returns a uid or generates one if not specified.

Example ​

const uid = Athena.controllers.staticPed.addToPlayer(somePlayer, { model: 'g_f_importexport_01', pos: { x: 0, y: 0, z: 0} })

Athena.controllers.staticPed.addToPlayer(somePlayer, { uid: 'the-id-you-specified', model: 'g_f_importexport_01', pos: { x: 0, y: 0, z: 0} })

Parameters ​

Returns ​

string

Defined in ​

server/controllers/staticPed.ts:138

append ​

Create a global static ped for the server.

A static pedestrian does not move, and simply stands there.

• Returns a uid or generates one if not specified.

Example ​

const uid = Athena.controllers.staticPed.append({ model: 'g_f_importexport_01', pos: { x: 0, y: 0, z: 0} })

Athena.controllers.staticPed.append({ uid: 'the-id-you-specified', model: 'g_f_importexport_01', pos: { x: 0, y: 0, z: 0} })

Parameters ​

Returns ​

string

uid A unique string for the ped

Defined in ​

server/controllers/staticPed.ts:53

override ​

Used to override any static ped streamer functionality.

Parameters ​

Returns ​

any

Defined in ​

server/controllers/staticPed.ts:180

Used to override any static ped streamer functionality.

Parameters ​

Returns ​

any

Defined in ​

server/controllers/staticPed.ts:181

Used to override any static ped streamer functionality.

Parameters ​

Returns ​

any

Defined in ​

server/controllers/staticPed.ts:182

Used to override any static ped streamer functionality.

Parameters ​

Returns ​

any

Defined in ​

server/controllers/staticPed.ts:183

playAnimation ​

Make a pedestrian play a specific animation.

Example ​

Athena.controllers.staticPed.playAnimation('the-id-you-specified', playAnimation('test',
     {
         dict: 'mp_ped_interaction',
         name: 'hugs_guy_a',
         duration: 2000,
         flags: 0,
     },
);

Parameters ​

Returns ​

void

Defined in ​

server/controllers/staticPed.ts:170

remove ​

Remove a global pedestrian

Example ​

Athena.controllers.staticPed.remove(someUid)

Athena.controllers.staticPed.remove('the-id-you-specified');

Parameters ​

Returns ​

boolean

Defined in ​

server/controllers/staticPed.ts:80

removeFromPlayer ​

Remove a pedestrian from a player.

Example ​

Athena.controllers.staticPed.removeFromPlayer(somePlayer, someUid)

Athena.controllers.staticPed.removeFromPlayer(somePlayer, 'the-id-you-specified');

Parameters ​

Returns ​

any

Defined in ​

server/controllers/staticPed.ts:110