luau-lang/rfcs
1
0
Fork 0
mirror of https://github.com/luau-lang/rfcs.git synced 2025-04-19 19:34:00 +01:00
Code Issues Projects Releases Packages Wiki Activity

Fix formatting

Browse source
This commit is contained in:
ffrostfall 2024-05-05 00:59:04 -04:00
parent 0bb608a0c1
commit 2d5cdd7b80
1 changed files with 5 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
docs/vector-library.md
View file

@ -17,20 +17,25 @@ Implement a standard library for creating & using the existing vector type.
It's important to keep in mind that this list of implementable functions isn't intended to be exhaustive, but rather to serve as a starting point.
`vector(x: number?, y: number?, z: number?)`
Creates a vector with 3 components: x, y, z. If the feature flag for wide vectors is enabled, a fourth argument `w: number?` will be introduced. As per standard, vectors wouldn't have a metatable by default. A vector's metatable would need to be set by the C API `lua_setmetatable`.
Due to the common usage of vectors, vector creation should be ergonomic. Therefore, it is probably worth breaking the `create()` naming standard.
`vector.magnitude(vecA: vector): vector`
Calculates the magnitude of a given vector.
`vector.unit(vec: vector): vector`
Returns the unit vector (aka normalized vector) of a given vector.
`vector.cross(vecA: vector, vecB: vector): vector`
Returns the cross product of two vectors.
`vector.dot(vecA: vector): vector`
Returns the dot product of a vector.
### Arithmetic operations