unreal.AutomationLibrary

class unreal.AutomationLibrary(outer=None, name='None')

Bases: unreal.BlueprintFunctionLibrary

Automation Blueprint Function Library

C++ Source:

  • Module: FunctionalTesting
  • File: AutomationBlueprintFunctionLibrary.h
classmethod are_automated_tests_running() → bool

Lets you know if any automated tests are running, or are about to run and the automation system is spinning up tests.

Returns:
Return type:bool
classmethod disable_stat_group(world_context_object, group_name) → None

Disable Stat Group

Parameters:
  • world_context_object (Object) –
  • group_name (Name) –
classmethod enable_stat_group(world_context_object, group_name) → None

Enable Stat Group

Parameters:
  • world_context_object (Object) –
  • group_name (Name) –
classmethod get_default_screenshot_options_for_gameplay(tolerance=ComparisonTolerance.LOW, delay=0.200000) → AutomationScreenshotOptions

Get Default Screenshot Options for Gameplay

Parameters:
Returns:

Return type:

AutomationScreenshotOptions

classmethod get_default_screenshot_options_for_rendering(tolerance=ComparisonTolerance.LOW, delay=0.200000) → AutomationScreenshotOptions

Get Default Screenshot Options for Rendering

Parameters:
Returns:

Return type:

AutomationScreenshotOptions

classmethod get_stat_call_count(stat_name) → float

Get Stat Call Count

Parameters:stat_name (Name) –
Returns:
Return type:float
classmethod get_stat_exc_average(stat_name) → float

Get Stat Exc Average

Parameters:stat_name (Name) –
Returns:
Return type:float
classmethod get_stat_exc_max(stat_name) → float

Get Stat Exc Max

Parameters:stat_name (Name) –
Returns:
Return type:float
classmethod get_stat_inc_average(stat_name) → float

Get Stat Inc Average

Parameters:stat_name (Name) –
Returns:
Return type:float
classmethod get_stat_inc_max(stat_name) → float

Get Stat Inc Max

Parameters:stat_name (Name) –
Returns:
Return type:float
classmethod set_scalability_quality_level_relative_to_max(world_context_object, value=1) → None

Sets all other settings based on an overall value

Parameters:
  • world_context_object (Object) –
  • value (int32) – 0:Cinematic, 1:Epic…etc.
classmethod set_scalability_quality_to_epic(world_context_object) → None

Set Scalability Quality to Epic

Parameters:world_context_object (Object) –
classmethod set_scalability_quality_to_low(world_context_object) → None

Set Scalability Quality to Low

Parameters:world_context_object (Object) –
classmethod take_automation_screenshot(world_context_object, latent_info, name, notes, options) → None

Takes a screenshot of the game’s viewport. Does not capture any UI.

Parameters:
classmethod take_automation_screenshot_at_camera(world_context_object, latent_info, camera, name_override, notes, options) → None

Takes a screenshot of the game’s viewport, from a particular camera actors POV. Does not capture any UI.

Parameters:
classmethod take_automation_screenshot_of_ui(world_context_object, latent_info, name, options) → None

Take Automation Screenshot Of UI

Parameters:
classmethod take_high_res_screenshot(res_x, res_y, filename, camera=None, mask_enabled=False, capture_hdr=False) → bool

take high res screenshot in editor.

Parameters:
  • res_x (int32) –
  • res_y (int32) –
  • filename (str) –
  • camera (CameraActor) –
  • mask_enabled (bool) –
  • capture_hdr (bool) –
Returns:

Return type:

bool