World Class Reference

#include <world.hpp>

List of all members.

Public Member Functions
	World ()
	~World ()
void	set_savegame_filename (const std::string &filename)
void	load (const std::string &filename)
void	save_state ()
void	load_state ()
unsigned int	get_num_levels () const
const std::string &	get_level_filename (unsigned int i) const
const std::string &	get_basedir () const
const std::string &	get_title () const
PlayerStatus *	get_player_status () const
	returns player status
void	run ()
Static Public Member Functions
static World *	current ()
Public Attributes
bool	hide_from_contribs
bool	is_levelset
Private Attributes
std::vector< std::string >	levels
std::string	basedir
std::string	savegame_filename
HSQOBJECT	state_table
	squirrel table that saves persistent state (about the world)
HSQOBJECT	world_thread
std::string	title
std::string	description
std::auto_ptr< PlayerStatus >	player_status
Static Private Attributes
static World *	current_

---

Detailed Description

Definition at line 26 of file world.hpp.

---

Constructor & Destructor Documentation

World::World

(

)

Definition at line 35 of file world.cpp.

References hide_from_contribs, is_levelset, player_status, and world_thread.

             :
  levels(),
  basedir(),
  savegame_filename(),
  state_table(),
  world_thread(),
  title(),
  description(),
  player_status(),
  hide_from_contribs(),
  is_levelset()
{
  player_status.reset(new PlayerStatus());

  is_levelset = true;
  hide_from_contribs = false;
  sq_resetobject(&world_thread);
}

World::~World

(

)

Definition at line 54 of file world.cpp.

References current_, scripting::global_vm, and world_thread.

{
  sq_release(scripting::global_vm, &world_thread);
  if(current_ == this)
    current_ = NULL;
}

---

Member Function Documentation

static World* World::current

(

)

[inline, static]

Definition at line 29 of file world.hpp.

References current_.

Referenced by scripting::load_worldmap(), worldmap::WorldMap::save_state(), and scripting::save_state().

  {
    return current_;
  }

void World::set_savegame_filename

(

const std::string &

filename

)

Definition at line 62 of file world.cpp.

References FileSystem::dirname(), and savegame_filename.

Referenced by TitleScreen::start_game().

{
  this->savegame_filename = filename;
  // make sure the savegame directory exists
  std::string dirname = FileSystem::dirname(filename);
  if(!PHYSFS_exists(dirname.c_str())) {
    if(!PHYSFS_mkdir(dirname.c_str())) {
      std::ostringstream msg;
      msg << "Couldn't create directory for savegames '"
          << dirname << "': " <<PHYSFS_getLastError();
      throw std::runtime_error(msg.str());
    }
  }

  if(!PHYSFS_isDirectory(dirname.c_str())) {
    std::ostringstream msg;
    msg << "Savegame path '" << dirname << "' is not a directory";
    throw std::runtime_error(msg.str());
  }
}

void World::load

(

const std::string &

filename

)

Definition at line 84 of file world.cpp.

References basedir, description, FileSystem::dirname(), lisp::Lisp::get(), lisp::Lisp::get_lisp(), StringUtil::has_suffix(), hide_from_contribs, is_levelset, levels, log_warning, StringUtil::numeric_less(), lisp::Parser::parse(), and title.

{
  basedir = FileSystem::dirname(filename);

  lisp::Parser parser;
  const lisp::Lisp* root = parser.parse(filename);

  const lisp::Lisp* info = root->get_lisp("supertux-world");
  if(info == NULL)
    info = root->get_lisp("supertux-level-subset");
  if(info == NULL)
    throw std::runtime_error("File is not a world or levelsubset file");

  hide_from_contribs = false;
  is_levelset = true;

  info->get("title", title);
  info->get("description", description);
  info->get("levelset", is_levelset);
  info->get("hide-from-contribs", hide_from_contribs);

  // Level info file doesn't define any levels, so read the
  // directory to see what we can find

  std::string path = basedir;
  char** files = PHYSFS_enumerateFiles(path.c_str());
  if(!files) {
    log_warning << "Couldn't read subset dir '" << path << "'" << std::endl;
    return;
  }

  for(const char* const* filename = files; *filename != 0; ++filename) {
    if(StringUtil::has_suffix(*filename, ".stl")) {
      levels.push_back(path + *filename);
    }
  }
  PHYSFS_freeList(files);

  std::sort(levels.begin(), levels.end(), StringUtil::numeric_less);
}

void World::save_state

(

)

Definition at line 159 of file world.cpp.

References lisp::Writer::end_list(), scripting::global_vm, player_status, scripting::save_squirrel_table(), savegame_filename, lisp::Writer::start_list(), title, and lisp::Writer::write().

Referenced by worldmap::WorldMap::save_state(), and scripting::save_state().

{
  using namespace scripting;

  lisp::Writer writer(savegame_filename);

  writer.start_list("supertux-savegame");
  writer.write("version", 1);

  using namespace worldmap;
  if(WorldMap::current() != NULL) {
    std::ostringstream title;
    title << WorldMap::current()->get_title();
    title << " (" << WorldMap::current()->solved_level_count()
          << "/" << WorldMap::current()->level_count() << ")";
    writer.write("title", title.str());
  }

  writer.start_list("tux");
  player_status->write(writer);
  writer.end_list("tux");

  writer.start_list("state");

  sq_pushroottable(global_vm);
  sq_pushstring(global_vm, "state", -1);
  if(SQ_SUCCEEDED(sq_get(global_vm, -2))) {
    scripting::save_squirrel_table(global_vm, -1, writer);
    sq_pop(global_vm, 1);
  }
  sq_pop(global_vm, 1);
  writer.end_list("state");

  writer.end_list("supertux-savegame");
}

