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 readonly, 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.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 [‘EDIT_MESH’, ‘EDIT_CURVE’, ‘EDIT_SURFACE’, ‘EDIT_TEXT’, ‘EDIT_ARMATURE’, ‘EDIT_METABALL’, ‘EDIT_LATTICE’, ‘POSE’, ‘SCULPT’, ‘PAINT_WEIGHT’, ‘PAINT_VERTEX’, ‘PAINT_TEXTURE’, ‘PARTICLE’, ‘OBJECT’, ‘PAINT_GPENCIL’, ‘EDIT_GPENCIL’, ‘SCULPT_GPENCIL’, ‘WEIGHT_GPENCIL’], 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.scene¶ Type: bpy.types.Scene, (readonly)
-
bpy.context.screen¶ Type: bpy.types.Screen, (readonly)
-
bpy.context.space_data¶ 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)
Screen Context¶
-
bpy.context.scene Type: bpy.types.Scene
-
bpy.context.view_layer Type: bpy.types.ViewLayer
-
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.types.EditBone
-
bpy.context.active_pose_bone¶ Type: bpy.types.PoseBone
-
bpy.context.active_object¶ Type: bpy.types.Object
-
bpy.context.object¶ Type: bpy.types.Object
-
bpy.context.edit_object¶ Type: bpy.types.Object
-
bpy.context.sculpt_object¶ Type: bpy.types.Object
-
bpy.context.vertex_paint_object¶ Type: bpy.types.Object
-
bpy.context.weight_paint_object¶ Type: bpy.types.Object
-
bpy.context.image_paint_object¶ Type: bpy.types.Object
-
bpy.context.particle_edit_object¶ Type: bpy.types.Object
-
bpy.context.pose_object¶ Type: bpy.types.Object
-
bpy.context.sequences¶ Type: sequence of bpy.types.Sequence
-
bpy.context.selected_sequences¶ Type: sequence of bpy.types.Sequence
-
bpy.context.selected_editable_sequences¶ Type: sequence of bpy.types.Sequence
-
bpy.context.gpencil_data¶ Type: bpy.types.GreasePencil
-
bpy.context.gpencil_data_owner¶ Type: bpy.types.ID
-
bpy.context.annotation_data¶ Type: bpy.types.GreasePencil
-
bpy.context.annotation_data_owner¶ Type: bpy.types.ID
-
bpy.context.visible_gpencil_layers¶ Type: sequence of bpy.types.GPencilLayer
-
bpy.context.editable_gpencil_layers¶ Type: sequence of bpy.types.GPencilLayer
-
bpy.context.editable_gpencil_strokes¶ Type: sequence of bpy.types.GPencilStroke
-
bpy.context.active_gpencil_layer¶ Type: sequence of bpy.types.GPencilLayer
-
bpy.context.active_gpencil_frame¶ Type: sequence of bpy.types.GreasePencilLayer
-
bpy.context.active_annotation_layer¶ Type: bpy.types.GPencilLayer
-
bpy.context.active_operator¶ Type: bpy.types.Operator
-
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.types.FCurve
View3D Context¶
-
bpy.context.active_base¶ Type: bpy.types.ObjectBase
-
bpy.context.active_object Type: bpy.types.Object
Buttons Context¶
-
bpy.context.texture_slot¶ Type: bpy.types.MaterialTextureSlot
-
bpy.context.scene Type: bpy.types.Scene
-
bpy.context.world¶ Type: bpy.types.World
-
bpy.context.object Type: bpy.types.Object
-
bpy.context.mesh¶ Type: bpy.types.Mesh
-
bpy.context.armature¶ Type: bpy.types.Armature
-
bpy.context.lattice¶ Type: bpy.types.Lattice
-
bpy.context.curve¶ Type: bpy.types.Curve
-
bpy.context.meta_ball¶ Type: bpy.types.MetaBall
-
bpy.context.light¶ Type: bpy.types.Light
-
bpy.context.speaker¶ Type: bpy.types.Speaker
-
bpy.context.lightprobe¶ Type: bpy.types.LightProbe
-
bpy.context.camera¶ Type: bpy.types.Camera
-
bpy.context.material¶ Type: bpy.types.Material
-
bpy.context.material_slot¶ Type: bpy.types.MaterialSlot
-
bpy.context.texture¶ Type: bpy.types.Texture
-
bpy.context.texture_user¶ Type: bpy.types.ID
-
bpy.context.texture_user_property¶ Type: bpy.types.Property
-
bpy.context.bone¶ Type: bpy.types.Bone
-
bpy.context.edit_bone¶ Type: bpy.types.EditBone
-
bpy.context.pose_bone¶ Type: bpy.types.PoseBone
-
bpy.context.particle_system¶ Type: bpy.types.ParticleSystem
-
bpy.context.particle_system_editable¶ Type: bpy.types.ParticleSystem
-
bpy.context.particle_settings¶ Type: bpy.types.ParticleSettings
-
bpy.context.cloth¶ Type: bpy.types.ClothModifier
-
bpy.context.soft_body¶ Type: bpy.types.SoftBodyModifier
-
bpy.context.fluid¶ Type: bpy.types.FluidSimulationModifier
-
bpy.context.collision¶ Type: bpy.types.CollisionModifier
-
bpy.context.brush¶ Type: bpy.types.Brush
-
bpy.context.dynamic_paint¶ Type: bpy.types.DynamicPaintModifier
-
bpy.context.line_style¶ Type: bpy.types.FreestyleLineStyle
-
bpy.context.collection Type: bpy.types.LayerCollection
-
bpy.context.gpencil¶ Type: bpy.types.GreasePencil
Image Context¶
-
bpy.context.edit_image¶ Type: bpy.types.Image
-
bpy.context.edit_mask¶ Type: bpy.types.Mask
Node Context¶
-
bpy.context.selected_nodes¶ Type: sequence of bpy.types.Node
-
bpy.context.active_node¶ Type: bpy.types.Node
-
bpy.context.light Type: bpy.types.Light
-
bpy.context.material Type: bpy.types.Material
-
bpy.context.world Type: bpy.types.World
Text Context¶
-
bpy.context.edit_text¶ Type: bpy.types.Text
Clip Context¶
-
bpy.context.edit_movieclip¶ Type: bpy.types.MovieClip
-
bpy.context.edit_mask Type: bpy.types.Mask
Sequencer Context¶
-
bpy.context.edit_mask Type: bpy.types.Mask