Table of Contents

Component Networking

(NOTE) Network User. Manages the replication of a single negotiated user on the network.

Methods Properties Base Classes Derived Classes
AddedByPeer AddedByMyPeer netobject
FindOwnedNetObjectByName NetPeerId
FindOwnedNetObjectByNameInSpace NetUserId
Constructor OwnedNetObjectCount
ReleaseOwnedNetObjects OwnedNetObjects

Properties


AddedByMyPeer : boolean

read-only

var AddedByMyPeer : Boolean

NetPeerId : integer

read-only

Adding network peer identifier.

var NetPeerId : Integer

NetUserId : integer

read-only

Network user identifier.

var NetUserId : Integer

OwnedNetObjectCount : integer

read-only

Returns the number of net objects owned by this user in all spaces.

var OwnedNetObjectCount : Integer

OwnedNetObjects : coghashsetrange

read-only

Returns all net objects owned by this user in all spaces.

var OwnedNetObjects : CogHashSetRange

Methods


AddedByPeer : boolean

Returns true if the user was added by the specified peer, else false. |Name|Type|Description| |---|---|---| |netPeerId|integer| |

function AddedByPeer(netPeerId : Integer) : Boolean

FindOwnedNetObjectByName : cog

Finds a net object with the given name owned by this user in any space, else nullptr. |Name|Type|Description| |---|---|---| |name|string| |

function FindOwnedNetObjectByName(name : String) : Cog

FindOwnedNetObjectByNameInSpace : cog

Finds a net object with the given name owned by this user in the specified space, else nullptr. |Name|Type|Description| |---|---|---| |name|string| | |space|space| |

function FindOwnedNetObjectByNameInSpace(name : String, space : Space) : Cog

NetUser : Void

constructor

Constructor. |Name|Type|Description| |---|---|---|

function NetUser()

ReleaseOwnedNetObjects : Void

[Server/Offline] Releases ownership of all net objects owned by this user in all spaces. |Name|Type|Description| |---|---|---|

function ReleaseOwnedNetObjects()