Skip to main content

server

Functions​

SetPersistent​

</>
server.SetPersistent(
t: table | buffer,
state: boolean
) → ()

Sets whether the provided table or buffer is persistent in syncdata even if not replicated to anyone.
This should be used for tables you know are guaranteed to be replicated. so that you have a safety guarantee that Syncee's api wont error on it.

SetSchema​

</>
server.SetSchema(
t: table,
schema: (number | string)?
) → ()

Registers the provided schema to be used for the given table, nil can be provided to remove the schema.
This doesn't need the value to be already in Syncee's registry.

If the schema has sub-schemas, they will be automatically applied to any table present within if they don't have a schema assigned already.

SetRatelimit​

</>
server.SetRatelimit(
t: table | buffer,
ratelimit: number?
) → ()

Limits the rate of replication for the provided table to atleast 'n' seconds between each replication.
This doesn't need the value to be already in syncee's registry.

Note that this only applies to the provided table/buffer.

Replicate​

</>
server.Replicate(
t: table,
key: any
) → ()

Replicates the value of the provided key, even if not changed.

ReplicateBufferRegion​

</>
server.ReplicateBufferRegion(
buf: buffer,
start: number,
length: number
) → ()

Marks a region of a buffer for delta replication.

Set​

</>
server.Set(
t: table,
key: any,
value: any
) → ()

Sets 'key' of 't' to 'value', replicates the change then fires TableChangedSignal if present.

GetDataToReplicate​

</>
server.GetDataToReplicate() → {[Player]: {
b: buffer,
refs: {{any} | false}?
}}

Returns a dictionary mapping each player to a table containing a buffer and an auxillary references array to send to them. Both should be sent to the client.

MarkPlayerLoaded​

</>
server.MarkPlayerLoaded(player: Player) → ()

Marks the given player as loaded and begins replicating the data to them.

GetProxy​

</>
server.GetProxy(t: table) → table

Returns a proxy for the provided table that automatically runs Syncee.server.Set() upon any changes. Do not use proxies with server.Set() or manually add them to replicated tables. Unexpected behaviors may occur if this is done.

ProxyToTable​

</>
server.ProxyToTable(proxy: table) → table?

Returns the original table that this proxy is bound to, if it exists.

Clear​

</>
server.Clear(t: table) → ()

table.clear(), but replicates the changes if on server. Does not fire change signal.

Insert​

</>
server.Insert(
t: table,
posOrValue: any,
value: any?
) → ()

table.insert(), but replicates the changes if on server and fires change signal.

Remove​

</>
server.Remove(
t: table,
pos: number?
) → any

table.remove(), but replicates the changes if on server and fires change signal.

GetRecipients​

</>
server.GetRecipients(t: table | buffer) → {Player}

Returns the players this table/buffer is replicated to.

