IUnitSync Class Reference

UnitSync interface definition. More...

#include <iunitsync.h>

Inherits wxEvtHandler.

Inherited by SpringUnitSync.

Collaboration diagram for IUnitSync:
Collaboration graph
[legend]

Public Types

enum  GameFeature { USYNC_Sett_Handler, USYNC_GetInfoMap, USYNC_GetDataDir, USYNC_GetSkirmishAI }
enum  MediaType { map, mod }
typedef std::map< wxString,
mmOptionBool > 		OptionMapBool
typedef std::map< wxString,
mmOptionFloat > 		OptionMapFloat
typedef std::map< wxString,
mmOptionString > 		OptionMapString
typedef std::map< wxString,
mmOptionList > 		OptionMapList
typedef std::map< wxString,
mmOptionSection > 		OptionMapSection
typedef std::map< wxString,
mmOptionBool >::iterator 		OptionMapBoolIter
typedef std::map< wxString,
mmOptionFloat >::iterator 		OptionMapFloatIter
typedef std::map< wxString,
mmOptionString >::iterator 		OptionMapStringIter
typedef std::map< wxString,
mmOptionList >::iterator 		OptionMapListIter
typedef std::map< wxString,
mmOptionSection >::iterator 		OptionMapSectionIter
typedef std::map< wxString,
mmOptionBool >::const_iterator 		OptionMapBoolConstIter
typedef std::map< wxString,
mmOptionFloat >
::const_iterator 		OptionMapFloatConstIter
typedef std::map< wxString,
mmOptionString >
::const_iterator 		OptionMapStringConstIter
typedef std::map< wxString,
mmOptionList >::const_iterator 		OptionMapListConstIter
typedef std::map< wxString,
mmOptionSection >
::const_iterator 		OptionMapSectionConstIter

Public Member Functions

virtual void OnReload (wxCommandEvent &event)=0
 IUnitSync ()
virtual ~IUnitSync ()
virtual wxArrayString GetModDeps (const wxString &name) const =0
virtual void UnSetCurrentMod ()=0
 Un-loads current mod in unitsync.
virtual int GetNumMaps () const =0
virtual wxArrayString GetMapList () const =0
virtual wxArrayString GetModValidMapList (const wxString &modname) const =0
virtual bool MapExists (const wxString &mapname) const =0
virtual bool MapExists (const wxString &mapname, const wxString &hash) const =0
virtual UnitSyncMap GetMap (const wxString &mapname)=0
virtual UnitSyncMap GetMap (int index)=0
virtual UnitSyncMap GetMapEx (const wxString &mapname)=0
virtual UnitSyncMap GetMapEx (int index)=0
virtual GameOptions GetMapOptions (const wxString &name)=0
virtual wxArrayString GetMapDeps (const wxString &name)=0
virtual int GetMapIndex (const wxString &name) const =0
virtual wxImage GetMinimap (const wxString &mapname)=0
virtual wxImage GetMinimap (const wxString &mapname, int width, int height)=0
virtual wxImage GetMetalmap (const wxString &mapname)=0
virtual wxImage GetMetalmap (const wxString &mapname, int width, int height)=0
virtual wxImage GetHeightmap (const wxString &mapname)=0
virtual wxImage GetHeightmap (const wxString &mapname, int width, int height)=0
virtual wxArrayString GetSides (const wxString &modname)=0
virtual wxImage GetSidePicture (const wxString &modname, const wxString &SideName) const =0
virtual wxImage GetImage (const wxString &modname, const wxString &image_path, bool useWhiteAsTransparent=true) const =0
virtual wxString GetTextfileAsString (const wxString &modname, const wxString &file_path)=0
virtual int GetNumUnits (const wxString &modname) const =0
virtual wxArrayString GetUnitsList (const wxString &modname)=0
virtual bool LoadUnitSyncLib (const wxString &unitsyncloc)=0
virtual void FreeUnitSyncLib ()=0
virtual bool IsLoaded () const =0
virtual wxString GetDefaultNick ()=0
virtual void SetDefaultNick (const wxString &nick)=0
virtual wxString GetSpringVersion () const =0
virtual bool VersionSupports (GameFeature feature) const =0
virtual wxArrayString GetAIList (const wxString &modname) const =0
virtual wxArrayString GetAIInfos (int index) const =0
virtual GameOptions GetAIOptions (const wxString &modname, int index)=0
virtual bool ReloadUnitSyncLib ()=0
virtual void ReloadUnitSyncLib (GlobalEvents::GlobalEventData data)=0
virtual wxArrayString GetPlaybackList (bool ReplayType=true) const =0
virtual void SetSpringDataPath (const wxString &path)=0
virtual bool FileExists (const wxString &name) const =0
virtual wxString GetArchivePath (const wxString &name) const =0
virtual void PrefetchMap (const wxString &mapname)=0
virtual int RegisterEvtHandler (wxEvtHandler *evtHandler)=0
virtual void UnregisterEvtHandler (int evtHandlerId)=0
virtual void GetMinimapAsync (const wxString &mapname, int evtHandlerId)=0
virtual void GetMinimapAsync (const wxString &mapname, int width, int height, int evtHandlerId)=0
virtual void GetMetalmapAsync (const wxString &mapname, int evtHandlerId)=0
virtual void GetMetalmapAsync (const wxString &mapname, int width, int height, int evtHandlerId)=0
virtual void GetHeightmapAsync (const wxString &mapname, int evtHandlerId)=0
virtual void GetHeightmapAsync (const wxString &mapname, int width, int height, int evtHandlerId)=0
virtual void GetMapExAsync (const wxString &mapname, int evtHandlerId)=0
virtual wxArrayString GetScreenshotFilenames () const =0
virtual GameOptions GetModCustomizations (const wxString &modname)=0
virtual GameOptions GetSkirmishOptions (const wxString &modname, const wxString &skirmish_name)=0
virtual void AddReloadEvent ()=0
 this only generates a wxUnitsyncReloadEvent type wxCommandEvent and appends it to itself
