Public Types
using	FunctorSignature = void(*)(const ConsoleCommandContainer &)

Public Member Functions
	ConsoleFunctor (const char name, const char desc, ConsoleFunctorFlags flags, const TypeId &typeId, FunctorSignature function)

	ConsoleFunctor (AZ::IConsole &console, const char name, const char desc, ConsoleFunctorFlags flags, const TypeId &typeId, FunctorSignature function)

	ConsoleFunctor (ConsoleFunctor &&)=default

ConsoleFunctor &	operator= (ConsoleFunctor &&)=default


void	operator() (const ConsoleCommandContainer &arguments) override

bool	GetReplicationString (CVarFixedString &outString) const override

Public Member Functions inherited from AZ::ConsoleFunctorBase
	ConsoleFunctorBase (const char name, const char desc, ConsoleFunctorFlags flags, const TypeId &typeId)

	ConsoleFunctorBase (AZ::IConsole &console, const char name, const char desc, ConsoleFunctorFlags flags, const TypeId &typeId)

	ConsoleFunctorBase (ConsoleFunctorBase &&other)

ConsoleFunctorBase &	operator= (ConsoleFunctorBase &&other)

virtual	~ConsoleFunctorBase ()
	Destructor.

const char *	GetName () const

const char *	GetDesc () const

ConsoleFunctorFlags	GetFlags () const

const TypeId &	GetTypeId () const

virtual void	operator() (const ConsoleCommandContainer &arguments)=0

virtual bool	GetReplicationString (CVarFixedString &outString) const =0

template<typename RETURN_TYPE >
GetValueResult	GetValue (RETURN_TYPE &outResult) const

Additional Inherited Members
Static Public Member Functions inherited from AZ::ConsoleFunctorBase
static ConsoleFunctorBase *&	GetDeferredHead ()
	Used internally to link cvars and functors from various modules to the console as they are loaded.

Protected Member Functions inherited from AZ::ConsoleFunctorBase
virtual GetValueResult	GetValueAsString (CVarFixedString &outString) const

void	Link (ConsoleFunctorBase *&head)

void	Unlink (ConsoleFunctorBase *&head)

Protected Attributes inherited from AZ::ConsoleFunctorBase
const char *	m_name = ""

const char *	m_desc = ""

ConsoleFunctorFlags	m_flags = ConsoleFunctorFlags::Null

TypeId	m_typeId

IConsole *	m_console = nullptr

ConsoleFunctorBase *	m_prev = nullptr

ConsoleFunctorBase *	m_next = nullptr

bool	m_isDeferred = true

Static Protected Attributes inherited from AZ::ConsoleFunctorBase
static ConsoleFunctorBase *	s_deferredHead

static bool	s_deferredHeadInvoked

Member Function Documentation

◆ GetReplicationString()

template<bool _REPLICATES_VALUE>

bool AZ::ConsoleFunctor< void, _REPLICATES_VALUE >::GetReplicationString ( CVarFixedString & outString ) const

inlineoverridevirtual

For functors that can be replicated (cvars). This will generate a replication string suitable for remote execution

Parameters

outString the output string which can be remotely executed

Returns: boolean true if a proper replicated value was returned, false otherwise

template<bool _REPLICATES_VALUE>

void AZ::ConsoleFunctor< void, _REPLICATES_VALUE >::operator() ( const ConsoleCommandContainer & arguments )

inlineoverridevirtual

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