Trees       Indices       Help   
Blender Game API post 2.49a (26/08/2009)
Module GameTypes :: Class KX_ParentActuator
[hide private]
[frames] | no frames]

Class KX_ParentActuator

source code

PyObjectPlus --+            
               |            
          CValue --+        
                   |        
     SCA_ILogicBrick --+    
                       |    
           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
    Deprecated
    Inherited from SCA_ILogicBrick
integer
getExecutePriority()
Gets the execution priority of this logic brick.		 source code
KX_GameObject
getOwner()
Gets the game object associated with this logic brick.		 source code
 
setExecutePriority(priority)
Sets the priority of this logic brick.		 source code
    Inherited from CValue
string
getName()
Returns the name of the CValue.		 source code
    Inherited from PyObjectPlus
bool
isA(game_type)
Check if this is a type or a subtype game_type.		 source code
Instance Variables [hide private]
bool compound
Whether the object shape should be added to the parent compound shape when parenting Effective only if the parent is already a compound shape
bool ghost
whether the object should be made ghost when parenting Effective only if the shape is not added to the parent compound shape
int from 0 to 1 GameLogic.Parent Actuator mode
The mode of this actuator
KX_GameObject or None object
the object this actuator sets the parent too.
    Inherited from SCA_ILogicBrick
int executePriority
This determines the order controllers are evaluated, and actuators are activated (lower priority is executed first).
string name
The name of this CValue derived object (read-only).
KX_GameObject or None in exceptional cases. owner
The game object this logic brick is attached to (read-only).
    Inherited from PyObjectPlus
bool invalid
Test if the object has been freed by the game engine and is no longer valid.
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.

Deprecated: Use the object property.

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

Deprecated: Use the object property.


   Trees       Indices       Help   
Blender Game API post 2.49a (26/08/2009)
Generated by Epydoc 3.0beta1 on Wed Aug 26 12:07:41 2009 http://epydoc.sourceforge.net