virtual wxArrayString FindFilesVFS (const wxString &pattern) const =0
Mods

virtual int GetNumMods () const =0
 Fetch the number of mods available.
virtual wxArrayString GetModList () const =0
 Get a list of the mods available.
virtual bool ModExists (const wxString &modname) const =0
 Check by name if a mod exists.
virtual bool ModExists (const wxString &modname, const wxString &hash) const =0
 Check by name and hash string if a mod exists.
virtual bool ModExistsCheckHash (const wxString &hash) const =0
 Check by hash string only if a mod exists.
virtual UnitSyncMod GetMod (const wxString &modname)=0
 Get a mod by name.
virtual UnitSyncMod GetMod (int index)=0
 Get a mod by index.
virtual int GetModIndex (const wxString &name) const =0
 Fetch the index of a mod by name.
virtual GameOptions GetModOptions (const wxString &name)=0
 Get the options for a mod by name.

Private Member Functions

 IUnitSync (const IUnitSync &)

Detailed Description

UnitSync interface definition.

Definition at line 59 of file iunitsync.h.

Member Typedef Documentation

typedef std::map<wxString,mmOptionBool> IUnitSync::OptionMapBool

Definition at line 87 of file iunitsync.h.

typedef std::map<wxString,mmOptionBool>::const_iterator IUnitSync::OptionMapBoolConstIter

Definition at line 99 of file iunitsync.h.

typedef std::map<wxString,mmOptionBool>::iterator IUnitSync::OptionMapBoolIter

Definition at line 93 of file iunitsync.h.

typedef std::map<wxString,mmOptionFloat> IUnitSync::OptionMapFloat

Definition at line 88 of file iunitsync.h.

typedef std::map<wxString,mmOptionFloat>::const_iterator IUnitSync::OptionMapFloatConstIter

Definition at line 100 of file iunitsync.h.

typedef std::map<wxString,mmOptionFloat>::iterator IUnitSync::OptionMapFloatIter

Definition at line 94 of file iunitsync.h.

typedef std::map<wxString,mmOptionList> IUnitSync::OptionMapList

Definition at line 90 of file iunitsync.h.

typedef std::map<wxString,mmOptionList>::const_iterator IUnitSync::OptionMapListConstIter

