Vector (API)

From ComputerCraft Wiki
Revision as of 08:56, 23 February 2013 by MafiaMoe (Talk | contribs)

Jump to: navigation, search
This page needs some serious TLC, stat!
Please help us by cleaning it, fixing it up, or sparing it some love.
(Reason: Needs function pages, some parameters missing types Pokepal101 02:42, 29 December 2012 (MSK))

The vector API provides methods to create and manipulate vectors. An introduction to vectors can be found on Wikipedia.

Grid disk.png   Vector (API)

Method NameDescription
vector.new(x, y, z) Creates a vector.
vectorA:add(table vectorB) Adds vectorB to vectorA and returns the resulted vector. Can also be used by writing vectorA + vectorB.
vectorA:sub(table vectorB) Subtracts vectorB from vectorA and returns the resulted vector. Can also be used by writing vectorA - vectorB.
vectorA:mul(n) Scalar multiplies vectorA with n and returns the resulted vector. Can also be used by writing vectorA * n.
vectorA:dot(vector vectorB) Returns the dot product of vectorA and vectorB.
vectorA:cross(table 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".