diff options
Diffstat (limited to 'doc/python_api/rst/bge_types/bge.types.KX_SceneActuator.rst')
-rw-r--r-- | doc/python_api/rst/bge_types/bge.types.KX_SceneActuator.rst | 49 |
1 files changed, 49 insertions, 0 deletions
diff --git a/doc/python_api/rst/bge_types/bge.types.KX_SceneActuator.rst b/doc/python_api/rst/bge_types/bge.types.KX_SceneActuator.rst new file mode 100644 index 00000000000..9d073ff5b19 --- /dev/null +++ b/doc/python_api/rst/bge_types/bge.types.KX_SceneActuator.rst @@ -0,0 +1,49 @@ +KX_SceneActuator(SCA_IActuator) +=============================== + +.. module:: bge.types + +base class --- :class:`SCA_IActuator` + +.. 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: + + .. code-block:: none + + Error: GameObject 'Name' has a SceneActuator 'ActuatorName' (SetScene) without scene + + .. attribute:: scene + + the name of the scene to change to/overlay/underlay/remove/suspend/resume. + + :type: string + + .. attribute:: camera + + the camera to change to. + + :type: :class:`KX_Camera` on read, string or :class:`KX_Camera` on write + + .. note:: + + When setting the attribute, you can use either a :class:`KX_Camera` or the name of the camera. + + .. attribute:: useRestart + + Set flag to True to restart the sene. + + :type: boolean + + .. attribute:: mode + + The mode of the actuator. + + :type: integer from 0 to 5. + |