Athena.controllers.interaction ​

Functions ​

append ​

Add an interaction to the scene.

An interaction is where a player can walk up to an invisible marker and press the interaction key to trigger a callback.

Interactions are accessible by all players.

Additional options may be added to the example interaction below.

See type interface in VSCode for more information.

Always subtract 1 from the 'z' axis when getting positions in-game.

Returns a uid or generates one if not specified.

Example ​

const uid = Athena.controllers.interaction.append({
   position: { x: 0, y: 0, z: 0 },
   isPlayerOnly: true,
   isVehicleOnly: false,
   callback(player: alt.Player) {
       alt.log(`${player.id} interacted with an interaction!`)
   }
});

Athena.controllers.interaction.append({
   uid: 'the-uid-you-specified',
   position: { x: 0, y: 0, z: 0 },
   isPlayerOnly: true,
   isVehicleOnly: false,
   callback(player: alt.Player) {
       alt.log(`${player.id} interacted with an interaction!`)
   }
});

Parameters ​

Returns ​

string

A string representing the uid of the interaction.

Defined in ​

server/controllers/interaction.ts:307

get ​

Returns interaction information.

This includes the internal ColShapes as well.

Example ​

const interaction = Athena.controllers.interaction.get('the-uid-you-specified');

Parameters ​

Returns ​

InteractionShape | undefined

The InteractionShape object.

Defined in ​

server/controllers/interaction.ts:376

getBindings ​

Used to obtain current interactions that are bound to a player id.

Returns ​

Object

Defined in ​

server/controllers/interaction.ts:395

override ​

Used to override any interaction controller function.

Parameters ​

Returns ​

any

Defined in ​

server/controllers/interaction.ts:430

Used to override any interaction controller function.

Parameters ​

Returns ​

any

Defined in ​

server/controllers/interaction.ts:431

Used to override any interaction controller function.

Parameters ​

Returns ​

any

Defined in ​

server/controllers/interaction.ts:432

Used to override any interaction controller function.

Parameters ​

Returns ​

any

Defined in ​

server/controllers/interaction.ts:433

overrideInternal ​

Used to override any internal interaction controller function. Handles things such as entering colshapes, leaving, and trigger them.

Parameters ​

Returns ​

any

Defined in ​

server/controllers/interaction.ts:445

Used to override any internal interaction controller function. Handles things such as entering colshapes, leaving, and trigger them.

Parameters ​

Returns ​

any

Defined in ​

server/controllers/interaction.ts:446

Used to override any internal interaction controller function. Handles things such as entering colshapes, leaving, and trigger them.

Parameters ​

Returns ​

any

Defined in ​

server/controllers/interaction.ts:447

remove ​

Removes an interaction from existence.

Removes the associated ColShape as well.

Example ​

Athena.controllers.interaction.remove(someUid);

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

Parameters ​

Returns ​

void

None

Defined in ​

server/controllers/interaction.ts:355