Remotes.lua is a part of the Pronghorn Framework.
Lines 1 to 236 in f482f4a
| --!strict | |
| --[[ | |
| ╔═══════════════════════════════════════════════╗ | |
| ║ Pronghorn Framework ║ | |
| ║ https://iron-stag-games.github.io/Pronghorn ║ | |
| ╚═══════════════════════════════════════════════╝ | |
| ]] | |
| local Remotes = {} | |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | |
| -- Dependencies | |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | |
| -- Services | |
| local ReplicatedStorage = game:GetService("ReplicatedStorage") | |
| local Players = game:GetService("Players") | |
| local RunService = game:GetService("RunService") | |
| -- Core | |
| local Print = require(script.Parent.Debug).Print | |
| local New = require(script.Parent.New) | |
| -- Child Modules | |
| local TypeChecker = require(script.TypeChecker) | |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | |
| -- Helper Variables | |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | |
| local remotesFolder: Folder; | |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | |
| -- Helper Functions | |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | |
| local function getEnvironment(): string | |
| local split = (debug.info(3, "s") :: string):split(".") | |
| return "[" .. split[#split] .. "]" | |
| end | |
| local function getDebugPrintItems(debugPrintText: string, ...): ...any | |
| local items = {debugPrintText .. "("} | |
| for _, parameter in {...} do | |
| table.insert(items, "\n\t") | |
| table.insert(items, parameter) | |
| end | |
| if #items > 1 then | |
| table.insert(items, "\n)") | |
| else | |
| items[1] ..= ")" | |
| end | |
| return table.unpack(items) | |
| end | |
| local function connectEventClient(remote: RemoteFunction | RemoteEvent) | |
| local moduleName: string = (remote :: any).Parent.Name | |
| local debugPrintText = `{moduleName}:{remote.Name}` | |
| local actions: any = {} | |
| local metaTable: any = {} | |
| if not Remotes[moduleName] then | |
| Remotes[moduleName] = {} | |
| end | |
| Remotes[moduleName][remote.Name] = setmetatable(actions, metaTable) | |
| if remote:IsA("RemoteFunction") then | |
| actions.Connect = function(_, func: (...any) -> (...any)) | |
| remote.OnClientInvoke = func | |
| end | |
| actions.Fire = function(_, ...: any?) | |
| Print(getEnvironment(), getDebugPrintItems(debugPrintText, ...)) | |
| return remote:InvokeServer(...) | |
| end | |
| metaTable.__call = function(_, context: any, ...: any?) | |
| if context ~= Remotes[moduleName] then error(`Must call {moduleName}:{remote.Name}() with a colon`, 0) end | |
| Print(getEnvironment(), getDebugPrintItems(debugPrintText, ...)) | |
| return remote:InvokeServer(...) | |
| end | |
| elseif remote:IsA("RemoteEvent") then | |
| actions.Connect = function(_, func: (...any) -> ()): RBXScriptConnection | |
| return remote.OnClientEvent:Connect(func) | |
| end | |
| actions.Fire = function(_, ...: any?) | |
| Print(getEnvironment(), getDebugPrintItems(debugPrintText, ...)) | |
| return remote:FireServer(...) | |
| end | |
| metaTable.__call = function(_, context: any, ...: any?) | |
| if context ~= Remotes[moduleName] then error(`Must call {moduleName}:{remote.Name}() with a colon`, 0) end | |
| Print(getEnvironment(), getDebugPrintItems(debugPrintText, ...)) | |
| remote:FireServer(...) | |
| end | |
| end | |
| end | |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | |
| -- Module Functions | |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | |
| --- Creates a Remote that sends information to Clients. | |
| --- @param name -- The name of the Remote. | |
| --- @param requiredParameterTypes -- The required types for parameters. Accepts ClassName, EnumItem, any, ..., ?, and |. | |
| --- @param returns -- Whether or not the Remote yields and returns a value. | |
| function Remotes:CreateToClient(name: string, requiredParameterTypes: {string}, returns: boolean?) | |
| if RunService:IsClient() then error("Remotes cannot be created on the client", 0) end | |
| if type(requiredParameterTypes) ~= "table" then error(`Remotes.CreateToClient: Parameter 'requiredParameterTypes' expected type '\{string}', got '{typeof(requiredParameterTypes)}'`, 0) end | |
| if returns ~= nil and type(returns) ~= "boolean" then error(`Remotes.CreateToClient: Parameter 'returns' expected type 'boolean', got '{typeof(returns)}'`, 0) end | |
| local moduleName = tostring(getfenv(2).script) | |
| if type(Remotes[moduleName]) == "function" then error(`Creating remotes under the ModuleScript name '{moduleName}' would overwrite a function`, 0) end | |
| if Remotes[moduleName] and Remotes[moduleName][name] then error(`Remote '{name}' already created in '{moduleName}'`, 0) end | |
| local environment = "[" .. moduleName .. "]" | |
| local serverFolder = remotesFolder:FindFirstChild(moduleName) or New.Instance("Folder", remotesFolder, moduleName) | |
| local remote = New.Instance(returns and "RemoteFunction" or "RemoteEvent", serverFolder, name) | |
| local actions = {} | |
| if not Remotes[moduleName] then | |
| Remotes[moduleName] = {} | |
| end | |
| Remotes[moduleName][remote.Name] = actions | |
| if returns then | |
| actions.Fire = function(_, player: Player, ...: any?) | |
| TypeChecker(remote, requiredParameterTypes, ...) | |
| Print(environment, name, "Fire", ...) | |
| return remote:InvokeClient(player, ...) | |
| end | |
| else | |
| actions.Fire = function(_, player: Player, ...: any?) | |
| TypeChecker(remote, requiredParameterTypes, ...) | |
| Print(environment, name, "Fire", player, ...) | |
| remote:FireClient(player, ...) | |
| end | |
| actions.FireAll = function(_, ...: any?) | |
| TypeChecker(remote, requiredParameterTypes, ...) | |
| Print(environment, name, "FireAll", ...) | |
| remote:FireAllClients(...) | |
| end | |
| actions.FireAllExcept = function(_, ignorePlayer: Player, ...: any?) | |
| TypeChecker(remote, requiredParameterTypes, ...) | |
| Print(environment, name, "FireAllExcept", ignorePlayer, ...) | |
| for _, player in Players:GetPlayers() do | |
| if player ~= ignorePlayer then | |
| remote:FireClient(player, ...) | |
| end | |
| end | |
| end | |
| end | |
| return actions | |
| end | |
| --- Creates a Remote that receives information from Clients. | |
| --- @param name -- The name of the Remote. | |
| --- @param requiredParameterTypes -- The required types for parameters. Accepts ClassName, EnumItem, any, ..., ?, and |. | |
| --- @param returns -- Whether or not the Remote yields and returns a value. | |
| --- @param func -- The listener function to be invoked. | |
| function Remotes:CreateToServer(name: string, requiredParameterTypes: {string}, returns: boolean?, func: (Player, ...any) -> (...any)?) | |
| if RunService:IsClient() then error("Remotes cannot be created on the client", 0) end | |
| if type(requiredParameterTypes) ~= "table" then error(`Remotes.CreateToServer: Parameter 'requiredParameterTypes' expected type '\{string}', got '{typeof(requiredParameterTypes)}'`, 0) end | |
| if returns ~= nil and type(returns) ~= "boolean" then error(`Remotes.CreateToServer: Parameter 'returns' expected type 'boolean', got '{typeof(returns)}'`, 0) end | |
| if func ~= nil and type(func) ~= "function" then error(`Remotes.CreateToServer: Parameter 'func' expected type '(Player, ...any) -> (...any)?', got '{typeof(func)}'`, 0) end | |
| local moduleName = tostring(getfenv(2).script) | |
| if type(Remotes[moduleName]) == "function" then error(`Creating remotes under the ModuleScript name '{moduleName}' would overwrite a function`, 0) end | |
| if Remotes[moduleName] and Remotes[moduleName][name] then error(`Remote '{name}' already created in '{moduleName}'`, 0) end | |
| local serverFolder = remotesFolder:FindFirstChild(moduleName) or New.Instance("Folder", remotesFolder, moduleName) | |
| local remote = New.Instance(returns and "RemoteFunction" or "RemoteEvent", serverFolder, name) | |
| local actions = {} | |
| if not Remotes[moduleName] then | |
| Remotes[moduleName] = {} | |
| end | |
| Remotes[moduleName][remote.Name] = actions | |
| local function getTypeCheckedFunction(newFunction: (Player, ...any) -> (...any)) | |
| return function(player: Player, ...: any) | |
| TypeChecker(remote, requiredParameterTypes, ...) | |
| return newFunction(player, ...) | |
| end | |
| end | |
| if returns then | |
| if func then | |
| remote.OnServerInvoke = getTypeCheckedFunction(func) | |
| end | |
| actions.SetListener = function(_, newFunction: (Player, ...any) -> (...any)) | |
| remote.OnServerInvoke = getTypeCheckedFunction(newFunction) | |
| end | |
| else | |
| if func then | |
| remote.OnServerEvent:Connect(getTypeCheckedFunction(func)) | |
| end | |
| actions.AddListener = function(_, newFunction: (Player, ...any) -> ()): RBXScriptConnection | |
| return remote.OnServerEvent:Connect(getTypeCheckedFunction(newFunction)) | |
| end | |
| end | |
| return actions | |
| end | |
| --- @ignore | |
| function Remotes:Init() | |
| if RunService:IsServer() then | |
| remotesFolder = New.Instance("Folder", ReplicatedStorage, "__remotes") | |
| else | |
| remotesFolder = ReplicatedStorage:WaitForChild("__remotes") | |
| for _, remote in remotesFolder:GetDescendants() do | |
| connectEventClient(remote :: any) | |
| end | |
| remotesFolder.DescendantAdded:Connect(function(remote) | |
| connectEventClient(remote :: any) | |
| end) | |
| end | |
| end | |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | |
| return Remotes |