blob: 1e2bfe60a4fd1622cd9c38f77de810f3b492cf8b (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
|
# $Id$
# Documentation for KX_ParentActuator
from SCA_IActuator import *
class KX_ParentActuator(SCA_IActuator):
"""
The parent actuator can set or remove an objects parent object.
@ivar object: the object this actuator sets the parent too.
@type object: KX_GameObject or None
@ivar mode: The mode of this actuator
@type mode: int from 0 to 1 L{GameLogic.Parent Actuator}
"""
def setObject(object):
"""
DEPRECATED: Use the object property.
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):
"""
DEPRECATED: Use the object property.
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
"""
|