diff options
Diffstat (limited to 'source/gameengine/PyDoc/KX_SceneActuator.py')
| -rw-r--r-- | source/gameengine/PyDoc/KX_SceneActuator.py | 14 |
1 files changed, 13 insertions, 1 deletions
diff --git a/source/gameengine/PyDoc/KX_SceneActuator.py b/source/gameengine/PyDoc/KX_SceneActuator.py index cfb40ae072f..6e27257533e 100644 --- a/source/gameengine/PyDoc/KX_SceneActuator.py +++ b/source/gameengine/PyDoc/KX_SceneActuator.py @@ -8,25 +8,34 @@ class KX_SceneActuator(SCA_IActuator): @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} + + @ivar scene: the name of the scene to change to/overlay/underlay/remove/suspend/resume + @type scene: string. + @ivar camera: the camera to change to. + When setting the attribute, you can use either a L{KX_Camera} or the name of the camera. + @type camera: L{KX_Camera} on read, string or L{KX_Camera} on write """ def setUseRestart(flag): """ + DEPRECATED Set flag to True to restart the scene. @type flag: boolean """ def setScene(scene): """ + DEPRECATED: use the scene property instead Sets the name of the scene to change to/overlay/underlay/remove/suspend/resume. @type scene: string """ def setCamera(camera): """ + DEPRECATED: use the camera property instead Sets the camera to change to. Camera can be either a L{KX_Camera} or the name of the camera. @@ -35,12 +44,14 @@ class KX_SceneActuator(SCA_IActuator): """ def getUseRestart(): """ + DEPRECATED Returns True if the scene will be restarted. @rtype: boolean """ def 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. @@ -49,6 +60,7 @@ class KX_SceneActuator(SCA_IActuator): """ def getCamera(): """ + DEPRECATED: use the camera property instead Returns the name of the camera to change to. @rtype: string |