Module KX_SceneActuator :: Class KX_SceneActuator
[frames | no frames]

Class KX_SceneActuator

SCA_ILogicBrick --+    
                  |    
      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

Method Summary
string getCamera()
Returns the name of the camera to change to.
string getScene()
Returns the name of the scene to change to/overlay/underlay/remove/suspend/resume.
boolean getUseRestart()
Returns True if the scene will be restarted.
  setCamera(camera)
Sets the camera to change to.
  setScene(scene)
Sets the name of the scene to change to/overlay/underlay/remove/suspend/resume.
  setUseRestart(flag)
Set flag to True to restart the scene.
    Inherited from SCA_ILogicBrick
integer getExecutePriority()
Gets the execution priority of this logic brick.
KX_GameObject getOwner()
Gets the game object associated with this logic brick.
  setExecutePriority(priority)
Sets the priority of this logic brick.

Method Details

getCamera()

Returns the name of the camera to change to.
Returns:
string

getScene()

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

getUseRestart()

Returns True if the scene will be restarted.
Returns:
boolean

setCamera(camera)

Sets the camera to change to.

Camera can be either a KX_Camera or the name of the camera.
Parameters:
camera
           (type=KX_Camera or string)

setScene(scene)

Sets the name of the scene to change to/overlay/underlay/remove/suspend/resume.
Parameters:
scene
           (type=string)

setUseRestart(flag)

Set flag to True to restart the scene.
Parameters:
flag
           (type=boolean)

Generated by Epydoc 2.1 on Thu Feb 1 00:12:33 2007 http://epydoc.sf.net