SpaceConsole(Space)

base classes — bpy_struct, Space

class bpy.types.SpaceConsole(Space)

Interactive python console

font_size

Font size to use for displaying the text

Type:int in [8, 32], default 0
history

Command history

Type:bpy_prop_collection of ConsoleLine, (readonly)
language

Command line prompt language

Type:string, default “”, (never None)
prompt

Command line prompt

Type:string, default “”, (never None)
scrollback

Command output

Type:bpy_prop_collection of ConsoleLine, (readonly)
select_end
Type:int in [0, inf], default 0
select_start
Type:int in [0, inf], default 0
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
draw_handler_add(callback, args, region_type, draw_type)

Add a new draw handler to this space type. It will be called every time the specified region in the space type will be drawn. Note: All arguments are positional only for now.

Parameters:
  • callback (function) – A function that will be called when the region is drawn. It gets the specified arguments as input.
  • args (tuple) – Arguments that will be passed to the callback.
  • region_type (str) – The region type the callback draws in; usually WINDOW. (bpy.types.Region.type)
  • draw_type (str) – Usually POST_PIXEL for 2D drawing and POST_VIEW for 3D drawing. In some cases PRE_VIEW can be used. BACKDROP can be used for backdrops in the node editor.
Returns:

Handler that can be removed later on.
Return type:

object
draw_handler_remove(handler, region_type)

Remove a draw handler that was added previously.

Parameters:
  • handler (object) – The draw handler that should be removed.
  • region_type (str) – Region type the callback was added to.

Inherited Properties

Inherited Functions