File: operators.rst

package info (click to toggle)
blender-doc 4.3-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 253,604 kB
  • sloc: python: 13,030; javascript: 322; makefile: 113; sh: 107
file content (110 lines) | stat: -rw-r--r-- 2,647 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110

*********
Operators
*********

.. _bpy.ops.wm.operator_cheat_sheet:

Operator Cheat Sheet
====================

.. reference::

   :Menu:      :menuselection:`Help --> Operator Cheat Sheet`
   :Context:   Enable :ref:`Developer Extras <bpy.types.PreferencesView.show_developer_ui>`

Creates a text file in the Text Editor that gives a list of all operators
and their default values in Python syntax, along with the generated docs.
This is a good way to get an overview of all Blender's operators.

.. seealso::

   `Blender's API documentation <https://docs.blender.org/api/current/>`__


System Operators
================

.. _bpy.ops.script.reload:

Reload Scripts
--------------

.. reference::

   :Mode:      All Modes
   :Menu:      :menuselection:`Topbar --> Blender --> System --> Reload Scripts`

Reloads all scripts found in the scripts data folder;
any changes that have been made in the Text Editor will be lost!


.. _bpy.ops.wm.memory_statistics:

Memory Statistics
-----------------

.. reference::

   :Mode:      ``--debug-memory``
   :Menu:      :menuselection:`Topbar --> Blender --> System --> Memory Statistics`

This operator which can be found by searching "Memory Statistics"
with the :ref:`Operator Search <bpy.ops.wm.search_operator>`
will print useful information about memory objects, their size and user count.

.. important::

   To fully use this operator run Blender from the console with ``--debug-memory``.


.. _bpy.ops.wm.debug_menu:

Debug Menu
----------

.. reference::

   :Mode:      All Modes
   :Menu:      :menuselection:`Topbar --> Blender --> System --> Debug Menu`

This operator brings up a menu to set Blender into a certain debug mode.

See the
`source code <https://projects.blender.org/blender/blender/src/branch/main/source/blender/blenkernel/BKE_global.h>`__
for a description of what each value does.

.. tip::

   Developers can search the code for ``G.debug_value`` to find other possible uses for this operator.

.. note::

   Additional debug options are available by launching Blender in debug mode or setting ``bpy.app.debug = True``.


.. _bpy.ops.wm.redraw_timer:

Redraw Timer
------------

.. reference::

   :Mode:      All Modes
   :Menu:      :menuselection:`Topbar --> Blender --> System --> Redraw Timer`

This operator brings up a menu with a list of tests
to benchmark UI render times along with undo/redo functions.


.. _bpy.ops.screen.spacedata_cleanup:

Clean Up Space-Data
-------------------

.. reference::

   :Mode:      All Modes
   :Menu:      :menuselection:`Topbar --> Blender --> System --> Clean Up Space-data`

Removes unused settings for invisible editors.