ServerTableReplicator

This item only works when running on the server. Server

Show Private

ServerTableReplicator 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 STR should replicate to. If "All" is given then the STR will replicate to all current and future players.

ReplicationToken

</>

type ReplicationToken = {Name: string}

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

Properties

AddedActivePlayer

</>

ServerTableReplicator.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

</>

ServerTableReplicator.All: ServerTableReplicator

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

None

</>

ServerTableReplicator.None: ServerTableReplicator

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

Functions

Token

</>

ServerTableReplicator.Token(tokenName: string) → ReplicationToken

Returns a Token Symbol that is used for identifying the ServerTableReplicator Class. We use unique symbols instead of strings to prevent accidental collisions on the server.

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

</>

ServerTableReplicator.new(config: {

Token: ReplicationToken,

TableManager: TableManager,

ReplicationTargets: ReplicationTargets?,

Parent: ServerTableReplicator?,

Tags: {[string]: any}?,

Client: {[string]: any}?,

}) → ()

Creates a new ServerTableReplicator instance. The config must be given a TableManager instance and a Token Symbol.

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

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

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

EXAMPLE:

-- Some Server Script
local token = ServerTableReplicator.Token("PlayerData")

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

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

-- Some Client Script
ClientTableReplicator.onNew("PlayerData", function(replicator)
    print("New PlayerData STR: ", 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

</>

ServerTableReplicator:Destroy() → ()

Destroys the Replicator on both the Server and any replicated Clients

Subscribe

</>

ServerTableReplicator:Subscribe(targets: ReplicationTargets) → ()

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

Unsubscribe

</>

ServerTableReplicator:Unsubscribe(targets: ReplicationTargets) → ()

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

SetSubscribers

</>

ServerTableReplicator:SetSubscribers(targets: ReplicationTargets) → ()

Overwrites the current replication targets with the new targets.

IsSubscribed

</>

ServerTableReplicator:IsSubscribed(player: Player) → boolean

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

IsSubscribedToAll

</>

ServerTableReplicator:IsSubscribedToAll() → boolean

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

GetSubscribers

</>

ServerTableReplicator:GetSubscribers() → {Player}

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

GetActiveSubscribers

</>

ServerTableReplicator:GetActiveSubscribers() → {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

</>

ServerTableReplicator:SetParent(newParent: ServerTableReplicator) → ()

Sets the Parent of this STR to the given STR.