diff --git a/docs/vector-library.md b/docs/vector-library.md index 254d502..815b91c 100644 --- a/docs/vector-library.md +++ b/docs/vector-library.md @@ -16,6 +16,8 @@ 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`. @@ -38,6 +40,8 @@ Returns the cross product of two vectors. Returns the dot product of a vector. +--- + ### Arithmetic operations Primitive operators for vectors are already implemented, so this RFC doesn't concern vector arithmetic.