Containers

Containers are the recommended and easy way to group together messages in light by name.

Container inputs should be a map of string message-names to any valid Datatype. This includes Datatypes like arrays or maps that are defined with luau tables. I.e., { light.datatypes.u8 }

If messages inside are already synchronized beforehand, the container will not yield.

The server defines the messages immediately, so container {...} will never yield on the server.

function light.container (On The Client)

function container<MessageNames>(
    message_names: MessageNames, -- { [string]: Datatype }
    namespace: string? --(1)!
): (MessageNames)

1. The "namespace" parameter exists to allow you to have multiple containers with overlapping message names.

function light.container (On The Server)

function container<T>(
    message_names: T, -- { [string]: Datatype }
    namespace: string? --(1)!
): (T)

1. The "namespace" parameter exists to allow you to have multiple containers with overlapping message names.

Some example code using containers:

local light = require(ReplicatedStorage.light).shared

local ty = light.datatypes

return light.container({
    abc = { ty.u8 }, -- send a table of u8 numbers
}, "some-cool-namespace")

You can replicate the above code 1:1 with light.message()