Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

Changeset 3225 in orxonox.OLD for orxonox/trunk/src/game_loader.cc


Ignore:
Timestamp:
Dec 20, 2004, 12:23:58 AM (19 years ago)
Author:
patrick
Message:

/orxonox/trunk: unstable - added many comments and now redefinit all function/variable names with underline

File:
1 edited

Legend:

Unmodified
Added
Removed

  • orxonox/trunk/src/game_loader.cc

    r3222 r3225  
    4242
    4343
     44/**
     45   \brief this class is a singleton class
     46   \returns an instance of itself
     47
     48   if you are unsure about singleton classes, check the theory out on the internet :)
     49*/
    4450GameLoader* GameLoader::getInstance()
    4551{
    … …  
    5763
    5864
     65/**
     66   \brief reads a campaign definition file into a campaign class
     67   \param filename to be loaded
     68   \returns the loaded campaign
     69
     70   this will interprete the map/campaign files and recursivly load a tree of worlds/campaigns
     71*/
    5972ErrorMessage GameLoader::loadCampaign(char* name)
    6073{
    … …  
    6477}
    6578
     79
     80/**
     81   \brief loads a debug campaign for test purposes only.
     82   \param the identifier of the campaign.
     83   \returns error message if not able to do so.
     84*/
    6685ErrorMessage GameLoader::loadDebugCampaign(Uint32 campaignID)
    6786{
    … …  
    117136}
    118137
    119 ErrorMessage GameLoader::free()
     138/**
     139   \brief release the mem
     140 */
     141ErrorMessage GameLoader::destroy()
    120142{}
    121143
    122144
     145/**
     146   \brief reads a campaign definition file into a campaign class
     147   \param filename to be loaded
     148   \returns the loaded campaign
     149
     150   this will interprete the map/campaign files and recursivly load a tree of worlds/campaigns
     151*/
    123152Campaign* GameLoader::fileToCampaign(char *name)
    124153{
    … …  
    133162   \brief handle keyboard commands
    134163   \param cmd: the command to handle
    135    \return true if the command was handled by the system
     164   \returns true if the command was handled by the system
    136165*/
    137166bool GameLoader::worldCommand (Command* cmd)
    … …  
    172201}
    173202
     203
     204/*
     205  \brief this changes to the next level
     206*/
    174207void GameLoader::nextLevel()
    175208{
    … …  
    178211}
    179212
     213
     214/*
     215  \brief change to the previous level - not implemented
     216
     217  this propably useless
     218*/
    180219void GameLoader::previousLevel()
    181220{
Note: See TracChangeset for help on using the changeset viewer.