- fixed errors with bge epydocs
[blender.git] / source / gameengine / PyDoc / KX_ParentActuator.py
1 # $Id$
2 # Documentation for KX_ParentActuator
3 from SCA_IActuator import *
4
5 class KX_ParentActuator(SCA_IActuator):
6         """
7         The parent actuator can set or remove an objects parent object. 
8         @ivar object: the object this actuator sets the parent too.
9         @type object: KX_GameObject or None
10         """
11         def setObject(object):
12                 """
13                 DEPRECATED: Use the object property.
14                 Sets the object to set as parent.
15                 
16                 Object can be either a L{KX_GameObject} or the name of the object.
17                 
18                 @type object: L{KX_GameObject}, string or None
19                 """
20         def getObject(name_only = 1):
21                 """
22                 DEPRECATED: Use the object property.
23                 Returns the name of the object to change to.
24                 @type name_only: bool
25                 @param name_only: optional argument, when 0 return a KX_GameObject
26                 @rtype: string, KX_GameObject or None if no object is set
27                 """