Agency-Notify Exports & API
Advanced notification system with two visual styles (V1 Classic and V2 Ultra) switchable per player, featuring.
01Client Exports
| Export | Description |
|---|---|
Notify(data: { title, text, type, duration, ... }) | Displays a v2 notification with optional AgencyAI smart-priority/duration/spam handling. |
02Events
| Name | Side | Description |
|---|---|---|
Agency:Notify:Send | Client | Legacy v1 entry point to display a notification with the same payload as the export. |
Agency:Notify:LoadSettings | Client | Applies per-player saved UI settings (position, color, scale, style) from the server. |
Agency:Notify:SaveSettings | Server | Validates and persists the player's notify settings (position, accent, scale, style). |
+Good to know
This page lists the available exports and events for Agency-Notify, allowing other resources to trigger notifications or interact with player notification settings. Exports and events are provided for client-side use only, as there are no server-side exports. Integration is straightforward and does not require any mandatory dependencies, though oxmysql can be used for persistent settings storage if enabled in the configuration.
- Client Export Usage
- The Notify export is available on the client side and lets you display a V2 notification with support for AgencyAI features, such as smart priority, duration, and spam protection. You can pass a data object with fields like title, text, type, and duration to customize the notification.
- Legacy Event Support
- Agency-Notify includes legacy v1 compatibility through the Agency:Notify:Send client event. This event accepts the same payload as the Notify export, making it easy to update older scripts or maintain backwards compatibility with minimal changes.
- Settings Persistence Events
- Two events manage player notification settings: Agency:Notify:LoadSettings (client) applies saved UI preferences, while Agency:Notify:SaveSettings (server) validates and persists settings such as position, color, scale, and style. Persistence requires oxmysql and must be enabled in the config.
?Frequently asked questions
Are there any server-side exports available in Agency-Notify?
No, Agency-Notify only provides client-side exports. All notification triggering and settings management are handled on the client, with persistence events available for saving and loading settings if oxmysql is enabled.
Is oxmysql required for Agency-Notify to function?
oxmysql is optional. It is only needed if you want to enable database persistence for player notification settings. Without oxmysql, notifications and UI settings work as normal, but settings will not be saved between sessions.
How do I trigger a notification from another resource?
You can use the Notify client export to display a notification. Pass a data object with the desired fields (title, text, type, duration, etc.). Alternatively, use the Agency:Notify:Send client event for legacy compatibility with the same payload structure.
What should I check if notifications are not appearing?
Ensure that Agency-Notify is properly started using ensure Agency-Notify in your server.cfg. Check that you are calling the client export or event with the correct data payload. If using persistence, verify that oxmysql is installed and enabled in the configuration.