Documentation: fixed documented types to match actual types

The BGE API uses Vectors, but often this was documented as list.

Maniphest Tasks: T43240

Differential Revision: https://developer.blender.org/D1006

6 files changed, 26 insertions, 26 deletions

diff --git a/doc/python_api/rst/bge_types/bge.types.KX_CharacterWrapper.rst b/doc/python_api/rst/bge_types/bge.types.KX_CharacterWrapper.rst
index 4d9dd5b5c34..e326892a824 100644
--- a/doc/python_api/rst/bge_types/bge.types.KX_CharacterWrapper.rst
+++ b/doc/python_api/rst/bge_types/bge.types.KX_CharacterWrapper.rst
@@ -37,7 +37,7 @@ base class --- :class:`PyObjectPlus`
 
       The speed and direction the character is traveling in using world coordinates. This should be used instead of applyMovement() to properly move the character.
 
-      :type: list [x, y, z]
+      :type: Vector((x, y, z))
 
    .. method:: jump()
 
diff --git a/doc/python_api/rst/bge_types/bge.types.KX_GameObject.rst b/doc/python_api/rst/bge_types/bge.types.KX_GameObject.rst
index 09f48fb17d5..8b2edf183e4 100644
--- a/doc/python_api/rst/bge_types/bge.types.KX_GameObject.rst
+++ b/doc/python_api/rst/bge_types/bge.types.KX_GameObject.rst
@@ -135,7 +135,7 @@ base class --- :class:`SCA_IObject`
 
       the object's inertia vector in local coordinates. Read only.
 
-      :type: list [ix, iy, iz]
+      :type: Vector((ix, iy, iz))
 
    .. attribute:: parent
 
@@ -517,7 +517,7 @@ base class --- :class:`SCA_IObject`
          * True: you get the "local" velocity ie: relative to object orientation.
       :type local: boolean
       :return: the object's linear velocity.
-      :rtype: list [vx, vy, vz]
+      :rtype: Vector((vx, vy, vz))
 
    .. method:: setLinearVelocity(velocity, local=False)
 
@@ -544,7 +544,7 @@ base class --- :class:`SCA_IObject`
          * True: you get the "local" velocity ie: relative to object orientation.
       :type local: boolean
       :return: the object's angular velocity.
-      :rtype: list [vx, vy, vz]
+      :rtype: Vector((vx, vy, vz))
 
    .. method:: setAngularVelocity(velocity, local=False)
 
@@ -568,7 +568,7 @@ base class --- :class:`SCA_IObject`
       :arg point: optional point to return the velocity for, in local coordinates.
       :type point: 3D Vector
       :return: the velocity at the specified point.
-      :rtype: list [vx, vy, vz]
+      :rtype: Vector((vx, vy, vz))
 
    .. method:: getReactionForce()
 
@@ -578,7 +578,7 @@ base class --- :class:`SCA_IObject`
       This also includes impulses, eg from collisions.
 
       :return: the reaction force of this object.
-      :rtype: list [fx, fy, fz]
+      :rtype: Vector((fx, fy, fz))
 
       .. note::
 
@@ -906,4 +906,4 @@ base class --- :class:`SCA_IObject`
       :arg name: name of the property that added to the debug list.
       :type name: string
       :arg debug: the debug state.
-      :type debug: boolean
\ No newline at end of file
+      :type debug: boolean
diff --git a/doc/python_api/rst/bge_types/bge.types.KX_ObjectActuator.rst b/doc/python_api/rst/bge_types/bge.types.KX_ObjectActuator.rst
index f10f101a4cc..347b000be3d 100644
--- a/doc/python_api/rst/bge_types/bge.types.KX_ObjectActuator.rst
+++ b/doc/python_api/rst/bge_types/bge.types.KX_ObjectActuator.rst
@@ -15,7 +15,7 @@ base class --- :class:`SCA_IActuator`
 
       The force applied by the actuator.
 
-      :type: list [x, y, z]
+      :type: Vector((x, y, z))
 
    .. attribute:: useLocalForce
 
@@ -27,7 +27,7 @@ base class --- :class:`SCA_IActuator`
 
       The torque applied by the actuator.
 
-      :type: list [x, y, z]
+      :type: Vector((x, y, z))
 
    .. attribute:: useLocalTorque
 
@@ -39,7 +39,7 @@ base class --- :class:`SCA_IActuator`
 
       The displacement vector applied by the actuator.
 
-      :type: list [x, y, z]
+      :type: Vector((x, y, z))
 
    .. attribute:: useLocalDLoc
 
@@ -51,7 +51,7 @@ base class --- :class:`SCA_IActuator`
 
       The angular displacement vector applied by the actuator
 
-      :type: list [x, y, z]
+      :type: Vector((x, y, z))
       
       .. note::
       
