/*
* UFO Saved Game Editor
* Copyright (C) 2010 Christopher Davoren
*
* 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/>.
*/
package net.rubikscomplex.ufosge.data;
import java.io.EOFException;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Iterator;
import net.rubikscomplex.ufosge.util.UFOInputStream;
import net.rubikscomplex.ufosge.util.UFOOutputStream;
/**
* Represents an entry in the UFOpaedia.
*
* @author Chris Davoren
*/
public class UPItem {
public static final byte RESEARCH_NOT_YET = 0;
public static final byte RESEARCH_DONE = 2;
public static final byte RESEARCH_ALWAYS = 3;
public static final int UNKNOWN2_SIZE = 2;
public static final int UNKNOWN3_SIZE = 3;
public static final String[] ARTICLE_CATEGORIES = {
"Craft and Armament",
"Heavy Weapons Platform",
"Weapons and Equipment",
"Alien Artifacts",
"Base Facilities",
"Alien Life Forms",
"Alien Research",
"UFO Components",
"UFOs"
};
public static final String[][] ARTICLE_NAMES = {
{
"Skyranger",
"Lightning",
"Avenger",
"Interceptor",
"Firestorm",
"Stingray Launcher",
"Avalanche Launcher",
"Cannon",
"Fusion Ball Launcher",
"Laser Cannon",
"Plasma Beam"
},
{
"Tank/Cannon",
"Tank/Rocket Launcher",
"Tank/Laser Cannon",
"Hovertank/Plasma",
"Hovertank/Launcher",
},
{
"Personal Armour",
"Power Suit",
"Flying Suit",
"Pistol",
"Rifle",
"Heavy Cannon",
"Auto-Cannon",
"Rocket Launcher",
"Laser Pistol",
"Laser Rifle",
"Heavy Laser",
"Grenade",
"Smoke Grenade",
"Proximity Grenade",
"High Explosive",
"Motion Scanner",
"Medi-kit",
"Psi-Amp",
"Stun Rod",
"Electro-flare",
},
{
"Heavy Plasma",
"Heavy Plasma Clip",
"Plasma Rifle",
"Plasma Rifle Clip",
"Plasma Pistol",
"Plasma Pistol Clip",
"Blaster Launcher",
"Blaster Bomb",
"Small Launcher",
"Stun Bomb",
"Alien Grenade",
"Elerium-115",
"Mind Probe",
"Access Lift",
},
{
"Access Lift",
"Living Quarters",
"Laboratory",
"Workshop",
"Small Radar System",
"Large Radar System",
"Missile Defense",
"General Stores",
"Alien Containment",
"Laser Defense",
"Plasma Defense",
"Fusion Ball Defense",
"Grav Shield",
"Mind Shield",
"Psionic Laboratory",
"Hyper-wave Decoder",
"Hangar",
},
{
"Sectoid",
"Sectoid Corpse",
"Snakeman",
"Snakeman Corpse",
"Ethereal",
"Ethereal Corpse",
"Muton",
"Muton Corpse",
"Floater",
"Floater Corpse",
"Celatid",
"Celatid Corpse",
"Silacoid",
"Silacoid Corpse",
"Chryssalid",
"Chryssalid Corpse",
"Reaper",
"Reaper Corpse",
"Sectopod",
"Sectopod Corpse",
"Cyberdisc",
"Cyberdisc Corpse",
},
{
"Alien Origins",
"Martian Solution",
"Cydonia or Bust",
"Alien Research",
"Alien Harvest",
"Alien Abduction",
"Alien Infiltration",
"Alien Base",
"Alien Terror",
"Alien Retailiation",
"Alien Supply",
},
{
"UFO Power Source",
"UFO Navigation",
"UFO Construction",
"Alien Food",
"Alien Reproduction",
"Alien Entertainment",
"Alien Surgery",
"Examination Room",
"Alien Alloys",
},
{
"Small Scout",
"Medium Scout",
"Large Scout",
"Harvester",
"Abductor",
"Terror Ship",
"Battleship",
"Supply Ship"
},
};
public int index;
public byte category;
public byte unknown1;
public byte nameIndex;
public byte[] unknown2;
public byte SPKFile;
public short nameOffset;
public byte researchFlag;
public byte[] unknown3;
protected UPItem() {
}
public UPItem(UPItem other) {
copy(other);
}
public void copy(UPItem other) {
this.index = other.index;
this.category = other.category;
this.unknown1 = other.unknown1;
this.nameIndex = other.nameIndex;
this.unknown2 = new byte[UNKNOWN2_SIZE];
System.arraycopy(other.unknown2, 0, this.unknown2, 0, UNKNOWN2_SIZE);
this.SPKFile = other.SPKFile;
this.nameOffset = other.nameOffset;
this.researchFlag = other.researchFlag;
this.unknown3 = new byte[UNKNOWN3_SIZE];
System.arraycopy(other.unknown3, 0, this.unknown3, 0, UNKNOWN3_SIZE);
}
public boolean readFromFile(UFOInputStream in) throws IOException {
try {
category = in.readByte();
unknown1 = in.readByte();
nameIndex = in.readByte();
unknown2 = new byte[UNKNOWN2_SIZE];
in.read(unknown2);
SPKFile = in.readByte();
nameOffset = in.readUFOShort();
researchFlag = in.readByte();
unknown3 = new byte[UNKNOWN3_SIZE];
in.read(unknown3);
return true;
}
catch(EOFException e) {
return false;
}
}
public void writeToFile(UFOOutputStream out) throws IOException {
out.writeByte(category);
out.writeByte(unknown1);
out.writeByte(nameIndex);
out.write(unknown2);
out.writeByte(SPKFile);
out.writeUFOShort(nameOffset);
out.writeByte(researchFlag);
out.write(unknown3);
}
public static ArrayList<UPItem> readList(UFOInputStream in) throws IOException {
ArrayList<UPItem> list = new ArrayList<UPItem>();
int index = 0;
while(true) {
UPItem upi = new UPItem();
if (upi.readFromFile(in)) {
upi.index = index++;
list.add(upi);
}
else {
break;
}
}
return list;
}
public static void writeList(UFOOutputStream out, ArrayList<UPItem> list) throws IOException {
Iterator<UPItem> upi = list.iterator();
while(upi.hasNext()) {
upi.next().writeToFile(out);
}
}
public static String researchFlagToString(int researchFlag) {
switch(researchFlag) {
case RESEARCH_DONE: return "Available";
case RESEARCH_ALWAYS: return "Always Available";
case RESEARCH_NOT_YET: return "Unavailable";
default: return "Unknown";
}
}
public static byte stringToResearchFlag(String str) {
if (str.equals("Available")) {
return RESEARCH_DONE;
}
else if (str.equals("Always Available")) {
return RESEARCH_ALWAYS;
}
else if (str.equals("Unavailable")) {
return RESEARCH_NOT_YET;
}
else {
return RESEARCH_ALWAYS;
}
}
public static String[] getResearchFlagNames() {
String[] researchFlags = new String[3];
researchFlags[0] = researchFlagToString(RESEARCH_NOT_YET);
researchFlags[1] = researchFlagToString(RESEARCH_ALWAYS);
researchFlags[2] = researchFlagToString(RESEARCH_DONE);
return researchFlags;
}
public String getName() {
if (nameIndex >= 100) {
return ARTICLE_NAMES[category][nameIndex - 100];
}
else if(category == 0x02) {
if (nameIndex >= 16) {
return ARTICLE_NAMES[category][nameIndex - 8];
}
else {
switch(nameIndex) {
case 0x00: return ARTICLE_NAMES[category][3];
case 0x02: return ARTICLE_NAMES[category][4];
case 0x04: return ARTICLE_NAMES[category][5];
case 0x08: return ARTICLE_NAMES[category][6];
default: return ARTICLE_NAMES[category][7];
}
}
}
else if (category == 0x06) {
return ARTICLE_NAMES[category][nameIndex + 3];
}
else if (category == 0x03) {
return ARTICLE_NAMES[category][nameIndex - 34];
}
else {
return ARTICLE_NAMES[category][nameIndex];
}
}
}