Console Operators

bpy.ops.console.autocomplete()

Evaluate the namespace up until the cursor and give a list of options or complete the name if there is only one

File :ui/space_console.py:145

bpy.ops.console.banner()

Print a message whem the terminal initializes

File :ui/space_console.py:162

bpy.ops.console.clear(scrollback=True, history=False)

Clear text by type

Parameters:

• scrollback (boolean, (optional)) – Scrollback, Clear the scrollback history
• history (boolean, (optional)) – History, Clear the command history

bpy.ops.console.copy()

Copy selected text to clipboard

bpy.ops.console.delete(type='NEXT_CHARACTER')

Delete text by cursor position

Parameters:

• type (enum in [‘NEXT_CHARACTER’, ‘PREVIOUS_CHARACTER’], (optional, never None)) – Type, Which part of the text to delete.

bpy.ops.console.execute()

Execute the current console line as a python expression

File :ui/space_console.py:123

bpy.ops.console.history_append(text="", current_character=0, remove_duplicates=False)

Append history at cursor position

Parameters:

• text (string, (optional)) – Text, Text to insert at the cursor position.
• current_character (int in [0, inf], (optional)) – Cursor, The index of the cursor.
• remove_duplicates (boolean, (optional)) – Remove Duplicates, Remove duplicate items in the history

bpy.ops.console.history_cycle(reverse=False)

Cycle through history

Parameters:

• reverse (boolean, (optional)) – Reverse, reverse cycle history

bpy.ops.console.insert(text="")

Insert text at cursor position

Parameters:

• text (string, (optional)) – Text, Text to insert at the cursor position.

bpy.ops.console.language(language="")

Set the current language for this console

Parameters:

• language (string, (optional)) – Language

File :

ui/space_console.py:185

bpy.ops.console.move(type='LINE_BEGIN')

Move cursor position

Parameters:

• type (enum in [‘LINE_BEGIN’, ‘LINE_END’, ‘PREVIOUS_CHARACTER’, ‘NEXT_CHARACTER’, ‘PREVIOUS_WORD’, ‘NEXT_WORD’], (optional, never None)) – Type, Where to move cursor to.

bpy.ops.console.paste()

Paste text from clipboard

bpy.ops.console.report_copy()

Copy selected reports to Clipboard

bpy.ops.console.report_delete()

Delete selected reports

bpy.ops.console.report_replay()

Replay selected reports

bpy.ops.console.scrollback_append(text="", type='OUTPUT')

Append scrollback text by type

Parameters:

• text (string, (optional)) – Text, Text to insert at the cursor position.
• type (enum in [‘OUTPUT’, ‘INPUT’, ‘INFO’, ‘ERROR’], (optional)) – Type, Console output type.

bpy.ops.console.select_all_toggle()

(de)select all reports

bpy.ops.console.select_border(gesture_mode=0, xmin=0, xmax=0, ymin=0, ymax=0)

Toggle border selection

Parameters:

• gesture_mode (int in [-inf, inf], (optional)) – Gesture Mode
• xmin (int in [-inf, inf], (optional)) – X Min
• xmax (int in [-inf, inf], (optional)) – X Max
• ymin (int in [-inf, inf], (optional)) – Y Min
• ymax (int in [-inf, inf], (optional)) – Y Max

bpy.ops.console.select_pick(report_index=0)

Select reports by index

Parameters:

• report_index (int in [0, inf], (optional)) – Report, The index of the report.

bpy.ops.console.select_set()

Set the console selection