Athena.controllers.object ​

Functions ​

addToPlayer ​

Add an object to the player that only they can see.

Returns a uid or generates one if not specified.

Example ​

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

Parameters ​

Returns ​

string

uid A unique string for object

Defined in ​

server/controllers/object.ts:168

append ​

Add an object to the global world.

These objects should not be used to construct interiors.

Create an MLO, or use something like CodeWalker to create large scale map changes.

Returns a uid or generates one if not specified.

Example ​

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

Athena.controllers.object.append({
     uid: 'the-uid-you-specified',
     model: 'prop_pizza_oven_01',
     pos: { x: 0, y: 0, z: 0}
});

Parameters ​

Returns ​

string

uid A unique string for object

Defined in ​

server/controllers/object.ts:70

override ​

Used to override any object streamer functionality

Parameters ​

Returns ​

any

Defined in ​

server/controllers/object.ts:250

Used to override any object streamer functionality

Parameters ​

Returns ​

any

Defined in ​

server/controllers/object.ts:251

Used to override any object streamer functionality

Parameters ​

Returns ​

any

Defined in ​

server/controllers/object.ts:252

Used to override any object streamer functionality

Parameters ​

Returns ​

any

Defined in ​

server/controllers/object.ts:253

Used to override any object streamer functionality

Parameters ​

Returns ​

any

Defined in ​

server/controllers/object.ts:254

Used to override any object streamer functionality

Parameters ​

Returns ​

any

Defined in ​

server/controllers/object.ts:255

remove ​

Removes an object from the global world.

If the object was found and removed this will return true.

Example ​

const result = Athena.controllers.object.remove(someUid);

Athena.controllers.object.remove('the-uid-you-specified');

Parameters ​

Returns ​

boolean

Defined in ​

server/controllers/object.ts:104

removeFromPlayer ​

Remove an object from the player that only they can see.

Example ​

Athena.controllers.object.removeFromPlayer(somePlayer, someUid);

Parameters ​

Returns ​

any

Defined in ​

server/controllers/object.ts:139

updateModel ​

Parameters ​

Returns ​

boolean

Defined in ​

server/controllers/object.ts:224

updatePosition ​

Updates the position for an object.

NOT ALL OBJECTS CAN BE MOVED DYNAMICALLY.

Example ​

Non-Player Object ​

Athena.controllers.object.updatePosition(someUid, { x: 0, y: 0, z: 0});

Player Object ​

Athena.controllers.object.updatePosition(someUid, { x: 0, y: 0, z: 0}, somePlayer);

Parameters ​

Returns ​

boolean

Defined in ​

server/controllers/object.ts:204