c8912783ab7915824356ce69a6c3c1bd1f491e3f
[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         Properties:
17         
18         @ivar scene: the name of the scene to change to/overlay/underlay/remove/suspend/resume
19         @type scene: string.
20         @ivar camera: the camera to change to.
21                       When setting the attribute, you can use either a L{KX_Camera} or the name of the camera.
22         @type camera: L{KX_Camera} on read, string or L{KX_Camera} on write
23         """
24         def setUseRestart(flag):
25                 """
26                 DEPRECATED
27                 Set flag to True to restart the scene.
28                 
29                 @type flag: boolean
30                 """
31         def setScene(scene):
32                 """
33                 DEPRECATED: use the scene property instead
34                 Sets the name of the scene to change to/overlay/underlay/remove/suspend/resume.
35                 
36                 @type scene: string
37                 """
38         def setCamera(camera):
39                 """
40                 DEPRECATED: use the camera property instead
41                 Sets the camera to change to.
42                 
43                 Camera can be either a L{KX_Camera} or the name of the camera.
44                 
45                 @type camera: L{KX_Camera} or string
46                 """
47         def getUseRestart():
48                 """
49                 DEPRECATED
50                 Returns True if the scene will be restarted.
51                 
52                 @rtype: boolean
53                 """
54         def getScene():
55                 """
56                 DEPRECATED: use the scene property instead
57                 Returns the name of the scene to change to/overlay/underlay/remove/suspend/resume.
58                 
59                 Returns an empty string ("") if no scene has been set.
60                 
61                 @rtype: string
62                 """
63         def getCamera():
64                 """
65                 DEPRECATED: use the camera property instead
66                 Returns the name of the camera to change to.
67                 
68                 @rtype: string
69                 """