V5 DocsAthena.controllers.worldNotifications ​
Functions ​
addToPlayer ​
Usage
Athena.controllers.worldNotifications.addToPlayer(player, notification): string
Add a world notification to a single local player.
Parameters ​
| Name | Type | Description |
|---|---|---|
player | Player | An alt:V Player Entity |
notification | IWorldNotification |
Returns ​
string
uid A unique string for notification
Defined in ​
server/controllers/worldNotifications.ts:93
append ​
Usage
Athena.controllers.worldNotifications.append(notification): string
Adds a global world notification for all players.
Parameters ​
| Name | Type |
|---|---|
notification | IWorldNotification |
Returns ​
string
uid A unique string for notification
Defined in ​
server/controllers/worldNotifications.ts:35
override ​
Usage
Athena.controllers.worldNotifications.override(functionName, callback): any
Used to override any in-world streamer notifications
Parameters ​
| Name | Type |
|---|---|
functionName | "append" |
callback | (notification: IWorldNotification) => string |
Returns ​
any
Defined in ​
server/controllers/worldNotifications.ts:131
Usage
Athena.controllers.worldNotifications.override(functionName, callback): any
Used to override any in-world streamer notifications
Parameters ​
| Name | Type |
|---|---|
functionName | "remove" |
callback | (uid: string) => boolean |
Returns ​
any
Defined in ​
server/controllers/worldNotifications.ts:132
Usage
Athena.controllers.worldNotifications.override(functionName, callback): any
Used to override any in-world streamer notifications
Parameters ​
| Name | Type |
|---|---|
functionName | "addToPlayer" |
callback | (player: Player, notification: IWorldNotification) => string |
Returns ​
any
Defined in ​
server/controllers/worldNotifications.ts:133
Usage
Athena.controllers.worldNotifications.override(functionName, callback): any
Used to override any in-world streamer notifications
Parameters ​
| Name | Type |
|---|---|
functionName | "removeFromPlayer" |
callback | (player: Player, uid: string) => any |
Returns ​
any
Defined in ​
server/controllers/worldNotifications.ts:134
Usage
Athena.controllers.worldNotifications.override(functionName, callback): any
Used to override any in-world streamer notifications
Parameters ​
| Name | Type |
|---|---|
functionName | "update" |
callback | (player: Player, notifications: IWorldNotification[]) => any |
Returns ​
any
Defined in ​
server/controllers/worldNotifications.ts:135
remove ​
Usage
Athena.controllers.worldNotifications.remove(uid): boolean
Removes a global world notification from all players based on the global uid.
Parameters ​
| Name | Type | Description |
|---|---|---|
uid | string | A unique string |
Returns ​
boolean
Defined in ​
server/controllers/worldNotifications.ts:55
removeFromPlayer ​
Usage
Athena.controllers.worldNotifications.removeFromPlayer(player, uid): any
Remove a world notification from a single local player.
Parameters ​
| Name | Type | Description |
|---|---|---|
player | Player | An alt:V Player Entity |
uid | string | A unique string |
Returns ​
any
Defined in ​
server/controllers/worldNotifications.ts:75
update ​
Usage
Athena.controllers.worldNotifications.update(player, notifications): any
Updates world notifications through the streamer service.
Parameters ​
| Name | Type | Description |
|---|---|---|
player | Player | An alt:V Player Entity |
notifications | IWorldNotification[] |
Returns ​
any