Definition at line 102 of file iunitsync.h.

typedef std::map<wxString,mmOptionList>::iterator IUnitSync::OptionMapListIter

Definition at line 96 of file iunitsync.h.

typedef std::map<wxString,mmOptionSection> IUnitSync::OptionMapSection

Definition at line 91 of file iunitsync.h.

typedef std::map<wxString,mmOptionSection>::const_iterator IUnitSync::OptionMapSectionConstIter

Definition at line 103 of file iunitsync.h.

typedef std::map<wxString,mmOptionSection>::iterator IUnitSync::OptionMapSectionIter

Definition at line 97 of file iunitsync.h.

typedef std::map<wxString,mmOptionString> IUnitSync::OptionMapString

Definition at line 89 of file iunitsync.h.

typedef std::map<wxString,mmOptionString>::const_iterator IUnitSync::OptionMapStringConstIter

Definition at line 101 of file iunitsync.h.

typedef std::map<wxString,mmOptionString>::iterator IUnitSync::OptionMapStringIter

Definition at line 95 of file iunitsync.h.

Member Enumeration Documentation

enum IUnitSync::GameFeature
Enumerator:
USYNC_Sett_Handler 
USYNC_GetInfoMap 
USYNC_GetDataDir 
USYNC_GetSkirmishAI 

Definition at line 73 of file iunitsync.h.

enum IUnitSync::MediaType
Enumerator:
map 
mod 

Definition at line 81 of file iunitsync.h.

Constructor & Destructor Documentation

IUnitSync::IUnitSync (  )  [inline]

Definition at line 63 of file iunitsync.h.

virtual IUnitSync::~IUnitSync (  )  [inline, virtual]

Definition at line 68 of file iunitsync.h.

IUnitSync::IUnitSync ( const IUnitSync &   )  [private]

Member Function Documentation

virtual void IUnitSync::AddReloadEvent (  )  [pure virtual]

this only generates a wxUnitsyncReloadEvent type wxCommandEvent and appends it to itself

Implemented in SpringUnitSync.

virtual bool IUnitSync::FileExists ( const wxString &  name  )  const [pure virtual]

Implemented in SpringUnitSync.

virtual wxArrayString IUnitSync::FindFilesVFS ( const wxString &  pattern  )  const [pure virtual]

Implemented in SpringUnitSync.

virtual void IUnitSync::FreeUnitSyncLib (  )  [pure virtual]

Implemented in SpringUnitSync.

virtual wxArrayString IUnitSync::GetAIInfos ( int  index  )  const [pure virtual]

Implemented in SpringUnitSync.

virtual wxArrayString IUnitSync::GetAIList ( const wxString &  modname  )  const [pure virtual]

Implemented in SpringUnitSync.

virtual GameOptions IUnitSync::GetAIOptions ( const wxString &  modname,
int  index 
) [pure virtual]

Implemented in SpringUnitSync.

virtual wxString IUnitSync::GetArchivePath ( const wxString &  name  )  const [pure virtual]

Implemented in SpringUnitSync.

virtual wxString IUnitSync::GetDefaultNick (  )  [pure virtual]

Implemented in SpringUnitSync.

virtual wxImage IUnitSync::GetHeightmap ( const wxString &  mapname,
int  width,
int  height 
) [pure virtual]

Implemented in SpringUnitSync.

virtual wxImage IUnitSync::GetHeightmap ( const wxString &  mapname  )  [pure virtual]

Implemented in SpringUnitSync.

virtual void IUnitSync::GetHeightmapAsync ( const wxString &  mapname,
int  width,
int  height,
int  evtHandlerId 
) [pure virtual]

Implemented in SpringUnitSync.

virtual void IUnitSync::GetHeightmapAsync ( const wxString &  mapname,
int  evtHandlerId 
) [pure virtual]

Implemented in SpringUnitSync.

virtual wxImage IUnitSync::GetImage ( const wxString &  modname,
const wxString &  image_path,
bool  useWhiteAsTransparent = true 
) const [pure virtual]

Implemented in SpringUnitSync.

virtual UnitSyncMap IUnitSync::GetMap ( int  index  )  [pure virtual]

