a4d5c2fd4d
- Added frontmatter to various markdown files for better metadata handling. - Updated site URLs in configuration files for consistency. - Improved content organization and clarity in getting started, server extension, and client addon guides.
1.8 KiB
1.8 KiB
title, description
| title | description |
|---|---|
| Client Notifications Usage Guide | The client notifications addon owns the notification HUD, notification sound, and local notification service used by Forge client and server modules. |
Runtime Behavior
The notification display is created during client initialization. The browser HUD sends:
notifications::ready
When that event is received, NotificationService initializes and sends a
startup notification.
Create a Notification
Use the notification service when available:
GVAR(NotificationService) call ["create", [
"success",
"Title",
"Notification text.",
4000
]];
Arguments:
| Argument | Purpose |
|---|---|
_type |
Notification type, such as success, info, warning, or error. |
_title |
Notification title. |
_content |
Notification body text. |
_duration |
Display duration in milliseconds. |
The service dispatches a browser forge:notify custom event.
CBA Event Surface
Other addons can use the client notification event:
["forge_client_notifications_recieveNotification", [
"warning",
"Garage",
"Vehicle spawn position is blocked.",
3000
]] call CBA_fnc_localEvent;
The event payload is:
[_type, _title, _content, _duration]
Usage Rules
- Use the shared notification service instead of opening separate transient browser UIs.
- Keep server-driven player feedback short and actionable.
- Treat notification state as transient client UI state.
- Do not use notifications as the only record of durable domain changes.