Events
Reference for client and server events fired or used by the bridge. Use these to hook into player load/unload, notifications, groups, allowlist, medical, and UniQueue.
Framework
Server
| Event | Parameters | Description |
|---|---|---|
prp-bridge:server:playerLoad | (src: number) | Fired when a player character loads. |
prp-bridge:server:playerUnload | (src: number) | Fired when a player character unloads. |
Core
Notifications and sound (client)
| Event | Parameters | Description |
|---|---|---|
prp-bridge:notify | (type, message, title, duration) | Sends a notification. type: success, error, inform. Trigger from server via bridge.fw.notify. |
prp-bridge:sound:play | (fileName, volume, noAutoPath, resourceName) | Plays a sound on the client. |
prp-bridge:sound:playSpatial | (fileName, volume, coords, distance, shouldMuffle, noAutoPath, resourceName) | Plays 3D sound at coordinates. |
Callbacks (client)
Invoked via lib.callback from server.
| Event | Description |
|---|---|
prp-bridge:progress | Progress bar callback. |
prp-bridge:minigame | Minigame callback. |
prp-bridge:confirmDialog | Confirm dialog callback. |
prp-bridge:inputDialog | Input dialog callback. |
prp-bridge:placeProp | Prop placer callback. |
Groups
Server
| Event | Parameters | Description |
|---|---|---|
prp-bridge:server:groupMemberAdded | (src: number, groupUuid: string) | Fired when a member joins a group. |
prp-bridge:server:groupMemberRemoved | (src: number, groupUuid: string) | Fired when a member leaves or is kicked. |
prp-bridge:server:groupDisbanded | (groupUuid: string) | Fired when a group is disbanded. |
Allowlist
Client
| Event | Parameters | Description |
|---|---|---|
prp-bridge:client:updateAllowlist | (allowlists: table<string, boolean>) | Fired when the player’s allowlists are updated or loaded. |
Medical
Client
| Event | Parameters | Description |
|---|---|---|
prp-bridge:client:revived | () | Fired when the player is revived. |
prp-bridge:client:died | () | Fired when the player dies. |
Server
| Event | Parameters | Description |
|---|---|---|
prp-bridge:server:revived | () (source implicit) | Fired when a player is revived. |
prp-bridge:server:died | () (source implicit) | Fired when a player dies. |
UniQueue
Server
| Event | Parameters | Description |
|---|---|---|
prp-bridge:uniqueue:partyDestroyed | (partyUuid: string) | Fired when a UniQueue party is destroyed. |
See UniQueue for queue and party usage.