Module GameTypes :: Class KX_GameActuator

Class KX_GameActuator

PyObjectPlus --+            
               |            
          CValue --+        
                   |        
     SCA_ILogicBrick --+    
                       |    
           SCA_IActuator --+
                           |
                          KX_GameActuator

The game actuator loads a new .blend file, restarts the current .blend file or quits the game.

Properties:

Instance Methods

bool

isA(game_type)
Check if this is a type or a subtype game_type. (Inherited from GameTypes.PyObjectPlus)

Deprecated

string

getFile()
Returns the filename of the new .blend file to load.

setFile(filename)
Sets the new .blend file to load.

integer

getExecutePriority()
Gets the execution priority of this logic brick. (Inherited from GameTypes.SCA_ILogicBrick)

string

getName()
Returns the name of the CValue. (Inherited from GameTypes.CValue)

KX_GameObject

getOwner()
Gets the game object associated with this logic brick. (Inherited from GameTypes.SCA_ILogicBrick)

setExecutePriority(priority)
Sets the priority of this logic brick. (Inherited from GameTypes.SCA_ILogicBrick)

Instance Variables
int	executePriority This determines the order controllers are evaluated, and actuators are activated (lower priority is executed first). (Inherited from GameTypes.SCA_ILogicBrick)
string.	fileName the new .blend file to load
bool	invalid Test if the object has been freed by the game engine and is no longer valid. (Inherited from GameTypes.PyObjectPlus)
Constant in... GameLogic.KX_GAME_LOAD GameLogic.KX_GAME_START GameLogic.KX_GAME_RESTART GameLogic.KX_GAME_QUIT GameLogic.KX_GAME_SAVECFG GameLogic.KX_GAME_LOADCFG	mode The mode of this actuator
string	name The name of this CValue derived object (read-only). (Inherited from GameTypes.SCA_ILogicBrick)
KX_GameObject or None in exceptional cases.	owner The game object this logic brick is attached to (read-only). (Inherited from GameTypes.SCA_ILogicBrick)

Method Details

getFile()

Returns the filename of the new .blend file to load.

Returns: string

Deprecated: use the fileName property

setFile(filename)

Sets the new .blend file to load.

Parameters:

filename (string) - The file name this actuator will load.

Deprecated: use the fileName property