Screen Operators

bpy.ops.screen.actionzone(modifier=0)

Handle area action zones for mouse actions/gestures

Parameters:modifier (int in [0, 2], (optional)) – Modifier, Modifier state

bpy.ops.screen.animation_cancel(restore_frame=True)

Cancel animation, returning to the original frame

Parameters:restore_frame (boolean, (optional)) – Restore Frame, Restore the frame when animation was initialized

bpy.ops.screen.animation_play(reverse=False, sync=False)

Play animation

Parameters:

• reverse (boolean, (optional)) – Play in Reverse, Animation is played backwards
• sync (boolean, (optional)) – Sync, Drop frames to maintain framerate

bpy.ops.screen.animation_step()

Step through animation by position

bpy.ops.screen.area_dupli()

Duplicate selected area into new window

bpy.ops.screen.area_join(min_x=-100, min_y=-100, max_x=-100, max_y=-100)

Join selected areas into new window

Parameters:

• min_x (int in [-inf, inf], (optional)) – X 1
• min_y (int in [-inf, inf], (optional)) – Y 1
• max_x (int in [-inf, inf], (optional)) – X 2
• max_y (int in [-inf, inf], (optional)) – Y 2

bpy.ops.screen.area_move(x=0, y=0, delta=0)

Move selected area edges

Parameters:

• x (int in [-inf, inf], (optional)) – X
• y (int in [-inf, inf], (optional)) – Y
• delta (int in [-inf, inf], (optional)) – Delta

bpy.ops.screen.area_options()

Operations for splitting and merging

bpy.ops.screen.area_split(direction='HORIZONTAL', factor=0.5, mouse_x=-100, mouse_y=-100)

Split selected area into new windows

Parameters:

• direction (enum in [‘HORIZONTAL’, ‘VERTICAL’], (optional)) – Direction
• factor (float in [0, 1], (optional)) – Factor
• mouse_x (int in [-inf, inf], (optional)) – Mouse X
• mouse_y (int in [-inf, inf], (optional)) – Mouse Y

bpy.ops.screen.area_swap()

Swap selected areas screen positions

bpy.ops.screen.back_to_previous()

Revert back to the original screen layout, before fullscreen area overlay

bpy.ops.screen.delete()

Delete active screen

bpy.ops.screen.frame_jump(end=False)

Jump to first/last frame in frame range

Parameters:end (boolean, (optional)) – Last Frame, Jump to the last frame of the frame range

bpy.ops.screen.frame_offset(delta=0)

Move current frame forward/backward by a given number

Parameters:delta (int in [-inf, inf], (optional)) – Delta

bpy.ops.screen.header_flip()

Toggle the header over/below the main window area

bpy.ops.screen.header_toggle_menus()

Show or hide the header pulldown menus

bpy.ops.screen.header_toolbox()

Display header region toolbox

bpy.ops.screen.keyframe_jump(next=True)

Jump to previous/next keyframe

Parameters:next (boolean, (optional)) – Next Keyframe

bpy.ops.screen.new()

Add a new screen

bpy.ops.screen.redo_last()

Display menu for last action performed

bpy.ops.screen.region_blend()

Blend in and out overlapping region

bpy.ops.screen.region_flip()

Toggle the region’s alignment (left/right or top/bottom)

bpy.ops.screen.region_quadview()

Split selected area into camera, front, right & top views

bpy.ops.screen.region_scale()

Scale selected area

bpy.ops.screen.repeat_history(index=0)

Display menu for previous actions performed

Parameters:index (int in [0, inf], (optional)) – Index

bpy.ops.screen.repeat_last()

Repeat last action

bpy.ops.screen.screen_full_area()

Toggle display selected area as fullscreen

bpy.ops.screen.screen_set(delta=0)

Cycle through available screens

Parameters:delta (int in [-inf, inf], (optional)) – Delta

bpy.ops.screen.screencast(filepath="", full=True)

Capture a video of the active area or whole Blender window

Parameters:

• filepath (string, (optional, never None)) – filepath
• full (boolean, (optional)) – Full Screen, Screencast the whole Blender window

bpy.ops.screen.screenshot(filepath="", check_existing=True, filter_blender=False, filter_backup=False, filter_image=True, filter_movie=False, filter_python=False, filter_font=False, filter_sound=False, filter_text=False, filter_btx=False, filter_collada=False, filter_folder=True, filemode=9, display_type='FILE_DEFAULTDISPLAY', full=True)

Capture a picture of the active area or whole Blender window

Parameters:

• filepath (string, (optional, never None)) – File Path, Path to file
• check_existing (boolean, (optional)) – Check Existing, Check and warn on overwriting existing files
• filter_blender (boolean, (optional)) – Filter .blend files
• filter_backup (boolean, (optional)) – Filter .blend files
• filter_image (boolean, (optional)) – Filter image files
• filter_movie (boolean, (optional)) – Filter movie files
• filter_python (boolean, (optional)) – Filter python files
• filter_font (boolean, (optional)) – Filter font files
• filter_sound (boolean, (optional)) – Filter sound files
• filter_text (boolean, (optional)) – Filter text files
• filter_btx (boolean, (optional)) – Filter btx files
• filter_collada (boolean, (optional)) – Filter COLLADA files
• filter_folder (boolean, (optional)) – Filter folders
• filemode (int in [1, 9], (optional)) – File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
• display_type (enum in [‘FILE_DEFAULTDISPLAY’, ‘FILE_SHORTDISPLAY’, ‘FILE_LONGDISPLAY’, ‘FILE_IMGDISPLAY’], (optional)) –

  Display Type

  • FILE_DEFAULTDISPLAY Default, Automatically determine display type for files.
  • FILE_SHORTDISPLAY Short List, Display files as short list.
  • FILE_LONGDISPLAY Long List, Display files as a detailed list.
  • FILE_IMGDISPLAY Thumbnails, Display files as thumbnails.
• full (boolean, (optional)) – Full Screen, Screenshot the whole Blender window

bpy.ops.screen.spacedata_cleanup()

Remove unused settings for invisible editors

bpy.ops.screen.userpref_show()

Show/hide user preferences