Function Osiris_LoadLevelModule

Descent3/OsirisLoadandBind.cpp:953–1145

Osiris_LoadLevelModule Purpose: Given a module name, it will attempt to load the module as a level module. If it succeeds it will return the id of the module where it has been loaded. If the module was already loaded before calling this function, it will return the id to where the module is, and will not reload the module. Returns -1 if the module does not exist. Returns -2 if the module could

//	the module.  Returns -1 if the module does not exist.  Returns -2 if the module couldn't initialize.
//	Returns -3 if the module is not a level module. Returns -4 if no module slots are available.
int Osiris_LoadLevelModule(char *module_name) {
  if ((Game_mode & GM_MULTI) && (Netgame.local_role != LR_SERVER)) {
    // no scripts for a client!
    return -2;
  }

  ASSERT(!tOSIRISCurrentLevel.level_loaded);
  if (tOSIRISCurrentLevel.level_loaded) {
    mprintf(0, "OSIRIS: Trying to load a level dll, when one has already been loaded\n");
    return tOSIRISCurrentLevel.dll_id;
  }

  int loaded_id;
  loaded_id = Osiris_FindLoadedModule(module_name);
  if (loaded_id != -1) {
    // the module is already loaded
    OSIRIS_loaded_modules[loaded_id].reference_count++;
    if (Show_osiris_debug) {
      mprintf(0, "OSIRIS: Level Module (%s) reference count increased to %d\n", module_name,
               OSIRIS_loaded_modules[loaded_id].reference_count);
    }
    return loaded_id;
  }

  // the module hasn't been loaded yet, find an available slot.
  for (loaded_id = 0; loaded_id < MAX_LOADED_MODULES; loaded_id++) {
    if (!(OSIRIS_loaded_modules[loaded_id].flags & OSIMF_INUSE)) {
      // we found a free slot
      break;
    }
  }

  if (loaded_id >= MAX_LOADED_MODULES) {
    // no slots available
    mprintf(0, "OSIRIS: Osiris_LoadLevelModule(%s): No available slots\n", module_name);
    Int3();
    return -4;
  }

  OSIRIS_loaded_modules[loaded_id].flags = 0; // set this to 0 as we fill in the data

  char fullpath[_MAX_PATH], basename[_MAX_PATH];
  int ret_val = _get_full_path_to_module(module_name, fullpath, basename);
  switch (ret_val) {
  case -2:
    // the module does not exist
    mprintf(0, "OSIRIS: Osiris_LoadLevelModule(%s): Module doesn't exist\n", module_name);
    return -1;
    break;
  case -1:
    // the module is in data\scripts
    break;
  default:
    // the module was an extracted file
    mprintf(0, "OSIRIS: Found module (%s) in a temp file\n", basename);
    OSIRIS_loaded_modules[loaded_id].flags |= OSIMF_INTEMPDIR;
    OSIRIS_loaded_modules[loaded_id].extracted_id = ret_val;
    break;