BlendDataMasks(bpy_struct)

base class — bpy_struct

class bpy.types.BlendDataMasks.BlendDataMasks(bpy_struct)

Collection of masks

tag(value)

tag

Parameters

value (boolean) – Value

new(name)

Add a new mask with a given name to the main database

Parameters

name (string, (never None)) – Mask, Name of new mask data-block

Returns

New mask data-block

Return type

Mask

remove(mask, do_unlink=True, do_id_user=True, do_ui_user=True)

Remove a masks from the current blendfile.

Parameters
  • mask (Mask, (never None)) – Mask to remove

  • do_unlink (boolean, (optional)) – Unlink all usages of this mask before deleting it

  • do_id_user (boolean, (optional)) – Decrement user counter of all datablocks used by this mask

  • do_ui_user (boolean, (optional)) – Make sure interface does not reference this mask

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

  • bpy_struct.id_data

Inherited Functions

  • bpy_struct.as_pointer

  • bpy_struct.driver_add

  • bpy_struct.driver_remove

  • bpy_struct.get

  • bpy_struct.is_property_hidden

  • bpy_struct.is_property_overridable_library

  • bpy_struct.is_property_readonly

  • bpy_struct.is_property_set

  • bpy_struct.items

  • bpy_struct.keyframe_delete

  • bpy_struct.keyframe_insert

  • bpy_struct.keys

  • bpy_struct.path_from_id

  • bpy_struct.path_resolve

  • bpy_struct.pop

  • bpy_struct.property_overridable_library_set

  • bpy_struct.property_unset

  • bpy_struct.type_recast

  • bpy_struct.values

References

  • BlendData.masks