void World::load_state

(

)

Definition at line 196 of file world.cpp.

References lisp::Lisp::get(), lisp::Lisp::get_lisp(), scripting::global_vm, scripting::load_squirrel_table(), log_fatal, lisp::Parser::parse(), player_status, and savegame_filename.

Referenced by run().

{
  using namespace scripting;

  if(PHYSFS_exists(savegame_filename.c_str())) {
    try {
      lisp::Parser parser;
      const lisp::Lisp* root = parser.parse(savegame_filename);

      const lisp::Lisp* lisp = root->get_lisp("supertux-savegame");
      if(lisp == NULL)
        throw std::runtime_error("file is not a supertux-savegame file");

      int version = 1;
      lisp->get("version", version);
      if(version != 1)
        throw std::runtime_error("incompatible savegame version");

      const lisp::Lisp* tux = lisp->get_lisp("tux");
      if(tux == NULL)
        throw std::runtime_error("No tux section in savegame");
      player_status->read(*tux);

      const lisp::Lisp* state = lisp->get_lisp("state");
      if(state == NULL)
        throw std::runtime_error("No state section in savegame");

      sq_pushroottable(global_vm);
      sq_pushstring(global_vm, "state", -1);
      if(SQ_FAILED(sq_deleteslot(global_vm, -2, SQFalse)))
        sq_pop(global_vm, 1);

      sq_pushstring(global_vm, "state", -1);
      sq_newtable(global_vm);
      load_squirrel_table(global_vm, -1, *state);
      if(SQ_FAILED(sq_createslot(global_vm, -3)))
        throw std::runtime_error("Couldn't create state table");
      sq_pop(global_vm, 1);
    } catch(std::exception& e) {
      log_fatal << "Couldn't load savegame: " << e.what() << std::endl;
    }
  }
}

unsigned int World::get_num_levels

(

)

const

Definition at line 247 of file world.cpp.

References levels.

Referenced by ContribWorldMenu::ContribWorldMenu().

{
  return levels.size();
}

const std::string & World::get_level_filename

(

unsigned int

i

)

const

Definition at line 241 of file world.cpp.

References levels.

Referenced by ContribWorldMenu::check_menu(), and ContribWorldMenu::ContribWorldMenu().

{
  return levels[i];
}

const std::string & World::get_basedir

(

)

const

Definition at line 253 of file world.cpp.

References basedir.

Referenced by TitleScreen::start_game().

{
  return basedir;
}

const std::string & World::get_title

(

)

const

Definition at line 259 of file world.cpp.

References title.

Referenced by ContribWorldMenu::ContribWorldMenu().

{
  return title;
}

PlayerStatus* World::get_player_status

(

)

const [inline]

returns player status

Definition at line 53 of file world.hpp.

References player_status.

Referenced by ContribWorldMenu::check_menu(), and run().

{ return player_status.get(); }

void World::run

(

)

Definition at line 126 of file world.cpp.

References basedir, scripting::compile_and_run(), scripting::create_thread(), current_, g_screen_manager, get_player_status(), scripting::global_vm, load_state(), scripting::object_to_vm(), ScreenManager::push_screen(), and world_thread.

Referenced by TitleScreen::start_game().

{
  using namespace scripting;

  current_ = this;

  // create new squirrel table for persistent game state
  HSQUIRRELVM vm = scripting::global_vm;

  sq_pushroottable(vm);
  sq_pushstring(vm, "state", -1);
  sq_newtable(vm);
  if(SQ_FAILED(sq_createslot(vm, -3)))
    throw scripting::SquirrelError(vm, "Couldn't create state table");
  sq_pop(vm, 1);

  load_state();

  std::string filename = basedir + "/world.nut";
  try {
    IFileStream in(filename);

    sq_release(global_vm, &world_thread);
    world_thread = create_thread(global_vm);
    compile_and_run(object_to_vm(world_thread), in, filename);
  } catch(std::exception& ) {
    // fallback: try to load worldmap worldmap.stwm
    using namespace worldmap;
    g_screen_manager->push_screen(new WorldMap(basedir + "worldmap.stwm", get_player_status()));
  }
}

---

Member Data Documentation

World * World::current_ [static, private]

Definition at line 35 of file world.hpp.

Referenced by current(), run(), and ~World().

std::vector<std::string> World::levels [private]

Definition at line 59 of file world.hpp.

Referenced by get_level_filename(), get_num_levels(), and load().

std::string World::basedir [private]

Definition at line 60 of file world.hpp.

Referenced by get_basedir(), load(), and run().

std::string World::savegame_filename [private]

Definition at line 61 of file world.hpp.

Referenced by load_state(), save_state(), and set_savegame_filename().

HSQOBJECT World::state_table [private]

squirrel table that saves persistent state (about the world)

Definition at line 63 of file world.hpp.

HSQOBJECT World::world_thread [private]

Definition at line 64 of file world.hpp.

Referenced by run(), World(), and ~World().

std::string World::title [private]

Definition at line 65 of file world.hpp.

Referenced by get_title(), load(), and save_state().

std::string World::description [private]

Definition at line 66 of file world.hpp.

Referenced by load().

std::auto_ptr<PlayerStatus> World::player_status [private]

Definition at line 67 of file world.hpp.

Referenced by get_player_status(), load_state(), save_state(), and World().

bool World::hide_from_contribs

Definition at line 70 of file world.hpp.

Referenced by load(), and World().

bool World::is_levelset

Definition at line 71 of file world.hpp.

Referenced by ContribMenu::check_menu(), load(), and World().

---

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

• src/supertux/world.hpp
• src/supertux/world.cpp

---