unreal.LearningAgentsTrainerGameSettings

class unreal.LearningAgentsTrainerGameSettings

Bases: StructBase

The configurable game settings for a ULearningAgentsTrainer. These allow the timestep and physics tick to be fixed during training, which can enable ticking faster than real-time.

C++ Source:

  • Plugin: LearningAgents

  • Module: LearningAgentsTraining

  • File: LearningAgentsTrainer.h

Editor Properties: (see get_editor_property/set_editor_property)

  • disable_editor_v_sync (bool): [Read-Write] If true, Editor VSync will be disabled; Otherwise, it will not. Disabling Editor VSync can speed up the game simulation.

  • disable_max_fps (bool): [Read-Write] If true, the MaxFPS console variable will be set to a negative number during training; Otherwise, it will not.

  • disable_use_less_cpu_in_the_background (bool): [Read-Write] If true, the Use Less CPU In The Background editor setting will be disabled. This prevents the editor from running slowly when minimized.

  • disable_v_sync (bool): [Read-Write] If true, VSync will be disabled; Otherwise, it will not. Disabling VSync can speed up the game simulation.

  • fixed_time_step_frequency (float): [Read-Write] Determines the amount of time for each frame when bUseFixedTimeStep is true; Ignored if false. You want this time step to match as closely as possible to the expected inference time steps, otherwise your training results may not generalize to your game.

  • set_max_physics_step_to_fixed_time_step (bool): [Read-Write] If true, set the physics delta time to match the fixed time step.

  • use_fixed_time_step (bool): [Read-Write] If true, the game will run in fixed time step mode (i.e the frame’s delta times will always be the same regardless of how much wall time has passed). This can enable faster than real-time training if your game runs quickly. If false, the time steps will match real wall time.

  • use_unlit_viewport_rendering (bool): [Read-Write] If true, the viewport rendering will be unlit; Otherwise, it will not. Disabling lighting can speed up the game simulation.