ScummVM API documentation
Public Member Functions | Public Attributes | Protected Member Functions | List of all members
Ultima::Ultima4::Debugger Class Reference

#include <debugger.h>

Inheritance diagram for Ultima::Ultima4::Debugger:
GUI::Debugger Ultima::Ultima4::DebuggerActions

Public Member Functions

void getChest (int player=-2)
 
void executeCommand (const Common::String &cmd)
 
void executeCommand (int argc, const char **argv)
 
- Public Member Functions inherited from GUI::Debugger
int getCharsPerLine ()
 
int debugPrintf (MSVC_PRINTF const char *format,...) GCC_PRINTF(2
 
int void debugPrintColumns (const Common::StringArray &list)
 
virtual void onFrame ()
 
virtual void attach (const char *entry=nullptr)
 
bool isActive () const
 
- Public Member Functions inherited from Ultima::Ultima4::DebuggerActions
void summonCreature (const Common::String &name)
 
bool destroyAt (const Coords &coords)
 
Direction directionFromName (const Common::String &dirStr)
 
bool getChestTrapHandler (int player)
 
bool jimmyAt (const Coords &coords)
 
bool mixReagentsForSpellU4 (int spell)
 
bool mixReagentsForSpellU5 (int spell)
 
bool gameSpellMixHowMany (int spell, int num, Ingredients *ingredients)
 
bool openAt (const Coords &coords)
 
void gameCastSpell (uint spell, int caster, int param)
 
bool talkAt (const Coords &coords)
 

Public Attributes

bool _collisionOverride
 
bool _disableHunger
 
bool _disableCombat
 

Protected Member Functions

bool isDebuggerActive () const override
 
bool handleCommand (int argc, const char **argv, bool &keepRunning) override
 
void print (const char *fmt,...) override
 
void printN (const char *fmt,...) override
 
void prompt () override
 
Direction getDirection (int argc, const char **argv)
 
void dontEndTurn ()
 
- Protected Member Functions inherited from GUI::Debugger
void registerVar (const Common::String &varname, byte *variable)
 
void registerVar (const Common::String &varname, int *variable)
 
void registerVar (const Common::String &varname, float *variable)
 
void registerVar (const Common::String &varname, bool *variable)
 
void registerVar (const Common::String &varname, int32 **variable, int arraySize)
 
void registerVar (const Common::String &varname, Common::String *variable)
 
void registerCmd (const Common::String &cmdname, Debuglet *debuglet)
 
void registerDefaultCmd (defaultCommand *defaultCommandProcessor)
 
void clearVars ()
 
void setPrompt (Common::String prompt)
 
void resetPrompt ()
 
virtual void preEnter ()
 
virtual void postEnter ()
 
void detach ()
 
bool cmdExit (int argc, const char **argv)
 
bool cmdHelp (int argc, const char **argv)
 
bool cmdOpenLog (int argc, const char **argv)
 
bool cmdMd5 (int argc, const char **argv)
 
bool cmdMd5Mac (int argc, const char **argv)
 
bool cmdDebugLevel (int argc, const char **argv)
 
bool cmdDebugFlagsList (int argc, const char **argv)
 
bool cmdDebugFlagEnable (int argc, const char **argv)
 
bool cmdDebugFlagDisable (int argc, const char **argv)
 
bool cmdClearLog (int argc, const char **argv)
 
bool cmdExecFile (int argc, const char **argv)
 
- Protected Member Functions inherited from Ultima::Ultima4::DebuggerActions
bool isCombat () const
 
int getCombatFocus () const
 

Additional Inherited Members

- Protected Types inherited from GUI::Debugger
enum  VarType {
  DVAR_BYTE, DVAR_INT, DVAR_FLOAT, DVAR_BOOL,
  DVAR_INTARRAY, DVAR_STRING
}
 
typedef Common::Functor1< const char *, bool > defaultCommand
 
typedef Common::Functor2< int, const char **, bool > Debuglet
 
- Protected Attributes inherited from GUI::Debugger
PauseToken _debugPauseToken
 
GUI::ConsoleDialog * _debuggerDialog
 

Detailed Description

Debugger base class

Member Function Documentation

◆ isDebuggerActive()

bool Ultima::Ultima4::Debugger::isDebuggerActive ( ) const
inlineoverrideprotectedvirtual

Returns true if the debugger is active

Implements Ultima::Ultima4::DebuggerActions.

◆ handleCommand()

bool Ultima::Ultima4::Debugger::handleCommand ( int  argc,
const char **  argv,
bool &  keepRunning 
)
overrideprotectedvirtual

Process the given command line. Returns true if and only if argv[0] is a known command and was handled, false otherwise.

Reimplemented from GUI::Debugger.

◆ print()

void Ultima::Ultima4::Debugger::print ( const char *  fmt,
  ... 
)
overrideprotectedvirtual

Prints a message to the console if it's active, or to the game screen if not

Implements Ultima::Ultima4::DebuggerActions.

◆ printN()

void Ultima::Ultima4::Debugger::printN ( const char *  fmt,
  ... 
)
overrideprotectedvirtual

Prints a message to the console if it's active, or to the game screen if not, with no newline

Implements Ultima::Ultima4::DebuggerActions.

◆ prompt()

void Ultima::Ultima4::Debugger::prompt ( )
overrideprotectedvirtual

Prompts for input, but only if debugger isn't running

Implements Ultima::Ultima4::DebuggerActions.

◆ getDirection()

Direction Ultima::Ultima4::Debugger::getDirection ( int  argc,
const char **  argv 
)
protected

Gets the direction for an action

◆ dontEndTurn()

void Ultima::Ultima4::Debugger::dontEndTurn ( )
inlineprotected

Used by methods so that when they're triggered by a keybinding action, stops the turn from being finished when they're done

◆ getChest()

void Ultima::Ultima4::Debugger::getChest ( int  player = -2)

Gets a chest. If the default -2 is used, it bypasses prompting for a user. Otherwise, a non-negative player number is expected

◆ executeCommand() [1/2]

void Ultima::Ultima4::Debugger::executeCommand ( const Common::String &  cmd)

Executes the given command

◆ executeCommand() [2/2]

void Ultima::Ultima4::Debugger::executeCommand ( int  argc,
const char **  argv 
)

Executes the given command

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