Open 3D Engine ScriptCanvas Gem API Reference 23.10.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 | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
ScriptCanvas::Nodeables::Time::BaseTimer Class Reference

Inherits ScriptCanvas::Nodeable, ScriptCanvas::NodePropertyInterfaceListener, AZ::TickBus::Handler, and AZ::SystemTickBus::Handler.

Inherited by ScriptCanvas::Nodeables::Core::RepeaterNodeable, ScriptCanvas::Nodeables::Time::HeartBeatNodeable, ScriptCanvas::Nodeables::Time::TimeDelayNodeable, and ScriptCanvas::Nodeables::Time::TimerNodeable.

Public Types

enum  TimeUnits { Ticks , Milliseconds , Seconds }
 

Public Member Functions

void OnSystemTick () override
 
void OnTick (float delta, AZ::ScriptTimePoint timePoint) override
 
int GetTickOrder () override
 
void SetTimeUnits (int timeUnits)
 
void StartTimer (Data::NumberType time)
 
void StopTimer ()
 
- Public Member Functions inherited from ScriptCanvas::Nodeable
 AZ_RTTI (Nodeable, "{C8195695-423A-4960-A090-55B2E94E0B25}")
 
 AZ_CLASS_ALLOCATOR (Nodeable, AZ::SystemAllocator)
 
 Nodeable (ExecutionStateWeakPtr executionState)
 
void CallOut (size_t index, AZ::BehaviorArgument *resultBVP, AZ::BehaviorArgument *argsBVPs, int numArguments) const
 
const Execution::FunctorOut & GetExecutionOut (size_t index) const
 
const Execution::FunctorOut & GetExecutionOutChecked (size_t index) const
 
virtual NodePropertyInterface * GetPropertyInterface (AZ::Crc32)
 
void Deactivate ()
 
virtual bool IsActive () const
 
void InitializeExecutionOuts (size_t count)
 
void SetExecutionOut (size_t index, Execution::FunctorOut &&out)
 
void SetExecutionOutChecked (size_t index, Execution::FunctorOut &&out)
 
- Public Member Functions inherited from ScriptCanvas::NodePropertyInterfaceListener
virtual void OnPropertyChanged ()
 

Static Public Attributes

static constexpr const char * s_timeUnitNames []
 

Protected Member Functions

AZStd::vector< AZStd::pair< int, AZStd::string > > GetTimeUnitList () const
 
void OnTimeUnitsChanged (const int &delayUnits)
 
void UpdateTimeName ()
 
virtual bool AllowInstantResponse () const
 
void OnDeactivate () override
 
virtual void OnTimeElapsed ()
 
- Protected Member Functions inherited from ScriptCanvas::Nodeable
ExecutionStateWeakConstPtr GetExecutionState () const
 
void InitializeExecutionOutByRequiredCount ()
 
void InitializeExecutionState (ExecutionState *executionState)
 
virtual void OnInitializeExecutionState ()
 
virtual void OnDeactivate ()
 
virtual size_t GetRequiredOutCount () const
 
template<typename... t_Args>
void ExecutionOut (size_t index, t_Args &&... args) const
 
void ExecutionOut (size_t index) const
 
template<typename t_Return >
void ExecutionOutResult (size_t index, t_Return &result) const
 
template<typename t_Return , typename... t_Args>
void ExecutionOutResult (size_t index, t_Return &result, t_Args &&... args) const
 

Protected Attributes

ScriptCanvas::EnumComboBoxNodePropertyInterface m_timeUnitsInterface
 

Additional Inherited Members

- Static Public Member Functions inherited from ScriptCanvas::Nodeable
static void Reflect (AZ::ReflectContext *reflectContext)
 
- Protected Types inherited from ScriptCanvas::Nodeable
template<typename T >
using decay_array = AZStd::conditional_t< AZStd::is_array_v< AZStd::remove_reference_t< T > >, std::remove_extent_t< AZStd::remove_reference_t< T > > *, T && >
 

Member Function Documentation

◆ OnDeactivate()

void ScriptCanvas::Nodeables::Time::BaseTimer::OnDeactivate ( )
overrideprotectedvirtual

Reimplemented from ScriptCanvas::Nodeable.

Member Data Documentation

◆ s_timeUnitNames

constexpr const char* ScriptCanvas::Nodeables::Time::BaseTimer::s_timeUnitNames[]
staticconstexpr
Initial value:
=
{
"Ticks",
"Milliseconds",
"Seconds"
}
The documentation for this class was generated from the following file: