Component Networking
(NOTE) Network Object. Manages the replication of a single object on the network.
Properties
AcceptIncomingChanges : boolean
Controls whether or not net channels on this net object may accept incoming changes.
var AcceptIncomingChanges : Boolean
AccurateTimestampOnChange : boolean
Controls whether or not the net object will serialize an accurate timestamp value when changed (on any net channel), or will instead accept an estimated timestamp value. (Enabling this will override the corresponding net channel type setting for all net channels added to this net object)
var AccurateTimestampOnChange : Boolean
AccurateTimestampOnOffline : boolean
Controls whether or not the net object will serialize an accurate timestamp value when taken offline, or will instead accept an estimated timestamp value.
var AccurateTimestampOnOffline : Boolean
AccurateTimestampOnOnline : boolean
Controls whether or not the net object will serialize an accurate timestamp value when brought online, or will instead accept an estimated timestamp value.
var AccurateTimestampOnOnline : Boolean
AllowNapping : boolean
Controls whether or not net channels on this net object may nap (perform change detection on longer intervals) if they haven't changed in a while.
var AllowNapping : Boolean
AutomaticChannel : netchannelconfig
Returns the automatic net channel configuration resource (assigned to net properties unless another channel is specified).
var AutomaticChannel : NetChannelConfig
DetectOutgoingChanges : boolean
Controls whether or not net channels on this net object may detect outgoing changes.
var DetectOutgoingChanges : Boolean
IsClient : boolean
read-only
Returns true if our open peer's network role is client, else false.
var IsClient : Boolean
IsClientAndMine : boolean
read-only
Returns true if our open peer's network role is client and the net object is conceptually owned by a user added by our local peer, else false.
var IsClientAndMine : Boolean
IsClientButNotMine : boolean
read-only
Returns true if our open peer's network role is client and the net object is not conceptually owned by a user added by our local peer, else false.
var IsClientButNotMine : Boolean
IsClientOrOffline : boolean
read-only
Returns true if our open peer's network role is client or offline, else false.
var IsClientOrOffline : Boolean
IsClientOrServer : boolean
read-only
Returns true if our open peer's network role is client or server, else false.
var IsClientOrServer : Boolean
IsMine : boolean
read-only
Returns true if the net object is conceptually owned by a user added by our local peer, else false.
var IsMine : Boolean
IsNapping : boolean
read-only
Returns true if all net channels on this net object are napping (performing change detection on longer intervals), else false.
var IsNapping : Boolean
IsNotMine : boolean
read-only
Returns true if the net object is not conceptually owned by a user added by our local peer, else false.
var IsNotMine : Boolean
IsNotOwnedByAUser : boolean
read-only
Returns true if the net object is not conceptually owned by a user, else false.
var IsNotOwnedByAUser : Boolean
IsOffline : boolean
read-only
Returns true if our open peer's network role is offline, else false.
var IsOffline : Boolean
IsOfflineAndMine : boolean
read-only
Returns true if our open peer's network role is offline and the net object is conceptually owned by a user added by our local peer, else false.
var IsOfflineAndMine : Boolean
IsOfflineButNotMine : boolean
read-only
Returns true if our open peer's network role is offline and the net object is not conceptually owned by a user added by our local peer, else false.
var IsOfflineButNotMine : Boolean
IsOnline : boolean
read-only
Returns true if the net object is online, else false.
var IsOnline : Boolean
IsOwnedByAUser : boolean
read-only
Returns true if the net object is conceptually owned by a user, else false.
var IsOwnedByAUser : Boolean
IsServer : boolean
read-only
Returns true if our open peer's network role is server, else false.
var IsServer : Boolean
IsServerAndMine : boolean
read-only
Returns true if our open peer's network role is server and the net object is conceptually owned by a user added by our local peer, else false.
var IsServerAndMine : Boolean
IsServerButNotMine : boolean
read-only
Returns true if our open peer's network role is server and the net object is not conceptually owned by a user added by our local peer, else false.
var IsServerButNotMine : Boolean
IsServerOrOffline : boolean
read-only
Returns true if our open peer's network role is server or offline, else false.
var IsServerOrOffline : Boolean
LastChangeTimePassed : real
read-only
Elapsed time passed since this net object was last changed, else 0.
var LastChangeTimePassed : Real
LastChangeTimestamp : real
read-only
Timestamp indicating when this net object was last changed, else 0.
var LastChangeTimestamp : Real
NetObjectId : integer
read-only
Returns the net object ID (set if the net object is live), else 0.
var NetObjectId : Integer
NetPropertyInfos : netpropertyinfos
Net property infos added through the property grid.
var NetPropertyInfos : NetPropertyInfos
NetUserOwner : cog
Returns the network user this object conceptually belongs to, else nullptr.
var NetUserOwner : Cog
NetUserOwnerPath : cogpath
read-only
Path to the network user this object conceptually belongs to, else empty cog path.
var NetUserOwnerPath : CogPath
NetUserOwnerPeerId : integer
read-only
Returns the network peer identifier of the peer who added the user this object conceptually belongs to, else 0.
var NetUserOwnerPeerId : Integer
NetUserOwnerUserId : integer
read-only
Returns the network user identifier of the user this object conceptually belongs to, else 0.
var NetUserOwnerUserId : Integer
OfflineTimePassed : real
read-only
Elapsed time passed since this net object was taken offline, else 0.
var OfflineTimePassed : Real
OfflineTimestamp : real
read-only
Timestamp indicating when this net object was taken offline, else 0.
var OfflineTimestamp : Real
OnlineTimePassed : real
read-only
Elapsed time passed since this net object was brought online, else 0.
var OnlineTimePassed : Real
OnlineTimestamp : real
read-only
Timestamp indicating when this net object was brought online, else 0.
var OnlineTimestamp : Real
Role : NetRole
read-only
Returns our open peer's network role (client, server, offline), else Role::Unspecified.
var Role : NetRole
Methods
DispatchBroadcast : Void
Dispatches the net event on the net object for all remote peers. In Offline mode, this calls DispatchLocal only. |Name|Type|Description| |---|---|---| |eventId|string| | |event|event| |
function DispatchBroadcast(eventId : String, event : Event)
DispatchLocal : Void
Dispatches the net event on the net object for the local peer. |Name|Type|Description| |---|---|---| |eventId|string| | |event|event| |
function DispatchLocal(eventId : String, event : Event)
DispatchLocalAndBroadcast : Void
Dispatches the net event on the net object for the local peer and for all remote peers. In Offline mode, this calls DispatchLocal only. |Name|Type|Description| |---|---|---| |eventId|string| | |event|event| |
function DispatchLocalAndBroadcast(eventId : String, event : Event)
DispatchLocalAndRemote : Void
Dispatches the net event on the net object for the local peer and for the remote peer. In Offline mode, this calls DispatchLocal only. |Name|Type|Description| |---|---|---| |eventId|string| | |event|event| | |netPeerId|integer| |
function DispatchLocalAndRemote(eventId : String, event : Event, netPeerId : Integer)
DispatchRemote : Void
Dispatches the net event on the net object for the remote peer. In Offline mode, this calls DispatchLocal only. |Name|Type|Description| |---|---|---| |eventId|string| | |event|event| | |netPeerId|integer| |
function DispatchRemote(eventId : String, event : Event, netPeerId : Integer)
Forget : boolean
[Client] Forgets the online net object locally. [Server] Forgets the online net object locally and remotely for all relevant peers. Effectively removes the net object from the network system without destroying it. Returns true if successful, else false. |Name|Type|Description| |---|---|---|
function Forget() : Boolean
GetNetChannel : netchannel
[Client/Server] Returns the specified net channel, else nullptr. |Name|Type|Description| |---|---|---| |netChannelName|string| |
function GetNetChannel(netChannelName : String) : NetChannel
HasNetChannel : boolean
[Client/Server] Returns true if the net object has the specified net channel, else false. |Name|Type|Description| |---|---|---| |netChannelName|string| |
function HasNetChannel(netChannelName : String) : Boolean
IsOwnedByPeer : boolean
Returns true if the net object is conceptually owned by a user added by the specified peer, else false. |Name|Type|Description| |---|---|---| |netPeerId|integer| |
function IsOwnedByPeer(netPeerId : Integer) : Boolean
IsOwnedByUser : boolean
Returns true if the net object is conceptually owned by the specified user, else false. |Name|Type|Description| |---|---|---| |cog|cog| |
function IsOwnedByUser(cog : Cog) : Boolean
NetObject : Void
constructor
Constructor. |Name|Type|Description| |---|---|---|
function NetObject()
ReplicateNow : boolean
[Client/Server] Replicates all net channels' property changes immediately (only where changes are detected). Will also update nap state as configured. Returns true if changes were replicated, else false. |Name|Type|Description| |---|---|---|
function ReplicateNow() : Boolean
SelectRemote : boolean
[Client/Server] Selects the remote net object on the first opposite-role peer found running in another game session instance on the engine. Will fail if the net object is not online, or not found remotely. Returns true if successful, else false. |Name|Type|Description| |---|---|---|
function SelectRemote() : Boolean
SetNetUserOwnerDown : Void
[Server/Offline] Sets the owning network user on this object and down the tree on all children recursively (pre-order traversal). |Name|Type|Description| |---|---|---| |cog|cog| |
function SetNetUserOwnerDown(cog : Cog)
SetNetUserOwnerUp : Void
[Server/Offline] Sets the owning network user on this object and up the tree on each parent recursively (pre-order traversal). |Name|Type|Description| |---|---|---| |cog|cog| |
function SetNetUserOwnerUp(cog : Cog)
TakeNap : Void
Forces all net channels on this net object to start napping immediately. |Name|Type|Description| |---|---|---|
function TakeNap()
WakeUp : Void
Forces all net channels on this net object to stop napping immediately. |Name|Type|Description| |---|---|---|
function WakeUp()