BPython:
[blender.git] / source / blender / python / api2_2x / doc / Blender.py
1 # The Blender Module
2
3 # The module files in this folder are used to create the API documentation.
4 # Doc system used: epydoc - http://epydoc.sf.net
5 # command line:
6
7 # epydoc -o BPY_API_230 --url "http://www.blender.org" -t Blender.py \
8 # -n "Blender" --no-private --no-frames Blender.py \
9 # Types.py Scene.py Object.py NMesh.py Material.py Camera.py Lamp.py \
10 # Armature.py Metaball.py Effect.py Curve.py Ipo.py World.py BGL.py Window.py \
11 # Draw.py Image.py Text.py Lattice.py Texture.py Registry.py Sys.py Mathutils.py
12
13 """
14 The main Blender module.
15
16 The Blender Python API Reference
17 ================================
18
19  Submodules:
20  -----------
21
22   - L{Armature}
23      - L{Bone}
24      - L{NLA}
25   - L{BGL}
26   - L{Camera}
27   - L{Curve}
28   - L{Draw}
29   - L{Effect}
30   - L{Image}
31   - L{Ipo}
32   - L{Lamp}
33   - L{Lattice}
34   - L{Library}
35   - L{Material}
36   - L{Mathutils}
37   - L{Metaball}
38   - L{NMesh}
39   - L{Noise}
40   - L{Object}
41   - L{Registry}
42   - L{Scene}
43      - L{Render}
44   - L{Text}
45   - L{Texture}
46   - L{Types}
47   - L{Window}
48   - L{World}
49   - L{sys<Sys>}
50
51  Introduction:
52  -------------
53
54  This Reference documents the Blender Python API, a growing collection of
55  Python modules (libs) that give access to part of the program's internal data
56  and functions.
57  
58  Through scripting, Blender can be extended in realtime.  Possibilities range
59  from simple functionality to importers / exporters and even more complex
60  "applications".  Blender scripts are written in
61  U{Python <www.python.org>}, an impressive high level, multi-paradigm,
62  open-source language.
63
64 @author: The Blender Python Team
65 @requires: Blender 2.34 or newer.
66 @version: 2.34
67 @see: U{www.blender.org<http://www.blender.org>}
68 @see: U{projects.blender.org<http://projects.blender.org>}
69 @see: U{www.python.org<http://www.python.org>}
70 @see: U{www.python.org/doc<http://www.python.org/doc>}
71 """
72
73 def Set (request, data):
74   """
75   Update settings in Blender.
76   @type request: string
77   @param request: The setting to change:
78       - 'curframe': the current animation frame
79   @type data: int
80   @param data: The new value.
81   """
82
83 def Get (request):
84   """
85   Retrieve settings from Blender.
86   @type request: string
87   @param request: The setting data to be returned:
88       - 'curframe': the current animation frame
89       - 'curtime' : the current animation time
90       - 'staframe': the start frame of the animation
91       - 'endframe': the end frame of the animation
92       - 'filename': the name of the last file read or written
93       - 'datadir' : the path to the dir where scripts should store and
94             retrieve their data files, including saved configuration (can
95             be None, if not found).
96       - 'version' : the Blender version number
97   @return: The requested data.
98   """
99
100 def Redraw ():
101   """
102   Redraw all 3D windows.
103   """
104
105 def Load (filename = None):
106   """
107   Load a Blender .blend file.
108   @type filename: string
109   @param filename: the pathname to the desired .blend file.  If 'filename'
110       isn't given or if it contains the substring '.B.blend', the default
111       .B.blend file is loaded.
112
113   @warn: loading a new .blend file removes the current data in Blender.  For
114      safety, this function saves the current data as an autosave file in
115      the temporary dir used by Blender before loading the new file.
116   """
117
118 def Save (filename, overwrite = 0):
119   """
120   Save a Blender .blend file with the current program data.
121   @type filename: string
122   @param filename: the pathname for the desired .blend file.  If it doesn't
123       contain ".blend", this extension is automatically appended.
124   @type overwrite: int (bool)
125   @param overwrite: if non-zero, file 'filename' will be overwritten if it
126       already exists.  By default existing files are not overwritten (an error
127       is returned).
128
129   @note: the substring ".B.blend" is not accepted inside 'filename'.
130   """
131
132 def Quit ():
133   """
134   Exit from Blender immediately.
135   @warn: the use of this function should obviously be avoided, it is available
136      because there are some cases where it can be useful, like in automated
137      tests.  For safety, a "quit.blend" file is saved (normal Blender behavior
138      upon exiting) when this function is called, so the data in Blender isn't
139      lost.
140   """