Open 3D Engine ScriptAutomation Gem API Reference  23.05.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
ScriptAutomation::ScriptAutomationSystemComponent Class Reference

#include <ScriptAutomationSystemComponent.h>

Inherits Component, Handler, Handler, Handler, and Handler.

Public Member Functions

 AZ_COMPONENT (ScriptAutomationSystemComponent,"{755280BF-F227-4048-B323-D5E28EC55D61}", ScriptAutomationRequests)
 
void SetIdleFrames (int numFrames) override
 
void SetIdleSeconds (float numSeconds) override
 
void SetFrameCaptureId (AZ::Render::FrameCaptureId frameCaptureId) override
 
void StartProfilingCapture () override
 
void ActivateScript (const char *scriptPath) override
 
void DeactivateScripts () override
 

Static Public Member Functions

static void Reflect (AZ::ReflectContext *context)
 
static void GetProvidedServices (AZ::ComponentDescriptor::DependencyArrayType &provided)
 
static void GetIncompatibleServices (AZ::ComponentDescriptor::DependencyArrayType &incompatible)
 
static void GetRequiredServices (AZ::ComponentDescriptor::DependencyArrayType &required)
 
static void GetDependentServices (AZ::ComponentDescriptor::DependencyArrayType &dependent)
 

Protected Member Functions

void Activate () override
 
void Deactivate () override
 
void OnTick (float deltaTime, AZ::ScriptTimePoint time) override
 
AZ::BehaviorContext * GetAutomationContext () override
 
void PauseAutomation (float timeout=DefaultPauseTimeout) override
 
void ResumeAutomation () override
 
void QueueScriptOperation (ScriptAutomationRequests::ScriptOperation &&operation) override
 
void OnFrameCaptureFinished (AZ::Render::FrameCaptureResult result, const AZStd::string &info) override
 
void OnCaptureQueryTimestampFinished (bool result, const AZStd::string &info) override
 
void OnCaptureCpuFrameTimeFinished (bool result, const AZStd::string &info) override
 
void OnCaptureQueryPipelineStatisticsFinished (bool result, const AZStd::string &info) override
 
void OnCaptureBenchmarkMetadataFinished (bool result, const AZStd::string &info) override
 
void ExecuteScript (const char *scriptFilePath)
 

Protected Attributes

AZStd::unique_ptr
< AZ::ScriptContext > 		m_scriptContext
 
AZStd::unique_ptr
< AZ::BehaviorContext > 		m_scriptBehaviorContext
 
AZStd::queue
< ScriptAutomationRequests::ScriptOperation > 		m_scriptOperations
 
AZStd::string m_automationScript
 
int m_scriptIdleFrames = 0
 
float m_scriptIdleSeconds = 0.0f
 
float m_scriptPauseTimeout = 0.0f
 
bool m_scriptPaused = false
 
AZ::Render::FrameCaptureId m_scriptFrameCaptureId = AZ::Render::InvalidFrameCaptureId
 
bool m_isStarted = false
 
bool m_exitOnFinish = false
 
bool m_doFinalCleanup = false
 

Detailed Description

Manages running lua scripts for test automation. This initializes a lua context, binds C++ callback functions and does per-frame processing to execute scripts

This uses an asynchronous execution model, which is necessary in order to allow scripts to simply call functions like IdleFrames() or IdleSeconds() to insert delays, making scripts much easier to write. When a script runs, every callback function adds an entry to an operations queue, and the Tick() function works its way through this queue every frame. Note that this means the C++ functions we expose to lua cannot return dynamic data; the only data we can return are constants like the number of samples available, or stateless utility functions

The documentation for this class was generated from the following file: