Welcome to mirror list, hosted at ThFree Co, Russian Federation.

git.blender.org/blender.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat (limited to 'source/blender/python/api2_2x/doc')
-rw-r--r--source/blender/python/api2_2x/doc/API_intro.py30
-rw-r--r--source/blender/python/api2_2x/doc/Effect.py13
2 files changed, 28 insertions, 15 deletions
diff --git a/source/blender/python/api2_2x/doc/API_intro.py b/source/blender/python/api2_2x/doc/API_intro.py
index 8f684c79144..bceef653dca 100644
--- a/source/blender/python/api2_2x/doc/API_intro.py
+++ b/source/blender/python/api2_2x/doc/API_intro.py
@@ -18,7 +18,7 @@ The Blender Python API Reference
- L{Camera}
- L{Curve}
- L{Draw}
- - L{Effect}
+ - L{Effect} (*)
- L{Image}
- L{Ipo}
- L{Lamp}
@@ -97,15 +97,16 @@ Registering scripts:
The header should be like this one (all double and single apostrophes below
are required)::
#!BPY
- \"\"\"
- Name: 'Script Name'
- Blender: 233
- Group: 'Export'
- Submenu: 'All' all
- Submenu: 'Selected' sel
- Submenu: 'Configure (gui)' gui
- Tooltip: 'Export to some format.'
- \"\"\"
+
+ # \"\"\"
+ # Name: 'Script Name'
+ # Blender: 233
+ # Group: 'Export'
+ # Submenu: 'All' all
+ # Submenu: 'Selected' sel
+ # Submenu: 'Configure (gui)' gui
+ # Tooltip: 'Export to some format.'
+ # \"\"\"
where:
- B{Name} is the string that will appear in the menu;
@@ -115,6 +116,15 @@ Registering scripts:
- B{Submenu} adds optional submenus for further control;
- B{Tooltip} is the (short) tooltip string for the menu entry.
+ note:
+ - all double and single apostrophes above are required;
+ - B{*NEW*}: you can "comment out" the header above, by starting lines with
+ '#', like we did. This is not required (except for the first line, #!BPY,
+ of course), but this way the header won't conflict with Python tools that
+ you can use to generate documentation for your script code. Just
+ remember to keep this header above any other line with triple
+ double-quotes (\"\"\") in your script.
+
Submenu lines are not required, use them if you want to provide extra
options. To see which submenu the user chose, check the "__script__"
dictionary in your code: __script__['arg'] has the defined keyword (the word
diff --git a/source/blender/python/api2_2x/doc/Effect.py b/source/blender/python/api2_2x/doc/Effect.py
index e25310cbced..b503523d3ec 100644
--- a/source/blender/python/api2_2x/doc/Effect.py
+++ b/source/blender/python/api2_2x/doc/Effect.py
@@ -3,6 +3,8 @@
"""
The Blender.Effect submodule
+B{new}: now L{Get}('objname') (without specifying second paramenter: 'position') returns a list of all effects linked to object "objname".
+
INTRODUCTION
The module effect allows you to access all the data of an effect.
@@ -39,16 +41,17 @@ def New (type):
@return: The created Effect.
"""
-def Get (objname,position):
+def Get (objname, position = None):
"""
Get an Effect from Blender.
@type objname: string
@param objname: The name of object to which is linked the effect.
- @type position: string
- @param position: The position of the effect in the list of effects liked to the object.
+ @type position: int
+ @param position: The position of the effect in the list of effects linked to the object.
@rtype: Blender Effect or a list of Blender Effects
- @return: It depends on the 'objname,position' parameters:
- - (objname,position): The Effect linked to the given object at the given position;
+ @return: It depends on the 'objname, position' parameters:
+ - (objname): A list with all Effects linked to the given object (new);
+ - (objname, position): The Effect linked to the given object at the given position;
- (): A list with all Effects in the current scene.
"""