https://github.com/ayvacs/chat-message-service
Interface for sending messages to clients via Roblox's default chat
https://github.com/ayvacs/chat-message-service
chat lua luau roblox
Last synced: 5 months ago
JSON representation
Interface for sending messages to clients via Roblox's default chat
- Host: GitHub
- URL: https://github.com/ayvacs/chat-message-service
- Owner: ayvacs
- License: mit
- Created: 2024-04-05T23:55:22.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-06-22T03:57:24.000Z (almost 2 years ago)
- Last Synced: 2024-12-27T11:46:06.136Z (over 1 year ago)
- Topics: chat, lua, luau, roblox
- Language: Luau
- Homepage:
- Size: 5.86 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ChatMessageService
An easy interface for sending system messages in Roblox chat on the server and client, optionally using RichText.
To install, follow the instructions at the top of each script in src/.
## API
### Server
#### :SpecifiedClient
```lua
ChatMessageService.Server:SpecifiedClient( client: Player, text: string ): nil
```
Send the specified message (`text`) to the specified client only. `text` may be any plain text message or properly-formated RichText string.
#### :SpecifiedClients
```lua
ChatMessageService.Server:SpecifiedClients( clients: table, text: string ): nil
```
Send the specified message (`text`) to all specified clients (`Player` instances of array `clients`) current client only. `text` may be any plain text message or properly-formated RichText string.
#### :AllClients
```lua
ChatMessageService.Server:AllClients( text: string ): nil
```
Send the specified message (`text`) to all available clients. `text` may be any plain text message or properly-formated RichText string.
### Client
#### :CurrentClient
```lua
ChatMessageService.Client:CurrentClient( text: string ): nil
```
Send the specified message (`text`) to the current client only. `text` may be any plain text message or properly-formated RichText string.