blob: 6e27257533ee0a534360199eea322585b01a8a4b (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
|
# $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}
@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.
@type camera: L{KX_Camera} or string
"""
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.
@rtype: string
"""
def getCamera():
"""
DEPRECATED: use the camera property instead
Returns the name of the camera to change to.
@rtype: string
"""
|