Module KX_ParentActuator :: Class KX_ParentActuator

Class KX_ParentActuator

SCA_ILogicBrick.SCA_ILogicBrick --+    
                                  |    
        SCA_IActuator.SCA_IActuator --+
                                      |
                                     KX_ParentActuator

The parent actuator can set or remove an objects parent object.

Instance Methods

[hide private]

setObject(object)
Sets the object to set as parent.

source code

string, KX_GameObject or None if no object is set

getObject(name_only=1)
Returns the name of the object to change to.

source code

Inherited from SCA_ILogicBrick.SCA_ILogicBrick: getExecutePriority, getOwner, setExecutePriority

Method Details

[hide private]

setObject(object)

source code

Sets the object to set as parent.

Object can be either a KX_GameObject or the name of the object.

Parameters:

object (KX_GameObject, string or None)

getObject(name_only=1)

source code

Returns the name of the object to change to.

Parameters:

name_only (bool) - optional argument, when 0 return a KX_GameObject

Returns: string, KX_GameObject or None if no object is set