Collection(ID)

base classes — bpy_struct, ID

class bpy.types.Collection(ID)

Collection of Object data-blocks

active_exporter_index

Active index in the exporters list (in [0, inf], default 0)

Type:

int

all_objects

Objects that are in this collection and its child collections (default None, readonly)

Type:

bpy_prop_collection[Object]

children

Collections that are immediate children of this collection (default None, readonly)

Type:

CollectionChildren[Collection]

collection_children

Children collections with their parent-collection-specific settings (default None, readonly)

Type:

bpy_prop_collection[CollectionChild]

collection_objects

Objects of the collection with their parent-collection-specific settings (default None, readonly)

Type:

bpy_prop_collection[CollectionObject]

color_tag

Color tag for a collection (default 'COLOR_01')

Type:

Literal[Collection Color Items]

exporters

Export Handlers configured for the collection (default None, readonly)

Type:

CollectionExports[CollectionExport]

hide_render

Globally disable in renders (default False)

Type:

bool

hide_select

Disable selection in viewport (default False)

Type:

bool

hide_viewport

Globally disable in viewports (default False)

Type:

bool

instance_offset

Offset from the origin to use when instancing (array of 3 items, in [-inf, inf], default (0.0, 0.0, 0.0))

Type:

mathutils.Vector

lineart_intersection_mask

Intersection generated by this collection will have this mask value (array of 8 items, default (False, False, False, False, False, False, False, False))

Type:

bpy_prop_array[bool]

lineart_intersection_priority

The intersection line will be included into the object with the higher intersection priority value (in [0, 255], default 0)

Type:

int

lineart_usage

How to use this collection in Line Art calculation (default 'INCLUDE')

  • INCLUDE Include – Generate feature lines for this collection.

  • OCCLUSION_ONLY Occlusion Only – Only use the collection to produce occlusion.

  • EXCLUDE Exclude – Don’t use this collection in Line Art.

  • INTERSECTION_ONLY Intersection Only – Only generate intersection lines for this collection.

  • NO_INTERSECTION No Intersection – Include this collection but do not generate intersection lines.

  • FORCE_INTERSECTION Force Intersection – Generate intersection lines even with objects that disabled intersection.

Type:

Literal[‘INCLUDE’, ‘OCCLUSION_ONLY’, ‘EXCLUDE’, ‘INTERSECTION_ONLY’, ‘NO_INTERSECTION’, ‘FORCE_INTERSECTION’]

lineart_use_intersection_mask

Use custom intersection mask for faces in this collection (default False)

Type:

bool

objects

Objects that are directly in this collection (default None, readonly)

Type:

CollectionObjects[Object]

use_collection_spawn

Spawn behaviour when instanced (default False)

Type:

bool

use_lineart_intersection_priority

Assign intersection priority value for this collection (default False)

Type:

bool

children_recursive

A list of all children from this collection.

Type:

list[Collection]

Note

Takes O(n) time, where n is the total number of all descendant collections.

(readonly)

users_dupli_group

The collection instance objects this collection is used in

Type:

tuple[Object, …]

Note

Takes O(len(bpy.data.objects)) time.

(readonly)

classmethod bl_rna_get_subclass(id, default=None, /)
Parameters:

  • id (str) – The RNA type identifier.

  • default (bpy.types.Struct | None) – The value to return when not found.

Returns:

The RNA type or default when not found.

Return type:

bpy.types.Struct

classmethod bl_rna_get_subclass_py(id, default=None, /)
Parameters:

  • id (str) – The RNA type identifier.

  • default (type | None) – The value to return when not found.

Returns:

The class or default when not found.

Return type:

type

Inherited Properties

Inherited Functions

References