diff options
Diffstat (limited to 'source/gameengine/PyDoc/KX_ParentActuator.py')
| -rw-r--r-- | source/gameengine/PyDoc/KX_ParentActuator.py | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/source/gameengine/PyDoc/KX_ParentActuator.py b/source/gameengine/PyDoc/KX_ParentActuator.py new file mode 100644 index 00000000000..6d6e0937257 --- /dev/null +++ b/source/gameengine/PyDoc/KX_ParentActuator.py @@ -0,0 +1,23 @@ +# $Id: KX_ParentActuator.py 2615 2004-06-02 12:43:27Z kester $ +# Documentation for KX_ParentActuator +from SCA_IActuator import * + +class KX_ParentActuator(SCA_IActuator): + """ + The parent actuator can set or remove an objects parent object. + """ + def setObject(object): + """ + Sets the object to set as parent. + + Object can be either a L{KX_GameObject} or the name of the object. + + @type object: L{KX_GameObject}, string or None + """ + def getObject(name_only = 1): + """ + Returns the name of the object to change to. + @type name_only: bool + @param name_only: optional argument, when 0 return a KX_GameObject + @rtype: string, KX_GameObject or None if no object is set + """ |