Package bpy :: Package ops :: Module console
[hide private]
[frames] | no frames]

Module console

Functions [hide private]
 
autocomplete()
Evaluate the namespace up until the cursor and give a list of options or complete the name if there is only one.
 
banner()
undocumented python operator
 
clear(scrollback=True, history=False)
Clear text by type.
 
copy()
Copy selected text to clipboard.
 
delete(type='NEXT_CHARACTER')
Delete text by cursor position.
 
execute()
Execute the current console line as a python expression.
 
history_append(text='', current_character=0, remove_duplicates=False)
Append history at cursor position.
 
history_cycle(reverse=False)
Cycle through history.
 
insert(text='')
Insert text at cursor position.
 
language(language='')
Set the current language for this console
 
move(type='LINE_BEGIN')
Move cursor position.
 
paste()
Paste text from clipboard.
 
report_copy()
Copy selected reports to Clipboard.
 
report_delete()
Delete selected reports.
 
report_replay()
Replay selected reports.
 
scrollback_append(text='', type='OUTPUT')
Append scrollback text by type.
 
select_all_toggle()
(de)select all reports.
 
select_border(gesture_mode=0, xmin=0, xmax=0, ymin=0, ymax=0)
Toggle border selection.
 
select_pick(report_index=0)
Select reports by index.
 
zoom(delta=0)
Zoom screen area.
Function Details [hide private]

clear(scrollback=True, history=False)

 

Clear text by type.

Parameters:
  • scrollback (boolean)
  • history (boolean)

delete(type='NEXT_CHARACTER')

 

Delete text by cursor position.

Parameters:
  • type (enum) - Which part of the text to delete. in (NEXT_CHARACTER, PREVIOUS_CHARACTER)

history_append(text='', current_character=0, remove_duplicates=False)

 

Append history at cursor position.

Parameters:
  • current_character (int) - The index of the cursor. in (0, inf)
  • text (string)
  • remove_duplicates (boolean)

history_cycle(reverse=False)

 

Cycle through history.

Parameters:
  • reverse (boolean)

insert(text='')

 

Insert text at cursor position.

Parameters:
  • text (string)

language(language='')

 

Set the current language for this console

Parameters:
  • language (string)

move(type='LINE_BEGIN')

 

Move cursor position.

Parameters:
  • type (enum) - Where to move cursor to. in (LINE_BEGIN, LINE_END, PREVIOUS_CHARACTER, NEXT_CHARACTER, PREVIOUS_WORD, NEXT_WORD)

scrollback_append(text='', type='OUTPUT')

 

Append scrollback text by type.

Parameters:
  • type (enum) - Console output type. in (OUTPUT, INPUT, INFO, ERROR)
  • text (string)

select_border(gesture_mode=0, xmin=0, xmax=0, ymin=0, ymax=0)

 

Toggle border selection.

Parameters:
  • gesture_mode (int) - in (-inf, inf)
  • xmin (int) - in (-inf, inf)
  • xmax (int) - in (-inf, inf)
  • ymin (int) - in (-inf, inf)
  • ymax (int) - in (-inf, inf)

select_pick(report_index=0)

 

Select reports by index.

Parameters:
  • report_index (int) - The index of the report. in (0, inf)

zoom(delta=0)

 

Zoom screen area.

Parameters:
  • delta (int) - Scale the view font. in (0, inf)