Pyrogenesis  trunk
Public Member Functions | Private Attributes | List of all members
CMapSummaryReader Class Reference

A restricted map reader that returns various summary information for use by scripts (particularly the GUI). More...

#include <MapReader.h>

Public Member Functions

PSRETURN LoadMap (const VfsPath &pathname)
 Try to load a map file. More...
 
void GetMapSettings (const ScriptInterface &scriptInterface, JS::MutableHandleValue)
 Returns a value of the form: More...
 

Private Attributes

CStr m_ScriptSettings
 

Detailed Description

A restricted map reader that returns various summary information for use by scripts (particularly the GUI).

Member Function Documentation

◆ GetMapSettings()

void CMapSummaryReader::GetMapSettings ( const ScriptInterface scriptInterface,
JS::MutableHandleValue  ret 
)

Returns a value of the form:

{
"settings": { ... contents of the map's <ScriptSettings> ... }
}

◆ LoadMap()

PSRETURN CMapSummaryReader::LoadMap ( const VfsPath pathname)

Try to load a map file.

Parameters
pathnamePath to .pmp or .xml file

Member Data Documentation

◆ m_ScriptSettings

CStr CMapSummaryReader::m_ScriptSettings
private

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