Add OOP class methods!

Author: Fernando-A-Rocha

classes/Matrix/Matrix.yaml

@@ -2,6 +2,106 @@ name: 'matrix'
 description: |
   Matrices are one of the most powerful features of MTA [OOP](/OOP). We did have a presence of Matrices before with [getElementMatrix](/getElementMatrix), but we were given an ugly disgusting table to play with. Now, with the new Matrix class, we can make and magically manipulate Matrices.
 
+methods:
+  - name: create
+    description: |
+      Default constructor for the Matrix class. Returns a Matrix object. 
+      Can be instantiated in multiple ways.
+    overloads:
+      - signature: Matrix(Vector3 position[, Vector3 rotation])
+        parameters:
+          - name: position
+            type: Vector3
+            description: The position vector of the matrix
+          - name: rotation
+            type: Vector3
+            optional: true
+            description: The rotation vector of the matrix
+      - signature: Matrix(Matrix matrixToClone)
+        parameters:
+          - name: matrixToClone
+            type: Matrix
+            description: A matrix you want to make a clone of
+      - signature: Matrix()
+        parameters: []
+        description: Initialize a zero matrix
+
+  - name: transformPosition
+    description: Transforms a given position vector using the Matrix.
+    signature: Vector3 Matrix:transformPosition(Vector3 position)
+    parameters:
+      - name: position
+        type: Vector3
+        description: The position vector you want to transform
+    examples:
+      - description: Teleports a random player 5 meters in front of them
+        code: |
+          local player = getRandomPlayer()
+          local desiredRelativePosition = Vector3(0, 5, 0)
+          local matrix = player.matrix
+          local newPosition = matrix:transformPosition(desiredRelativePosition)
+          player.position = newPosition
+
+  - name: getPosition
+    description: Returns the position vector of the matrix.
+    signature: Vector3 Matrix:getPosition()
+    parameters: []
+    examples:
+      - description: Prints the position of a random player.
+        code: |
+          local player = getRandomPlayer()
+          local matrix = player.matrix
+          local position = matrix:getPosition()
+          outputChatBox("x: " .. position:getX() .. ", y: " .. position:getY() .. ", z:" .. position:getZ())
+
+  - name: getRotation
+    description: Returns the rotation vector of the matrix.
+    signature: Vector3 Matrix:getRotation()
+    parameters: []
+    examples:
+      - description: Prints the rotation of a random player.
+        code: |
+          local player = getRandomPlayer()
+          local matrix = player.matrix
+          local rotation = matrix:getRotation()
+          outputChatBox("rx: " .. rotation:getX() .. ", ry: " .. rotation:getY() .. ", rz:" .. rotation:getZ())
+
+  - name: getForward
+    description: Returns the forward vector of the matrix.
+    signature: Vector3 Matrix:getForward()
+    parameters: []
+    examples:
+      - description: Prints the forward vector of a random player.
+        code: |
+          local player = getRandomPlayer()
+          local matrix = player.matrix
+          local vector = matrix:getForward()
+          outputChatBox("X: " .. vector:getX() .. ", Y: " .. vector:getY() .. ", Z:" .. vector:getZ())
+
+  - name: getRight
+    description: Returns the right vector of the matrix.
+    signature: Vector3 Matrix:getRight()
+    parameters: []
+    examples:
+      - description: Prints the right vector of a random player.
+        code: |
+          local player = getRandomPlayer()
+          local matrix = player.matrix
+          local vector = matrix:getRight()
+          outputChatBox("X: " .. vector:getX() .. ", Y: " .. vector:getY() .. ", Z:" .. vector:getZ())
+
+  - name: getUp
+    description: Returns the up vector of the matrix.
+    signature: Vector3 Matrix:getUp()
+    parameters: []
+    examples:
+      - description: Prints the up vector of a random player.
+        code: |
+          local player = getRandomPlayer()
+          local matrix = player.matrix
+          local vector = matrix:getUp()
+          outputChatBox("X: " .. vector:getX() .. ", Y: " .. vector:getY() .. ", Z:" .. vector:getZ())
+
 examples:
   - path: examples/matrix-1.lua
     description: >

classes/Vector/Vector2.yaml

@@ -1,4 +1,104 @@
 name: 'vector2'
 description: |
   This is a 2D [Vector](/Vector) class.
+methods:
+  - name: create
+    description: |
+      Default constructor for the Vector2 class. Returns a Vector2 object.
+    overloads:
+      - signature: Vector2(mixed vectorOrX[, float y])
+        parameters:
+          - name: vectorOrX
+            type: float | table | vector2
+            description: Vector2, table, or float indicating vector's coordinates
+          - name: y
+            type: float
+            optional: true
+            description: If vectorOrX is a float, this is the Y coordinate
 
+  - name: normalize
+    description: Normalizes the vector
+    signature: bool Vector2.normalize(vector2 vector)
+    parameters:
+      - name: vector
+        type: vector2
+        description: Vector2 to normalize
+
+  - name: getX
+    description: Gets the X coordinate of a vector
+    signature: float Vector2.getX(vector2 vector)
+    parameters:
+      - name: vector
+        type: vector2
+        description: Vector2 to get X coordinate from
+
+  - name: getY
+    description: Gets the Y coordinate of a vector
+    signature: float Vector2.getY(vector2 vector)
+    parameters:
+      - name: vector
+        type: vector2
+        description: Vector2 to get Y coordinate from
+
+  - name: setX
+    description: Sets the X coordinate of a vector
+    signature: bool Vector2.setX(vector2 vector, float x)
+    parameters:
+      - name: vector
+        type: vector2
+        description: Vector2 to set X coordinate on
+      - name: x
+        type: float
+        description: New X coordinate
+
+  - name: setY
+    description: Sets the Y coordinate of a vector
+    signature: bool Vector2.setY(vector2 vector, float y)
+    parameters:
+      - name: vector
+        type: vector2
+        description: Vector2 to set Y coordinate on
+      - name: y
+        type: float
+        description: New Y coordinate
+
+  - name: getNormalized
+    description: Gets a normalized version of the vector
+    signature: vector2 Vector2.getNormalized(vector2 vector)
+    parameters:
+      - name: vector
+        type: vector2
+        description: Vector2 to get normalized version of
+
+  - name: getLength
+    description: Gets the length of a vector
+    signature: float Vector2.getLength(vector2 vector)
+    parameters:
+      - name: vector
+        type: vector2
+        description: Vector2 to get length from
+
+  - name: getSquaredLength
+    description: Gets the squared length of a vector
+    signature: float Vector2.getSquaredLength(vector2 vector)
+    parameters:
+      - name: vector
+        type: vector2
+        description: Vector2 to get squared length from
+
+  - name: dot
+    description: Gets the dot product of two vectors
+    signature: float Vector2.dot(vector2 vectorOne, vector2 vectorTwo)
+    parameters:
+      - name: vectorOne
+        type: vector2
+        description: First vector
+      - name: vectorTwo
+        type: vector2
+        description: Second vector
+
+examples:
+  - path: examples/vector2-1.lua
+    description: Checks if the player is using a low resolution
+  - path: examples/vector2-2.lua
+    description: Draws a red line from center to cursor, 200px long