Skip to content
On this page

Athena.systems.defaults.displayId ​

Functions ​

disable ​

Usage

Athena.systems.defaults.displayId.disable(): void

Disable default id display on-screen for players.

Example ​

ts
Athena.systems.defaults.displayId.disable();

Returns ​

void

Defined in ​

server/systems/defaults/displayId.ts:47


setLocation ​

Usage

Athena.systems.defaults.displayId.setLocation(x, y): void

Change the position of the on-screen id a player sees

X as 1 = Right of Screen Y as 1 = Bottom of Screen

Example ​

ts
// Place in the very center of the screen. I'm sure everyone would love it.
Athena.systems.defaults.displayId.setLocation(0.5, 0.5);

Parameters ​

NameTypeDescription
xnumber0 - 1.0
ynumber0 - 1.0

Returns ​

void

Defined in ​

server/systems/defaults/displayId.ts:69

Created by Stuyk | Est. 2020