mirror of
https://github.com/jimathy/jim_bridge.git
synced 2026-08-18 22:36:04 +01:00
better documentation layout
- seperated the 2000+ lines in ReadMe.md into seperate files. - useful if things expand - better readability for users - more organised layout
This commit is contained in:
21
documentation/main_functions/phones.md
Normal file
21
documentation/main_functions/phones.md
Normal file
@@ -0,0 +1,21 @@
|
||||
### phones.lua
|
||||
|
||||
This module allows you to send in-game mail/messages to player phones, depending on the phone system integrated (e.g., QB, NPWD).
|
||||
|
||||
- **sendPhoneMail(data)**
|
||||
|
||||
- Sends a mail message to a player's in-game phone app.
|
||||
- Typically used to notify players about deliveries, missions, or reminders.
|
||||
- **Parameters:**
|
||||
- `data` (`table`): Must contain phone/mail system-compatible fields like `sender`, `subject`, `message`, and `receiver`.
|
||||
- **Example:**
|
||||
```lua
|
||||
sendPhoneMail({
|
||||
subject = "Welcome!",
|
||||
sender = "Admin",
|
||||
message = "Thank you for joining our server.",
|
||||
actions = {
|
||||
{ label = "Reply", action = replyFunction }
|
||||
}
|
||||
})
|
||||
```
|
||||
Reference in New Issue
Block a user