bpy_prop_collection_idprop¶
- class bpy.types.bpy_prop_collection_idprop¶
built-in class used for user defined collections.
Note
Note that
bpy.types.bpy_prop_collection_idprop
is not actually available from within Blender, it only exists for the purpose of documentation.- find(key)¶
Returns the index of a key in a collection or -1 when not found (matches Python’s string find function of the same name).
- Parameters:
key (str) – The identifier for the collection member.
- Returns:
index of the key.
- Return type:
int
- foreach_get(attr, seq)¶
This is a function to give fast access to attributes within a collection.
- foreach_set(attr, seq)¶
This is a function to give fast access to attributes within a collection.
- get(key, default=None)¶
Returns the value of the item assigned to key or default when not found (matches Python’s dictionary function of the same name).
- Parameters:
key (str) – The identifier for the collection member.
default (Any) – Optional argument for the value to return if key is not found.
- items()¶
Return the identifiers of collection members (matching Python’s dict.items() functionality).
- Returns:
(key, value) pairs for each member of this collection.
- Return type:
list[tuple[str,
bpy.types.bpy_struct
]]
- keys()¶
Return the identifiers of collection members (matching Python’s dict.keys() functionality).
- Returns:
the identifiers for each member of this collection.
- Return type:
list[str]
- values()¶
Return the values of collection (matching Python’s dict.values() functionality).
- Returns:
The members of this collection.
- Return type:
list[
bpy.types.bpy_struct
]