TorqueScript  0.2
Public Member Functions | List of all members
TorqueScript::PlatformContext Class Reference

Public Member Functions

virtual void logEcho (const std::string &message)
 Asks the interpreter to handle a simple echo message. More...
 
virtual void logError (const std::string &message)
 Asks the interpreter to handle an error log message. More...
 
virtual void logWarning (const std::string &message)
 Asks the interpreter to handle a warning log message. More...
 
virtual void logDebug (const std::string &message)
 Asks the interpreter to handle a debug log message. More...
 
virtual std::unique_ptr< FileHandleBasegetFileHandle (const std::string &path)
 Retrieves an abstract file handle to the file at the specified path. This allows for platform-dependent implementations of file I/O such as with Unreal Engine or PhysicsFS. More...
 

Member Function Documentation

◆ getFileHandle()

virtual std::unique_ptr<FileHandleBase> TorqueScript::PlatformContext::getFileHandle ( const std::string &  path)
virtual

Retrieves an abstract file handle to the file at the specified path. This allows for platform-dependent implementations of file I/O such as with Unreal Engine or PhysicsFS.

Returns
A pointer to the file handle. Must be deleted by the call site when done.

◆ logDebug()

virtual void TorqueScript::PlatformContext::logDebug ( const std::string &  message)
virtual

Asks the interpreter to handle a debug log message.

Parameters
messageThe message to output as a debug message.

◆ logEcho()

virtual void TorqueScript::PlatformContext::logEcho ( const std::string &  message)
virtual

Asks the interpreter to handle a simple echo message.

Parameters
messageThe message to echo.

◆ logError()

virtual void TorqueScript::PlatformContext::logError ( const std::string &  message)
virtual

Asks the interpreter to handle an error log message.

Parameters
messageThe message to output as an error.

◆ logWarning()

virtual void TorqueScript::PlatformContext::logWarning ( const std::string &  message)
virtual

Asks the interpreter to handle a warning log message.

Parameters
messageThe message to output as a warning.

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