Module KX_SceneActuator :: Class KX_SceneActuator

Class KX_SceneActuator

SCA_ILogicBrick.SCA_ILogicBrick --+    
                                  |    
        SCA_IActuator.SCA_IActuator --+
                                      |
                                     KX_SceneActuator

Scene Actuator logic brick.


Warning: Scene actuators that use a scene name will be ignored if at game start, the named scene doesn't exist or is empty

This will generate a warning in the console:

ERROR: GameObject OBName has a SceneActuator ActuatorName (SetScene) without scene

Instance Methods
 
setUseRestart(flag)
DEPRECATED Set flag to True to restart the scene.
 
setScene(scene)
DEPRECATED: use the scene property instead Sets the name of the scene to change to/overlay/underlay/remove/suspend/resume.
 
setCamera(camera)
DEPRECATED: use the camera property instead Sets the camera to change to.
boolean
getUseRestart()
DEPRECATED Returns True if the scene will be restarted.
string
getScene()
DEPRECATED: use the scene property instead Returns the name of the scene to change to/overlay/underlay/remove/suspend/resume.
string
getCamera()
DEPRECATED: use the camera property instead Returns the name of the camera to change to.
integer
getExecutePriority()
Gets the execution priority of this logic brick. (Inherited from SCA_ILogicBrick.SCA_ILogicBrick)
KX_GameObject
getOwner()
Gets the game object associated with this logic brick. (Inherited from SCA_ILogicBrick.SCA_ILogicBrick)
 
setExecutePriority(priority)
Sets the priority of this logic brick. (Inherited from SCA_ILogicBrick.SCA_ILogicBrick)
Instance Variables
KX_Camera on read, string or KX_Camera on write camera
the camera to change to.
int executePriority
This determines the order controllers are evaluated, and actuators are activated (lower priority is executed first). (Inherited from SCA_ILogicBrick.SCA_ILogicBrick)
KX_GameObject or None in exceptional cases. owner
The game object this logic brick is attached to (read only). (Inherited from SCA_ILogicBrick.SCA_ILogicBrick)
string. scene
the name of the scene to change to/overlay/underlay/remove/suspend/resume
Method Details

setUseRestart(flag)

 

DEPRECATED Set flag to True to restart the scene.

Parameters:
  • flag (boolean)

setScene(scene)

 

DEPRECATED: use the scene property instead Sets the name of the scene to change to/overlay/underlay/remove/suspend/resume.

Parameters:
  • scene (string)

setCamera(camera)

 

DEPRECATED: use the camera property instead Sets the camera to change to.

Camera can be either a KX_Camera or the name of the camera.

Parameters:

getScene()

 

DEPRECATED: use the scene property instead Returns the name of the scene to change to/overlay/underlay/remove/suspend/resume.

Returns an empty string ("") if no scene has been set.

Returns: string

Instance Variable Details

camera

the camera to change to. When setting the attribute, you can use either a KX_Camera or the name of the camera.
Type:
KX_Camera on read, string or KX_Camera on write