Urho
1.0.0.0
Urho.UrhoObject
Connection to a remote network host.
On the client, this object is retrieved after a successful connection from the property. On the server, a new instance of this object is created for every connected client.
Constructor
1.0.0.0
Preserve
Pointer to the raw unmanaged Urho object.
Constructs a new instance of Urho.Network.Connection, given a raw pointer to an unmanaged object
This creates a new managed wrapper for the type using the raw pointer to an unmanaged object.
Objects that are created in this fashion get registered with the UrhoSharp runtime.
This is intended to be used by the UrhoSharp runtime, and is not intended to be used by users.
Constructor
1.0.0.0
Preserve
Pass UrhoObjectFlag.Empty.
Empty constructor, chain to this constructor when you provide your own constructor that sets the handle field.
This constructor should be invoked by your code if you provide your own constructor that sets the handle field.
This essentially circumvents the default path that creates a new object and sets the handle and does not call RegisterObject on the target, you must do this on your own constructor.
You would typically chain to this constructor from your own, and then set the handle to the unmanaged object from your code, and then register your object.
Property
1.0.0.0
System.String
Return remote address.
To be added.
To be added.
Property
1.0.0.0
System.Single
Return bytes received per second.
To be added.
To be added.
Property
1.0.0.0
System.Single
Return bytes sent per second.
To be added.
To be added.
Property
1.0.0.0
System.Boolean
Return whether is a client connection.
To be added.
To be added.
Event
1.0.0.0
System.Action<Urho.Network.ClientIdentityEventArgs>
Event raised on the server after the connection and contains the client identity information. The default is to accept all connections.
The event can register multiple callbacks and invoke all of them. If this is not desired, and you only need a single shot callback, you can use the method. That one will force that callback and will ignore any previously set events here.
Event
1.0.0.0
System.Action<Urho.Network.ClientSceneLoadedEventArgs>
To be added.
The event can register multiple callbacks and invoke all of them. If this is not desired, and you only need a single shot callback, you can use the method. That one will force that callback and will ignore any previously set events here.
Method
1.0.0.0
System.Void
To be added.
To be added.
Set network simulation parameters. Called by Network.
To be added.
Property
1.0.0.0
System.Boolean
Return whether is fully connected.
To be added.
To be added.
Property
1.0.0.0
System.Boolean
Return whether connection is pending.
To be added.
To be added.
Property
1.0.0.0
Urho.Controls
To be added.
To be added.
To be added.
Method
1.0.0.0
System.Void
To be added.
Disconnect. If wait time is non-zero, will block while waiting for disconnect to finish.
To be added.
Property
1.0.0.0
System.String
Return name of current package download, or empty if no downloads.
To be added.
To be added.
Property
1.0.0.0
System.Single
Return progress of current package download, or 1.0 if no downloads.
To be added.
To be added.
Property
1.0.0.0
System.Single
Return the time since last received data from the remote host in milliseconds.
To be added.
To be added.
Property
1.0.0.0
System.Boolean
Return whether to log data in/out statistics.
Or
Set whether to log data in/out statistics.
To be added.
To be added.
Property
1.0.0.0
System.UInt32
Return number of package downloads remaining.
To be added.
To be added.
Property
1.0.0.0
System.Single
Return packets received per second.
To be added.
To be added.
Property
1.0.0.0
System.Single
Return packets sent per second.
To be added.
To be added.
Property
1.0.0.0
System.UInt16
Return remote port.
To be added.
To be added.
Property
1.0.0.0
Urho.Vector3
Return the observer position sent by the client for interest management.
Or
Set the observer position for interest management, to be sent to the server.
To be added.
To be added.
Method
1.0.0.0
System.Void
Process pending latest data for nodes and components.
To be added.
Property
1.0.0.0
Urho.Quaternion
Return the observer rotation sent by the client for interest management.
Or
Set the observer rotation for interest management, to be sent to the server. Note: not used by the NetworkPriority component.
To be added.
To be added.
Property
1.0.0.0
System.Single
Return the connection's round trip time in milliseconds.
To be added.
To be added.
Property
1.0.0.0
Urho.Scene
Return the scene used by this connection.
Or
Assign scene. On the server, this will cause the client to load it.
To be added.
To be added.
Property
1.0.0.0
System.Boolean
Return whether the scene is loaded and ready to receive server updates.
To be added.
To be added.
Method
1.0.0.0
System.Void
Send latest controls from the client. Called by Network.
To be added.
Method
1.0.0.0
System.Void
To be added.
To be added.
To be added.
To be added.
To be added.
Sends a message over the connection.
To be added.
Method
1.0.0.0
System.Void
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
Sends a message over the connection.
To be added.
Method
1.0.0.0
System.Void
Send package files to client. Called by network.
To be added.
Method
1.0.0.0
System.Void
To be added.
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.
To be added.
Method
1.0.0.0
System.Void
Send queued remote events. Called by Network.
To be added.
Method
1.0.0.0
System.Void
Send scene update messages. Called by Network.
To be added.
Method
1.0.0.0
System.Obsolete("SubscribeTo API may lead to unxpected behaviour and will be removed in a future version. Use C# event '.ClientIdentity += ...' instead.")
Urho.Subscription
The handler to invoke when this event is raised.
Subscribes to the ClientIdentity event raised by the Connection.
Returns an Urho.Subscription that can be used to cancel the subscription.
This method will override any prior subscription, including those assigned to on event handlers.
This has the advantage that it does a straight connection and returns a handle that is easy to unsubscribe from.
For a more event-like approach, use the event.
Method
1.0.0.0
System.Obsolete("SubscribeTo API may lead to unxpected behaviour and will be removed in a future version. Use C# event '.ClientSceneLoaded += ...' instead.")
Urho.Subscription
The handler to invoke when this event is raised.
Subscribes to the ClientSceneLoaded event raised by the Connection.
Returns an Urho.Subscription that can be used to cancel the subscription.
This method will override any prior subscription, including those assigned to on event handlers.
This has the advantage that it does a straight connection and returns a handle that is easy to unsubscribe from.
For a more event-like approach, use the event.
Property
1.0.0.0
System.Byte
Return the controls timestamp, sent from client to server along each control update.
To be added.
To be added.
Method
1.0.0.0
System.String
Return an address:port string.
To be added.
To be added.
Property
1.0.0.0
Urho.StringHash
Urho's type system type.
StringHash representing the type for this C# type.
This returns the Urho's type and is surfaced for low-level Urho code.
Property
1.0.0.0
System.String
Urho's low-level type name.
Stringified low-level type name.
Property
1.0.0.0
System.String
Urho's low-level type name, accessible as a static method.
Stringified low-level type name.
Property
1.0.0.0
Preserve
Urho.StringHash
Urho's low-level type, accessible as a static method.
This returns the Urho's type and is surface for the low-level Urho code.