unreal.AutomatedStaticCameraPerfTestProjectSettings

class unreal.AutomatedStaticCameraPerfTestProjectSettings(outer: Object | None = None, name: Name | str = 'None')

Bases: DeveloperSettings

Automated Static Camera Perf Test Project Settings

C++ Source:

  • Plugin: AutomatedPerfTesting

  • Module: AutomatedPerfTesting

  • File: AutomatedStaticCameraPerfTestBase.h

Editor Properties: (see get_editor_property/set_editor_property)

  • capture_screenshots (bool): [Read-Write] * If true, will capture a screenshot for each camera tested after gathering data

  • cooldown_time (float): [Read-Write] * For how long the static camera performance test should delay after ending evaluation before switching to the next camera

  • csv_output_mode (AutomatedPerfTestCSVOutputMode): [Read-Write] * For Static Camera Perf Tests, Separate will output one CSV per map tested, and Granular will output one CSV per camera.

  • game_mode_override (str): [Read-Write] * If set, will launch the material performance test map with this game mode alias (make sure you’ve set the game mode alias in * the Maps and Modes settings of your project!)

  • maps_to_test (Array[SoftObjectPath]): [Read-Write] * List of levels to test

  • soak_time (float): [Read-Write] * For how long the static camera performance test should gather data on each camera, in seconds

  • warm_up_time (float): [Read-Write] * For how long the material performance test should delay before beginning to gather data for a material, in seconds

property capture_screenshots: bool

[Read-Write] * If true, will capture a screenshot for each camera tested after gathering data

Type:

(bool)

property cooldown_time: float

[Read-Write] * For how long the static camera performance test should delay after ending evaluation before switching to the next camera

Type:

(float)

property csv_output_mode: AutomatedPerfTestCSVOutputMode

[Read-Write] * For Static Camera Perf Tests, Separate will output one CSV per map tested, and Granular will output one CSV per camera.

Type:

(AutomatedPerfTestCSVOutputMode)

property game_mode_override: str

[Read-Write] * If set, will launch the material performance test map with this game mode alias (make sure you’ve set the game mode alias in * the Maps and Modes settings of your project!)

Type:

(str)

get_map_from_asset_name(asset_name) → SoftObjectPath or None

Get Map from Asset Name

Parameters:

asset_name (str)

Returns:

out_soft_object_path (SoftObjectPath):

Return type:

SoftObjectPath or None

property maps_to_test: None

[Read-Write] * List of levels to test

Type:

(Array[SoftObjectPath])

property soak_time: float

[Read-Write] * For how long the static camera performance test should gather data on each camera, in seconds

Type:

(float)

property warm_up_time: float

[Read-Write] * For how long the material performance test should delay before beginning to gather data for a material, in seconds

Type:

(float)