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 Types | Public Member Functions | List of all members
ScriptAutomation::ScriptAutomationRequests Class Referenceabstract

Public Types

using ScriptOperation = AZStd::function< void()>
 

Public Member Functions

 AZ_RTTI (ScriptAutomationRequests,"{403E1E72-5070-4683-BFF8-289364791723}")
 
virtual AZ::BehaviorContext * GetAutomationContext ()=0
 Retrieve the specialized behaviour context used for automation purposes.
 
virtual void ActivateScript (const char *scriptPath)=0
 Load and activate the script, and connect to the tick bus.
 
virtual void DeactivateScripts ()=0
 Deactivate all scripts and disconnect from the tick bus.
 
virtual void PauseAutomation (float timeout=DefaultPauseTimeout)=0
 
virtual void ResumeAutomation ()=0
 
virtual void SetIdleFrames (int numFrames)=0
 Set the script automation to idle for the number of frames.
 
virtual void SetIdleSeconds (float numSeconds)=0
 set the script automation to idle for the supplied number of seconds
 
virtual void SetFrameCaptureId (AZ::Render::FrameCaptureId frameCaptureId)=0
 pass the frame capture id to the automation system so it can listen for capture completion
 
virtual void StartProfilingCapture ()=0
 tell the automation system that a profiling capture has started
 
virtual void QueueScriptOperation (ScriptOperation &&action)=0
 Add an operation into the queue for processing later.
 

Member Function Documentation

virtual void ScriptAutomation::ScriptAutomationRequests::PauseAutomation ( float  timeout = DefaultPauseTimeout)
pure virtual

Can be used by sample components to temporarily pause script processing, for example to delay until some required resources are loaded and initialized.

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