mirror of
https://github.com/Kaveinator/NetickProForUnity.git
synced 2025-10-26 09:49:06 -07:00
Updated XML docs.
This commit is contained in:
Karrar
34
Netick/Runtime/Netick.Pro.xml
Normal file
34
Netick/Runtime/Netick.Pro.xml
Normal file
@@ -0,0 +1,34 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Netick.Pro</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="M:Netick.Pro.LagCompensation.Raycast(System.Numerics.Vector3,System.Numerics.Vector3,Netick.Pro.NetHit@,Netick.NetworkPlayer,System.Single,System.Int32,System.Boolean)">
|
||||
<summary>
|
||||
Casts a lag compensated ray, from point origin, in direction direction, of length maxDistance,
|
||||
against all HitShapes and Colliders (if includeUnityColliders is equal to true) in the Scene.
|
||||
</summary>
|
||||
<param name="origin">The starting point of the ray in world coordinates.</param>
|
||||
<param name="direction">The direction of the ray.</param>
|
||||
<param name="hitData"></param>
|
||||
<param name="inputSource">The input source to compensate for.</param>
|
||||
<param name="maxDistance">The max distance the ray should check for collisions.</param>
|
||||
<param name="layerMask">A that is used to selectively ignore Colliders when casting a ray.</param>
|
||||
<param name="includeUnityColliders">Choose whether you want to include normal unity colliders, or only Netick HitShapes.</param>
|
||||
<returns>Returns true if the ray intersects with a Collider/HitShape, otherwise false.</returns>
|
||||
</member>
|
||||
<member name="M:Netick.Pro.LagCompensation.OverlapSphere(System.Numerics.Vector3,System.Single,System.Collections.Generic.List{Netick.Pro.NetHit},Netick.NetworkPlayer,System.Int32,System.Boolean,System.Boolean)">
|
||||
<summary>
|
||||
Performs a lag compensated OverlapSphere which computes and stores HitShapes and Colliders (if includeUnityColliders is equal to true) touching or inside the sphere.
|
||||
</summary>
|
||||
<param name="center">Center of the sphere.</param>
|
||||
<param name="radius">Radius of the sphere.</param>
|
||||
<param name="hits"></param>
|
||||
<param name="inputSource">The input source to compensate for.</param>
|
||||
<param name="layerMask">A defines which layers of colliders to include in the query.</param>
|
||||
<param name="includeUnityColliders">Choose whether you want to include normal unity colliders, or only Netick HitShapes.</param>
|
||||
<param name="oneHitPerHitShapeContainer">Choose whether you want to include only one HitShape per HitShapeContainer</param>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
60
Netick/Runtime/Netick.Unity.Pro.xml
Normal file
60
Netick/Runtime/Netick.Unity.Pro.xml
Normal file
@@ -0,0 +1,60 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Netick.Unity.Pro</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="M:Netick.Unity.Pro.NetworkSandboxExts.Raycast(Netick.Unity.NetworkSandbox,UnityEngine.Vector3,UnityEngine.Vector3,Netick.Unity.Pro.LagCompHit@,Netick.NetworkPlayer,System.Single,System.Int32,UnityEngine.QueryTriggerInteraction,System.Boolean,System.Boolean)">
|
||||
<summary>
|
||||
Casts a lag compensated ray, from point origin, in direction direction, of length maxDistance,
|
||||
against all HitShapes and Colliders (if includeUnityColliders is equal to true) in the Scene.
|
||||
</summary>
|
||||
<param name="origin">The starting point of the ray in world coordinates.</param>
|
||||
<param name="direction">The direction of the ray.</param>
|
||||
<param name="hitData"></param>
|
||||
<param name="inputSource">The input source to compensate for.</param>
|
||||
<param name="maxDistance">The max distance the ray should check for collisions.</param>
|
||||
<param name="layerMask">A that is used to selectively ignore Colliders when casting a ray.</param>
|
||||
<param name="includeUnityColliders">Choose whether you want to include normal unity colliders, or only Netick HitShapes.</param>
|
||||
<returns>Returns true if the ray intersects with a Collider/HitShape, otherwise false.</returns>
|
||||
</member>
|
||||
<member name="M:Netick.Unity.Pro.NetworkSandboxExts.Raycast2D(Netick.Unity.NetworkSandbox,UnityEngine.Vector2,UnityEngine.Vector2,Netick.Unity.Pro.LagCompHit2D@,Netick.NetworkPlayer,System.Single,System.Int32,System.Boolean,System.Boolean)">
|
||||
<summary>
|
||||
Casts a lag compensated ray, from point origin, in direction direction, of length maxDistance,
|
||||
against all HitShapes and Colliders (if includeUnityColliders is equal to true) in the Scene.
|
||||
</summary>
|
||||
<param name="origin">The starting point of the ray in world coordinates.</param>
|
||||
<param name="direction">The direction of the ray.</param>
|
||||
<param name="hitData"></param>
|
||||
<param name="inputSource">The input source to compensate for.</param>
|
||||
<param name="maxDistance">The max distance the ray should check for collisions.</param>
|
||||
<param name="layerMask">A that is used to selectively ignore Colliders when casting a ray.</param>
|
||||
<param name="includeUnityColliders">Choose whether you want to include normal unity colliders, or only Netick HitShapes.</param>
|
||||
<returns>Returns true if the ray intersects with a Collider/HitShape, otherwise false.</returns>
|
||||
</member>
|
||||
<member name="M:Netick.Unity.Pro.NetworkSandboxExts.OverlapSphere(Netick.Unity.NetworkSandbox,UnityEngine.Vector3,System.Single,System.Collections.Generic.List{Netick.Unity.Pro.LagCompHit},Netick.NetworkPlayer,System.Int32,UnityEngine.QueryTriggerInteraction,System.Boolean,System.Boolean,System.Boolean)">
|
||||
<summary>
|
||||
Performs a lag compensated OverlapSphere which computes and stores HitShapes and Colliders (if includeUnityColliders is equal to true) touching or inside the sphere.
|
||||
</summary>
|
||||
<param name="center">Center of the sphere.</param>
|
||||
<param name="radius">Radius of the sphere.</param>
|
||||
<param name="hits"></param>
|
||||
<param name="inputSource">The input source to compensate for.</param>
|
||||
<param name="layerMask">A defines which layers of colliders to include in the query.</param>
|
||||
<param name="includeUnityColliders">Choose whether you want to include normal unity colliders, or only Netick HitShapes.</param>
|
||||
<param name="oneHitPerHitShapeContainer">Choose whether you want to include only one HitShape per HitShapeContainer</param>
|
||||
</member>
|
||||
<member name="M:Netick.Unity.Pro.NetworkSandboxExts.OverlapCircle(Netick.Unity.NetworkSandbox,UnityEngine.Vector2,System.Single,System.Collections.Generic.List{Netick.Unity.Pro.LagCompHit2D},Netick.NetworkPlayer,System.Int32,System.Boolean,System.Boolean,System.Boolean)">
|
||||
<summary>
|
||||
Performs a lag compensated OverlapCircle which computes and stores HitShapes and Colliders (if includeUnityColliders is equal to true) touching or inside the circle.
|
||||
</summary>
|
||||
<param name="center">Center of the sphere.</param>
|
||||
<param name="radius">Radius of the sphere.</param>
|
||||
<param name="hits"></param>
|
||||
<param name="inputSource">The input source to compensate for.</param>
|
||||
<param name="layerMask">A defines which layers of colliders to include in the query.</param>
|
||||
<param name="includeUnityColliders">Choose whether you want to include normal unity colliders, or only Netick HitShapes.</param>
|
||||
<param name="oneHitPerHitShapeContainer">Choose whether you want to include only one HitShape per HitShapeContainer</param>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
@@ -24,7 +24,7 @@
|
||||
<para>Note: this must be called only for non-networked prefabs. If you want to instantiate a network prefab, use <see cref="!:NetworkInstantiate(GameObject, Vector3, Quaternion, NetworkPlayer)"/> instead.</para>
|
||||
</summary>
|
||||
<param name="prefab">The prefab to be instantiated.</param>
|
||||
<param name="position">GridIndex of the instantiated object.</param>
|
||||
<param name="position">Position of the instantiated object.</param>
|
||||
<param name="rotation">Rotation of the instantiated object.</param>
|
||||
<returns></returns>
|
||||
</member>
|
||||
@@ -36,7 +36,7 @@
|
||||
<para>Note: the specified input source will be given to every <see cref="T:Netick.Unity.NetworkObject"/> child of this prefab.</para>
|
||||
</summary>
|
||||
<param name="prefab">The prefab to be instantiated.</param>
|
||||
<param name="position">GridIndex of the instantiated object.</param>
|
||||
<param name="position">Position of the instantiated object.</param>
|
||||
<param name="rotation">Rotation of the instantiated object.</param>
|
||||
<param name="inputSource">Input source of the instantiated object.</param>
|
||||
<returns></returns>
|
||||
@@ -280,6 +280,12 @@
|
||||
Requests an update to the match list. Only functional if the low-level transport has support for matchmaking.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Netick.Unity.NetworkSandbox.SwitchScene(System.String)">
|
||||
<summary>
|
||||
<i><b>[Server Only]</b></i> Switches to a different scene. This must be called instead of <see cref="M:UnityEngine.SceneManagement.SceneManager.LoadSceneAsync(System.Int32)"/> or its variations.
|
||||
</summary>
|
||||
<param name="sceneBuildIndex">SceneBuildIndex of the desired scene.</param>
|
||||
</member>
|
||||
<member name="M:Netick.Unity.NetworkSandbox.SwitchScene(System.Int32)">
|
||||
<summary>
|
||||
<i><b>[Server Only]</b></i> Switches to a different scene. This must be called instead of <see cref="M:UnityEngine.SceneManagement.SceneManager.LoadSceneAsync(System.Int32)"/> or its variations.
|
||||
@@ -310,11 +316,6 @@
|
||||
Any GameObject which needs to be synced/replicated must have a Network Object component. It’s the component that tells Netick a GameObject is networked. Although not every child GameObject needs it, only the root has to have a Network Object.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Netick.Unity.NetworkObject.SpawnTick">
|
||||
<summary>
|
||||
The tick which this object was spawned at.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Netick.Unity.NetworkObject.Parent">
|
||||
<summary>
|
||||
The <see cref="T:Netick.Unity.NetworkObject"/> parent of this object.
|
||||
@@ -409,8 +410,8 @@
|
||||
</member>
|
||||
<member name="M:Netick.Unity.NetickBehaviour.NetworkFixedUpdate">
|
||||
<summary>
|
||||
Called every fixed-time network update/tick. Any changes/updates to the network state must happen here.
|
||||
<para>On the client, if you are the Input Source or if this Object.PredictionMode is set to None, it will be called several times in one update/tick during resimulations. To check for resimulations, use [<see cref="!:IsResimulating"/>].</para>
|
||||
Called every fixed-time network step. Any changes to the networked state should happen here.
|
||||
<para>On the client, if you are the Input Source or if this Object.PredictionMode is set to Everyone, it will be called several times in one update/tick during resimulations. To check for resimulations, use [<see cref="!:IsResimulating"/>].</para>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Netick.Unity.NetickBehaviour.NetworkRender">
|
||||
@@ -495,6 +496,9 @@
|
||||
Manages Netick and its clients, and is used to start and shut down Netick.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Netick.Unity.Network.StartMode">
|
||||
e
|
||||
</member>
|
||||
<member name="M:Netick.Unity.Network.Init(Netick.Unity.NetickConfig,System.Int32)">
|
||||
<summary>
|
||||
Initializes Netick. This is automatically called when you start Netick.
|
||||
@@ -537,7 +541,7 @@
|
||||
Starts multiple peers together.
|
||||
</summary>
|
||||
<param name="serverPort">Network port.</param>
|
||||
<param name="numOfClients">Number of client clients to create.</param>
|
||||
<param name="numOfClients">Number of clients to create.</param>
|
||||
<param name="startAServer">Should we start a server too.</param>
|
||||
|
||||
<returns></returns>
|
||||
|
||||
@@ -431,6 +431,9 @@
|
||||
<member name="F:Netick.ClientSimulation.SimReady">
|
||||
-------------------------------- -------------------------------- -------------------------------- --------------------------------
|
||||
</member>
|
||||
<member name="M:Netick.ClientSimulation.AddSnaps">
|
||||
-------------------------------- -------------------------------- -------------------------------- --------------------------------
|
||||
</member>
|
||||
<member name="T:Netick.NetworkStackSnapshot`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.
|
||||
|
||||
Reference in New Issue
Block a user