File Operators¶
-
bpy.ops.file.
autopack_toggle
()¶ Automatically pack all external files into the .blend file
-
bpy.ops.file.
bookmark_add
()¶ Add a bookmark for the selected/active directory
-
bpy.ops.file.
bookmark_cleanup
()¶ Delete all invalid bookmarks
-
bpy.ops.file.
bookmark_delete
(index=-1)¶ Delete selected bookmark
Parameters: index (int in [-1, 20000], (optional)) – Index
-
bpy.ops.file.
bookmark_move
(direction='TOP')¶ Move the active bookmark up/down in the list
Parameters: direction (enum in ['TOP', 'UP', 'DOWN', 'BOTTOM'], (optional)) – Direction, Direction to move, UP or DOWN
TOP
Top, Top of the list.UP
Up.DOWN
Down.BOTTOM
Bottom, Bottom of the list.
-
bpy.ops.file.
bookmark_toggle
()¶ Toggle bookmarks display
-
bpy.ops.file.
cancel
()¶ Cancel loading of selected file
-
bpy.ops.file.
delete
()¶ Delete selected files
-
bpy.ops.file.
directory_new
(directory="", open=False)¶ Create a new directory
Parameters: - directory (string, (optional, never None)) – Directory, Name of new directory
- open (boolean, (optional)) – Open, Open new directory
-
bpy.ops.file.
execute
(need_active=False)¶ Execute selected file
Parameters: need_active (boolean, (optional)) – Need Active, Only execute if there’s an active selected file in the file list
-
bpy.ops.file.
filenum
(increment=1)¶ Increment number in filename
Parameters: increment (int in [-100, 100], (optional)) – Increment
-
bpy.ops.file.
filepath_drop
(filepath="Path")¶ Undocumented
-
bpy.ops.file.
find_missing_files
(find_all=False, directory="", filter_blender=False, filter_backup=False, filter_image=False, filter_movie=False, filter_python=False, filter_font=False, filter_sound=False, filter_text=False, filter_btx=False, filter_collada=False, filter_alembic=False, filter_folder=False, filter_blenlib=False, filemode=9, display_type='DEFAULT', sort_method='FILE_SORT_ALPHA')¶ Try to find missing external files
Parameters: - find_all (boolean, (optional)) – Find All, Find all files in the search path (not just missing)
- directory (string, (optional, never None)) – Directory, Directory of the file
- 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_alembic (boolean, (optional)) – Filter Alembic files
- filter_folder (boolean, (optional)) – Filter folders
- filter_blenlib (boolean, (optional)) – Filter Blender IDs
- 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 ['DEFAULT', 'LIST_SHORT', 'LIST_LONG', 'THUMBNAIL'], (optional)) –
Display Type
DEFAULT
Default, Automatically determine display type for files.LIST_SHORT
Short List, Display files as short list.LIST_LONG
Long List, Display files as a detailed list.THUMBNAIL
Thumbnails, Display files as thumbnails.
- sort_method (enum in ['FILE_SORT_ALPHA', 'FILE_SORT_EXTENSION', 'FILE_SORT_TIME', 'FILE_SORT_SIZE'], (optional)) –
File sorting mode
FILE_SORT_ALPHA
Sort alphabetically, Sort the file list alphabetically.FILE_SORT_EXTENSION
Sort by extension, Sort the file list by extension/type.FILE_SORT_TIME
Sort by time, Sort files by modification time.FILE_SORT_SIZE
Sort by size, Sort files by size.
-
bpy.ops.file.
hidedot
()¶ Toggle hide hidden dot files
-
bpy.ops.file.
highlight
()¶ Highlight selected file(s)
-
bpy.ops.file.
make_paths_absolute
()¶ Make all paths to external files absolute
-
bpy.ops.file.
make_paths_relative
()¶ Make all paths to external files relative to current .blend
-
bpy.ops.file.
next
()¶ Move to next folder
-
bpy.ops.file.
pack_all
()¶ Pack all used external files into the .blend
-
bpy.ops.file.
pack_libraries
()¶ Pack all used Blender library files into the current .blend
-
bpy.ops.file.
parent
()¶ Move to parent directory
-
bpy.ops.file.
previous
()¶ Move to previous folder
-
bpy.ops.file.
refresh
()¶ Refresh the file list
-
bpy.ops.file.
rename
()¶ Rename file or file directory
-
bpy.ops.file.
report_missing_files
()¶ Report all missing external files
-
bpy.ops.file.
reset_recent
()¶ Reset Recent files
-
bpy.ops.file.
select
(extend=False, fill=False, open=True)¶ Activate/select file
Parameters: - extend (boolean, (optional)) – Extend, Extend selection instead of deselecting everything first
- fill (boolean, (optional)) – Fill, Select everything beginning with the last selection
- open (boolean, (optional)) – Open, Open a directory when selecting it
-
bpy.ops.file.
select_all_toggle
()¶ Select or deselect all files
-
bpy.ops.file.
select_bookmark
(dir="")¶ Select a bookmarked directory
Parameters: dir (string, (optional, never None)) – Dir
-
bpy.ops.file.
select_border
(gesture_mode=0, xmin=0, xmax=0, ymin=0, ymax=0, extend=True)¶ Activate/select the file(s) contained in the border
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
- extend (boolean, (optional)) – Extend, Extend selection instead of deselecting everything first
-
bpy.ops.file.
select_walk
(direction='UP', extend=False, fill=False)¶ Select/Deselect files by walking through them
Parameters: - direction (enum in ['UP', 'DOWN', 'LEFT', 'RIGHT'], (optional)) – Walk Direction, Select/Deselect file in this direction
- extend (boolean, (optional)) – Extend, Extend selection instead of deselecting everything first
- fill (boolean, (optional)) – Fill, Select everything beginning with the last selection
-
bpy.ops.file.
smoothscroll
()¶ Smooth scroll to make editable file visible
-
bpy.ops.file.
unpack_all
(method='USE_LOCAL')¶ Unpack all files packed into this .blend to external ones
Parameters: method (enum in ['USE_LOCAL', 'WRITE_LOCAL', 'USE_ORIGINAL', 'WRITE_ORIGINAL', 'KEEP'], (optional)) – Method, How to unpack
-
bpy.ops.file.
unpack_item
(method='USE_LOCAL', id_name="", id_type=19785)¶ Unpack this file to an external file
Parameters: - method (enum in ['USE_LOCAL', 'WRITE_LOCAL', 'USE_ORIGINAL', 'WRITE_ORIGINAL'], (optional)) – Method, How to unpack
- id_name (string, (optional, never None)) – ID name, Name of ID block to unpack
- id_type (int in [0, inf], (optional)) – ID Type, Identifier type of ID block
-
bpy.ops.file.
unpack_libraries
()¶ Unpack all used Blender library files from this .blend file