Collection(ID)

base classes — bpy_struct, ID

class bpy.types.Collection(ID)

Collection of Object data-blocks

all_objects

Objects that are in this collection and its child collections

Type

bpy_prop_collection of Object, (readonly)

children

Collections that are immediate children of this collection

Type

CollectionChildren bpy_prop_collection of Collection, (readonly)

color_tag

Color tag for a collection

  • NONE None, Assign no color tag to the collection.

  • COLOR_01 Color 01.

  • COLOR_02 Color 02.

  • COLOR_03 Color 03.

  • COLOR_04 Color 04.

  • COLOR_05 Color 05.

  • COLOR_06 Color 06.

  • COLOR_07 Color 07.

  • COLOR_08 Color 08.

Type

enum in [‘NONE’, ‘COLOR_01’, ‘COLOR_02’, ‘COLOR_03’, ‘COLOR_04’, ‘COLOR_05’, ‘COLOR_06’, ‘COLOR_07’, ‘COLOR_08’], default ‘NONE’

hide_render

Globally disable in renders

Type

boolean, default False

hide_select

Disable selection in viewport

Type

boolean, default False

hide_viewport

Globally disable in viewports

Type

boolean, default False

instance_offset

Offset from the origin to use when instancing

Type

float array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0)

objects

Objects that are directly in this collection

Type

CollectionObjects bpy_prop_collection of Object, (readonly)

use_collection_spawn

Spawn behaviour when instanced

Type

boolean, default False

users_dupli_group

The collection instance objects this collection is used in

(readonly)

classmethod bl_rna_get_subclass(id, default=None)
Parameters

id (string) – The RNA type identifier.

Returns

The RNA type or default when not found.

Return type

bpy.types.Struct subclass

classmethod bl_rna_get_subclass_py(id, default=None)
Parameters

id (string) – The RNA type identifier.

Returns

The class or default when not found.

Return type

type

Inherited Properties

Inherited Functions

References