diff options
author | Kester Maddock <Christopher.Maddock.1@uni.massey.ac.nz> | 2004-06-02 16:43:27 +0400 |
---|---|---|
committer | Kester Maddock <Christopher.Maddock.1@uni.massey.ac.nz> | 2004-06-02 16:43:27 +0400 |
commit | 976e3a1824622c11c0bc72110345fcceae75fd73 (patch) | |
tree | 27921d8ff9ae80ed3eb288ae702ff17902a6163d /source/gameengine/PyDoc/KX_SceneActuator.py | |
parent | 474ec217aefd4057429d4cbde4c08768e833cfe5 (diff) |
Updates to GamePython Reference.
Added Actuator documentation.
Diffstat (limited to 'source/gameengine/PyDoc/KX_SceneActuator.py')
-rw-r--r-- | source/gameengine/PyDoc/KX_SceneActuator.py | 51 |
1 files changed, 51 insertions, 0 deletions
diff --git a/source/gameengine/PyDoc/KX_SceneActuator.py b/source/gameengine/PyDoc/KX_SceneActuator.py new file mode 100644 index 00000000000..e0eae7a5526 --- /dev/null +++ b/source/gameengine/PyDoc/KX_SceneActuator.py @@ -0,0 +1,51 @@ +# $Id$ +# Documentation for KX_SceneActuator +from SCA_IActuator import * + +class KX_SceneActuator(SCA_IActuator): + """ + 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: + + C{ERROR: GameObject I{OBName} has a SceneActuator I{ActuatorName} (SetScene) without scene} + """ + def setUseRestart(flag): + """ + Set flag to True to restart the scene. + + @type flag: boolean + """ + def setScene(scene): + """ + Sets the name of the scene to change to/overlay/underlay/remove/suspend/resume. + + @type scene: string + """ + def setCamera(camera): + """ + Sets the name of the camera to change to. + + @type camera: string + """ + def getUseRestart(): + """ + Returns True if the scene will be restarted. + + @rtype: boolean + """ + def getScene(): + """ + Returns the name of the scene to change to/overlay/underlay/remove/suspend/resume. + + @rtype: string + """ + def getCamera(): + """ + Returns the name of the camera to change to. + + @rtype: string + """ |