AtomicNET : AtomicEngine Namespace

Connection Class

%Connection to a remote network host.

Syntax

public class Connection : AObject

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Members

See Also: Inherited members from AObject.

Public Constructors

Documentation for this section has not yet been entered.
Documentation for this section has not yet been entered.

Public Fields

nativeInstance IntPtr . Documentation for this section has not yet been entered. (Inherited from RefCounted.)

Public Properties

[read-only]
Address string . Documentation for this section has not yet been entered.
[read-only]
BytesInPerSec float . Documentation for this section has not yet been entered.
[read-only]
BytesOutPerSec float . Documentation for this section has not yet been entered.
[read-only]
Category string . Documentation for this section has not yet been entered. (Inherited from AObject.)
[read-only]
Client bool . Documentation for this section has not yet been entered.
[read-only]
Connected bool . Documentation for this section has not yet been entered.
ConnectPending bool . Documentation for this section has not yet been entered.
[read-only]
Context Context . Documentation for this section has not yet been entered. (Inherited from AObject.)
[read-only]
DownloadName string . Documentation for this section has not yet been entered.
[read-only]
DownloadProgress float . Documentation for this section has not yet been entered.
[read-only]
EventSender AObject . Documentation for this section has not yet been entered. (Inherited from AObject.)
InstantiationType InstantiationType . Documentation for this section has not yet been entered. (Inherited from RefCounted.)
[read-only]
LastHeardTime float . Documentation for this section has not yet been entered.
LogStatistics bool . Documentation for this section has not yet been entered.
[read-only]
NativeInstance IntPtr . Documentation for this section has not yet been entered. (Inherited from RefCounted.)
[read-only]
NumDownloads uint . Documentation for this section has not yet been entered.
[read-only]
PacketsInPerSec float . Documentation for this section has not yet been entered.
[read-only]
PacketsOutPerSec float . Documentation for this section has not yet been entered.
[read-only]
Port ushort . Documentation for this section has not yet been entered.
Position Vector3 . Documentation for this section has not yet been entered.
Rotation Quaternion . Documentation for this section has not yet been entered.
[read-only]
RoundTripTime float . Documentation for this section has not yet been entered.
Scene Scene . Documentation for this section has not yet been entered.
[read-only]
SceneLoaded bool . Documentation for this section has not yet been entered.
[read-only]
TimeStamp byte . Documentation for this section has not yet been entered.
[read-only]
TypeName string . Documentation for this section has not yet been entered. (Inherited from AObject.)
[read-only]
TypeName string . Documentation for this section has not yet been entered. (Inherited from RefCounted.)
[read-only]
TypeNameStatic string . Documentation for this section has not yet been entered. (Inherited from AObject.)

Public Methods

