App::ICheatManager class
#include <Spore ModAPI/Spore/App/ICheatManager.h>

This manager is used to control the available cheats in the game, and the cheat console.

It contains a map that assigns a keyword to an ArgScript::ICommand object, which parses the cheat and does the action.

Derived classes

class cCheatManager
The implementation of ICheatManager; this should only be used for extending and detouring.

Public types

enum MessageIDs { kMsgCheatInvoked = 0x4BEF1E3 }

Public static functions

static auto Get() -> ICheatManager*
Returns the active cheat manager.

Constructors, destructors, conversion operators

~ICheatManager() virtual

Public functions

auto AddRef() -> int pure virtual
auto Release() -> int pure virtual
auto Initialize() -> bool pure virtual
auto Dispose() -> bool pure virtual
auto func14h() -> void pure virtual
auto AddCheat(const char* pString, ArgScript::ICommand* pParser, bool bNotify = false) -> void pure virtual
Adds a cheat to this manager.
auto AddCheat(const char* pKeyword, ArgScript::ParseLine_t pParseLine, ArgScript::GetDescription_t pGetDescription, bool bNotify = false) -> void
auto RemoveCheat(const char* pString) -> void pure virtual
Removes the cheat that is invoked with the given keyword from this manager.
auto ProcessLine(const char* pString) -> bool pure virtual
Called every time a line is submitted to the console.
auto func24h() -> int pure virtual
auto GetCheat(const char* pKeyword) -> ArgScript::ICommand* pure virtual
Returns the ArgScript::ICommand that is operating behind the requested cheat.
auto GetKeywords(const char* pPattern, eastl::vector<const char*> dst) -> size_t pure virtual
Gets all the cheat keywords in this manager that match the given pattern.
auto func30h(Object*) -> void pure virtual
auto func34h(Object*) -> void pure virtual
auto GetArgScript() -> ArgScript::FormatParser* pure virtual
Returns the ArgScript::FormatParser instance that this manager is using.
auto func3Ch(int) -> void pure virtual
auto func40h(int) -> void pure virtual
auto func44h(int) -> void pure virtual
auto func48h() -> bool pure virtual
auto func4Ch(bool) -> void pure virtual

Enum documentation

enum App::ICheatManager::MessageIDs

Enumerators
kMsgCheatInvoked

A message with no content sent when certain cheats are invoked.

This message disables achievements.

Function documentation

void App::ICheatManager::AddCheat(const char* pString, ArgScript::ICommand* pParser, bool bNotify = false) pure virtual

Adds a cheat to this manager.

Parameters
pString The keyword that is used to invoke the cheat. This is case insensitive and it can't contain whitespaces.
pParser The ArgScript::ICommand that represents this cheat.
bNotify [Optional] If true, a kMsgCheatInvoked message will be sent when the cheat is invoked, which will disable achievements.

The cheat is just an ArgScript::ICommand object; the ArgScript::ICommand::ParseLine() function will be called when the cheat is invoked.

void App::ICheatManager::RemoveCheat(const char* pString) pure virtual

Removes the cheat that is invoked with the given keyword from this manager.

Parameters
pString The keyword used to invoke the cheat. This is case insensitive and it can't contain whitespaces.

bool App::ICheatManager::ProcessLine(const char* pString) pure virtual

Called every time a line is submitted to the console.

Parameters
pString The text contents of the line.
Returns Whether the line was correctly processed or not.

ArgScript::ICommand* App::ICheatManager::GetCheat(const char* pKeyword) pure virtual

Returns the ArgScript::ICommand that is operating behind the requested cheat.

Parameters
pKeyword The keyword used to invoke the cheat.

size_t App::ICheatManager::GetKeywords(const char* pPattern, eastl::vector<const char*> dst) pure virtual

Gets all the cheat keywords in this manager that match the given pattern.

Parameters
pPattern The pattern keywords must match in order to be added to the vector.
dst A const char* vector where the keywords will be added.
Returns The number of keywords added.

The pattern uses the character '?' to allow any character, and '*' to allow any sequence of characters.