Inherits AZ::ConsoleDataContainer< BASE_TYPE, THREAD_SAFETY >.
|
using | BaseType = BASE_TYPE |
|
using | SelfType = ConsoleDataWrapper< BASE_TYPE, THREAD_SAFETY > |
|
using | CallbackFunc = void(*)(const BaseType &value) |
|
◆ ConsoleDataWrapper()
template<typename BASE_TYPE , ThreadSafety THREAD_SAFETY>
AZ::ConsoleDataWrapper< BASE_TYPE, THREAD_SAFETY >::ConsoleDataWrapper |
( |
const BASE_TYPE & |
value, |
|
|
CallbackFunc |
callback, |
|
|
const char * |
name, |
|
|
const char * |
desc, |
|
|
ConsoleFunctorFlags |
flags |
|
) |
| |
|
inline |
Constructor.
- Parameters
-
value | the initial value to initialize the wrapped data to |
callback | an optional callback that will be invoked upon any change in value to this variable |
name | the string name of the variable |
desc | a string help description of the variable |
flags | a set of optional flags that mutate the behaviour of the variable |
◆ CvarFunctor()
template<typename BASE_TYPE , ThreadSafety THREAD_SAFETY>
Cvar functor, reads data contained in arguments to set the console variable value.
- Parameters
-
arguments | StringSet instance to read new values from |
◆ operator BASE_TYPE()
template<typename BASE_TYPE , ThreadSafety THREAD_SAFETY>
Const base type operator
- Returns
- value in const base type form.
◆ operator!=()
template<typename BASE_TYPE , ThreadSafety THREAD_SAFETY>
Inequality operator, provided for convenience. The contained value could have changed after the comparison is made and before the result is returned
- Parameters
-
rhs | base type value to compare against |
- Returns
- boolean true if this != rhs
◆ operator<()
template<typename BASE_TYPE , ThreadSafety THREAD_SAFETY>
Strictly less than operator, provided for convenience. The contained value could have changed after the comparison is made and before the result is returned
- Parameters
-
rhs | base type value to compare against |
- Returns
- boolean true if this < rhs
◆ operator<=()
template<typename BASE_TYPE , ThreadSafety THREAD_SAFETY>
Less than equal to operator, provided for convenience. The contained value could have changed after the comparison is made and before the result is returned
- Parameters
-
rhs | base type value to compare against |
- Returns
- boolean true if this <= rhs
◆ operator=()
template<typename BASE_TYPE , ThreadSafety THREAD_SAFETY>
Assignment from underlying base type.
- Parameters
-
rhs | base type value to assign from |
◆ operator==()
template<typename BASE_TYPE , ThreadSafety THREAD_SAFETY>
Equality operator, provided for convenience. The contained value could have changed after the comparison is made and before the result is returned.
- Parameters
-
rhs | base type value to compare against |
- Returns
- boolean true if this == rhs
◆ operator>()
template<typename BASE_TYPE , ThreadSafety THREAD_SAFETY>
Strictly greater than operator, provided for convenience. The contained value could have changed after the comparison is made and before the result is returned
- Parameters
-
rhs | base type value to compare against |
- Returns
- boolean true if this > rhs
◆ operator>=()
template<typename BASE_TYPE , ThreadSafety THREAD_SAFETY>
Greater than equal to operator, provided for convenience. The contained value could have changed after the comparison is made and before the result is returned
- Parameters
-
rhs | base type value to compare against |
- Returns
- boolean true if this >= rhs
◆ StringToValue()
template<typename BASE_TYPE , ThreadSafety THREAD_SAFETY>
Reads data contained in arguments to set the console variable value.
- Parameters
-
arguments | StringSet instance to read new values from |
- Returns
- boolean true on success, false if an error occurred
◆ ValueToString()
template<typename BASE_TYPE , ThreadSafety THREAD_SAFETY>
Stringifies the contained variables value and write the result to outString.
- Parameters
-
outString | output string instance to write the stringified value to |
The documentation for this class was generated from the following files:
- Code/Framework/AzCore/AzCore/Console/ConsoleDataWrapper.h
- Code/Framework/AzCore/AzCore/Console/ConsoleDataWrapper.inl