Athena.controllers.doors ​

Functions ​

append ​

Append door information to be controlled.

Returns the door uid to remove all door controls if necessary.

All doors in the game are already added to the gamemode by default.

Example ​

const uid = Athena.controllers.doors.append({
  uid: 'my-cool-door-or-whatever',
  description: 'Pacific Standard Bank Main Right Door',
  isUnlocked: true,
  model: 110411286,
  pos: { x: 232.6054, y: 214.1584, z: 106.4049 },
});

Parameters ​

Returns ​

string

Defined in ​

server/controllers/doors.ts:71

override ​

Used to override any door streamer functionaltiy

Parameters ​

Returns ​

any

Defined in ​

server/controllers/doors.ts:157

Used to override any door streamer functionaltiy

Parameters ​

Returns ​

any

Defined in ​

server/controllers/doors.ts:158

Used to override any door streamer functionaltiy

Parameters ​

Returns ​

any

Defined in ​

server/controllers/doors.ts:159

remove ​

Remove all controls from a door.

Example ​

// uid is a variable here
Athena.controllers.doors.remove(uid);

Parameters ​

Returns ​

boolean

Defined in ​

server/controllers/doors.ts:97

update ​

Update door lock status.

Call this function to change door lock status.

Example ​

// set to true to unlock
Athena.controllers.doors.update('117', true);

Parameters ​

Returns ​

Promise<boolean>

Defined in ​

server/controllers/doors.ts:127