AddRef ()
Increment reference count. Can also be called outside of a SharedPtr for traditional reference counting. (Inherited from RefCounted.)
AddRefSilent ()
Increment reference count. Do not call any lifetime book keeping (Inherited from RefCounted.)
ConfigureNetworkSimulator (int, float)
Set network simulation parameters. Called by Network.
static
csb_Atomic_Connection_GetClassIDStatic () : IntPtr
Documentation for this section has not yet been entered.
Disconnect (int)
Disconnect. If wait time is non-zero, will block while waiting for disconnect to finish.
GetAddress () : string
Return remote address.
GetBytesInPerSec () : float
Return bytes received per second.
GetBytesOutPerSec () : float
Return bytes sent per second.
GetCategory () : string
Return object category. Categories are (optionally) registered along with the object factory. Return an empty string if the object category is not registered. (Inherited from AObject.)
GetContext () : Context
Return execution context. (Inherited from AObject.)
GetControlDataInt (string) : int
Documentation for this section has not yet been entered.
GetDownloadName () : string
Return name of current package download, or empty if no downloads.
GetDownloadProgress () : float
Return progress of current package download, or 1.0 if no downloads.
GetEventSender () : AObject
Return active event sender. Null outside event handling. (Inherited from AObject.)
GetInstantiationType () : InstantiationType
Documentation for this section has not yet been entered. (Inherited from RefCounted.)
GetLastHeardTime () : float
Return the time since last received data from the remote host in milliseconds.
GetLogStatistics () : bool
Return whether to log data in/out statistics.
GetNumDownloads () : uint
Return number of package downloads remaining.
GetPacketsInPerSec () : float
Return packets received per second.
GetPacketsOutPerSec () : float
Return packets sent per second.
GetPort () : ushort
Return remote port.
GetPosition () : Vector3
Return the observer position sent by the client for interest management.
GetRotation () : Quaternion
Return the observer rotation sent by the client for interest management.
GetRoundTripTime () : float
Return the connection's round trip time in milliseconds.
GetScene () : Scene
Return the scene used by this connection.
GetSubsystem (StringHash) : AObject
Return subsystem by type. (Inherited from AObject.)
GetTimeStamp () : byte
Return the controls timestamp, sent from client to server along each control update.
override
GetTypeName () : string
Return type name. (Inherited from AObject.)
GetTypeName () : string
Documentation for this section has not yet been entered. (Inherited from RefCounted.)
HasEventHandlers () : bool
Return whether has subscribed to any event. (Inherited from AObject.)
HasSubscribedToEvent (StringHash) : bool
Return whether has subscribed to an event without specific sender. (Inherited from AObject.)
HasSubscribedToEvent (AObject, StringHash) : bool
Return whether has subscribed to a specific sender's event. (Inherited from AObject.)
IsClient () : bool
Return whether is a client connection.
IsConnected () : bool
Return whether is fully connected.
IsConnectPending () : bool
Return whether connection is pending.
IsControlButtonDown (uint) : bool
Check if a button is held down.
IsInstanceOf (StringHash) : bool
Check current instance is type of specified type. (Inherited from AObject.)
override
IsObject () : bool
Documentation for this section has not yet been entered. (Inherited from AObject.)
IsObject () : bool
Documentation for this section has not yet been entered. (Inherited from RefCounted.)
IsSceneLoaded () : bool
Return whether the scene is loaded and ready to receive server updates.
ProcessPendingLatestData ()
Process pending latest data for nodes and components.
Refs () : int
Return reference count. (Inherited from RefCounted.)
ReleaseRef ()
Decrement reference count and delete self if no more references. Can also be called outside of a SharedPtr for traditional reference counting. (Inherited from RefCounted.)
SendClientUpdate ()
Send latest controls from the client. Called by Network.
SendEvent (string, ScriptVariantMap)
Documentation for this section has not yet been entered. (Inherited from AObject.)
SendPackages ()
Send package files to client. Called by network.
SendPackageToClient (PackageFile)
Trigger client connection to download a package file from the server. Can be used to download additional resource packages when client is already joined in a scene. The package must have been added as a requirement to the scene the client is joined in, or else the eventual download will fail.
SendRemoteEvent (StringHash, bool)
Send a remote event.
SendRemoteEvent (Node, StringHash, bool)
Send a remote event with the specified node as sender.
SendRemoteEvents ()
Send queued remote events. Called by Network.
SendServerUpdate ()
Send scene update messages. Called by Network.
SendStringMessage (string)
Send a message.
SetConnectPending (bool)
Set the connection pending status. Called by Network.
SetControlButtons (uint, bool)
Expose control methods for current controls
SetControlDataInt (string, int)
Documentation for this section has not yet been entered.
SetInstantiationType (InstantiationType)
Documentation for this section has not yet been entered. (Inherited from RefCounted.)
SetLogStatistics (bool)
Set whether to log data in/out statistics.
SetPosition (Vector3)
Set the observer position for interest management, to be sent to the server.
SetRotation (Quaternion)
Set the observer rotation for interest management, to be sent to the server. Note: not used by the NetworkPriority component.
SetScene (Scene)
Assign scene. On the server, this will cause the client to load it.
SubscribeToEvent (string, EventDelegate)
Documentation for this section has not yet been entered. (Inherited from AObject.)
SubscribeToEvent (uint, EventDelegate)
Documentation for this section has not yet been entered. (Inherited from AObject.)
SubscribeToEvent (AObject, string, EventDelegate)
Documentation for this section has not yet been entered. (Inherited from AObject.)
SubscribeToEvent (AObject, uint, EventDelegate)
Documentation for this section has not yet been entered. (Inherited from AObject.)
SubscribeToEvent<T> (NativeEventDelegate<T>)
Documentation for this section has not yet been entered. (Inherited from AObject.)
SubscribeToEvent<T> (AObject, NativeEventDelegate<T>)
Documentation for this section has not yet been entered. (Inherited from AObject.)
ToString () : string
Return an address:port string.
UnsubscribeFromAllEvents ()
Documentation for this section has not yet been entered. (Inherited from AObject.)
UnsubscribeFromEvent (StringHash)
Unsubscribe from an event. (Inherited from AObject.)
UnsubscribeFromEvent (uint)
Documentation for this section has not yet been entered. (Inherited from AObject.)
UnsubscribeFromEvent (AObject, StringHash)
Unsubscribe from a specific sender's event. (Inherited from AObject.)
UnsubscribeFromEvent<T> ()
Documentation for this section has not yet been entered. (Inherited from AObject.)
UnsubscribeFromEventReceiver (AObject)
Unsubscribe from event for specific receiver (where the event handler isn't necessarily in the subscribed object) (Inherited from AObject.)
UnsubscribeFromEvents (AObject)
Unsubscribe from a specific sender's events. (Inherited from AObject.)
WeakRefs () : int
Return weak reference count. (Inherited from RefCounted.)

Member Details

Connection Constructor

Documentation for this section has not yet been entered.

Syntax

public Connection ()

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Connection Constructor

Documentation for this section has not yet been entered.

Syntax

public Connection (IntPtr native)

Parameters

native
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Address Property

Documentation for this section has not yet been entered.

Syntax

public string Address { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

BytesInPerSec Property

Documentation for this section has not yet been entered.

Syntax

public float BytesInPerSec { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

BytesOutPerSec Property

Documentation for this section has not yet been entered.

Syntax

public float BytesOutPerSec { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Client Property

Documentation for this section has not yet been entered.

Syntax

public bool Client { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

ConfigureNetworkSimulator Method

Set network simulation parameters. Called by Network.

Syntax

public void ConfigureNetworkSimulator (int latencyMs, float packetLoss)

Parameters

latencyMs
Documentation for this section has not yet been entered.
packetLoss
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Connected Property

Documentation for this section has not yet been entered.

Syntax

public bool Connected { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

ConnectPending Property

Documentation for this section has not yet been entered.

Syntax

public bool ConnectPending { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

csb_Atomic_Connection_GetClassIDStatic Method

Documentation for this section has not yet been entered.

Syntax

public static IntPtr csb_Atomic_Connection_GetClassIDStatic ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Disconnect Method

Disconnect. If wait time is non-zero, will block while waiting for disconnect to finish.

Syntax

public void Disconnect (int waitMSec)

Parameters

waitMSec
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

DownloadName Property

Documentation for this section has not yet been entered.

Syntax

public string DownloadName { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

DownloadProgress Property

Documentation for this section has not yet been entered.

Syntax

public float DownloadProgress { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetAddress Method

Return remote address.

Syntax

public string GetAddress ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetBytesInPerSec Method

Return bytes received per second.

Syntax

public float GetBytesInPerSec ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetBytesOutPerSec Method

Return bytes sent per second.

Syntax

public float GetBytesOutPerSec ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetControlDataInt Method

Documentation for this section has not yet been entered.

Syntax

public int GetControlDataInt (string key)

Parameters

key
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetDownloadName Method

Return name of current package download, or empty if no downloads.

Syntax

public string GetDownloadName ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetDownloadProgress Method

Return progress of current package download, or 1.0 if no downloads.

Syntax

public float GetDownloadProgress ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetLastHeardTime Method

Return the time since last received data from the remote host in milliseconds.

Syntax

public float GetLastHeardTime ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetLogStatistics Method

Return whether to log data in/out statistics.

Syntax

public bool GetLogStatistics ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetNumDownloads Method

Return number of package downloads remaining.

Syntax

public uint GetNumDownloads ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetPacketsInPerSec Method

Return packets received per second.

Syntax

public float GetPacketsInPerSec ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetPacketsOutPerSec Method

Return packets sent per second.

Syntax

public float GetPacketsOutPerSec ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetPort Method

Return remote port.

Syntax

public ushort GetPort ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetPosition Method

Return the observer position sent by the client for interest management.

Syntax

public Vector3 GetPosition ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetRotation Method

Return the observer rotation sent by the client for interest management.

Syntax

public Quaternion GetRotation ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetRoundTripTime Method

Return the connection's round trip time in milliseconds.

Syntax

public float GetRoundTripTime ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetScene Method

Return the scene used by this connection.

Syntax

public Scene GetScene ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetTimeStamp Method

Return the controls timestamp, sent from client to server along each control update.

Syntax

public byte GetTimeStamp ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

IsClient Method

Return whether is a client connection.

Syntax

public bool IsClient ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

IsConnected Method

Return whether is fully connected.

Syntax

public bool IsConnected ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

IsConnectPending Method

Return whether connection is pending.

Syntax

public bool IsConnectPending ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

IsControlButtonDown Method

Check if a button is held down.

Syntax

public bool IsControlButtonDown (uint button)

Parameters

button
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

IsSceneLoaded Method

Return whether the scene is loaded and ready to receive server updates.

Syntax

public bool IsSceneLoaded ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

LastHeardTime Property

Documentation for this section has not yet been entered.

Syntax

public float LastHeardTime { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

LogStatistics Property

Documentation for this section has not yet been entered.

Syntax

public bool LogStatistics { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

NumDownloads Property

Documentation for this section has not yet been entered.

Syntax

public uint NumDownloads { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

PacketsInPerSec Property

Documentation for this section has not yet been entered.

Syntax

public float PacketsInPerSec { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

PacketsOutPerSec Property

Documentation for this section has not yet been entered.

Syntax

public float PacketsOutPerSec { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Port Property

Documentation for this section has not yet been entered.

Syntax

public ushort Port { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Position Property

Documentation for this section has not yet been entered.

Syntax

public Vector3 Position { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

ProcessPendingLatestData Method

Process pending latest data for nodes and components.

Syntax

public void ProcessPendingLatestData ()

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Rotation Property

Documentation for this section has not yet been entered.

Syntax

public Quaternion Rotation { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

RoundTripTime Property

Documentation for this section has not yet been entered.

Syntax

public float RoundTripTime { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Scene Property

Documentation for this section has not yet been entered.

Syntax

public Scene Scene { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

SceneLoaded Property

Documentation for this section has not yet been entered.

Syntax

public bool SceneLoaded { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

SendClientUpdate Method

Send latest controls from the client. Called by Network.

Syntax

public void SendClientUpdate ()

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

SendPackages Method

Send package files to client. Called by network.

Syntax

public void SendPackages ()

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

SendPackageToClient Method

Trigger client connection to download a package file from the server. Can be used to download additional resource packages when client is already joined in a scene. The package must have been added as a requirement to the scene the client is joined in, or else the eventual download will fail.

Syntax

public void SendPackageToClient (PackageFile package)

Parameters

package
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

SendRemoteEvent Method

Send a remote event.

Syntax

public void SendRemoteEvent (StringHash eventType, bool inOrder)

Parameters

eventType
Documentation for this section has not yet been entered.
inOrder
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

SendRemoteEvent Method

Send a remote event with the specified node as sender.

Syntax

public void SendRemoteEvent (Node node, StringHash eventType, bool inOrder)

Parameters

node
Documentation for this section has not yet been entered.
eventType
Documentation for this section has not yet been entered.
inOrder
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

SendRemoteEvents Method

Send queued remote events. Called by Network.

Syntax

public void SendRemoteEvents ()

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

SendServerUpdate Method

Send scene update messages. Called by Network.

Syntax

public void SendServerUpdate ()

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

SendStringMessage Method

Send a message.

Syntax

public void SendStringMessage (string message)

Parameters

message
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

SetConnectPending Method

Set the connection pending status. Called by Network.

Syntax

public void SetConnectPending (bool connectPending)

Parameters

connectPending
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

SetControlButtons Method

Expose control methods for current controls

Syntax

public void SetControlButtons (uint buttons, bool down)

Parameters

buttons
Documentation for this section has not yet been entered.
down
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

SetControlDataInt Method

Documentation for this section has not yet been entered.

Syntax

public void SetControlDataInt (string key, int value)

Parameters

key
Documentation for this section has not yet been entered.
value
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

SetLogStatistics Method

Set whether to log data in/out statistics.

Syntax

public void SetLogStatistics (bool enable)

Parameters

enable
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

SetPosition Method

Set the observer position for interest management, to be sent to the server.

Syntax

public void SetPosition (Vector3 position)

Parameters

position
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

SetRotation Method

Set the observer rotation for interest management, to be sent to the server. Note: not used by the NetworkPriority component.

Syntax

public void SetRotation (Quaternion rotation)

Parameters

rotation
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

SetScene Method

Assign scene. On the server, this will cause the client to load it.

Syntax

public void SetScene (Scene newScene)

Parameters

newScene
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

TimeStamp Property

Documentation for this section has not yet been entered.

Syntax

public byte TimeStamp { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

ToString Method

Return an address:port string.

Syntax

public string ToString ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0