Function Osiris_LoadGameModule

Descent3/OsirisLoadandBind.cpp:1154–1311

Osiris_LoadGameModule Purpose: Given a module name, it will attempt to load the module as a game 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 couldn'

//	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 game module. Returns -4 if no module slots are available.
int Osiris_LoadGameModule(char *module_name) {
  if (module_name[0] == '\0') {
    return -1;
  }

  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: Game 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_LoadGameModule(%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;
  }

  // the module exists, now attempt to load it
  if (!mod_LoadModule(&OSIRIS_loaded_modules[loaded_id].mod, fullpath)) {
    // there was an error trying to load the module
    mprintf(0, "OSIRIS: Osiris_LoadGameModule(%s): Unable to load module\n", module_name);
    Int3();