Added NetworkDictionary<TKey,TValue>, NetworkHashSet<T> and NetworkUnorderedList<T>.

This commit is contained in:
Karrar
2024-07-29 04:32:17 +03:00
parent b2c604dbcb
commit 010cd7a4cc
13 changed files with 245 additions and 66 deletions

View File

@@ -7,12 +7,14 @@
<member name="M:Netick.NetickTransport.OnConnectRequest(Netick.NetworkConnectionRequest)">
-------------------------------
</member>
<member name="T:Netick.SequenceId">
<member name="T:Netick.NetworkQueueSnapshot`1">
<summary>
A rolling sequence counter for ordering values. Repeats indefinitely
with 1022 possible unique values (0 is treated as invalid internally).
Consumes 10 bits when encoded for transmission.
A snapshot of the state of a <see cref="T:Netick.NetworkQueue`1"/> collection. Note this must not be used outside the scope of an OnChanged call or a NetworkRender call.
</summary>
</member>
<member name="T:Netick.NetworkQueue`1">
<summary>
A networked <see cref="T:System.Collections.Generic.Queue`1"/> collection.
</summary>
</member>
<member name="M:Netick.IGameEngine.GetConnectionMetaSizeWords">
@@ -120,43 +122,23 @@
<param name="netickEngine"></param>
<param name="entity"></param>
</member>
<member name="M:Netick.NotServerException.#ctor">
<summary>
Constructs a NotServerException
</summary>
</member>
<member name="M:Netick.NotServerException.#ctor(System.String)">
<summary>
Constructs a NotServerException with a message
</summary>
<param name="message">The exception message</param>
</member>
<member name="M:Netick.NotServerException.#ctor(System.String,System.Exception)">
<summary>
Constructs a NotServerException with a message and a inner exception
</summary>
<param name="message">The exception message</param>
<param name="inner">The inner exception</param>
</member>
<member name="T:Netick.OnChanged">
<summary>
Use this attribute on a method you want to call when a specific property value changes. Example: [OnChanged(nameof(PropertyName)]
</summary>
</member>
<member name="T:Netick.Rpc">
<summary>
Use this attribute on any method you want to make an RPC. Should have the return type of void, and not be static.
<para> * Use the parameter "source" to specify who is allowed to send this RPC.</para>
<para> * Use the parameter "target" to specify who is allowed to receive and execute this RPC.</para>
<para> * Use the parameter "isReliable" to specify if this Rpc should be reliable or not, meaning it won't be lost (due to packet loss).</para>
<para> * Use the parameter "localInvoke" to specify if this Rpc should be executed on the machine it was called from.</para>
</summary>
</member>
<member name="P:Netick.OnChangedData.InvokedForMisprediction">
<summary>
Returns true if this OnChanged callback is due to a mismatch between the state of this variable before rollback, and the state after rollback and resimulation.
</summary>
</member>
<member name="M:Netick.OnChangedData.GetPreviousNetworkDictionary``2(Netick.NetworkDictionary{``0,``1})">
<summary>
Gets a snapshot of the previous state of a NetworkDictionary collection.
</summary>
<returns></returns>
</member>
<member name="M:Netick.OnChangedData.GetPreviousNetworkHashSet``1(Netick.NetworkHashSet{``0})">
<summary>
Gets a snapshot of the previous state of a NetworkHashSet collection.
</summary>
<returns></returns>
</member>
<member name="M:Netick.OnChangedData.GetPreviousNetworkLinkedList``1(Netick.NetworkLinkedList{``0})">
<summary>
Gets a snapshot of the previous state of a NetworkLinkedList collection.
@@ -208,6 +190,16 @@
<typeparam name="T"></typeparam>
<returns></returns>
</member>
<member name="T:Netick.NetworkDictionarySnapshot`2">
<summary>
A snapshot of the state of a <see cref="T:Netick.NetworkDictionary`2"/> collection. Note this must not be used outside the scope of an OnChanged call or a NetworkRender call.
</summary>
</member>
<member name="T:Netick.NetworkDictionary`2">
<summary>
A networked <see cref="T:System.Collections.Generic.Dictionary`2"/> collection.
</summary>
</member>
<member name="T:Netick.Interpolator">
<summary>
A struct that is used to obtain interpolation data for a network property.
@@ -293,6 +285,52 @@
Internal method. Never call this.
</summary>
</member>
<member name="T:Netick.SequenceId">
<summary>
A rolling sequence counter for ordering values. Repeats indefinitely
with 1022 possible unique values (0 is treated as invalid internally).
Consumes 10 bits when encoded for transmission.
</summary>
</member>
<member name="T:Netick.NetworkHashSetSnapshot`1">
<summary>
A snapshot of the state of a <see cref="T:Netick.NetworkHashSet`1"/> collection. Note this must not be used outside the scope of an OnChanged call or a NetworkRender call.
</summary>
</member>
<member name="T:Netick.NetworkHashSet`1">
<summary>
A networked <see cref="T:System.Collections.Generic.HashSet`1"/> collection.
</summary>
</member>
<member name="T:Netick.NetworkStackSnapshot`1">
<summary>
A snapshot of the state of a <see cref="T:Netick.NetworkStack`1"/> collection. Note this must not be used outside the scope of an OnChanged call or a NetworkRender call.
</summary>
</member>
<member name="T:Netick.NetworkStack`1">
<summary>
A networked <see cref="T:System.Collections.Generic.Stack`1"/> collection.
</summary>
</member>
<member name="M:Netick.NotServerException.#ctor">
<summary>
Constructs a NotServerException
</summary>
</member>
<member name="M:Netick.NotServerException.#ctor(System.String)">
<summary>
Constructs a NotServerException with a message
</summary>
<param name="message">The exception message</param>
</member>
<member name="M:Netick.NotServerException.#ctor(System.String,System.Exception)">
<summary>
Constructs a NotServerException with a message and a inner exception
</summary>
<param name="message">The exception message</param>
<param name="inner">The inner exception</param>
</member>
<member name="M:Netick.NotClientException.#ctor">
<summary>
Constructs a NotClientException
@@ -316,14 +354,18 @@
Constructs a BadPacketException
</summary>
</member>
<member name="F:Netick.CustomizableSocketTransport._connectRequestBuffer">
----------------------------------------------------
</member>
<member name="T:Netick.NetworkLinkedListSnapshot`1">
<summary>
A snapshot of the previous state of a NetworkLinkedList collection. Note this must not be used outside the the scope of an OnChanged call.
A snapshot of the state of a <see cref="T:Netick.NetworkLinkedList`1"/> collection. Note this must not be used outside the scope of an OnChanged call or a NetworkRender call.
</summary>
<typeparam name="T"></typeparam>
</member>
<member name="T:Netick.NetworkLinkedList`1">
<summary>
A networked linked list collection. This is an ordered list meaning that the elements insertion order is maintained when iterating through the collection.
</summary>
</member>
<member name="F:Netick.CustomizableSocketTransport._connectRequestBuffer">
----------------------------------------------------
</member>
<member name="T:Netick.NetworkPlayer">
<summary>
@@ -422,11 +464,20 @@
</summary>
<param name="behaviour"></param>
</member>
<member name="T:Netick.NetworkQueueSnapshot`1">
<member name="M:Netick.NetworkConnection.SendData(System.Byte,System.Byte*,System.Int32,Netick.TransportDeliveryMethod)">
<summary>
A snapshot of the previous state of a NetworkQueue collection. Note this must not be used outside the the scope of an OnChanged call.
Sends data to this connection.
<para>Note: the low-level transport must implement <see cref="M:Netick.TransportConnection.SendUserData(System.IntPtr,System.Int32,Netick.TransportDeliveryMethod)"/> for this method to have an effect.</para>
</summary>
<typeparam name="T"></typeparam>
<param name="id"></param>
<param name="data"></param>
<param name="length"></param>
</member>
<member name="M:Netick.NativeUDPSocket.Deinitialize">
--------------------------------------------------------------------------------------------------------------
--------------------------------------------------------------------------------------------------------------
--------------------------------------------------------------------------------------------------------------
--------------------------------------------------------------------------------------------------------------
</member>
<member name="F:Netick.ClientSimulation.SimReady">
-------------------------------- -------------------------------- -------------------------------- --------------------------------
@@ -434,11 +485,29 @@
<member name="M:Netick.ClientSimulation.AddSnaps">
-------------------------------- -------------------------------- -------------------------------- --------------------------------
</member>
<member name="T:Netick.NetworkStackSnapshot`1">
<member name="T:Netick.NetworkUnorderedListSnapshot`1">
<summary>
A snapshot of the previous state of a NetworkStack collection. Note this must not be used outside the the scope of an OnChanged call.
A snapshot of the state of a <see cref="T:Netick.NetworkUnorderedList`1"/> collection. Note this must not be used outside the scope of an OnChanged call or a NetworkRender call.
</summary>
<typeparam name="T"></typeparam>
</member>
<member name="T:Netick.NetworkUnorderedList`1">
<summary>
A networked list collection. This is an unordered list meaning that the order of the elements during iteration is undefined.
</summary>
</member>
<member name="T:Netick.OnChanged">
<summary>
Use this attribute on a method you want to call when a specific property value changes. Example: [OnChanged(nameof(PropertyName)]
</summary>
</member>
<member name="T:Netick.Rpc">
<summary>
Use this attribute on any method you want to make an RPC. Should have the return type of void, and not be static.
<para> * Use the parameter "source" to specify who is allowed to send this RPC.</para>
<para> * Use the parameter "target" to specify who is allowed to receive and execute this RPC.</para>
<para> * Use the parameter "isReliable" to specify if this Rpc should be reliable or not, meaning it won't be lost (due to packet loss).</para>
<para> * Use the parameter "localInvoke" to specify if this Rpc should be executed on the machine it was called from.</para>
</summary>
</member>
</members>
</doc>