Merge branch 'randvector-docs' of https://github.com/grunkgrunk/hump into grunkgrunk-randvector-docs

This commit is contained in:
Matthias Richter 2017-11-19 20:52:40 +01:00
commit 9a8e16a55f
2 changed files with 13 additions and 21 deletions

View File

@ -99,14 +99,10 @@ Convert the vector to polar coordinates, i.e., the angle and the radius/lenth.
:returns: ``x``, ``y``: A vector pointing in a random direction with a random length between len_min and len_max.
**Examples**::
-- length is a random value between 1 and 5
x,y = vector.randomDirection(1,5)
-- length is 1
x,y = vector.randomDirection()
-- length is 100
x,y = vector.randomDirection(100)
x,y = vector.randomDirection(1,5) -- length is a random value between 1 and 5
x,y = vector.randomDirection() -- length is 1
x,y = vector.randomDirection(100) -- length is 100
.. function:: vector.mul(s, x,y)

View File

@ -121,14 +121,10 @@ The ``angle`` is measured against the vector (1,0), i.e., the x axis.
:returns: A vector pointing in a random direction with a random length between len_min and len_max.
**Examples**::
-- length is a random value between 1 and 5
rnd = vector.randomDirection(1,5)
-- length is 1
rnd = vector.randomDirection()
-- length is 100
rnd = vector.randomDirection(100)
rnd = vector.randomDirection(1,5) -- length is a random value between 1 and 5
rnd = vector.randomDirection() -- length is 1
rnd = vector.randomDirection(100) -- length is 100
.. function:: vector.isvector(v)