2.50: svn merge https://svn.blender.org/svnroot/bf-blender/trunk/blender -r19323...
[blender.git] / source / gameengine / PyDoc / KX_SceneActuator.py
1 # $Id$
2 # Documentation for KX_SceneActuator
3 from SCA_IActuator import *
4
5 class KX_SceneActuator(SCA_IActuator):
6         """
7         Scene Actuator logic brick.
8         
9         @warning: Scene actuators that use a scene name will be ignored if at game start, the
10                   named scene doesn't exist or is empty
11
12                   This will generate a warning in the console:
13                   
14                   C{ERROR: GameObject I{OBName} has a SceneActuator I{ActuatorName} (SetScene) without scene}
15         
16         @ivar scene: the name of the scene to change to/overlay/underlay/remove/suspend/resume
17         @type scene: string.
18         @ivar camera: the camera to change to.
19                       When setting the attribute, you can use either a L{KX_Camera} or the name of the camera.
20         @type camera: L{KX_Camera} on read, string or L{KX_Camera} on write
21         """
22         def setUseRestart(flag):
23                 """
24                 DEPRECATED
25                 Set flag to True to restart the scene.
26                 
27                 @type flag: boolean
28                 """
29         def setScene(scene):
30                 """
31                 DEPRECATED: use the scene property instead
32                 Sets the name of the scene to change to/overlay/underlay/remove/suspend/resume.
33                 
34                 @type scene: string
35                 """
36         def setCamera(camera):
37                 """
38                 DEPRECATED: use the camera property instead
39                 Sets the camera to change to.
40                 
41                 Camera can be either a L{KX_Camera} or the name of the camera.
42                 
43                 @type camera: L{KX_Camera} or string
44                 """
45         def getUseRestart():
46                 """
47                 DEPRECATED
48                 Returns True if the scene will be restarted.
49                 
50                 @rtype: boolean
51                 """
52         def getScene():
53                 """
54                 DEPRECATED: use the scene property instead
55                 Returns the name of the scene to change to/overlay/underlay/remove/suspend/resume.
56                 
57                 Returns an empty string ("") if no scene has been set.
58                 
59                 @rtype: string
60                 """
61         def getCamera():
62                 """
63                 DEPRECATED: use the camera property instead
64                 Returns the name of the camera to change to.
65                 
66                 @rtype: string
67                 """