Skip to content

Commit 15c8e59

Browse files
update
Adding XML API documentation to some new NetworkTransform properties.
1 parent de3094f commit 15c8e59

File tree

1 file changed

+15
-2
lines changed

1 file changed

+15
-2
lines changed

com.unity.netcode.gameobjects/Runtime/Components/NetworkTransform.cs

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -114,8 +114,6 @@ internal uint BitSet
114114
// Used for NetworkDeltaPosition delta position synchronization
115115
internal int NetworkTick;
116116

117-
internal float TickOffset;
118-
119117
// Used when tracking by state ID is enabled
120118
internal int StateId;
121119

@@ -953,10 +951,25 @@ public enum InterpolationTypes
953951
SmoothDampening
954952
}
955953

954+
/// <summary>
955+
/// The interpolation type to use for the <see cref="NetworkTransform"/> instance.
956+
/// </summary>
957+
/// <remarks>
958+
/// For more details review <see cref="InterpolationTypes"/>.
959+
/// </remarks>
956960
public InterpolationTypes InterpolationType;
957961

962+
/// <summary>
963+
/// When <see cref="Interpolate"/> is enabled and using <see cref="InterpolationTypes.Lerp"/>, this adjust the maximum interpolation time for position.
964+
/// </summary>
958965
public float PositionMaxInterpolationTime = 0.1f;
966+
/// <summary>
967+
/// When <see cref="Interpolate"/> is enabled and using <see cref="InterpolationTypes.Lerp"/>, this adjust the maximum interpolation time for rotation.
968+
/// </summary>
959969
public float RotationMaxInterpolationTime = 0.1f;
970+
/// <summary>
971+
/// When <see cref="Interpolate"/> is enabled and using <see cref="InterpolationTypes.Lerp"/>, this adjust the maximum interpolation time for scale.
972+
/// </summary>
960973
public float ScaleMaxInterpolationTime = 0.1f;
961974

962975
public enum AuthorityModes

0 commit comments

Comments
 (0)