unreal.AutomationLibrary
¶
- class unreal.AutomationLibrary(outer=None, name='None')¶
Bases:
unreal.BlueprintFunctionLibrary
Automation Blueprint Function Library
C++ Source:
Module: FunctionalTesting
File: AutomationBlueprintFunctionLibrary.h
- classmethod add_expected_log_error(expected_pattern_string, occurrences=1, exact_match=False) → None¶
Mute the report of log error and warning matching a pattern during an automated test
- 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
- classmethod automation_wait_for_loading(world_context_object, latent_info, options) → None¶
Automation Wait for Loading
- Parameters
world_context_object (Object) –
latent_info (LatentActionInfo) –
options (AutomationWaitForLoadingOptions) –
- classmethod get_default_screenshot_options_for_gameplay(tolerance=ComparisonTolerance.LOW, delay=0.2) → AutomationScreenshotOptions¶
Get Default Screenshot Options for Gameplay
- Parameters
tolerance (ComparisonTolerance) –
delay (float) –
- Returns
- Return type
- classmethod get_default_screenshot_options_for_rendering(tolerance=ComparisonTolerance.LOW, delay=0.2) → AutomationScreenshotOptions¶
Get Default Screenshot Options for Rendering
- Parameters
tolerance (ComparisonTolerance) –
delay (float) –
- Returns
- Return type
- 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
world_context_object (Object) –
latent_info (LatentActionInfo) –
name (str) –
notes (str) –
options (AutomationScreenshotOptions) –
- 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
world_context_object (Object) –
latent_info (LatentActionInfo) –
camera (CameraActor) –
name_override (str) –
notes (str) –
options (AutomationScreenshotOptions) –
- classmethod take_automation_screenshot_of_ui(world_context_object, latent_info, name, options) → None¶
Take Automation Screenshot Of UI
- Parameters
world_context_object (Object) –
latent_info (LatentActionInfo) –
name (str) –
options (AutomationScreenshotOptions) –
- classmethod take_high_res_screenshot(res_x, res_y, filename, camera=None, mask_enabled=False, capture_hdr=False, comparison_tolerance=ComparisonTolerance.LOW, comparison_notes='', delay=0.0) → AutomationEditorTask¶
take high res screenshot in editor.
- Parameters
res_x (int32) –
res_y (int32) –
filename (str) –
camera (CameraActor) –
mask_enabled (bool) –
capture_hdr (bool) –
comparison_tolerance (ComparisonTolerance) –
comparison_notes (str) –
delay (float) –
- Returns
- Return type