Client
Summary
Properties
| IsReady : boolean |
Methods
| GetReplicate () : ClientReplicate |
Events
| OnReady () : Signal |
Properties
IsReady
Read Only
Returns true if the server-client replication has begun. If true, GetReplicate calls will return the ClientReplicate instantly without yielding.
Client.IsReady ( ) : boolean
Methods
GetReplicate
Can Yield
Client:GetReplicate ( ) : ClientReplicate
Returns
| ClientReplicate The ClientReplicate instance for this client. If IsReady is false, this method will yield until the server-client replication has begun, at which point it will return the ClientReplicate instance. |
local Replicate = require(path.to.Replicate).Client
local clientReplicate = Replicate:GetReplicate()
Unlike other replication modules, Replicate allows the initiation method to be called whenever and as many times as you need in your scripts. Calling GetReplicate the first time will begin the replication process for the LocalPlayer and yield the current thread until the server begins replication after StartReplicating is called. If the replication process has already started on the client and server, this method will return the active ClientReplicate without yielding.
Events
OnReady
Returns a Signal that fires when the server-client replication has begun. If the replication process has already begun, the signal will never fire.
Client.OnReady ( ) : Signal
Returns
| Signal |