https://github.com/huotchu/roblox-pubsub
PubSub Module for Roblox Lua
https://github.com/huotchu/roblox-pubsub
roblox robloxlua
Last synced: 4 months ago
JSON representation
PubSub Module for Roblox Lua
- Host: GitHub
- URL: https://github.com/huotchu/roblox-pubsub
- Owner: HuotChu
- Created: 2017-07-01T18:48:46.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-08-19T21:01:44.000Z (over 8 years ago)
- Last Synced: 2023-03-01T08:02:36.465Z (about 3 years ago)
- Topics: roblox, robloxlua
- Language: Lua
- Homepage: https://www.roblox.com/games/896539588/Event-Management-Demo
- Size: 9.77 KB
- Stars: 9
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# roblox-pubsub
### PubSub for Roblox enables 4 way code communication via an Event Management system.
(Server/Server, Server/Client, Client/Client, Client/Server)
PubSub works with FilteringEnabled and allows for easy Publish and Subscribe functionality.
No Copylock Sample on Roblox: https://www.roblox.com/games/896539588/Event-Management-Demo
Examples and discussion on RBXDev Forums: https://devforum.roblox.com/t/pubsub-for-roblox-publish-subscribe-eventing/47850
Why is this cool? Well, let's say I wanted to announce a player has joined the game in chat.
The Player joining is something we connect to on the server [Players.PlayerAdded]
The chat is on the client, so the server and client need a RemoteEvent to communicate through.
You COULD create the RemoteEvent as a static object in ReplicatedStorage, then write code on
both the server and the client to access that event and handle it as needed.
Of course, you have to hope the event is there when both the client and the server are looking for it.
You also have to do this for every RemoteEvent in your game...
*ugh*
Better way? PubSub.
PubSub creates RemoteEvents when they are needed and cleans them up when they aren't.
PubSub ensures RemoteEvents are always available prior to attempted use.
PubSub also supports client to client and server to server eventing. RemoteEvents (alone) do not.
___
Let's announce that new player in chat using PubSub:
`ServerScriptService > Script`
```lua
local Players = game:GetService('Players')
local ReplicatedStorage = game:GetService('ReplicatedStorage')
local PubSub = require(ReplicatedStorage:WaitForChild('PubSub'))
local OnPlayerConnected = function (player)
wait(1)
PubSub.publish('AnnouncePlayer', player.Name)
end
Players.PlayerAdded:connect(OnPlayerConnected)
```
`StarterGui > YourLocalScript`
```lua
local StarterGui = game:GetService('StarterGui')
local PubSub = require(ReplicatedStorage:WaitForChild('PubSub'))
PubSub.subscribe('AnnouncePlayer', function (playerName)
StarterGui:SetCore('ChatMakeSystemMessage', {
Text = playerName..' joined the game!'
})
end, 'YourLocalScript')
```
Done. That's all there is to it.
No RemoteEvent objects for you to create and it is easy to use, just Publish and Subscribe!
___
### To start using PubSub in your game:
+ Create a Module in ReplicatedStorage.
+ Rename the module to PubSub.
+ Copy source from the code here on GitHub in ReplicatedStorage\PubSub.lua
+ Paste the code into the PubSub module you made in your game and close the file.
+ Look in the GitHub ServerScriptService\BootStrap.lua to see more examples of use.
## THE FOLLOWING CODE FROM BOOTSTRAP.LUA IS REQUIRED IN YOUR SERVER CODE AS EARLY AS YOU CAN LOAD IT
If you leave this step out, the client and server will not talk to eachother!
If you are not sure what to do with this part, just copy the contents of BootStrap.lua
and paste them into a Script in ServerScriptService. Do your game init or start your game
at the end of the file after the following section has a chance to run.
```lua
local Players = game:GetService('Players')
local ReplicatedStorage = game:GetService('ReplicatedStorage')
local PubSub = require(ReplicatedStorage:WaitForChild('PubSub'))
local CreateRemoteEvent = PubSub:FindFirstChild('CreateRemoteEvent')
local onCreateRemoteEvent = function (player, t)
return PubSub.createEvent(t)
end
CreateRemoteEvent.OnServerInvoke = onCreateRemoteEvent
```
On Roblox I'm HuotChu.
Check out my game, Big Idea, on Roblox!
If PubSub helps make your game awesome, consider buying a Coffee Reward game pass :)
#### https://www.roblox.com/games/798131599/