TableServerReplicator

This item only works when running on the server. Server

Show Private

TableServerReplicator handles replication of a given TableManager object to the client. This system very closely follows the idea behind ReplicaService and should be familiar to anyone who has used it.

Inherits from BaseTableReplicator. See BaseTableReplicator for inherited methods.

Types

ReplicationTargets

</>

type ReplicationTargets = "All" | Player | {Player}

The Player(s) that the TSR should replicate to. If "All" is given then the TSR will replicate to all current and future players.

ClassToken

</>

type ClassToken = {Name: string}

A unique symbol that identifies the TSR Class. This is used to identify the TSR Class when it is replicated to the client. Use .newClassToken to generate an object of this type. Do NOT manually create the table.

Properties

AddedActivePlayer

</>

TableServerReplicator.AddedActivePlayer: Signal<Player>

A signal that fires whenever a player starts being replicated to. This happens when their client requests the current data from the server.

All

</>

TableServerReplicator.All: TableServerReplicator

A TSR that replicates to all current and future players. Used as a global parent for child TSRs that need a home and should be replicated to all current and future players. Do not modify anything about this TSR, only use it as a Parent.

None

</>

TableServerReplicator.None: TableServerReplicator

A TSR that doesnt replicate to anyone. Used as a global parent for child TSRs that shouldnt be replicated. Do not modify anything about this TSR, only use it as a Parent.

Functions

newClassToken

</>

TableServerReplicator.newClassToken(tokenName: string) → ClassToken

Returns a ClassToken Symbol that is used for identifying the TSR Class. We use unique symbols instead of strings to prevent accidental collisions.

warning

This may only be called once per unique string. The returned symbol should be used repeatedly instead of calling this function again. Calling this function again with the same string will result in an error.

new

</>

TableServerReplicator.new(config: {

ClassToken: ClassToken,

TableManager: TableManager,

ReplicationTargets: ReplicationTargets?,

Parent: TableServerReplicator?,

Tags: {[string]: any}?,

Client: {[string]: any}?,

}) → ()

Creates a new TableServerReplicator instance. The config must be given a TableManager instance and a ClassToken Symbol.

A list of replication targets can be provided to specify which players the TSR should replicate to immediately. If no replication targets are specified, the TSR will not replicate to any players.

You can specify a Parent TSR instead of giving ReplicationTargets and it will inherit the replication targets of the top level TSR.

Optionally, a list of tags can be provided to help identify the TSR. The tags list will become immutable internally after the TSR is created.

EXAMPLE:

-- Some Server Script
local token = TableServerReplicator.newClassToken("PlayerData")

Players.PlayerAdded:Connect(function(player)
    local manager = TableManager.new({
        Money = math.random(1, 100);
    })

    local replicator = TableServerReplicator.new({
        TableManager = manager,
        ClassToken = token,
        ReplicationTargets = "All",
        Tags = {UserId = player.UserId},
    })
end)

-- Some Client Script
TableClientReplicator.listenToNewReplicator("PlayerData", function(replicator)
    print("New PlayerData TSR: ", replicator:GetTag("UserId"))
    print("Money: ", replicator:GetTableManager():Get("Money"))
end)

Top Level Replicators

A replicator must be given either a Parent Replicator or a list of ReplicationTargets. If both are given then it will produce an error.

If you give ReplicationTargets then that Replicator will be known as TopLevel. Only TopLevel Replicators can have their ReplicationTargets manually changed.

If a Parent Replicator is given, the Child Replicator will inherit the replication targets of the Ancestor TopLevel Replicator.

Destroy

</>

TableServerReplicator:Destroy() → ()

Destroys the Replicator on both the Server and any replicated Clients

RegisterRemoteFunction

</>

TableServerReplicator:RegisterRemoteFunction(

fnName: string,

fn: (...any) → ...any

) → ()

IsReplicatingToAll

</>

TableServerReplicator:IsReplicatingToAll() → boolean

Returns whether or not this TSR is replicating to all current and future players.

IsReplicationTarget

</>

TableServerReplicator:IsReplicationTarget(player: Player) → boolean

Checks whether the player is a valid target for replication. Not whether the player is currently being replicated to.

GetReplicationTargets

</>

TableServerReplicator:GetReplicationTargets() → {Player}

Gets the list of Players that this Replicator is attempting to replicate to.

GetActiveReplicationTargets

</>

TableServerReplicator:GetActiveReplicationTargets() → {Player}

Gets the list of Players that this Replicator is currently replicating to. This is different from GetReplicationTargets as it does not include pending replication targets.

SetParent

</>

TableServerReplicator:SetParent(newParent: TableServerReplicator) → ()

Sets the Parent of this TSR to the given TSR.

DestroyFor

</>

TableServerReplicator:DestroyFor(targets: ReplicationTargets) → ()

Removes a player or list of players from the replication targets.

ReplicateFor

</>

TableServerReplicator:ReplicateFor(targets: ReplicationTargets) → ()

Adds a player or list of players to the replication targets.

SetReplicationTargets

</>

TableServerReplicator:SetReplicationTargets(targets: ReplicationTargets) → ()

Overwrites the current replication targets with the new targets.