Ark Server API (ASA) - Wiki
|
#include <ConsoleManager.h>
Private Member Functions | |
IConsoleObject * | AddConsoleObject (const TCHAR *Name, IConsoleObject *Obj) |
IConsoleObject * | FindConsoleObjectUnfiltered (const TCHAR *Name) const |
void | UnregisterConsoleObject (const TCHAR *Name, bool bKeepState) |
void | LoadHistoryIfNeeded () |
void | SaveHistory () |
Static Private Member Functions | |
static bool | MatchPartialName (const TCHAR *Stream, const TCHAR *Pattern) |
static bool | MatchSubstring (const TCHAR *Stream, const TCHAR *Pattern) |
static FString | GetTextSection (const TCHAR *&It) |
Additional Inherited Members | |
Static Public Member Functions inherited from IConsoleManager | |
static FORCEINLINE IConsoleManager & | Get () |
Protected Member Functions inherited from IConsoleManager | |
virtual | ~IConsoleManager () |
Definition at line 15 of file ConsoleManager.h.
|
inline |
constructor
Definition at line 19 of file ConsoleManager.h.
|
inline |
destructor
Definition at line 27 of file ConsoleManager.h.
|
overridevirtual |
Input | - must not be 0 |
Implements IConsoleManager.
|
private |
Name | must not be 0, must not be empty |
Obj | must not be 0 |
The sinks are only called if a change has been done since the last time Should be called in very few points:
Implements IConsoleManager.
|
overridevirtual |
Find a console variable or command
Name | must not be 0 |
Implements IConsoleManager.
|
overridevirtual |
InVar | must not be 0 |
Implements IConsoleManager.
|
private |
same as FindConsoleObject() but ECVF_CreatedFromIni are not filtered out (for internal use)
|
overridevirtual |
Find a console variable
Name | must not be 0 |
Implements IConsoleManager.
|
overridevirtual |
Not case sensitive, does not guarantee that UnregisterConsoleObject() will work in the loop
Visitor | must not be 0 |
ThatContains | must not be 0 |
Implements IConsoleManager.
|
overridevirtual |
Iterate in O(n), not case sensitive, does not guarantee that UnregisterConsoleObject() will work in the loop
Visitor | must not be 0 |
ThatStartsWith | must not be 0 |
Implements IConsoleManager.
|
overridevirtual |
Implements IConsoleManager.
Get string till whitespace, jump over whitespace inefficient but this code is not performance critical
IConsoleThreadPropagation * FConsoleManager::GetThreadPropagationCallback | ( | ) |
Check if a name (command or variable) has been registered with the console manager
Name | - Name to check. Must not be 0 |
Implements IConsoleManager.
bool FConsoleManager::IsThreadPropagationThread | ( | ) |
|
private |
|
staticprivate |
Stream | must not be 0 |
Pattern | must not be 0 |
|
staticprivate |
Returns true if Pattern is found in Stream, case insensitive.
void FConsoleManager::OnCVarChanged | ( | ) |
|
overridevirtual |
Implements IConsoleManager.
|
overridevirtual |
Process user input e.g. "MyCVar" to get the current value of the console variable "MyCVar -5.2" to set the value to -5.2 "MyCVar ?" to get the help text
Input | must not be 0 |
Ar | archive |
InWorld | world context |
Implements IConsoleManager.
|
overridevirtual |
Register a console command that takes no arguments
Name | The name of this command (must not be nullptr) |
Help | Help text for this command |
Command | The user function to call when this command is executed |
Flags | Optional flags bitmask |
Implements IConsoleManager.
|
overridevirtual |
Register a console command that takes arguments
Name | The name of this command (must not be nullptr) |
Help | Help text for this command |
Command | The user function to call when this command is executed |
Flags | Optional flags bitmask |
Implements IConsoleManager.
|
overridevirtual |
Register a console command that takes arguments
Name | The name of this command (must not be nullptr) |
Help | Help text for this command |
Command | The user function to call when this command is executed |
Flags | Optional flags bitmask |
Implements IConsoleManager.
|
overridevirtual |
Register a console command that takes arguments
Name | The name of this command (must not be nullptr) |
Help | Help text for this command |
Command | The user function to call when this command is executed |
Flags | Optional flags bitmask |
Implements IConsoleManager.
|
overridevirtual |
Register a console command that takes arguments
Name | The name of this command (must not be nullptr) |
Help | Help text for this command |
Command | The user function to call when this command is executed |
Flags | Optional flags bitmask |
Implements IConsoleManager.
|
overridevirtual |
Register a console command that takes arguments
Name | The name of this command (must not be nullptr) |
Help | Help text for this command |
Command | The user function to call when this command is executed |
Flags | Optional flags bitmask |
Implements IConsoleManager.
|
overridevirtual |
Register a console command that takes arguments
Name | The name of this command (must not be nullptr) |
Help | Help text for this command |
Command | The user function to call when this command is executed |
Flags | Optional flags bitmask |
Implements IConsoleManager.
|
overridevirtual |
Register a console command that is handles by an Exec functions (for auto completion)
Name | The name of this command (must not be nullptr) |
Help | Help text for this command |
Flags | Optional flags bitmask |
Implements IConsoleManager.
|
overridevirtual |
Create a bool console variable
Name | must not be 0 |
Help | must not be 0 |
Flags | bitmask combined from EConsoleVariableFlags |
Implements IConsoleManager.
|
overridevirtual |
Create a string console variable
Name | must not be 0 |
Help | must not be 0 |
Flags | bitmask combined from EConsoleVariableFlags |
Implements IConsoleManager.
|
overridevirtual |
Create a string console variable
Name | must not be 0 |
Help | must not be 0 |
Flags | bitmask combined from EConsoleVariableFlags |
Implements IConsoleManager.
|
overridevirtual |
Create a float console variable
Name | must not be 0 |
Help | must not be 0 |
Flags | bitmask combined from EConsoleVariableFlags |
Implements IConsoleManager.
|
overridevirtual |
Create a int console variable
Name | must not be 0 |
Help | must not be 0 |
Flags | bitmask combined from EConsoleVariableFlags |
Implements IConsoleManager.
|
overridevirtual |
Create a reference to a show flag variable
CVarName | must not be 0, e.g. "Show.PostProcessing" |
FlagName | must not be 0, e.g. "PostProcessing" |
BitNumber | in the memory defined by Force0MaskPtr and Force1MaskPtr |
Force0MaskPtr | memory that contains the bits that should be forced to 0 |
Force1MaskPtr | memory that contains the bits that should be forced to 1 |
Help | must not be 0 |
Flags | bitmask combined from EConsoleVariableFlags |
Implements IConsoleManager.
|
overridevirtual |
Create a reference to a bool console variable
Name | must not be 0 |
Help | must not be 0 |
Flags | bitmask combined from EConsoleVariableFlags |
Implements IConsoleManager.
|
overridevirtual |
Create a reference to a float console variable
Name | must not be 0 |
Help | must not be 0 |
Flags | bitmask combined from EConsoleVariableFlags |
Implements IConsoleManager.
|
overridevirtual |
Create a reference to a string console variable
Name | must not be 0 |
Help | must not be 0 |
Flags | bitmask combined from EConsoleVariableFlags |
Implements IConsoleManager.
|
overridevirtual |
Create a reference to a int console variable
Name | must not be 0 |
Help | must not be 0 |
Flags | bitmask combined from EConsoleVariableFlags |
Implements IConsoleManager.
|
overridevirtual |
The registered command is executed at few defined points (see CallAllConsoleVariableSinks)
Command |
Implements IConsoleManager.
|
overridevirtual |
Implements IConsoleManager.
|
private |
void FConsoleManager::Test | ( | ) |
Can be moved out into some automated testing system
|
privatevirtual |
Unregisters a console variable or command, if that object was registered. For console variables, this will actually only "deactivate" the variable so if it becomes registered again the state may persist (unless bKeepState is false).
Name | Name of the console object to remove (not case sensitive) |
bKeepState | if the current state is kept in memory until a cvar with the same name is registered |
Implements IConsoleManager.
|
overridevirtual |
Unregisters a console object, if that object was registered. O(n), n is the console object count
ConsoleObject | - object to remove |
bKeepState | if the current state is kept in memory until a cvar with the same name is registered |
Implements IConsoleManager.
|
overridevirtual |
The registered command is executed at few defined points (see CallAllConsoleVariableSinks)
Command |
Implements IConsoleManager.
|
private |
Definition at line 105 of file ConsoleManager.h.
|
private |
Definition at line 96 of file ConsoleManager.h.
|
private |
Map of console variables and commands, indexed by the name of that command or variable
Definition at line 94 of file ConsoleManager.h.
|
mutableprivate |
Used to prevent concurrent access to ConsoleObjects. We don't aim to solve all concurrency problems (for example registering and unregistering a cvar on different threads, or reading a cvar from one thread while writing it from a different thread). Rather we just ensure that operations on a cvar from one thread will not conflict with operations on another cvar from another thread.
Definition at line 112 of file ConsoleManager.h.
|
private |
Definition at line 98 of file ConsoleManager.h.
|
private |
Definition at line 100 of file ConsoleManager.h.
Definition at line 97 of file ConsoleManager.h.
|
private |
Definition at line 102 of file ConsoleManager.h.