← Back to branch summary

~ubuntu-branches/ubuntu/lucid/blender/lucid

« back to all changes in this revision

Viewing changes to source/gameengine/PyDoc/KX_SceneActuator.py

  • Committer: Bazaar Package Importer
  • Author(s): Chris Coulson
  • Date: 2009-08-06 22:32:19 UTC
  • mfrom: (1.2.10 upstream)
  • Revision ID: james.westby@ubuntu.com-20090806223219-8z4eej1u8levu4pz
Tags: 2.49a+dfsg-0ubuntu1
https://launchpad.net/bugs/382153
* Merge from debian unstable, remaining changes:
  - debian/control: Build-depend on python-2.6 rather than python-2.5.
  - debian/misc/*.desktop: Add Spanish translation to .desktop 
    files.
  - debian/pyversions: 2.6.
  - debian/rules: Clean *.o of source/blender/python/api2_2x/
* New upstream release (LP: #382153).
* Refreshed patches:
  - 01_sanitize_sys.patch
  - 02_tmp_in_HOME
  - 10_use_systemwide_ftgl
  - 70_portability_platform_detection
* Removed patches merged upstream:
  - 30_fix_python_syntax_warning
  - 90_ubuntu_ffmpeg_52_changes

Show diffs side-by-side

added added

removed removed

Lines of Context:
source/gameengine/PyDoc/KX_SceneActuator.py
1
 
# $Id: KX_SceneActuator.py 15444 2008-07-05 17:05:05Z lukep $
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
 
        def setUseRestart(flag):
17
 
                """
18
 
                Set flag to True to restart the scene.
19
 
                
20
 
                @type flag: boolean
21
 
                """
22
 
        def setScene(scene):
23
 
                """
24
 
                Sets the name of the scene to change to/overlay/underlay/remove/suspend/resume.
25
 
                
26
 
                @type scene: string
27
 
                """
28
 
        def setCamera(camera):
29
 
                """
30
 
                Sets the camera to change to.
31
 
                
32
 
                Camera can be either a L{KX_Camera} or the name of the camera.
33
 
                
34
 
                @type camera: L{KX_Camera} or string
35
 
                """
36
 
        def getUseRestart():
37
 
                """
38
 
                Returns True if the scene will be restarted.
39
 
                
40
 
                @rtype: boolean
41
 
                """
42
 
        def getScene():
43
 
                """
44
 
                Returns the name of the scene to change to/overlay/underlay/remove/suspend/resume.
45
 
                
46
 
                Returns an empty string ("") if no scene has been set.
47
 
                
48
 
                @rtype: string
49
 
                """
50
 
        def getCamera():
51
 
                """
52
 
                Returns the name of the camera to change to.
53
 
                
54
 
                @rtype: string
55
 
                """