PreferencesEdit(bpy_struct)

base class — bpy_struct

class bpy.types.PreferencesEdit(bpy_struct)

Settings for interacting with Blender data

auto_keying_mode

Mode of automatic keyframe insertion for Objects and Bones (default setting used for new Scenes)

Type:enum in [‘ADD_REPLACE_KEYS’, ‘REPLACE_KEYS’], default ‘ADD_REPLACE_KEYS’
fcurve_unselected_alpha

Amount that unselected F-Curves stand out from the background (Graph Editor)

Type:float in [0.001, 1], default 0.0
grease_pencil_default_color

Color of new annotation layers

Type:float array of 4 items in [0, inf], default (0.0, 0.0, 0.0, 0.0)
grease_pencil_eraser_radius

Radius of eraser ‘brush’

Type:int in [1, 500], default 0
grease_pencil_euclidean_distance

Distance moved by mouse when drawing stroke to include

Type:int in [0, 100], default 0
grease_pencil_manhattan_distance

Pixels moved by mouse per axis when drawing stroke

Type:int in [0, 100], default 0
keyframe_new_handle_type

Handle type for handles of new keyframes

  • FREE Free, Completely independent manually set handle.
  • ALIGNED Aligned, Manually set handle with rotation locked together with its pair.
  • VECTOR Vector, Automatic handles that create straight lines.
  • AUTO Automatic, Automatic handles that create smooth curves.
  • AUTO_CLAMPED Auto Clamped, Automatic handles that create smooth curves which only change direction at keyframes.
Type:enum in [‘FREE’, ‘ALIGNED’, ‘VECTOR’, ‘AUTO’, ‘AUTO_CLAMPED’], default ‘FREE’
keyframe_new_interpolation_type

Interpolation mode used for first keyframe on newly added F-Curves (subsequent keyframes take interpolation from preceding keyframe)

  • CONSTANT Constant, No interpolation, value of A gets held until B is encountered.
  • LINEAR Linear, Straight-line interpolation between A and B (i.e. no ease in/out).
  • BEZIER Bezier, Smooth interpolation between A and B, with some control over curve shape.
  • SINE Sinusoidal, Sinusoidal easing (weakest, almost linear but with a slight curvature).
  • QUAD Quadratic, Quadratic easing.
  • CUBIC Cubic, Cubic easing.
  • QUART Quartic, Quartic easing.
  • QUINT Quintic, Quintic easing.
  • EXPO Exponential, Exponential easing (dramatic).
  • CIRC Circular, Circular easing (strongest and most dynamic).
  • BACK Back, Cubic easing with overshoot and settle.
  • BOUNCE Bounce, Exponentially decaying parabolic bounce, like when objects collide.
  • ELASTIC Elastic, Exponentially decaying sine wave, like an elastic band.
Type:enum in [‘CONSTANT’, ‘LINEAR’, ‘BEZIER’, ‘SINE’, ‘QUAD’, ‘CUBIC’, ‘QUART’, ‘QUINT’, ‘EXPO’, ‘CIRC’, ‘BACK’, ‘BOUNCE’, ‘ELASTIC’], default ‘CONSTANT’

Toggle whether the material is linked to object data or the object block

  • OBDATA Object Data, Toggle whether the material is linked to object data or the object block.
  • OBJECT Object, Toggle whether the material is linked to object data or the object block.
Type:enum in [‘OBDATA’, ‘OBJECT’], default ‘OBDATA’
node_margin

Minimum distance between nodes for Auto-offsetting nodes

Type:int in [0, 255], default 0
object_align

When adding objects from a 3D View menu, either align them with that view or with the world

  • WORLD World, Align newly added objects to the world coordinate system.
  • VIEW View, Align newly added objects to the active 3D View direction.
  • CURSOR 3D Cursor, Align newly added objects to the 3D Cursor’s rotation.
Type:enum in [‘WORLD’, ‘VIEW’, ‘CURSOR’], default ‘WORLD’
sculpt_paint_overlay_color

Color of texture overlay

Type:float array of 3 items in [0, inf], default (0.0, 0.0, 0.0)
undo_memory_limit

Maximum memory usage in megabytes (0 means unlimited)

Type:int in [0, inf], default 0
undo_steps

Number of undo steps available (smaller values conserve memory)

Type:int in [0, 256], default 0
use_auto_keying

Automatic keyframe insertion for Objects and Bones (default setting used for new Scenes)

Type:boolean, default False
use_auto_keying_warning

Show warning indicators when transforming objects and bones if auto keying is enabled

Type:boolean, default False
use_cursor_lock_adjust

Place the cursor without ‘jumping’ to the new location (when lock-to-cursor is used)

Type:boolean, default False
use_duplicate_action

Causes actions to be duplicated with the object

Type:boolean, default False
use_duplicate_armature

Causes armature data to be duplicated with the object

Type:boolean, default False
use_duplicate_curve

Causes curve data to be duplicated with the object

Type:boolean, default False
use_duplicate_fcurve

Causes F-curve data to be duplicated with the object

Type:boolean, default False
use_duplicate_grease_pencil

Causes grease pencil data to be duplicated with the object

Type:boolean, default False
use_duplicate_light

Causes light data to be duplicated with the object

Type:boolean, default False
use_duplicate_lightprobe

Causes light probe data to be duplicated with the object

Type:boolean, default False
use_duplicate_material

Causes material data to be duplicated with the object

Type:boolean, default False
use_duplicate_mesh

Causes mesh data to be duplicated with the object

Type:boolean, default False
use_duplicate_metaball

Causes metaball data to be duplicated with the object

Type:boolean, default False
use_duplicate_particle

Causes particle systems to be duplicated with the object

Type:boolean, default False
use_duplicate_surface

Causes surface data to be duplicated with the object

Type:boolean, default False
use_duplicate_text

Causes text data to be duplicated with the object

Type:boolean, default False
use_duplicate_texture

Causes texture data to be duplicated with the object

Type:boolean, default False
use_enter_edit_mode

Enter Edit Mode automatically after adding a new object

Type:boolean, default False
use_global_undo

Global undo works by keeping a full copy of the file itself in memory, so takes extra memory

Type:boolean, default False
use_grease_pencil_simplify_stroke

Simplify the final stroke

Type:boolean, default False
use_insertkey_xyz_to_rgb

Color for newly added transformation F-Curves (Location, Rotation, Scale) and also Color is based on the transform axis

Type:boolean, default False
use_keyframe_insert_available

Automatic keyframe insertion in available F-Curves

Type:boolean, default False
use_keyframe_insert_needed

Keyframe insertion only when keyframe needed

Type:boolean, default False
use_mouse_depth_cursor

Use the surface depth for cursor placement

Type:boolean, default False
use_negative_frames

Current frame number can be manually set to a negative value

Type:boolean, default False
use_visual_keying

Use Visual keying automatically for constrained objects

Type:boolean, default False
classmethod bl_rna_get_subclass(id, default=None)
Parameters:id (string) – The RNA type identifier.
Returns:The RNA type or default when not found.
Return type:bpy.types.Struct subclass
classmethod bl_rna_get_subclass_py(id, default=None)
Parameters:id (string) – The RNA type identifier.
Returns:The class or default when not found.
Return type:type

Inherited Properties

Inherited Functions

References