Difference between revisions of "Vector (API)"
From ComputerCraft Wiki
(the vector methods now use the correct self call syntax) |
(Added link to an introduction to vectors as used in the mod.) |
||
| Line 1: | Line 1: | ||
| − | The vector API provides methods to create and manipulate vectors. | + | The vector API provides methods to create and manipulate vectors. An introduction to vectors can be found on [http://en.wikipedia.org/wiki/Euclidean_vector Wikipedia]. |
Revision as of 18:51, 12 May 2012
The vector API provides methods to create and manipulate vectors. An introduction to vectors can be found on Wikipedia.
| Static methods | |
|---|---|
| Method name | Description |
| vector.new(x, y, z) | Creates a vector. @param x, y, z the vector coordinates |
| Object methods | |
|---|---|
| Method name | Description |
| vectorA:add(vectorB) | Adds vectorB to vectorA and returns the resulted vector. |
| vectorA:sub(vectorB) | Subtracts vectorB to vectorA and returns the resulted vector. |
| vectorA:mul(vectorB) | Multiplies vectorB with vectorA and returns the resulted vector. |
| vectorA:dot(vectorB) | Returns the dot product of vectorA and vectorB. |
| vectorA:cross(vectorB) | Returns the vector which resulted in the cross product of vectorA and vectorB. |
| vectorA:length() | Returns the vector's length. |
| vectorA:normalize() | Normalizes the vector and returns the result as a new vector. |
| vectorA:round() | Rounds the vector coordinates to the nearest integers and returns the result as a new vector. |
| vectorA:tostring() | Returns a string representation of the vector in the form of "x,y,z". |
