add warning about misuse of ID.user_clear() since it can crash blender.
[blender.git] / doc / python_api / examples / bpy.types.ID.user_clear.1.py
1 """
2 User Clear
3 ++++++++++
4 This function is for advanced use only, misuse can crash blender since the user
5 count is used to prevent data being removed when it is used.
6 """
7
8 # This example shows what _not_ to do, and will crash blender.
9 import bpy
10
11 # object which is in the scene.
12 obj = bpy.data.objects["Cube"]
13
14 # without this, removal would raise an error.
15 obj.user_clear()
16
17 # runs without an exception
18 # but will crash on redraw.
19 bpy.data.objects.remove(obj)