Pydoc: Fix multiple bpy.type modules
[blender.git] / doc / python_api / rst / bge_types / bge.types.KX_SceneActuator.rst
1 KX_SceneActuator(SCA_IActuator)
2 ===============================
3
4 base class --- :class:`SCA_IActuator`
5
6 .. class:: KX_SceneActuator(SCA_IActuator)
7
8    Scene Actuator logic brick.
9
10    .. warning::
11
12       Scene actuators that use a scene name will be ignored if at game start, the named scene doesn't exist or is empty
13
14       This will generate a warning in the console:
15
16       .. code-block:: none
17       
18          Error: GameObject 'Name' has a SceneActuator 'ActuatorName' (SetScene) without scene
19
20    .. attribute:: scene
21
22       the name of the scene to change to/overlay/underlay/remove/suspend/resume.
23
24       :type: string
25
26    .. attribute:: camera
27
28       the camera to change to.
29
30       :type: :class:`KX_Camera` on read, string or :class:`KX_Camera` on write
31       
32       .. note::
33          
34          When setting the attribute, you can use either a :class:`KX_Camera` or the name of the camera.
35
36    .. attribute:: useRestart
37
38       Set flag to True to restart the sene.
39
40       :type: boolean
41
42    .. attribute:: mode
43
44       The mode of the actuator.
45
46       :type: integer from 0 to 5.