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

[hide private]

Deprecated

string

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

source code

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

source code

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]

string.

fileName
the new .blend file to load

Constant in...

mode
The mode of this actuator

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]

getFile()

source code

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

Returns: string

Deprecated: use the fileName property

setFile(filename)

source code

Sets the new .blend file to load.

Parameters:

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

Deprecated: use the fileName property