Show raw api
{
    "functions": [
        {
            "name": "SetPersistent",
            "desc": "Sets whether the provided table or buffer is persistent in syncdata even if not replicated to anyone.\\\nThis should be used for tables you know are guaranteed to be replicated. so that you have a safety guarantee that Syncee's api wont error on it.",
            "params": [
                {
                    "name": "t",
                    "desc": "",
                    "lua_type": "table | buffer"
                },
                {
                    "name": "state",
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 90,
                "path": "docs_luau/moonwave.luau"
            }
        },
        {
            "name": "SetSchema",
            "desc": "Registers the provided schema to be used for the given table, nil can be provided to remove the schema.\\\nThis doesn't need the value to be already in Syncee's registry.\n\nIf the schema has sub-schemas, they will be automatically applied to any table present within if they don't have a schema assigned already.",
            "params": [
                {
                    "name": "t",
                    "desc": "",
                    "lua_type": "table"
                },
                {
                    "name": "schema",
                    "desc": "",
                    "lua_type": "(number | string)?"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 101,
                "path": "docs_luau/moonwave.luau"
            }
        },
        {
            "name": "SetRatelimit",
            "desc": "Limits the rate of replication for the provided table to atleast 'n' seconds between each replication.\\\nThis doesn't need the value to be already in syncee's registry.\\\n\\\nNote that this only applies to the provided table/buffer.",
            "params": [
                {
                    "name": "t",
                    "desc": "",
                    "lua_type": "table | buffer"
                },
                {
                    "name": "ratelimit",
                    "desc": "",
                    "lua_type": "number?"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 112,
                "path": "docs_luau/moonwave.luau"
            }
        },
        {
            "name": "Replicate",
            "desc": "Replicates the value of the provided key, even if not changed.",
            "params": [
                {
                    "name": "t",
                    "desc": "",
                    "lua_type": "table"
                },
                {
                    "name": "key",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 118,
                "path": "docs_luau/moonwave.luau"
            }
        },
        {
            "name": "ReplicateBufferRegion",
            "desc": "Marks a region of a buffer for delta replication.",
            "params": [
                {
                    "name": "buf",
                    "desc": "",
                    "lua_type": "buffer"
                },
                {
                    "name": "start",
                    "desc": "",
                    "lua_type": "number"
                },
                {
                    "name": "length",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 125,
                "path": "docs_luau/moonwave.luau"
            }
        },
        {
            "name": "Set",
            "desc": "Sets 'key' of 't' to 'value', replicates the change then fires TableChangedSignal if present.",
            "params": [
                {
                    "name": "t",
                    "desc": "",
                    "lua_type": "table"
                },
                {
                    "name": "key",
                    "desc": "",
                    "lua_type": "any"
                },
                {
                    "name": "value",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 132,
                "path": "docs_luau/moonwave.luau"
            }
        },
        {
            "name": "GetDataToReplicate",
            "desc": "Returns a dictionary mapping each player to a table containing a buffer and an auxillary references array to send to them.\nBoth should be sent to the client.",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "{[Player]: {b: buffer, refs: {{any} | false}?}}"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 138,
                "path": "docs_luau/moonwave.luau"
            }
        },
        {
            "name": "MarkPlayerLoaded",
            "desc": "Marks the given player as loaded and begins replicating the data to them.",
            "params": [
                {
                    "name": "player",
                    "desc": "",
                    "lua_type": "Player"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 143,
                "path": "docs_luau/moonwave.luau"
            }
        },
        {
            "name": "GetProxy",
            "desc": "Returns a proxy for the provided table that automatically runs Syncee.server.Set() upon any changes.\n<strong>Do not use proxies with server.Set() or manually add them to replicated tables</strong>. Unexpected behaviors may occur if this is done.",
            "params": [
                {
                    "name": "t",
                    "desc": "",
                    "lua_type": "table"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "table"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 150,
                "path": "docs_luau/moonwave.luau"
            }
        },
        {
            "name": "ProxyToTable",
            "desc": "Returns the original table that this proxy is bound to, if it exists.",
            "params": [
                {
                    "name": "proxy",
                    "desc": "",
                    "lua_type": "table"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "table?"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 156,
                "path": "docs_luau/moonwave.luau"
            }
        },
        {
            "name": "Clear",
            "desc": "table.clear(), but replicates the changes if on server. Does not fire change signal.",
            "params": [
                {
                    "name": "t",
                    "desc": "",
                    "lua_type": "table"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 161,
                "path": "docs_luau/moonwave.luau"
            }
        },
        {
            "name": "Insert",
            "desc": "table.insert(), but replicates the changes if on server and fires change signal.",
            "params": [
                {
                    "name": "t",
                    "desc": "",
                    "lua_type": "table"
                },
                {
                    "name": "posOrValue",
                    "desc": "",
                    "lua_type": "any"
                },
                {
                    "name": "value",
                    "desc": "",
                    "lua_type": "any?"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 168,
                "path": "docs_luau/moonwave.luau"
            }
        },
        {
            "name": "Remove",
            "desc": "table.remove(), but replicates the changes if on server and fires change signal.",
            "params": [
                {
                    "name": "t",
                    "desc": "",
                    "lua_type": "table"
                },
                {
                    "name": "pos",
                    "desc": "",
                    "lua_type": "number?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 175,
                "path": "docs_luau/moonwave.luau"
            }
        },
        {
            "name": "GetRecipients",
            "desc": "Returns the players this table/buffer is replicated to.",
            "params": [
                {
                    "name": "t",
                    "desc": "",
                    "lua_type": "table | buffer"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "{Player}"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 181,
                "path": "docs_luau/moonwave.luau"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "server",
    "desc": "",
    "source": {
        "line": 81,
        "path": "docs_luau/moonwave.luau"
    }
}