Ui Operators

bpy.ops.ui.assign_default_button()

Set this property’s current value as the new default

bpy.ops.ui.button_execute(skip_depressed=False)

Presses active button

Parameters

skip_depressed (boolean, (optional)) – Skip Depressed

bpy.ops.ui.button_string_clear()

Unsets the text of the active button

bpy.ops.ui.copy_as_driver_button()

Create a new driver with this property as input, and copy it to the clipboard. Use Paste Driver to add it to the target property, or Paste Driver Variables to extend an existing driver

bpy.ops.ui.copy_data_path_button(full_path=False)

Copy the RNA data path for this property to the clipboard

Parameters

full_path (boolean, (optional)) – full_path, Copy full data path

bpy.ops.ui.copy_python_command_button()

Copy the Python command matching this button

bpy.ops.ui.copy_to_selected_button(all=True)

Copy property from this object to selected objects or bones

Parameters

all (boolean, (optional)) – All, Copy to selected all elements of the array

bpy.ops.ui.drop_color(color=(0.0, 0.0, 0.0), gamma=False)

Drop colors to buttons

Parameters

  • color (float array of 3 items in [0, inf], (optional)) – Color, Source color

  • gamma (boolean, (optional)) – Gamma Corrected, The source color is gamma corrected

bpy.ops.ui.editsource()

Edit UI source code of the active button

bpy.ops.ui.edittranslation_init()

Edit i18n in current language for the active button

bpy.ops.ui.eyedropper_color(use_accumulate=True)

Sample a color from the Blender window to store in a property

Parameters

use_accumulate (boolean, (optional)) – Accumulate

bpy.ops.ui.eyedropper_colorramp()

Sample a color band

bpy.ops.ui.eyedropper_colorramp_point()

Point-sample a color band

bpy.ops.ui.eyedropper_depth()

Sample depth from the 3D view

bpy.ops.ui.eyedropper_driver(mapping_type='SINGLE_MANY')

Pick a property to use as a driver target

Parameters

mapping_type (enum in ['SINGLE_MANY', 'DIRECT', 'MATCH', 'NONE_ALL', 'NONE_SINGLE'], (optional)) –

Mapping Type, Method used to match target and driven properties

  • SINGLE_MANY All from Target, Drive all components of this property using the target picked.

  • DIRECT Single from Target, Drive this component of this property using the target picked.

  • MATCH Match Indices, Create drivers for each pair of corresponding elements.

  • NONE_ALL Manually Create Later, Create drivers for all properties without assigning any targets yet.

  • NONE_SINGLE Manually Create Later (Single), Create driver for this property only and without assigning any targets yet.

bpy.ops.ui.eyedropper_gpencil_color(mode='MATERIAL')

Sample a color from the Blender Window and create Grease Pencil material

Parameters

mode (enum in ['MATERIAL', 'PALETTE'], (optional)) – Mode

bpy.ops.ui.eyedropper_id()

Sample a data-block from the 3D View to store in a property

bpy.ops.ui.jump_to_target_button()

Switch to the target object or bone

bpy.ops.ui.override_remove_button(all=True)

Remove an override operation

Parameters

all (boolean, (optional)) – All, Reset to default values all elements of the array

bpy.ops.ui.override_type_set_button(all=True, type='REPLACE')

Create an override operation, or set the type of an existing one

Parameters

  • all (boolean, (optional)) – All, Reset to default values all elements of the array

  • type (enum in ['NOOP', 'REPLACE', 'DIFFERENCE', 'FACTOR'], (optional)) –

    Type, Type of override operation

    • NOOP NoOp, ‘No-Operation’, place holder preventing automatic override to ever affect the property.

    • REPLACE Replace, Completely replace value from linked data by local one.

    • DIFFERENCE Difference, Store difference to linked data value.

    • FACTOR Factor, Store factor to linked data value (useful e.g. for scale).

bpy.ops.ui.reloadtranslation()

Force a full reload of UI translation

bpy.ops.ui.reset_default_button(all=True)

Reset this property’s value to its default value

Parameters

all (boolean, (optional)) – All, Reset to default values all elements of the array

bpy.ops.ui.unset_property_button()

Clear the property and use default or generated value in operators