Table of Contents

Networking

(NOTE) Network Channel Type. Configures the replication of a set of properties on the network.

Methods Properties Base Classes Derived Classes
ResetConfig AcceptIncomingChanges safeid32object
SetConfig AccurateTimestampOnChange
AllowNapping
AllowRelay
AuthorityDefault
AuthorityMode
AwakeDetectionInterval
AwakeDuration
DetectionMode
DetectOutgoingChanges
EventOnIncomingPropertyChange
EventOnOutgoingPropertyChange
Name
NapDetectionInterval
ReliabilityMode
ReplicateOnOffline
ReplicateOnOnline
SerializationMode
TransferMode

Properties


AcceptIncomingChanges : boolean

Controls whether or not net channels should accept incoming changes.

var AcceptIncomingChanges : Boolean

AccurateTimestampOnChange : boolean

Controls whether or not the net channel will serialize an accurate timestamp value when changed, or will instead accept an estimated timestamp value. (This setting may be overridden for net channels belonging to a specific net object by enabling the corresponding net object setting)

var AccurateTimestampOnChange : Boolean

AllowNapping : boolean

Controls whether or not net channels may nap (perform change detection on longer intervals) if they haven't changed in a while.

var AllowNapping : Boolean

AllowRelay : boolean

Controls whether or not net channels will have their changes immediately broadcast to all relevant, incidental peers (if any) once received. (Enabling this allows a server to automatically relay client authoritative changes to other clients, otherwise this must be done manually using NetChannel::ReplicateNow)

var AllowRelay : Boolean

AuthorityDefault : Authority

Controls which peer has the authority to observe and replicate property changes on each net channel by default. (Client: Indicates both the client and server are allowed to observe and replicate property changes) (Server: Indicates only the server is allowed to observe and replicate property changes) Only a single client, specified by NetObject::NetUserOwnerPeerId, may possess client authority at any given time. The server is still responsible for relaying contained property changes to other clients, but will not replicate contained property changes back to the authority client. However, the server is also still responsible for other replication commands (such as object creation/destruction), and these WILL be replicated to the authority client.

var AuthorityDefault : Authority

AuthorityMode : AuthorityMode

Controls when net channels can modify their change authority. (Dynamic: Authority may be modified at any time, even after a net object is brought online) (Fixed: Authority may be modified only before a net object is brought online) (Cannot be modified at game runtime)

var AuthorityMode : AuthorityMode

AwakeDetectionInterval : integer

Controls the frame interval in which awake net channels are observed for changes. (Cannot be modified at game runtime)

var AwakeDetectionInterval : Integer

AwakeDuration : integer

Controls the frame duration following the last detected change in which net channels are considered actively changing and will be kept awake.

var AwakeDuration : Integer

DetectionMode : DetectionMode

Controls how net channel changes are detected. (Assume: Assumes something has changed) (Manual: Detects changes manually using change flags) (Automatic: Detects changes automatically using comparisons) (Manumatic: Detects changes manually using change flags and automatically using comparisons)

var DetectionMode : DetectionMode

DetectOutgoingChanges : boolean

Controls whether or not net channels should detect outgoing changes.

var DetectOutgoingChanges : Boolean

EventOnIncomingPropertyChange : boolean

Controls whether or not net channels should dispatch NetChannelIncomingPropertyChange when an incoming net property change is accepted.

var EventOnIncomingPropertyChange : Boolean

EventOnOutgoingPropertyChange : boolean

Controls whether or not net channels should dispatch NetChannelOutgoingPropertyChange when an outgoing net property change is detected.

var EventOnOutgoingPropertyChange : Boolean

Name : string

read-only

Net channel type name.

var Name : String

NapDetectionInterval : integer

Controls the frame interval in which napping net channels are observed for changes. (Cannot be modified at game runtime)

var NapDetectionInterval : Integer

ReliabilityMode : ReliabilityMode

Controls whether or not net channel changes will be retransmitted should they get lost over the network. (Unreliable: Lost changes are not retransmitted) (Reliable: Lost changes are retransmitted)

var ReliabilityMode : ReliabilityMode

ReplicateOnOffline : boolean

Controls whether or not the net channel will be replicated when the net object goes offline. If enabled, all net channel property values are guaranteed to be set immediately before the NetObjectOffline event. (Cannot be modified at game runtime)

var ReplicateOnOffline : Boolean

ReplicateOnOnline : boolean

Controls whether or not the net channel will be replicated when the net object comes online. If enabled, all net channel property values are guaranteed to be set immediately before the NetObjectOnline event. (Cannot be modified at game runtime)

var ReplicateOnOnline : Boolean

SerializationMode : SerializationMode

Controls how net channels are serialized. (All: Serialize all net properties) (Changed: Serialize only net properties that have changed, using bit flags in between) (Cannot be modified at game runtime)

var SerializationMode : SerializationMode

TransferMode : TransferMode

Controls how net channel changes are to be ordered and released once received. (Immediate: Changes are released immediately once received, including late changes) (Sequenced: Changes are released immediately once received, discarding late changes) (Ordered: Changes are released immediately once preceding late changes have been received; forces all changes to be sent reliably) (Cannot be modified at game runtime)

var TransferMode : TransferMode

Methods


ResetConfig : Void

Resets all configuration settings. |Name|Type|Description| |---|---|---|

function ResetConfig()

SetConfig : Void

Sets all configuration settings according to the specified NetChannelConfig resource. |Name|Type|Description| |---|---|---| |netChannelConfig|netchannelconfig| |

function SetConfig(netChannelConfig : NetChannelConfig)