Implemented in SpringUnitSync.

virtual UnitSyncMap IUnitSync::GetMap ( const wxString &  mapname  )  [pure virtual]

Implemented in SpringUnitSync.

virtual wxArrayString IUnitSync::GetMapDeps ( const wxString &  name  )  [pure virtual]

Implemented in SpringUnitSync.

virtual UnitSyncMap IUnitSync::GetMapEx ( int  index  )  [pure virtual]

Implemented in SpringUnitSync.

virtual UnitSyncMap IUnitSync::GetMapEx ( const wxString &  mapname  )  [pure virtual]

Implemented in SpringUnitSync.

virtual void IUnitSync::GetMapExAsync ( const wxString &  mapname,
int  evtHandlerId 
) [pure virtual]

Implemented in SpringUnitSync.

virtual int IUnitSync::GetMapIndex ( const wxString &  name  )  const [pure virtual]

Implemented in SpringUnitSync.

virtual wxArrayString IUnitSync::GetMapList (  )  const [pure virtual]

Implemented in SpringUnitSync.

virtual GameOptions IUnitSync::GetMapOptions ( const wxString &  name  )  [pure virtual]

Implemented in SpringUnitSync.

virtual wxImage IUnitSync::GetMetalmap ( const wxString &  mapname,
int  width,
int  height 
) [pure virtual]

Implemented in SpringUnitSync.

virtual wxImage IUnitSync::GetMetalmap ( const wxString &  mapname  )  [pure virtual]

Implemented in SpringUnitSync.

virtual void IUnitSync::GetMetalmapAsync ( const wxString &  mapname,
int  width,
int  height,
int  evtHandlerId 
) [pure virtual]

Implemented in SpringUnitSync.

virtual void IUnitSync::GetMetalmapAsync ( const wxString &  mapname,
int  evtHandlerId 
) [pure virtual]

Implemented in SpringUnitSync.

virtual wxImage IUnitSync::GetMinimap ( const wxString &  mapname,
int  width,
int  height 
) [pure virtual]

Implemented in SpringUnitSync.

virtual wxImage IUnitSync::GetMinimap ( const wxString &  mapname  )  [pure virtual]

Implemented in SpringUnitSync.

virtual void IUnitSync::GetMinimapAsync ( const wxString &  mapname,
int  width,
int  height,
int  evtHandlerId 
) [pure virtual]

Implemented in SpringUnitSync.

virtual void IUnitSync::GetMinimapAsync ( const wxString &  mapname,
int  evtHandlerId 
) [pure virtual]

Implemented in SpringUnitSync.

virtual UnitSyncMod IUnitSync::GetMod ( int  index  )  [pure virtual]

Get a mod by index.

Implemented in SpringUnitSync.

virtual UnitSyncMod IUnitSync::GetMod ( const wxString &  modname  )  [pure virtual]

Get a mod by name.

Implemented in SpringUnitSync.

virtual GameOptions IUnitSync::GetModCustomizations ( const wxString &  modname  )  [pure virtual]
Parameters:
name Modname

Implemented in SpringUnitSync.

virtual wxArrayString IUnitSync::GetModDeps ( const wxString &  name  )  const [pure virtual]

Implemented in SpringUnitSync.

virtual int IUnitSync::GetModIndex ( const wxString &  name  )  const [pure virtual]

Fetch the index of a mod by name.

Implemented in SpringUnitSync.

virtual wxArrayString IUnitSync::GetModList (  )  const [pure virtual]

Get a list of the mods available.

Implemented in SpringUnitSync.

virtual GameOptions IUnitSync::GetModOptions ( const wxString &  name  )  [pure virtual]

Get the options for a mod by name.

Implemented in SpringUnitSync.

virtual wxArrayString IUnitSync::GetModValidMapList ( const wxString &  modname  )  const [pure virtual]

Implemented in SpringUnitSync.

virtual int IUnitSync::GetNumMaps (  )  const [pure virtual]

Implemented in SpringUnitSync.

virtual int IUnitSync::GetNumMods (  )  const [pure virtual]

Fetch the number of mods available.

