NetworkReplicator
An object which handles the replication of other objects either from the server to the client, or from the client to the server.
This class is not replicated. Its interface does not cross the network boundary.
This class is not creatable. Instances of this class cannot be created with Instance.new.
| Memory category | Instances |
|---|
Member index 1
Removed member index 11
| History | Member | |
|---|---|---|
| 310 | MachineAddress: string | |
| 310 | Port: int | |
| 438 | CloseConnection(): void | |
| 287 | DisableProcessPackets(): void | |
| 287 | EnableProcessPackets(): void | |
| 438 | GetRakStatsString(verbosityLevel: int = 0): string | |
| 310 | RequestCharacter(): void | |
| 310 | SendMarker(): Instance | |
| 287 | SetPropSyncExpiration(seconds: double): void | |
| 310 | Disconnection(peer: string, lostConnection: bool, reason: string) | |
| 202 | StatsReceived(stats: Dictionary) |
Description
Each NetworkReplicator corresponds to a single network connection between
two peers and serializes, transmits, receives, and applies the stream of data
model changes (new instances, property and attribute changes, event
invocations, and instance removals) that keeps those peers in sync. It is the
base class for the two concrete replicators: a ServerReplicator runs
on the server and replicates between the server and the connected client,
while a ClientReplicator runs on a client and replicates between that
client and the server. A NetworkReplicator is created and managed by the
engine automatically as clients connect and disconnect, and is not
instantiated or manipulated by creator scripts.
History 46
- 462 Change ThreadSafety of GetPlayer from to Unsafe
- 438 Remove GetRakStatsString
- 438 Remove CloseConnection
- 310 Remove Disconnection
- 310 Remove SendMarker
- 310 Remove RequestCharacter
- 310 Remove Port
- 310 Remove MachineAddress
- 287 Remove SetPropSyncExpiration
- 287 Remove EnableProcessPackets
- 287 Remove DisableProcessPackets
- 285 Add SetPropSyncExpiration
- 285 Add EnableProcessPackets
- 285 Add DisableProcessPackets
- 286 Remove SetPropSyncExpiration
- 286 Remove EnableProcessPackets
- 286 Remove DisableProcessPackets
- 285 Add SetPropSyncExpiration
- 285 Add EnableProcessPackets
- 285 Add DisableProcessPackets
- 286 Remove SetPropSyncExpiration
- 286 Remove EnableProcessPackets
- 286 Remove DisableProcessPackets
- 262 Change Parameters of Disconnection from (peer: string, lostConnection: bool) to (peer: string, lostConnection: bool, reason: string)
- 202 Remove StatsReceived
- 157 Add StatsReceived
- 152 Change Security of GetRakStatsString from LocalUserSecurity to PluginSecurity
- 98 Change Security of Disconnection from None to LocalUserSecurity
- 83 Change Security of SendMarker from RobloxScriptSecurity to LocalUserSecurity
- 83 Change Security of GetRakStatsString from RobloxScriptSecurity to LocalUserSecurity
- 61 Change Security of GetPlayer from RobloxScriptSecurity to None
- 49 Change Security of SendMarker from LocalUserSecurity to RobloxScriptSecurity
- 49 Change Security of GetRakStatsString from LocalUserSecurity to RobloxScriptSecurity
- 49 Change Security of GetPlayer from LocalUserSecurity to RobloxScriptSecurity
- 47 Add Disconnection
- 47 Add SetPropSyncExpiration
- 47 Add SendMarker
- 47 Add RequestCharacter
- 47 Add GetRakStatsString
- 47 Add GetPlayer
- 47 Add EnableProcessPackets
- 47 Add DisableProcessPackets
- 47 Add CloseConnection
- 47 Add Port
- 47 Add MachineAddress
- 47 Add NetworkReplicator
Members 1
GetPlayer
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| Instance | ||
Returns the Player associated with the connection that this
NetworkReplicator serves. On a ServerReplicator, this is the
remote client's player; on a ClientReplicator it is the local
player. Returns nil if the replicator has no target player, such as
before the connection has been assigned a player or after it has been torn
down.
| Thread safety | Unsafe |
|---|
Removed members 11
CloseConnection
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| void | ||
| Security | LocalUserSecurity |
|---|
History 2
- 438 Remove CloseConnection
- 47 Add CloseConnection
DisableProcessPackets
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| void | ||
| Security | LocalUserSecurity |
|---|
History 6
- 287 Remove DisableProcessPackets
- 285 Add DisableProcessPackets
- 286 Remove DisableProcessPackets
- 285 Add DisableProcessPackets
- 286 Remove DisableProcessPackets
- 47 Add DisableProcessPackets
Disconnection
| Parameters (3) | |
|---|---|
| peer | string |
| lostConnection | bool |
| reason | string |
| Security | LocalUserSecurity |
|---|
History 4
- 310 Remove Disconnection
- 262 Change Parameters of Disconnection from (peer: string, lostConnection: bool) to (peer: string, lostConnection: bool, reason: string)
- 98 Change Security of Disconnection from None to LocalUserSecurity
- 47 Add Disconnection
EnableProcessPackets
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| void | ||
| Security | LocalUserSecurity |
|---|
History 6
- 287 Remove EnableProcessPackets
- 285 Add EnableProcessPackets
- 286 Remove EnableProcessPackets
- 285 Add EnableProcessPackets
- 286 Remove EnableProcessPackets
- 47 Add EnableProcessPackets
GetRakStatsString
| Parameters (1) | Default | |
|---|---|---|
| verbosityLevel | int | 0 |
| Returns (1) | ||
| string | ||
| Security | PluginSecurity |
|---|
History 5
- 438 Remove GetRakStatsString
- 152 Change Security of GetRakStatsString from LocalUserSecurity to PluginSecurity
- 83 Change Security of GetRakStatsString from RobloxScriptSecurity to LocalUserSecurity
- 49 Change Security of GetRakStatsString from LocalUserSecurity to RobloxScriptSecurity
- 47 Add GetRakStatsString
MachineAddress
| Type | Default | |
|---|---|---|
| string | ||
This property is read-only. Its value can be read, but it cannot be modified.
| Security | LocalUserSecurity |
|---|---|
| Category | |
| Loaded/Saved | false |
History 2
- 310 Remove MachineAddress
- 47 Add MachineAddress
Port
| Type | Default | |
|---|---|---|
| int | ||
This property is read-only. Its value can be read, but it cannot be modified.
| Security | LocalUserSecurity |
|---|---|
| Category | |
| Loaded/Saved | false |
RequestCharacter
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| void | ||
| Security | LocalUserSecurity |
|---|
History 2
- 310 Remove RequestCharacter
- 47 Add RequestCharacter
SendMarker
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| Instance | ||
| Security | LocalUserSecurity |
|---|
History 4
- 310 Remove SendMarker
- 83 Change Security of SendMarker from RobloxScriptSecurity to LocalUserSecurity
- 49 Change Security of SendMarker from LocalUserSecurity to RobloxScriptSecurity
- 47 Add SendMarker
SetPropSyncExpiration
| Parameters (1) | ||
|---|---|---|
| seconds | double | |
| Returns (1) | ||
| void | ||
| Security | LocalUserSecurity |
|---|
History 6
- 287 Remove SetPropSyncExpiration
- 285 Add SetPropSyncExpiration
- 286 Remove SetPropSyncExpiration
- 285 Add SetPropSyncExpiration
- 286 Remove SetPropSyncExpiration
- 47 Add SetPropSyncExpiration
StatsReceived
| Parameters (1) | |
|---|---|
| stats | Dictionary |
| Security | RobloxScriptSecurity |
|---|
History 2
- 202 Remove StatsReceived
- 157 Add StatsReceived