Skip to main content

network

A simple yet incredibly useful network module which simplifies and extends server-client communication.

local Workspace = game:GetService("Workspace")

-- Server
local testNetwork = Network.Server.new("TestNetwork")
testNetwork:append("method", function(player)
	return string.format("hi, %s!", player.Name)
end)
testNetwork:dispatch(Workspace)

-- Client
local Workspace = game:GetService("Workspace")

local testNetwork = network.client.fromParent("TestNetwork", Workspace):expect()
print(testNetwork.method():expect()) --> "hi, babypatrick100!"

Types​

RemoteProperty​

</>
type RemoteProperty = RemoteProperty

RemoteSignal​

</>
type RemoteSignal = RemoteSignal

ClientRemoteProperty​

</>
type ClientRemoteProperty = ClientRemoteProperty

ClientRemoteSignal​

</>
type ClientRemoteSignal = ClientRemoteSignal

NetworkServer​

</>
type NetworkServer = NetworkServer

Properties​

Server​

Read only
</>
network.Server: NetworkServer

client​

Read only
</>
network.client: networkClient
Show raw api
{
    "functions": [],
    "properties": [
        {
            "name": "Server",
            "desc": " ",
            "lua_type": "NetworkServer",
            "tags": [
                "Read only"
            ],
            "source": {
                "line": 29,
                "path": "src/network/init.luau"
            }
        },
        {
            "name": "client",
            "desc": " ",
            "lua_type": "networkClient",
            "tags": [
                "Read only"
            ],
            "source": {
                "line": 35,
                "path": "src/network/init.luau"
            }
        }
    ],
    "types": [
        {
            "name": "RemoteProperty",
            "desc": " ",
            "lua_type": "RemoteProperty",
            "source": {
                "line": 40,
                "path": "src/network/init.luau"
            }
        },
        {
            "name": "RemoteSignal",
            "desc": " ",
            "lua_type": "RemoteSignal",
            "source": {
                "line": 45,
                "path": "src/network/init.luau"
            }
        },
        {
            "name": "ClientRemoteProperty",
            "desc": " ",
            "lua_type": "ClientRemoteProperty",
            "source": {
                "line": 50,
                "path": "src/network/init.luau"
            }
        },
        {
            "name": "ClientRemoteSignal",
            "desc": " ",
            "lua_type": "ClientRemoteSignal",
            "source": {
                "line": 55,
                "path": "src/network/init.luau"
            }
        },
        {
            "name": "NetworkServer",
            "desc": " ",
            "lua_type": "NetworkServer",
            "source": {
                "line": 60,
                "path": "src/network/init.luau"
            }
        }
    ],
    "name": "network",
    "desc": "A simple yet incredibly useful network module which simplifies and extends server-client communication.\n\n```lua\nlocal Workspace = game:GetService(\"Workspace\")\n\n-- Server\nlocal testNetwork = Network.Server.new(\"TestNetwork\")\ntestNetwork:append(\"method\", function(player)\n\treturn string.format(\"hi, %s!\", player.Name)\nend)\ntestNetwork:dispatch(Workspace)\n\n-- Client\nlocal Workspace = game:GetService(\"Workspace\")\n\nlocal testNetwork = network.client.fromParent(\"TestNetwork\", Workspace):expect()\nprint(testNetwork.method():expect()) --> \"hi, babypatrick100!\"\n```",
    "source": {
        "line": 23,
        "path": "src/network/init.luau"
    }
}