BGE patch 17547 applied in trunk: Cleaned up pydoc for BGE, compiles now error free
This commit is contained in:
@@ -30,11 +30,11 @@ class KX_GameObject:
|
||||
Delete this object, can be used inpace of the EndObject Actuator.
|
||||
The actual removal of the object from the scene is delayed.
|
||||
"""
|
||||
def getVisible(visible):
|
||||
def getVisible():
|
||||
"""
|
||||
Gets the game object's visible flag.
|
||||
|
||||
@type visible: boolean
|
||||
@rtype: boolean
|
||||
"""
|
||||
def setVisible(visible):
|
||||
"""
|
||||
@@ -49,12 +49,12 @@ class KX_GameObject:
|
||||
@rtype: int
|
||||
@return: the objects state.
|
||||
"""
|
||||
def setState():
|
||||
def setState(state):
|
||||
"""
|
||||
Sets the game object's visible flag.
|
||||
Sets the game object's state flag.
|
||||
The bitmasks for states from 1 to 30 can be set with (1<<0, 1<<1, 1<<2 ... 1<<29)
|
||||
|
||||
@type visible: boolean
|
||||
@type state: integer
|
||||
"""
|
||||
def setPosition(pos):
|
||||
"""
|
||||
@@ -342,7 +342,7 @@ class KX_GameObject:
|
||||
@param poly: polygon option: 1=>return value is a 4-tuple and the 4th element is a L{KX_PolyProxy}
|
||||
@type poly: int
|
||||
@rtype: 3-tuple (L{KX_GameObject}, 3-tuple (x,y,z), 3-tuple (nx,ny,nz))
|
||||
or 4-tuple (L{KX_GameObject}, 3-tuple (x,y,z), 3-tuple (nx,ny,nz), L{KX_PolyProxy))
|
||||
or 4-tuple (L{KX_GameObject}, 3-tuple (x,y,z), 3-tuple (nx,ny,nz), L{KX_PolyProxy})
|
||||
@return: (object,hitpoint,hitnormal) or (object,hitpoint,hitnormal,polygon)
|
||||
If no hit, returns (None,None,None) or (None,None,None,None)
|
||||
If the object hit is not a static mesh, polygon is None
|
||||
|
||||
@@ -111,9 +111,7 @@ class KX_ObjectActuator(SCA_IActuator):
|
||||
For the servo control actuator, this is the target speed.
|
||||
|
||||
@rtype: list [vx, vy, vz, local]
|
||||
@return: A four item list, containing the vector velocity, and whether
|
||||
the velocity is applied in local coordinates (True) or world
|
||||
coordinates (False)
|
||||
@return: A four item list, containing the vector velocity, and whether the velocity is applied in local coordinates (True) or world coordinates (False)
|
||||
"""
|
||||
def setLinearVelocity(vx, vy, vz, local):
|
||||
"""
|
||||
|
||||
@@ -59,7 +59,7 @@ class KX_PolyProxy:
|
||||
|
||||
@rtype: integer
|
||||
@return: the material index in the mesh
|
||||
|
||||
"""
|
||||
def getNumVertex():
|
||||
"""
|
||||
Returns the number of vertex of the polygon.
|
||||
|
||||
@@ -21,7 +21,7 @@ class KX_TrackToActuator(SCA_IActuator):
|
||||
@type object: L{KX_GameObject}, string or None
|
||||
@param object: Either a reference to a game object or the name of the object to track.
|
||||
"""
|
||||
def getObject():
|
||||
def getObject(name_only):
|
||||
"""
|
||||
Returns the name of the object to track.
|
||||
|
||||
|
||||
@@ -84,7 +84,8 @@ def setMousePosition(x, y):
|
||||
"""
|
||||
Sets the mouse cursor position.
|
||||
|
||||
@type x, y: integer
|
||||
@type x: integer
|
||||
@type y: integer
|
||||
"""
|
||||
|
||||
def setBackgroundColor(rgba):
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# $Id$
|
||||
# Documentation for SCA_DelaySensor
|
||||
from SCA_IActuator import *
|
||||
from SCA_ISensor import *
|
||||
|
||||
class SCA_DelaySensor(SCA_ISensor):
|
||||
"""
|
||||
|
||||
Reference in New Issue
Block a user