Skip to content
On this page

Athena.controllers.interaction

Functions

append

Usage

Athena.controllers.interaction.append(interaction): string

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

ts
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

NameTypeDescription
interactionInteractionThe interaction object to be added.

Returns

string

A string representing the uid of the interaction.

Defined in

server/controllers/interaction.ts:307


get

Usage

Athena.controllers.interaction.get(uid): InteractionShape | undefined

Returns interaction information.

This includes the internal ColShapes as well.

Example

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

Parameters

NameTypeDescription
uidstringA unique string - The unique identifier of the interaction.

Returns

InteractionShape | undefined

The InteractionShape object.

Defined in

server/controllers/interaction.ts:376


getBindings

Usage

Athena.controllers.interaction.getBindings(): Object

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

Returns

Object

Defined in

server/controllers/interaction.ts:395


override

Usage

Athena.controllers.interaction.override(functionName, callback): any

Used to override any interaction controller function.

Parameters

NameType
functionName"append"
callback(interaction: Interaction) => string

Returns

any

Defined in

server/controllers/interaction.ts:430

Usage

Athena.controllers.interaction.override(functionName, callback): any

Used to override any interaction controller function.

Parameters

NameType
functionName"remove"
callback(uid: string) => void

Returns

any

Defined in

server/controllers/interaction.ts:431

Usage

Athena.controllers.interaction.override(functionName, callback): any

Used to override any interaction controller function.

Parameters

NameType
functionName"get"
callback(uid: string) => InteractionShape | undefined

Returns

any

Defined in

server/controllers/interaction.ts:432

Usage

Athena.controllers.interaction.override(functionName, callback): any

Used to override any interaction controller function.

Parameters

NameType
functionName"getBindings"
callback() => { [player_id: string]: InteractionShape; }

Returns

any

Defined in

server/controllers/interaction.ts:433


overrideInternal

Usage

Athena.controllers.interaction.overrideInternal(functionName, callback): any

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

Parameters

NameType
functionName"trigger"
callback(player: Player) => void

Returns

any

Defined in

server/controllers/interaction.ts:445

Usage

Athena.controllers.interaction.overrideInternal(functionName, callback): any

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

Parameters

NameType
functionName"leave"
callback(colshape: InteractionShape, entity: Entity) => any

Returns

any

Defined in

server/controllers/interaction.ts:446

Usage

Athena.controllers.interaction.overrideInternal(functionName, callback): any

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

Parameters

NameType
functionName"enter"
callback(colshape: InteractionShape, entity: Entity) => any

Returns

any

Defined in

server/controllers/interaction.ts:447


remove

Usage

Athena.controllers.interaction.remove(uid): void

Removes an interaction from existence.

Removes the associated ColShape as well.

Example

ts
Athena.controllers.interaction.remove(someUid);

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

Parameters

NameTypeDescription
uidstringA unique string - The unique identifier of the interaction to remove.

Returns

void

None

Defined in

server/controllers/interaction.ts:355

Created by Stuyk | Est. 2020