> For the complete documentation index, see [llms.txt](https://bros-development.gitbook.io/documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://bros-development.gitbook.io/documentation/scripts/editor/exports.md).

# 📤 Exports

BrosDev\_notify provides a simple and developer-friendly export function that can be used from any client-side script.

***

## 🚀 Basic Usage

Use the export anywhere inside your client scripts:

```lua
exports['BrosDev_notify']:BrosDev_notify(type, title, message, duration)
```

***

## 🧾 Parameters

| Parameter  | Type   | Description                                               |
| ---------- | ------ | --------------------------------------------------------- |
| `type`     | string | Notification type (`success`, `error`, `warning`, `info`) |
| `title`    | string | Small notification title                                  |
| `message`  | string | Main notification text                                    |
| `duration` | number | Display duration in milliseconds                          |

***

## ✅ Example Usage

### Success Notification

```lua
exports['BrosDev_notify']:BrosDev_notify(
    'success',
    'Vehicle',
    'Vehicle stored successfully.',
    5000
)
```

***

### Error Notification

```lua
exports['BrosDev_notify']:BrosDev_notify(
    'error',
    'Garage',
    'You do not own this vehicle.',
    5000
)
```

***

### Warning Notification

```lua
exports['BrosDev_notify']:BrosDev_notify(
    'warning',
    'Fuel System',
    'Your fuel level is getting low.',
    4000
)
```

***

### Info Notification

```lua
exports['BrosDev_notify']:BrosDev_notify(
    'info',
    'Dispatch',
    'A new call has been received.',
    4500
)
```

***

## ⚡ Quick One-Line Example

```lua
exports['BrosDev_notify']:BrosDev_notify('success', 'Success', 'Action completed successfully.', 3000)
```

***

## 🎨 Supported Default Types

The following notification types are included by default:

| Type      | Description              |
| --------- | ------------------------ |
| `success` | Successful actions       |
| `error`   | Failed actions or errors |
| `warning` | Warnings or alerts       |
| `info`    | General information      |

You can also create fully custom types inside:

```bash
config.lua
```

***

## 🔧 Creating Custom Notification Types

Example custom type:

```lua
Config.Types['police'] = {
    icon = 'fa-shield-alt',
    color = '#1E90FF',
    label = 'Police',
    sound = 'notify.mp3',
    volume = 0.5
}
```

Usage:

```lua
exports['BrosDev_notify']:BrosDev_notify(
    'police',
    'Dispatch',
    'Officer assistance requested.',
    5000
)
```

***

## 🧪 Testing Notifications

If debug mode is enabled:

```lua
Config.EnableDebugMode = true
```

You can test notifications in-game using:

```bash
/notify success "Test notification" 3000
```

***

## 💡 Best Practices

* Keep messages short and readable
* Use appropriate notification types
* Avoid spamming notifications repeatedly
* Use longer durations only for important alerts
* Match custom colors with your server branding

***

## 📌 Recommended Use Cases

BrosDev\_notify works perfectly for:

* Job systems
* Dispatch alerts
* Inventory actions
* Banking systems
* Vehicle garages
* Illegal activities
* Admin tools
* Character systems
* Phone systems
* Custom gameplay mechanics

***

## ✅ Export Ready

That’s it — your scripts can now send modern, animated notifications anywhere across your server using a single export function.