Ark Server API (ASA) - Wiki
Loading...
Searching...
No Matches
Public Member Functions | Private Member Functions | Private Attributes | Friends | List of all members
IConsoleObject Class Referenceabstract

#include <IConsoleManager.h>

+ Inheritance diagram for IConsoleObject:

Public Member Functions

 IConsoleObject ()
 
virtual ~IConsoleObject ()
 
virtual const TCHAR * GetHelp () const =0
 
virtual void SetHelp (const TCHAR *Value)=0
 
virtual EConsoleVariableFlags GetFlags () const =0
 
virtual void SetFlags (const EConsoleVariableFlags Value)=0
 
void ClearFlags (const EConsoleVariableFlags Value)
 
bool TestFlags (const EConsoleVariableFlags Value) const
 
virtual class IConsoleVariable * AsVariable ()
 
virtual bool IsVariableBool () const
 
virtual bool IsVariableInt () const
 
virtual bool IsVariableFloat () const
 
virtual bool IsVariableString () const
 
virtual class TConsoleVariableData< bool > * AsVariableBool ()
 
virtual class TConsoleVariableData< int32 > * AsVariableInt ()
 
virtual class TConsoleVariableData< float > * AsVariableFloat ()
 
virtual class TConsoleVariableData< FString > * AsVariableString ()
 
virtual struct IConsoleCommand * AsCommand ()
 

Private Member Functions

virtual void Release ()=0
 

Private Attributes

uint32 FindCallCount
 

Friends

class FConsoleManager
 

Detailed Description

Interface for console objects (variables and commands)

Definition at line 308 of file IConsoleManager.h.

Constructor & Destructor Documentation

◆ IConsoleObject()

IConsoleObject::IConsoleObject ( )
inline

Definition at line 313 of file IConsoleManager.h.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ ~IConsoleObject()

virtual IConsoleObject::~IConsoleObject ( )
inlinevirtual

Definition at line 319 of file IConsoleManager.h.

Member Function Documentation

◆ AsCommand()

virtual struct IConsoleCommand * IConsoleObject::AsCommand ( )
inlinevirtual

Casts this object to an IConsoleCommand, verifying first that it is safe to do so

Definition at line 397 of file IConsoleManager.h.

◆ AsVariable()

virtual class IConsoleVariable * IConsoleObject::AsVariable ( )
inlinevirtual

Casts this object to an IConsoleVariable, returns 0 if it's not

Definition at line 360 of file IConsoleManager.h.

◆ AsVariableBool()

virtual class TConsoleVariableData< bool > * IConsoleObject::AsVariableBool ( )
inlinevirtual

Definition at line 370 of file IConsoleManager.h.

+ Here is the caller graph for this function:

◆ AsVariableFloat()

virtual class TConsoleVariableData< float > * IConsoleObject::AsVariableFloat ( )
inlinevirtual

Definition at line 382 of file IConsoleManager.h.

+ Here is the caller graph for this function:

◆ AsVariableInt()

virtual class TConsoleVariableData< int32 > * IConsoleObject::AsVariableInt ( )
inlinevirtual

Definition at line 376 of file IConsoleManager.h.

+ Here is the caller graph for this function:

◆ AsVariableString()

virtual class TConsoleVariableData< FString > * IConsoleObject::AsVariableString ( )
inlinevirtual

Definition at line 388 of file IConsoleManager.h.

◆ ClearFlags()

void IConsoleObject::ClearFlags ( const EConsoleVariableFlags Value)
inline

Removes the specified flags in the internal state.

Definition at line 343 of file IConsoleManager.h.

+ Here is the call graph for this function:

◆ GetFlags()

virtual EConsoleVariableFlags IConsoleObject::GetFlags ( ) const
pure virtual

Get the internal state of the flags.

+ Here is the caller graph for this function:

◆ GetHelp()

virtual const TCHAR * IConsoleObject::GetHelp ( ) const
pure virtual
Returns
never 0, can be multi line ('
')

◆ IsVariableBool()

virtual bool IConsoleObject::IsVariableBool ( ) const
inlinevirtual

Definition at line 365 of file IConsoleManager.h.

◆ IsVariableFloat()

virtual bool IConsoleObject::IsVariableFloat ( ) const
inlinevirtual

Definition at line 367 of file IConsoleManager.h.

◆ IsVariableInt()

virtual bool IConsoleObject::IsVariableInt ( ) const
inlinevirtual

Definition at line 366 of file IConsoleManager.h.

◆ IsVariableString()

virtual bool IConsoleObject::IsVariableString ( ) const
inlinevirtual

Definition at line 368 of file IConsoleManager.h.

◆ Release()

virtual void IConsoleObject::Release ( )
privatepure virtual

should only be called by the manager, needs to be implemented for each instance

◆ SetFlags()

virtual void IConsoleObject::SetFlags ( const EConsoleVariableFlags Value)
pure virtual

Sets the internal flag state to the specified value.

+ Here is the caller graph for this function:

◆ SetHelp()

virtual void IConsoleObject::SetHelp ( const TCHAR * Value)
pure virtual
Returns
never 0, can be multi line ('
')

◆ TestFlags()

bool IConsoleObject::TestFlags ( const EConsoleVariableFlags Value) const
inline

Test is any of the specified flags is set in the internal state.

Definition at line 352 of file IConsoleManager.h.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Friends And Related Symbol Documentation

◆ FConsoleManager

friend class FConsoleManager
friend

Definition at line 415 of file IConsoleManager.h.

Member Data Documentation

◆ FindCallCount

uint32 IConsoleObject::FindCallCount
private

Definition at line 407 of file IConsoleManager.h.

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