diff options
| author | Stephen Swaney <sswaney@centurytel.net> | 2004-08-05 00:52:55 +0400 |
|---|---|---|
| committer | Stephen Swaney <sswaney@centurytel.net> | 2004-08-05 00:52:55 +0400 |
| commit | 0e4cfa3fcfa3b52c4e4b16eab51b86aa3da82431 (patch) | |
| tree | 0b9c936f7e470752e2d43d7b53731db7c7883b6b /source/blender/python/api2_2x/doc/Effectdoc.txt | |
| parent | fa6d79b277c72c6bb31fdf614ff6890fdb8c615b (diff) | |
pidhash noticed some discrepancies in the bpy doc between getMode(), getFlag(),
getType() and their associated setters. I changed the doc to match the
implementation.
Also did a little spellcheck.
Diffstat (limited to 'source/blender/python/api2_2x/doc/Effectdoc.txt')
| -rw-r--r-- | source/blender/python/api2_2x/doc/Effectdoc.txt | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/source/blender/python/api2_2x/doc/Effectdoc.txt b/source/blender/python/api2_2x/doc/Effectdoc.txt index 2aa8a20eecf..76cff428ed6 100644 --- a/source/blender/python/api2_2x/doc/Effectdoc.txt +++ b/source/blender/python/api2_2x/doc/Effectdoc.txt @@ -4,10 +4,10 @@ EFFECT Module documentation INTRODUCTION The module effect allows you to access all the data of an effect. An effect can modify an object (typically a mesh) in three different ways. - a) the build effect : makes the mesh appear progressivly. + a) the build effect : makes the mesh appear progressively. b) the wave effect : waves appear on the mesh (which should be fine-grained) c) the particle effect : every vertex of the mesh emits particles, -which can themselves emit new particles. This effect is the most parametrizable. +which can themselves emit new particles. This effect is the most parameterizable. In the blender internals, the effect object is just a placeholder for the "real" effect, which can be a wave, particle or build effect. The python API follows @@ -41,11 +41,11 @@ The possible values of the type are : 2 : effect wave. -getMode()Retrieves the mode of the Effect Object +getFlag()Retrieves the flag of the Effect Object -setMode(val:int) :Sets the mode +setFlag(val:int) :Sets the flag -The mode of the effect is a combination of parameters, whose semantics depend upon the effect type. +The flag of the effect is a combination of parameters, whose semantics depend upon the effect type. All types : Bit 0 : set to 1 if the effect is selected in the effects window. Wave effect : @@ -125,7 +125,7 @@ The Object.attr syntax Wave attributes can be read/written with the object.attr syntax. Example : -w = Blender.Wave.Get("Obname",3) #retreives the 4th effect associated to the object named Obname +w = Blender.Wave.Get("Obname",3) #retrieves the 4th effect associated to the object named Obname a = w.speed # a is now the value corresponding to the speed of the effect w.speed = 42 # the speed of the effect is now equal to 42 |