@@ -67,7 +67,7 @@ base class --- :class:`SCA_IActuator`
 
       The linear velocity applied by the actuator.
 
-      :type: list [x, y, z]
+      :type: Vector((x, y, z))
 
    .. attribute:: useLocalLinV
 
@@ -83,7 +83,7 @@ base class --- :class:`SCA_IActuator`
 
       The angular velocity applied by the actuator.
 
-      :type: list [x, y, z]
+      :type: Vector((x, y, z))
 
    .. attribute:: useLocalAngV
 
diff --git a/doc/python_api/rst/bge_types/bge.types.KX_Scene.rst b/doc/python_api/rst/bge_types/bge.types.KX_Scene.rst
index f2dad58731c..fc5ba357add 100644
--- a/doc/python_api/rst/bge_types/bge.types.KX_Scene.rst
+++ b/doc/python_api/rst/bge_types/bge.types.KX_Scene.rst
@@ -123,7 +123,7 @@ base class --- :class:`PyObjectPlus`
 
       The scene gravity using the world x, y and z axis.
 
-      :type: list [fx, fy, fz]
+      :type: Vector((gx, gy, gz))
 
    .. method:: addObject(object, other, time=0)
 
diff --git a/doc/python_api/rst/bge_types/bge.types.KX_VertexProxy.rst b/doc/python_api/rst/bge_types/bge.types.KX_VertexProxy.rst
index 9c0d1169d49..73d692770d6 100644
--- a/doc/python_api/rst/bge_types/bge.types.KX_VertexProxy.rst
+++ b/doc/python_api/rst/bge_types/bge.types.KX_VertexProxy.rst
@@ -17,25 +17,25 @@ base class --- :class:`SCA_IObject`
 
       The position of the vertex.
 
-      :type: list [x, y, z]
+      :type: Vector((x, y, z))
 
    .. attribute:: UV
 
       The texture coordinates of the vertex.
 
-      :type: list [u, v]
+      :type: Vector((u, v))
 
    .. attribute:: normal
 
       The normal of the vertex.
 
-      :type: list [nx, ny, nz]
+      :type: Vector((nx, ny, nz))
 
    .. attribute:: color
 
       The color of the vertex.
 
-      :type: list [r, g, b, a]
+      :type: Vector((r, g, b, a))
 
       Black = [0.0, 0.0, 0.0, 1.0], White = [1.0, 1.0, 1.0, 1.0]
 
@@ -110,13 +110,13 @@ base class --- :class:`SCA_IObject`
       Gets the position of this vertex.
 
       :return: this vertexes position in local coordinates.
-      :rtype: list [x, y, z]
+      :rtype: Vector((x, y, z))
 
    .. method:: setXYZ(pos)
 
       Sets the position of this vertex.
 
-      :type:  list [x, y, z]
+      :type:  Vector((x, y, z))
 
       :arg pos: the new position for this vertex in local coordinates.
 
@@ -125,26 +125,26 @@ base class --- :class:`SCA_IObject`
       Gets the UV (texture) coordinates of this vertex.
 
       :return: this vertexes UV (texture) coordinates.
-      :rtype: list [u, v]
+      :rtype: Vector((u, v))
 
    .. method:: setUV(uv)
 
       Sets the UV (texture) coordinates of this vertex.
 
-      :type:  list [u, v]
+      :type:  Vector((u, v))
 
    .. method:: getUV2()
 
       Gets the 2nd UV (texture) coordinates of this vertex.
 
       :return: this vertexes UV (texture) coordinates.
-      :rtype: list [u, v]
+      :rtype: Vector((u, v))
 
    .. method:: setUV2(uv, unit)
 
       Sets the 2nd UV (texture) coordinates of this vertex.
 
-      :type:  list [u, v]
+      :type:  Vector((u, v))
 
       :arg unit: optional argument, FLAT==1, SECOND_UV==2, defaults to SECOND_UV
       :arg unit:  integer
@@ -197,7 +197,7 @@ base class --- :class:`SCA_IObject`
       Gets the normal vector of this vertex.
 
       :return: normalized normal vector.
-      :rtype: list [nx, ny, nz]
+      :rtype: Vector((nx, ny, nz))
 
    .. method:: setNormal(normal)
 
diff --git a/doc/python_api/rst/bge_types/bge.types.SCA_PythonMouse.rst b/doc/python_api/rst/bge_types/bge.types.SCA_PythonMouse.rst
index b1c6e5d1487..5dfa78d3942 100644
--- a/doc/python_api/rst/bge_types/bge.types.SCA_PythonMouse.rst
+++ b/doc/python_api/rst/bge_types/bge.types.SCA_PythonMouse.rst
@@ -25,7 +25,7 @@ base class --- :class:`PyObjectPlus`
 
       The normalized x and y position of the mouse cursor.
 
-      :type: list [x, y]
+      :type: tuple (x, y)
 
    .. attribute:: visible