Skip to content

Commit 4cad635

Browse files
committed
Clarified bytesPerAngle on Write & Read rotation
1 parent f8288ef commit 4cad635

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

MLAPI/NetworkingManagerComponents/Binary/BitStream.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -434,7 +434,7 @@ public void WriteRangedDouble(double value, double minValue, double maxValue, in
434434
/// Write a rotation to the stream.
435435
/// </summary>
436436
/// <param name="rotation">Rotation to write</param>
437-
/// <param name="bytesPerAngle">How many bytes each written angle should occupy</param>
437+
/// <param name="bytesPerAngle">How many bytes each written angle should occupy. Must be between 1 and 4 (inclusive)</param>
438438
public void WriteRotation(Quaternion rotation, int bytesPerAngle)
439439
{
440440
if (bytesPerAngle < 1 || bytesPerAngle > 4) throw new ArgumentOutOfRangeException("Bytes per angle must be at least 1 byte and at most 4 bytes!");
@@ -583,7 +583,7 @@ public double ReadRangedDouble(double minValue, double maxValue, int bytes)
583583
/// <summary>
584584
/// Read a rotation from the stream.
585585
/// </summary>
586-
/// <param name="bytesPerAngle">How many bytes each angle occupies</param>
586+
/// <param name="bytesPerAngle">How many bytes each angle occupies. Must be between 1 and 4 (inclusive)</param>
587587
/// <returns>The rotation read from the stream</returns>
588588
public Quaternion ReadRotation(int bytesPerAngle)
589589
{

0 commit comments

Comments
 (0)