Networking
(NOTE) Network Channel. Manages the replication of a set of properties on the network.
Methods | Properties | Base Classes | Derived Classes |
---|---|---|---|
GetNetProperty | Authority | safeid32object | |
HasNetProperty | ChangeFlag | ||
ReplicateNow | IsNapping | ||
TakeNap | IsScheduled | ||
WakeUp | LastChangeTimePassed | ||
LastChangeTimestamp | |||
Name | |||
NetChannelType |
Properties
Authority : Authority
Controls which peer has the authority to observe and replicate property changes. (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 Authority : Authority
ChangeFlag : boolean
Manual change flag (checked upon manual change observation).
var ChangeFlag : Boolean
IsNapping : boolean
read-only
Returns true if the net channel is currently napping (performing change detection on longer intervals), else false.
var IsNapping : Boolean
IsScheduled : boolean
read-only
Returns true if this net channel is scheduled for change observation, else false.
var IsScheduled : Boolean
LastChangeTimePassed : real
read-only
Elapsed time passed since this net channel was last changed, else 0.
var LastChangeTimePassed : Real
LastChangeTimestamp : real
read-only
Timestamp indicating when this net channel was last changed, else 0.
var LastChangeTimestamp : Real
Name : string
read-only
Net channel name.
var Name : String
NetChannelType : netchanneltype
read-only
Operating net channel type.
var NetChannelType : NetChannelType
Methods
GetNetProperty : netproperty
[Client/Server] Returns the specified net property, else nullptr. |Name|Type|Description| |---|---|---| |component|component| | |propertyName|string| |
function GetNetProperty(component : Component, propertyName : String) : NetProperty
HasNetProperty : boolean
[Client/Server] Returns true if the net object has the specified net property, else false. |Name|Type|Description| |---|---|---| |component|component| | |propertyName|string| |
function HasNetProperty(component : Component, propertyName : String) : Boolean
ReplicateNow : boolean
Replicates net property changes immediately (only if changes are detected). Will also update nap state as configured. Returns true if changes were replicated, else false. |Name|Type|Description| |---|---|---|
function ReplicateNow() : Boolean
TakeNap : Void
Forces the net channel to start napping immediately. |Name|Type|Description| |---|---|---|
function TakeNap()
WakeUp : Void
Forces the net channel to stop napping immediately. |Name|Type|Description| |---|---|---|
function WakeUp()