Python API
---------- Fixing various typos (hey guys, it's helpful to proofread the documentation before you commit it :-) )
This commit is contained in:
@@ -164,7 +164,7 @@ class Armature:
|
||||
@ivar users: The number of users of the armature. Read-only.
|
||||
@type users: int
|
||||
@ivar fakeUser: The fake user status.
|
||||
enabling this will keep it in the blend even if there are no users.
|
||||
Enabling this will keep it in the blend even if there are no users.
|
||||
@type fakeUser: bool
|
||||
"""
|
||||
|
||||
|
||||
@@ -53,7 +53,7 @@ class Font:
|
||||
def pack():
|
||||
"""
|
||||
Packs the sound into the current blend file.
|
||||
@note: An error will be raised if the sound is alredy packed or the filename path does not exist.
|
||||
@note: An error will be raised if the sound is already packed or the filename path does not exist.
|
||||
@returns: nothing
|
||||
@rtype: none
|
||||
"""
|
||||
|
||||
@@ -92,7 +92,7 @@ class Group:
|
||||
@ivar users: Number of users this group has (read only)
|
||||
@type users: int
|
||||
@ivar fakeUser: The fake user status.
|
||||
enabling this will keep it in the blend even if there are no users.
|
||||
Enabling this will keep it in the blend even if there are no users.
|
||||
@type fakeUser: bool
|
||||
@ivar layers: Layer bitmask for this group.
|
||||
@type layers: int
|
||||
|
||||
@@ -317,7 +317,7 @@ class Image:
|
||||
def pack():
|
||||
"""
|
||||
Packs the image into the current blend file.
|
||||
@note: An error will be raised if the image is alredy packed or the filename path does not exist.
|
||||
@note: An error will be raised if the image is already packed or the filename path does not exist.
|
||||
@returns: nothing
|
||||
@rtype: none
|
||||
"""
|
||||
|
||||
@@ -107,7 +107,7 @@ class Material:
|
||||
===================
|
||||
This object gives access to Materials in Blender.
|
||||
@ivar properties: Returns an L{IDGroup<IDProp.IDGroup>} reference to this
|
||||
materials's ID Properties.
|
||||
material's ID Properties.
|
||||
@ivar B: Diffuse color (L{rgbCol}) blue component.
|
||||
Value is clamped to the range [0.0,1.0].
|
||||
@type B: float
|
||||
|
||||
@@ -381,10 +381,10 @@ class MEdge:
|
||||
changing the select state of an edge changes the select state of the edge's
|
||||
vertices.
|
||||
@type sel: int
|
||||
@ivar key: The edges vert indicies in an ordered tuple, this can be used as a dictionary key. Read-only.
|
||||
|
||||
@ivar key: The edge's vert indices in an ordered tuple, which can be used
|
||||
as a dictionary key. Read-only.
|
||||
This is the same as (min(ed.v1.index, ed.v2.index), max(ed.v1.index, ed.v2.index))
|
||||
@type key: typle
|
||||
@type key: tuple
|
||||
"""
|
||||
|
||||
def __iter__():
|
||||
@@ -580,8 +580,8 @@ class MFace:
|
||||
@type cent: vector
|
||||
@ivar area: The area of the face. Read-only.
|
||||
@type area: float
|
||||
@ivar edge_keys: A tuple, each item a key that can reference an edge by its ordered indicies. Read-only.
|
||||
This is usefull for building connectivity data
|
||||
@ivar edge_keys: A tuple, each item a key that can reference an edge by its
|
||||
ordered indices. Read-only. This is useful for building connectivity data.
|
||||
Example::
|
||||
from Blender import Mesh
|
||||
me = Mesh.Get('Cube')
|
||||
|
||||
@@ -132,7 +132,7 @@ class Metaball:
|
||||
@ivar users: The user count (read only)
|
||||
@type users: int
|
||||
@ivar fakeUser: The fake user status.
|
||||
enabling this will keep it in the blend even if there are no users.
|
||||
Enabling this will keep it in the blend even if there are no users.
|
||||
@type fakeUser: bool
|
||||
@ivar elements: Element iterator of MetaElemSeq type.
|
||||
@type elements: MetaElemSeq
|
||||
@@ -242,4 +242,4 @@ class Metaelem:
|
||||
@type hide: bool
|
||||
"""
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -345,7 +345,7 @@ class NMesh:
|
||||
This object gives access to mesh data in Blender. We refer to mesh as the
|
||||
object in Blender and NMesh as its Python counterpart.
|
||||
@ivar properties: Returns an L{IDGroup<IDProp.IDGroup>} reference to this
|
||||
objects's ID Properties.
|
||||
object's ID Properties.
|
||||
@type properties: L{IDGroup<IDProp.IDGroup>}
|
||||
@ivar name: The NMesh name. It's common to use this field to store extra
|
||||
data about the mesh (to be exported to another program, for example).
|
||||
|
||||
@@ -246,13 +246,13 @@ class Object:
|
||||
|
||||
B{Note}:
|
||||
When dealing with properties and functions such as LocX/RotY/getLocation(), getSize() and getEuler(),
|
||||
keep in mind that these transformation properties are relative to the objects parent (if any).
|
||||
keep in mind that these transformation properties are relative to the object's parent (if any).
|
||||
|
||||
To get these values in worldspace (taking into account vertex parents, constraints etc)
|
||||
To get these values in worldspace (taking into account vertex parents, constraints, etc.)
|
||||
pass the argument 'worldspace' to these functions.
|
||||
|
||||
@ivar properties: Returns an L{IDGroup<IDProp.IDGroup>} reference to this
|
||||
objects's ID Properties.
|
||||
object's ID Properties.
|
||||
@type properties: L{IDGroup<IDProp.IDGroup>}
|
||||
@ivar restrictDisplay: Don't display this object in the 3D view: disabled by default, use the outliner to toggle.
|
||||
@type restrictDisplay: bool
|
||||
@@ -483,7 +483,7 @@ class Object:
|
||||
@ivar users: The number of users of the object. Read-only.
|
||||
@type users: int
|
||||
@ivar fakeUser: The fake user status.
|
||||
enabling this will keep it in the blend even if there are no users.
|
||||
Enabling this will keep it in the blend even if there are no users.
|
||||
@type fakeUser: bool
|
||||
@ivar boundingBox: The bounding box of this object. Read-only.
|
||||
@type boundingBox: list of 8 3D vectors
|
||||
|
||||
@@ -130,7 +130,7 @@ class Sound:
|
||||
def pack():
|
||||
"""
|
||||
Packs the sound into the current blend file.
|
||||
@note: An error will be raised if the sound is alredy packed or the filename path does not exist.
|
||||
@note: An error will be raised if the sound is already packed or the filename path does not exist.
|
||||
@returns: nothing
|
||||
@rtype: none
|
||||
"""
|
||||
|
||||
Reference in New Issue
Block a user