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 (in [1, 256], default 0)

Type:

int

history

Command history (default None, readonly)

Type:

bpy_prop_collection[ConsoleLine]

language

Command line prompt language (default “”, never None)

Type:

str

prompt

Command line prompt (default “”, never None)

Type:

str

scrollback

Command output (default None, readonly)

Type:

bpy_prop_collection[ConsoleLine]

select_end

(in [0, inf], default 0)

Type:

int

select_start

(in [0, inf], default 0)

Type:

int

classmethod bl_rna_get_subclass(id, default=None, /)
Parameters:

  • id (str) – The RNA type identifier.

  • default (bpy.types.Struct | None) – The value to return when not found.

Returns:

The RNA type or default when not found.

Return type:

bpy.types.Struct

classmethod bl_rna_get_subclass_py(id, default=None, /)
Parameters:

  • id (str) – The RNA type identifier.

  • default (type | None) – The value to return when not found.

Returns:

The class or default when not found.

Return type:

type

classmethod 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 (Callable[..., Any]) – A function that will be called when the region is drawn. It gets the specified arguments as input, it’s return value is ignored.

  • args (tuple[Any, ...]) – 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

classmethod 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