From f4e728494f8518d6c2e21021f155ce6cf31eed8f Mon Sep 17 00:00:00 2001 From: Jack <85714123+jackdotink@users.noreply.github.com> Date: Tue, 16 Jul 2024 14:12:29 -0500 Subject: [PATCH] add axis to angle function --- docs/vector-library.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/vector-library.md b/docs/vector-library.md index 131aa1a..73fe7f8 100644 --- a/docs/vector-library.md +++ b/docs/vector-library.md @@ -32,11 +32,11 @@ Calculates the magnitude of a given vector. Returns the normalized version (aka unit vector) of a given vector. -`vector.cross(vecA: vector, vecB: vector): vector` +`vector.cross(vec1: vector, vec2: vector): vector` Returns the cross product of two vectors. If 4-wide vectors are enabled, this function will ignore the fourth component, and return the 3-dimensional cross product. -`vector.dot(vecA: vector, vecB: vector): number` +`vector.dot(vec1: vector, vec2: vector): number` Returns the dot product of two vectors. @@ -48,9 +48,9 @@ Equivalent of `math.floor` for vectors. Equivalent of `math.ceil` for vectors. -`vector.angle(vecA: vector, vecB: vector): number` +`vector.angle(vec1: vector, vec2: vector, axis: vector?): number` -Returns the angle between two vectors in radians. +Returns the angle between two vectors in radians. The axis, if specified, is used to determine the sign of the angle. `vector.abs(vec: vector): vector`