archive/blender-archive
Archived
1
1
Fork 0
Code Pull Requests Packages Activity

Update foreach_get/_set doc.

Browse Source
This commit is contained in:
Bastien Montagne
2013-09-17 14:02:13 +00:00
parent edde749850
commit daa87ff0b4
1 changed files with 7 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
source/blender/python/intern/bpy_rna.c
View File

@@ -4601,12 +4601,15 @@ PyDoc_STRVAR(pyrna_prop_collection_foreach_get_doc,
"\n"
" This is a function to give fast access to attributes within a collection.\n"
"\n"
" Only works for 'basic type' properties (bool, int and float)!\n"
" Multi-dimensional arrays (like array of vectors) will be flattened into seq.\n"
"\n"
" .. code-block:: python\n"
"\n"
" collection.foreach_get(attr, someseq)\n"
"\n"
" # Python equivalent\n"
" for i in range(len(seq)): someseq[i] = getattr(collection, attr)\n"
" for i in range(len(seq)): someseq[i] = getattr(collection[i], attr)\n"
"\n"
);
static PyObject *pyrna_prop_collection_foreach_get(BPy_PropertyRNA *self, PyObject *args)
@@ -4621,6 +4624,9 @@ PyDoc_STRVAR(pyrna_prop_collection_foreach_set_doc,
"\n"
" This is a function to give fast access to attributes within a collection.\n"
"\n"
" Only works for 'basic type' properties (bool, int and float)!\n"
" seq must be uni-dimensional, multi-dimensional arrays (like array of vectors) will be re-created from it.\n"
"\n"
" .. code-block:: python\n"
"\n"
" collection.foreach_set(attr, seq)\n"