Implemented in SpringUnitSync.

virtual int IUnitSync::GetNumUnits ( const wxString &  modname  )  const [pure virtual]

Implemented in SpringUnitSync.

virtual wxArrayString IUnitSync::GetPlaybackList ( bool  ReplayType = true  )  const [pure virtual]

Implemented in SpringUnitSync.

virtual wxArrayString IUnitSync::GetScreenshotFilenames (  )  const [pure virtual]

Implemented in SpringUnitSync.

virtual wxImage IUnitSync::GetSidePicture ( const wxString &  modname,
const wxString &  SideName 
) const [pure virtual]

Implemented in SpringUnitSync.

virtual wxArrayString IUnitSync::GetSides ( const wxString &  modname  )  [pure virtual]

Implemented in SpringUnitSync.

virtual GameOptions IUnitSync::GetSkirmishOptions ( const wxString &  modname,
const wxString &  skirmish_name 
) [pure virtual]

Implemented in SpringUnitSync.

virtual wxString IUnitSync::GetSpringVersion (  )  const [pure virtual]

Implemented in SpringUnitSync.

virtual wxString IUnitSync::GetTextfileAsString ( const wxString &  modname,
const wxString &  file_path 
) [pure virtual]

Implemented in SpringUnitSync.

virtual wxArrayString IUnitSync::GetUnitsList ( const wxString &  modname  )  [pure virtual]

Implemented in SpringUnitSync.

virtual bool IUnitSync::IsLoaded (  )  const [pure virtual]

Implemented in SpringUnitSync.

virtual bool IUnitSync::LoadUnitSyncLib ( const wxString &  unitsyncloc  )  [pure virtual]

Implemented in SpringUnitSync.

virtual bool IUnitSync::MapExists ( const wxString &  mapname,
const wxString &  hash 
) const [pure virtual]

Implemented in SpringUnitSync.

virtual bool IUnitSync::MapExists ( const wxString &  mapname  )  const [pure virtual]

Implemented in SpringUnitSync.

virtual bool IUnitSync::ModExists ( const wxString &  modname,
const wxString &  hash 
) const [pure virtual]

Check by name and hash string if a mod exists.

Implemented in SpringUnitSync.

virtual bool IUnitSync::ModExists ( const wxString &  modname  )  const [pure virtual]

Check by name if a mod exists.

Implemented in SpringUnitSync.

virtual bool IUnitSync::ModExistsCheckHash ( const wxString &  hash  )  const [pure virtual]

Check by hash string only if a mod exists.

Implemented in SpringUnitSync.

virtual void IUnitSync::OnReload ( wxCommandEvent &  event  )  [pure virtual]

Implemented in SpringUnitSync.

virtual void IUnitSync::PrefetchMap ( const wxString &  mapname  )  [pure virtual]

Implemented in SpringUnitSync.

virtual int IUnitSync::RegisterEvtHandler ( wxEvtHandler *  evtHandler  )  [pure virtual]

Implemented in SpringUnitSync.

virtual void IUnitSync::ReloadUnitSyncLib ( GlobalEvents::GlobalEventData  data  )  [pure virtual]

Implemented in SpringUnitSync.

virtual bool IUnitSync::ReloadUnitSyncLib (  )  [pure virtual]

Implemented in SpringUnitSync.

virtual void IUnitSync::SetDefaultNick ( const wxString &  nick  )  [pure virtual]

Implemented in SpringUnitSync.

virtual void IUnitSync::SetSpringDataPath ( const wxString &  path  )  [pure virtual]

Implemented in SpringUnitSync.

virtual void IUnitSync::UnregisterEvtHandler ( int  evtHandlerId  )  [pure virtual]

Implemented in SpringUnitSync.

virtual void IUnitSync::UnSetCurrentMod (  )  [pure virtual]

Un-loads current mod in unitsync.

Implemented in SpringUnitSync.

virtual bool IUnitSync::VersionSupports ( GameFeature  feature  )  const [pure virtual]

Implemented in SpringUnitSync.

The documentation for this class was generated from the following file:
Generated on Sun Feb 27 13:07:02 2011 for SpringLobby by doxygen 1.6.3