Context Access (bpy.context)¶
+The context members available depend on the area of Blender which is currently being + accessed.
+Note that all context values are read-only, + but may be modified through the data API or by running operators.
+Global Context¶ +
+These properties are available in any contexts.
+-
+
- + bpy.context.area¶ +
-
+
-
+
- Type: +
+bpy.types.Area, + (readonly)
+
+
-
+
- + bpy.context.asset¶ +
-
+
-
+
- Type: +
+bpy.types.AssetRepresentation, + (readonly)
+
+
-
+
- + bpy.context.blend_data¶ +
-
+
-
+
- Type: +
+bpy.types.BlendData, + (readonly)
+
+
-
+
- + bpy.context.collection¶ +
-
+
-
+
- Type: +
+bpy.types.Collection, + (readonly)
+
+
-
+
- + bpy.context.engine¶ +
-
+
-
+
- Type: +
string, default “”, (readonly, never None)
+
+
+
-
+
- + bpy.context.gizmo_group¶ +
-
+
-
+
- Type: +
+bpy.types.GizmoGroup, + (readonly)
+
+
-
+
- + bpy.context.layer_collection¶ +
-
+
-
+
- Type: +
+bpy.types.LayerCollection, + (readonly)
+
+
-
+
- + bpy.context.mode¶ +
-
+
-
+
- Type: +
enum in Context Mode Items, default ‘EDIT_MESH’, + (readonly)
+
+
+
-
+
- + bpy.context.preferences¶ +
-
+
-
+
- Type: +
+bpy.types.Preferences, + (readonly)
+
+
-
+
- + bpy.context.region¶ +
-
+
-
+
- Type: +
+bpy.types.Region, + (readonly)
+
+
-
+
- + bpy.context.region_data¶ +
-
+
-
+
- Type: +
+bpy.types.RegionView3D, + (readonly)
+
+
-
+
- + bpy.context.region_popup¶ +
The temporary region for pop-ups (including menus and pop-overs)
+-
+
- Type: +
+bpy.types.Region, + (readonly)
+
+
-
+
- + bpy.context.scene¶ +
-
+
-
+
- Type: +
+bpy.types.Scene, + (readonly)
+
+
-
+
- + bpy.context.screen¶ +
-
+
-
+
- Type: +
+bpy.types.Screen, + (readonly)
+
+
-
+
- + bpy.context.space_data¶ +
The current space, may be None in background-mode, when the cursor is outside the + window or when using menu-search
+-
+
- Type: +
+bpy.types.Space, + (readonly)
+
+
-
+
- + bpy.context.tool_settings¶ +
-
+
-
+
- Type: +
+bpy.types.ToolSettings, + (readonly)
+
+
-
+
- + bpy.context.view_layer¶ +
-
+
-
+
- Type: +
+bpy.types.ViewLayer, + (readonly)
+
+
-
+
- + bpy.context.window¶ +
-
+
-
+
- Type: +
+bpy.types.Window, + (readonly)
+
+
-
+
- + bpy.context.window_manager¶ +
-
+
-
+
- Type: +
+bpy.types.WindowManager, + (readonly)
+
+
-
+
- + bpy.context.workspace¶ +
-
+
-
+
- Type: +
+bpy.types.WorkSpace, + (readonly)
+
+
Clip Context¶
+-
+
- + bpy.context.edit_movieclip¶ +
-
+
-
+
- Type: +
- + +
+
-
+
- + bpy.context.edit_mask¶ +
-
+
-
+
- Type: +
- + +
+
File Context¶
+-
+
- + bpy.context.active_file¶ +
-
+
-
+
- Type: +
- + +
+
-
+
- + bpy.context.selected_files¶ +
-
+
-
+
- Type: +
sequence of
+bpy.types.FileSelectEntry+
+
+
-
+
- + bpy.context.asset_library_reference¶ + +
-
+
-
+
- Type: +
- + +
+
-
+
- + bpy.context.selected_assets¶ +
-
+
-
+
- Type: +
sequence of
+bpy.types.AssetRepresentation+
+
+
-
+
- + bpy.context.id¶ + +
-
+
-
+
- Type: +
- + +
+
-
+
- + bpy.context.selected_ids¶ +
-
+
-
+
- Type: +
sequence of
+bpy.types.ID+
+
+
Image Context¶
+-
+
- + bpy.context.edit_image¶ +
-
+
-
+
- Type: +
- + +
+
-
+
- + bpy.context.edit_mask +
-
+
-
+
- Type: +
- + +
+
Node Context¶
+-
+
- + bpy.context.selected_nodes¶ +
-
+
-
+
- Type: +
sequence of
+bpy.types.Node+
+
+
-
+
- + bpy.context.active_node¶ +
-
+
-
+
- Type: +
- + +
+
-
+
- + bpy.context.light +
-
+
-
+
- Type: +
- + +
+
-
+
- + bpy.context.material +
-
+
-
+
- Type: +
- + +
+
-
+
- + bpy.context.world +
-
+
-
+
- Type: +
- + +
+
Screen Context¶ +
+-
+
- + bpy.context.scene +
-
+
-
+
- Type: +
- + +
+
-
+
- + bpy.context.view_layer +
-
+
-
+
- Type: +
- + +
+
-
+
- + bpy.context.visible_objects¶ +
-
+
-
+
- Type: +
sequence of
+bpy.types.Object+
+
+
-
+
- + bpy.context.selectable_objects¶ +
-
+
-
+
- Type: +
sequence of
+bpy.types.Object+
+
+
-
+
- + bpy.context.selected_objects¶ +
-
+
-
+
- Type: +
sequence of
+bpy.types.Object+
+
+
-
+
- + bpy.context.editable_objects¶ +
-
+
-
+
- Type: +
sequence of
+bpy.types.Object+
+
+
-
+
- + bpy.context.selected_editable_objects¶ + +
-
+
-
+
- Type: +
sequence of
+bpy.types.Object+
+
+
-
+
- + bpy.context.objects_in_mode¶ +
-
+
-
+
- Type: +
sequence of
+bpy.types.Object+
+
+
-
+
- + bpy.context.objects_in_mode_unique_data¶ + +
-
+
-
+
- Type: +
sequence of
+bpy.types.Object+
+
+
-
+
- + bpy.context.visible_bones¶ +
-
+
-
+
- Type: +
sequence of
+bpy.types.EditBone+
+
+
-
+
- + bpy.context.editable_bones¶ +
-
+
-
+
- Type: +
sequence of
+bpy.types.EditBone+
+
+
-
+
- + bpy.context.selected_bones¶ +
-
+
-
+
- Type: +
sequence of
+bpy.types.EditBone+
+
+
-
+
- + bpy.context.selected_editable_bones¶ + +
-
+
-
+
- Type: +
sequence of
+bpy.types.EditBone+
+
+
-
+
- + bpy.context.visible_pose_bones¶ +
-
+
-
+
- Type: +
sequence of
+bpy.types.PoseBone+
+
+
-
+
- + bpy.context.selected_pose_bones¶ +
-
+
-
+
- Type: +
sequence of
+bpy.types.PoseBone+
+
+
-
+
- + bpy.context.selected_pose_bones_from_active_object¶ +
-
+
-
+
- Type: +
sequence of
+bpy.types.PoseBone+
+
+
-
+
- + bpy.context.active_bone¶ +
-
+
-
+
- Type: +
- + +
+
-
+
- + bpy.context.active_pose_bone¶ +
-
+
-
+
- Type: +
- + +
+
-
+
- + bpy.context.active_object¶ +
-
+
-
+
- Type: +
- + +
+
-
+
- + bpy.context.object +
-
+
-
+
- Type: +
- + +
+
-
+
- + bpy.context.edit_object¶ +
-
+
-
+
- Type: +
- + +
+
-
+
- + bpy.context.sculpt_object¶ +
-
+
-
+
- Type: +
- + +
+
-
+
- + bpy.context.vertex_paint_object¶ +
-
+
-
+
- Type: +
- + +
+
-
+
- + bpy.context.weight_paint_object¶ +
-
+
-
+
- Type: +
- + +
+
-
+
- + bpy.context.image_paint_object¶ +
-
+
-
+
- Type: +
- + +
+
-
+
- + bpy.context.particle_edit_object¶ +
-
+
-
+
- Type: +
- + +
+
-
+
- + bpy.context.pose_object¶ +
-
+
-
+
- Type: +
- + +
+
-
+
- + bpy.context.active_sequence_strip¶ + +
-
+
-
+
- Type: +
- + +
+
-
+
- + bpy.context.sequences¶ +
-
+
-
+
- Type: +
sequence of
+bpy.types.Strip+
+
+
-
+
- + bpy.context.selected_sequences¶ +
-
+
-
+
- Type: +
sequence of
+bpy.types.Strip+
+
+
-
+
- + bpy.context.selected_editable_sequences¶ + +
-
+
-
+
- Type: +
sequence of
+bpy.types.Strip+
+
+
-
+
- + bpy.context.active_nla_track¶ +
-
+
-
+
- Type: +
- + +
+
-
+
- + bpy.context.active_nla_strip¶ +
-
+
-
+
- Type: +
- + +
+
-
+
- + bpy.context.selected_nla_strips¶ +
-
+
-
+
- Type: +
sequence of
+bpy.types.NlaStrip+
+
+
-
+
- + bpy.context.selected_movieclip_tracks¶ + +
-
+
-
+
- Type: +
sequence of
+bpy.types.MovieTrackingTrack+
+
+
-
+
- + bpy.context.annotation_data¶ +
-
+
-
+
- Type: +
- + +
+
-
+
- + bpy.context.annotation_data_owner¶ + +
-
+
-
+
- Type: +
- + +
+
-
+
- + bpy.context.active_annotation_layer¶ + +
-
+
-
+
- Type: +
- + +
+
-
+
- + bpy.context.grease_pencil +
-
+
-
+
- Type: +
- + +
+
-
+
- + bpy.context.active_operator¶ +
-
+
-
+
- Type: +
- + +
+
-
+
- + bpy.context.active_action¶ +
-
+
-
+
- Type: +
- + +
+
-
+
- + bpy.context.selected_visible_actions¶ + +
-
+
-
+
- Type: +
sequence of
+bpy.types.Action+
+
+
-
+
- + bpy.context.selected_editable_actions¶ + +
-
+
-
+
- Type: +
sequence of
+bpy.types.Action+
+
+
-
+
- + bpy.context.visible_fcurves¶ +
-
+
-
+
- Type: +
sequence of
+bpy.types.FCurve+
+
+
-
+
- + bpy.context.editable_fcurves¶ +
-
+
-
+
- Type: +
sequence of
+bpy.types.FCurve+
+
+
-
+
- + bpy.context.selected_visible_fcurves¶ + +
-
+
-
+
- Type: +
sequence of
+bpy.types.FCurve+
+
+
-
+
- + bpy.context.selected_editable_fcurves¶ + +
-
+
-
+
- Type: +
sequence of
+bpy.types.FCurve+
+
+
-
+
- + bpy.context.active_editable_fcurve¶ +
-
+
-
+
- Type: +
- + +
+
-
+
- + bpy.context.selected_editable_keyframes¶ + +
-
+
-
+
- Type: +
sequence of
+bpy.types.Keyframe+
+
+
-
+
- + bpy.context.ui_list¶ +
-
+
-
+
- Type: +
- + +
+
-
+
- + bpy.context.property¶ + +
-
+
-
+
- Type: +
+bpy.types.AnyType+ orstrorint
+
Get the property associated with a hovered button. + Returns a tuple of the data-block, data path to the property, and array + index.
+++Note
+When the property doesn’t have an associated
+bpy.types.ID+ non-ID data may be returned. + This may occur when accessing windowing data, for example, operator + properties.+++# Example inserting keyframe for the hovered property. +active_property = bpy.context.property +if active_property: + datablock, data_path, index = active_property + datablock.keyframe_insert(data_path=data_path, index=index, frame=1) +
+
+
-
+
- + bpy.context.asset_library_reference +
-
+
-
+
- Type: +
- + +
+
-
+
- + bpy.context.active_strip¶ +
-
+
-
+
- Type: +
- + +
+
-
+
- + bpy.context.strips¶ +
-
+
-
+
- Type: +
sequence of
+bpy.types.Strip+
+
+
-
+
- + bpy.context.selected_strips¶ +
-
+
-
+
- Type: +
sequence of
+bpy.types.Strip+
+
+
-
+
- + bpy.context.selected_editable_strips¶ + +
-
+
-
+
- Type: +
sequence of
+bpy.types.Strip+
+
+
Sequencer Context¶
+-
+
- + bpy.context.edit_mask +
-
+
-
+
- Type: +
- + +
+
Text Context¶
+-
+
- + bpy.context.edit_text¶ +
-
+
-
+
- Type: +
- + +
+
View3D Context¶ +
+-
+
- + bpy.context.active_object +
-
+
-
+
- Type: +
- + +
+
-
+
- + bpy.context.selected_ids +
-
+
-
+
- Type: +
sequence of
+bpy.types.ID+
+
+