Descent3/manage/doorpage.h

/*
* Descent 3 
* Copyright (C) 2024 Parallax Software
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

#ifndef DOORPAGE_H
#define DOORPAGE_H

#include "manage.h"
#include "door.h"
#include "cfile.h"
#include "pstypes.h"

struct mngs_door_page {
  door door_struct;
  char image_name[PAGENAME_LEN];
  char open_sound_name[PAGENAME_LEN];
  char close_sound_name[PAGENAME_LEN];
};

// Door page functions
//---------------------------------------------------------------

// Given an open file pointer and a door_page struct, writes that doorpage out
void mng_WriteDoorPage(CFILE *outfile, mngs_door_page *doorpage);

// Reads a door page from an open file.  Returns 0 on error.
int mng_ReadDoorPage(CFILE *infile, mngs_door_page *doorpage);

// Given an open file pointer and a door_page struct, writes that doorpage out
void mng_WriteNewDoorPage(CFILE *outfile, mngs_door_page *doorpage);

// Reads a door page from an open file.  Returns 0 on error.
int mng_ReadNewDoorPage(CFILE *infile, mngs_door_page *doorpage);

// Reads in the doorpage named "name" into doorpage struct
// Returns 0 on error or couldn't find, else 1 if all is good
int mng_FindSpecificDoorPage(char *name, mngs_door_page *doorpage, int offset = 0);

// Given a door page, allocs a door and calls AssignDoorPageToDoor to actually
// load model and values. Returns door handle on success, -1 if fail
int mng_SetAndLoadDoor(mngs_door_page *doorpage);

// Given a doorpage and a door handle, attempts to make door n correspond to
// to the doorpage.
// Returns 1 on success, 0 otherwise
int mng_AssignDoorPageToDoor(mngs_door_page *doorpage, int n);

// Copies values from a Door into a door_page
void mng_AssignDoorToDoorPage(int n, mngs_door_page *doorpage);

// Reads in a door page from the local table file, superseding any door
// already in RAM with that same name
void mng_LoadLocalDoorPage(CFILE *);

// Reads in a page off the net
void mng_LoadNetDoorPage(CFILE *, bool overlay = false);

#endif