Sancaros/phantasmal-world
1
0
Fork 0
mirror of https://github.com/DaanVandenBosch/phantasmal-world.git synced 2025-04-04 22:58:29 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Sensible default values are now set for most object properties when creating a new object.

Browse Source
This commit is contained in:
Daan Vanden Bosch 2020-09-30 20:07:29 +02:00
parent 43161ae7e7
commit d5bc11dc4b
5 changed files with 1548 additions and 191 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

439
assets_generation/quest_stats.ts
View File

@ -1,16 +1,37 @@
import { walk_quests } from "./walk_quests";
import { RESOURCE_DIR } from "./index";
import { npc_data, NpcType } from "../src/core/data_formats/parsing/quest/npc_types";
import { get_npc_type, QuestNpc } from "../src/core/data_formats/parsing/quest/QuestNpc";
import { NpcType } from "../src/core/data_formats/parsing/quest/npc_types";
import { QuestNpc } from "../src/core/data_formats/parsing/quest/QuestNpc";
import { EntityProp, EntityPropType } from "../src/core/data_formats/parsing/quest/properties";
import { get_entity_prop_value, QuestEntity } from "../src/core/data_formats/parsing/quest/Quest";
import {
entity_data,
EntityType,
get_entity_prop_value,
get_entity_type,
is_npc_type,
Quest,
QuestEntity,
} from "../src/core/data_formats/parsing/quest/Quest";
import { ObjectType } from "../src/core/data_formats/parsing/quest/object_types";
import { QuestObject } from "../src/core/data_formats/parsing/quest/QuestObject";
const prop_cache = new Map<NpcType, EntityProp[]>();
const prop_cache = new Map<EntityType, EntityProp[]>();
print_quest_stats();
print_quest_entity_stats({ npcs: true, objects: true, print: "stats" });
function print_quest_stats(): void {
const type_data: Map<NpcType, { npc: QuestNpc; quest: string; count: number }[]> = new Map();
function print_quest_entity_stats(config: {
npcs?: boolean;
objects?: boolean;
print?: "stats" | "code";
}): void {
const npcs_by_type: Map<
NpcType,
{ entity: QuestNpc; quest: string; count: number }[]
> = new Map();
const objects_by_type: Map<
ObjectType,
{ entity: QuestObject; quest: string; count: number }[]
> = new Map();
walk_quests(
{
@ -18,188 +39,302 @@ function print_quest_stats(): void {
exclude: ["/battle", "/chl/ep1", "/chl/ep4", "/shop"],
},
({ quest }) => {
for (const npc of quest.npcs) {
const type = get_npc_type(npc);
const npcs = type_data.get(type);
if (config.npcs) {
process_entities(quest, quest.npcs, npcs_by_type);
}
if (npcs == undefined) {
type_data.set(type, [{ npc, quest: quest.name, count: 1 }]);
} else {
const found = npcs.find(({ npc: npc_2 }) => entities_equal(npc, npc_2, type));
if (found) {
found.count++;
} else {
npcs.push({ npc, quest: quest.name, count: 1 });
}
}
if (config.objects) {
process_entities(quest, quest.objects, objects_by_type);
}
},
);
for (const [type, npcs] of [...type_data.entries()].sort(
([a_type], [b_type]) => a_type - b_type,
)) {
if (config.npcs) {
if (config.print === "code") {
print_entity_code(npcs_by_type);
} else {
print_entity_property_stats(npcs_by_type);
}
}
if (config.objects) {
if (config.print === "code") {
print_entity_code(objects_by_type);
} else {
print_entity_property_stats(objects_by_type);
}
}
}
function print_entity_property_stats(
entities_by_type: Map<EntityType, { entity: QuestEntity; quest: string; count: number }[]>,
): void {
const sorted = [...entities_by_type.entries()].sort(([a_type], [b_type]) => a_type - b_type);
for (const [type, entities] of sorted) {
const props = get_properties(type);
/* eslint-disable no-console */
console.log(NpcType[type]);
console.log(ObjectType[type] ?? NpcType[type]);
console.log(" cnt " + props.map(col_print_name).join(" "));
for (const { npc, quest, count } of npcs.sort((a, b) => b.count - a.count).slice(0, 5)) {
const sorted = entities.sort((a, b) => b.count - a.count).slice(0, 5);
for (const { entity, quest, count } of sorted) {
console.log(
` ${count.toString().padStart(3, " ")} ` +
props.map(p => col_print_value(npc, p)).join(" ") +
props.map(p => col_print_value(entity, p)).join(" ") +
` ${quest}`,
);
}
/* eslint-enable no-console */
}
}
// Used to populate the switch in set_npc_default_data.
// Prints code of the following form (view is assumed to be a DataView).
//
// case NpcType.$NPC_TYPE:
// view.set$PROP_TYPE($OFFSET, $VALUE, true); // $PROP_NAME
// break;
//
// for (const [type, npcs] of [...type_data.entries()].sort(
// ([a_type], [b_type]) => a_type - b_type,
// )) {
// const { npc } = npcs.sort((a, b) => b.count - a.count)[0];
//
// const props = get_properties(type)
// .map(prop => {
// const value =
// prop.type === EntityPropType.Angle
// ? npc.view.getInt32(prop.offset, true)
// : get_entity_prop_value(npc, prop);
// return [prop, value] as const;
// })
// .filter(([, value]) => value !== 0);
//
// if (props.length === 0) continue;
//
// /* eslint-disable no-console */
// console.log(`case NpcType.${NpcType[type]}:`);
//
// for (const [prop, value] of props) {
// let prop_type: string;
//
// switch (prop.type) {
// case EntityPropType.U8:
// prop_type = "Uint8";
// break;
// case EntityPropType.U16:
// prop_type = "Uint16";
// break;
// case EntityPropType.U32:
// prop_type = "Uint32";
// break;
// case EntityPropType.I8:
// prop_type = "Int8";
// break;
// case EntityPropType.I16:
// prop_type = "Int16";
// break;
// case EntityPropType.I32:
// prop_type = "Int32";
// break;
// case EntityPropType.F32:
// prop_type = "Float32";
// break;
// case EntityPropType.Angle:
// prop_type = "Int32";
// break;
// default:
// throw new Error(`EntityPropType.${EntityPropType[prop.type]} not supported.`);
// }
//
// const offset = prop.offset;
// const comment = prop.name === "Unknown" ? "" : ` // ${prop.name}`;
//
// console.log(` view.set${prop_type}(${offset}, ${value}, true);${comment}`);
// }
//
// console.log(" break;");
// /* eslint-enable no-console */
// }
/**
* Used to populate the switch in set_npc_default_data or set_object_default_data.
* Prints code of the following form (view is assumed to be a DataView).
*
* ```ts
* case EntityType.$ENTITY_TYPE:
* view.set$PROP_TYPE($OFFSET, $VALUE, true); // $PROP_NAME
* break;
* ```
*/
function print_entity_code(
entities_by_type: Map<EntityType, { entity: QuestEntity; quest: string; count: number }[]>,
): void {
for (const [type, entities] of [...entities_by_type.entries()].sort(
([a_type], [b_type]) => a_type - b_type,
)) {
const is_npc = is_npc_type(type);
const { entity } = entities.sort((a, b) => b.count - a.count)[0];
const props = get_properties(type)
.map(prop => {
const value =
prop.type === EntityPropType.Angle
? entity.view.getInt32(prop.offset, true)
: get_entity_prop_value(entity, prop);
return [prop, value] as const;
})
.filter(([prop, value]) => {
if (!is_npc && prop.offset >= 40 && prop.offset < 52) {
return value !== 1;
} else {
return value !== 0;
}
});
if (props.length === 0) continue;
/* eslint-disable no-console */
if (is_npc) {
console.log(`case NpcType.${NpcType[type]}:`);
} else {
console.log(`case ObjectType.${ObjectType[type]}:`);
}
for (const [prop, value] of props) {
let prop_type: string;
switch (prop.type) {
case EntityPropType.U8:
prop_type = "Uint8";
break;
case EntityPropType.U16:
prop_type = "Uint16";
break;
case EntityPropType.U32:
prop_type = "Uint32";
break;
case EntityPropType.I8:
prop_type = "Int8";
break;
case EntityPropType.I16:
prop_type = "Int16";
break;
case EntityPropType.I32:
prop_type = "Int32";
break;
case EntityPropType.F32:
prop_type = "Float32";
break;
case EntityPropType.Angle:
prop_type = "Int32";
break;
default:
throw new Error(`EntityPropType.${EntityPropType[prop.type]} not supported.`);
}
const offset = prop.offset;
const comment = prop.name === "Unknown" ? "" : ` // ${prop.name}`;
console.log(` view.set${prop_type}(${offset}, ${value}, true);${comment}`);
}
console.log(" break;");
/* eslint-enable no-console */
}
}
function process_entities(
quest: Quest,
entities: readonly QuestEntity[],
entities_by_type: Map<EntityType, { entity: QuestEntity; quest: string; count: number }[]>,
): void {
for (const entity of entities) {
const type = get_entity_type(entity);
const existing_entities = entities_by_type.get(type);
if (existing_entities == undefined) {
entities_by_type.set(type, [{ entity, quest: quest.name, count: 1 }]);
} else {
const found = existing_entities.find(({ entity: entity_2 }) =>
entities_equal(entity, entity_2, type),
);
if (found) {
found.count++;
} else {
existing_entities.push({ entity, quest: quest.name, count: 1 });
}
}
}
}
/**
* @returns the entity's properties enriched with many default properties.
*/
function get_properties(type: NpcType): EntityProp[] {
function get_properties(type: EntityType): EntityProp[] {
let props = prop_cache.get(type);
if (props) {
return props;
}
const data = npc_data(type);
if (is_npc_type(type)) {
props = [
{
name: "Unknown",
offset: 2,
type: EntityPropType.I16,
},
{
name: "Unknown",
offset: 4,
type: EntityPropType.I16,
},
{
name: "Clone count",
offset: 6,
type: EntityPropType.I16,
},
{
name: "Unknown",
offset: 8,
type: EntityPropType.I16,
},
{
name: "Unknown",
offset: 10,
type: EntityPropType.I16,
},
{
name: "Scale x",
offset: 44,
type: EntityPropType.F32,
},
{
name: "Scale y",
offset: 48,
type: EntityPropType.F32,
},
{
name: "Scale z",
offset: 52,
type: EntityPropType.F32,
},
{
name: "Unknown",
offset: 68,
type: EntityPropType.I16,
},
{
name: "Unknown",
offset: 70,
type: EntityPropType.I16,
},
];
} else {
props = [
{
name: "Unknown",
offset: 2,
type: EntityPropType.I16,
},
{
name: "Unknown",
offset: 4,
type: EntityPropType.I16,
},
{
name: "Unknown",
offset: 6,
type: EntityPropType.I16,
},
{
name: "Unknown",
offset: 14,
type: EntityPropType.I16,
},
{
name: "Scale x",
offset: 40,
type: EntityPropType.F32,
},
{
name: "Scale y",
offset: 44,
type: EntityPropType.F32,
},
{
name: "Scale z",
offset: 48,
type: EntityPropType.F32,
},
{
name: "Unknown",
offset: 56,
type: EntityPropType.I32,
},
{
name: "Unknown",
offset: 60,
type: EntityPropType.I32,
},
{
name: "Unknown",
offset: 64,
type: EntityPropType.I32,
},
];
}
props = [
{
name: "Unknown",
offset: 2,
type: EntityPropType.I16,
},
{
name: "Unknown",
offset: 4,
type: EntityPropType.I16,
},
{
name: "Clone count",
offset: 6,
type: EntityPropType.I16,
},
{
name: "Unknown",
offset: 8,
type: EntityPropType.I16,
},
{
name: "Unknown",
offset: 10,
type: EntityPropType.I16,
},
{
name: "Scale x",
offset: 44,
type: EntityPropType.F32,
},
{
name: "Scale z",
offset: 52,
type: EntityPropType.F32,
},
{
name: "Unknown",
offset: 68,
type: EntityPropType.I16,
},
{
name: "Unknown",
offset: 70,
type: EntityPropType.I16,
},
];
outer: for (const npc_prop of data.properties) {
outer: for (const entity_prop of entity_data(type).properties) {
for (let i = 0; i < props.length; i++) {
const prop = props[i];
if (npc_prop.offset === prop.offset) {
props.splice(i, 1, npc_prop);
if (entity_prop.offset === prop.offset) {
props.splice(i, 1, entity_prop);
continue outer;
} else if (npc_prop.offset < prop.offset) {
props.splice(i, 0, npc_prop);
} else if (entity_prop.offset < prop.offset) {
props.splice(i, 0, entity_prop);
continue outer;
}
}
props.push(npc_prop);
props.push(entity_prop);
}
return props;
@ -242,7 +377,7 @@ function col_width(prop: EntityProp): number {
}
}
function entities_equal(a: QuestEntity, b: QuestEntity, type: NpcType): boolean {
function entities_equal(a: QuestEntity, b: QuestEntity, type: EntityType): boolean {
for (const prop of get_properties(type)) {
if (get_entity_prop_value(a, prop) !== get_entity_prop_value(b, prop)) {
return false;

3
src/core/data_formats/parsing/quest/QuestObject.ts
View File

@ -3,6 +3,7 @@ import { Vec3 } from "../../vector";
import { OBJECT_BYTE_SIZE } from "./dat";
import { assert } from "../../../util";
import { angle_to_rad, rad_to_angle } from "../ninja/angle";
import { set_object_default_data } from "./set_object_default_data";
export type QuestObject = {
area_id: number;
@ -18,6 +19,8 @@ export function create_quest_object(type: ObjectType, area_id: number): QuestObj
view: new DataView(data),
};
set_object_default_data(type, obj.view);
set_object_type(obj, type);
return obj;

68
src/core/data_formats/parsing/quest/object_types.ts
View File

@ -214,15 +214,15 @@ export enum ObjectType {
FourButtonSpaceshipDoor,
ItemBoxCca,
TeleporterEp2,
CCADoor,
SpecialBoxCCA,
BigCCADoor,
BigCCADoorSwitch,
CcaDoor,
SpecialBoxCca,
BigCcaDoor,
BigCcaDoorSwitch,
LittleRock,
Little3StoneWall,
Medium3StoneWall,
SpiderPlant,
CCAAreaTeleporter,
CcaAreaTeleporter,
UnknownItem523,
WhiteBird,
OrangeBird,
@ -731,13 +731,13 @@ export function id_to_object_type(id: number): ObjectType {
case 513:
return ObjectType.TeleporterEp2;
case 514:
return ObjectType.CCADoor;
return ObjectType.CcaDoor;
case 515:
return ObjectType.SpecialBoxCCA;
return ObjectType.SpecialBoxCca;
case 516:
return ObjectType.BigCCADoor;
return ObjectType.BigCcaDoor;
case 517:
return ObjectType.BigCCADoorSwitch;
return ObjectType.BigCcaDoorSwitch;
case 518:
return ObjectType.LittleRock;
case 519:
@ -747,7 +747,7 @@ export function id_to_object_type(id: number): ObjectType {
case 521:
return ObjectType.SpiderPlant;
case 522:
return ObjectType.CCAAreaTeleporter;
return ObjectType.CcaAreaTeleporter;
case 523:
return ObjectType.UnknownItem523;
case 524:
@ -2815,21 +2815,21 @@ define_object_type_data(
define_object_type_data(
ObjectType.FourSwitchTempleDoor,
427,
"4 switch temple door",
"4 Switch Temple Door",
[[Episode.II, [1, 2]]],
[],
);
define_object_type_data(
ObjectType.FourButtonSpaceshipDoor,
448,
"4 button spaceship door",
"4 button Spaceship Door",
[[Episode.II, [3, 4]]],
[],
);
define_object_type_data(
ObjectType.ItemBoxCca,
512,
"item box cca",
"Item Box CCA",
[
[Episode.II, [5, 6, 7, 8, 9, 12, 16, 17]],
[Episode.IV, [5]],
@ -2839,12 +2839,12 @@ define_object_type_data(
define_object_type_data(
ObjectType.TeleporterEp2,
513,
"Teleporter (Ep 2)",
"Teleporter (Ep. II)",
[[Episode.II, [5, 6, 7, 8, 9, 10, 11, 12, 13, 16, 17]]],
[],
);
define_object_type_data(
ObjectType.CCADoor,
ObjectType.CcaDoor,
514,
"CCA Door",
[[Episode.II, [5, 6, 7, 8, 9, 16, 17]]],
@ -2858,7 +2858,7 @@ define_object_type_data(
],
);
define_object_type_data(
ObjectType.SpecialBoxCCA,
ObjectType.SpecialBoxCca,
515,
"Special Box CCA",
[
@ -2867,9 +2867,9 @@ define_object_type_data(
],
[],
);
define_object_type_data(ObjectType.BigCCADoor, 516, "Big CCA Door", [[Episode.II, [5]]], []);
define_object_type_data(ObjectType.BigCcaDoor, 516, "Big CCA Door", [[Episode.II, [5]]], []);
define_object_type_data(
ObjectType.BigCCADoorSwitch,
ObjectType.BigCcaDoorSwitch,
517,
"Big CCA Door Switch",
[[Episode.II, [5, 6, 7, 8, 9, 16, 17]]],
@ -2904,7 +2904,7 @@ define_object_type_data(
[],
);
define_object_type_data(
ObjectType.CCAAreaTeleporter,
ObjectType.CcaAreaTeleporter,
522,
"CCA Area Teleporter",
[[Episode.II, [5, 6, 7, 8, 9, 16, 17]]],
@ -2998,7 +2998,7 @@ define_object_type_data(
define_object_type_data(
ObjectType.SeabedDoorWithBlueEdges,
545,
"Seabed Door (with blue edges)",
"Seabed Door (with Blue Edges)",
[[Episode.II, [10, 11]]],
[
["Scale x", 40, "F32"],
@ -3012,7 +3012,7 @@ define_object_type_data(
define_object_type_data(
ObjectType.SeabedDoorAlwaysOpenNonTriggerable,
546,
"Seabed door (always open, non-triggerable)",
"Seabed Door (Always Open, Non-Triggerable)",
[[Episode.II, [10, 11]]],
[],
);
@ -3026,21 +3026,21 @@ define_object_type_data(
define_object_type_data(
ObjectType.WideGlassWallBreakable,
548,
"Wide Glass Wall (breakable)",
"Wide Glass Wall (Breakable)",
[[Episode.II, [10, 11]]],
[],
);
define_object_type_data(
ObjectType.BlueFloatingRobot,
549,
"Blue floating robot",
"Blue Floating Robot",
[[Episode.II, [10, 11]]],
[],
);
define_object_type_data(
ObjectType.RedFloatingRobot,
550,
"Red floating robot",
"Red Floating Robot",
[[Episode.II, [10, 11]]],
[],
);
@ -3055,7 +3055,7 @@ define_object_type_data(
define_object_type_data(
ObjectType.VRLink,
553,
"VR link",
"VR Link",
[[Episode.II, [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17]]],
[],
);
@ -3115,23 +3115,23 @@ define_object_type_data(
define_object_type_data(
ObjectType.OrangeWallWithHoleInMiddle,
692,
"orange wall with hole in middle",
"Orange Wall with Hole in Middle",
[[Episode.II, [0]]],
[],
);
define_object_type_data(
ObjectType.GreyWallWithHoleInMiddle,
693,
"grey wall with hole in middle",
"Grey Wall with Hole in Middle",
[[Episode.II, [0]]],
[],
);
define_object_type_data(ObjectType.LongTable, 694, "long table", [[Episode.II, [0]]], []);
define_object_type_data(ObjectType.LongTable, 694, "Long Table", [[Episode.II, [0]]], []);
define_object_type_data(ObjectType.GBAStation, 695, "GBA Station", [], []);
define_object_type_data(
ObjectType.TalkLinkToSupport,
696,
"Talk (link to support)",
"Talk (Link to Support)",
[
[Episode.I, [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14]],
[Episode.II, [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17]],
@ -3142,7 +3142,7 @@ define_object_type_data(
define_object_type_data(
ObjectType.InstaWarp,
697,
"insta-warp",
"Insta-Warp",
[
[Episode.I, [0, 1, 2, 3, 4, 5, 6, 7, 11, 12, 13, 14, 16, 17]],
[Episode.II, [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 16, 17]],
@ -3164,7 +3164,7 @@ define_object_type_data(
define_object_type_data(
ObjectType.LabGlassWindowDoor,
699,
"Lab Glass window Door",
"Lab Glass Window Door",
[[Episode.II, [0]]],
[],
);
@ -3185,7 +3185,7 @@ define_object_type_data(
define_object_type_data(
ObjectType.Ep4LightSource,
768,
"Ep4 Light Source",
"Ep. IV Light Source",
[[Episode.IV, [1, 2, 3, 4, 5, 6, 7, 8, 9]]],
[],
);
@ -3273,7 +3273,7 @@ define_object_type_data(ObjectType.FallingRock, 907, "Falling Rock", [[Episode.I
define_object_type_data(
ObjectType.DesertPlantHasCollision,
908,
"Desert Plant (has collision)",
"Desert Plant (Has Collision)",
[[Episode.IV, [6, 7, 8]]],
[],
);
@ -3312,7 +3312,7 @@ define_object_type_data(
define_object_type_data(
ObjectType.TopOfSaintMillionEgg,
960,
"Top of saint million egg",
"Top of Saint Million Egg",
[[Episode.IV, [9]]],
[],
);

1219
src/core/data_formats/parsing/quest/set_object_default_data.ts Normal file
View File

File diff suppressed because it is too large Load Diff

10
src/quest_editor/loading/EntityAssetLoader.ts
View File

@ -186,7 +186,7 @@ export class EntityAssetLoader implements Disposable {
ObjectType.FloatingSoul,
ObjectType.Butterfly,
ObjectType.UnknownItem400,
ObjectType.CCAAreaTeleporter,
ObjectType.CcaAreaTeleporter,
ObjectType.UnknownItem523,
ObjectType.WhiteBird,
ObjectType.OrangeBird,
@ -303,13 +303,13 @@ function geometry_parts(type: EntityType): (string | undefined)[] {
return ["", "-3"]; // What are the other two parts for?
case ObjectType.TeleporterEp2:
return ["", "-2"];
case ObjectType.CCADoor:
case ObjectType.CcaDoor:
return ["", "-2"];
case ObjectType.SpecialBoxCCA:
case ObjectType.SpecialBoxCca:
return ["", "-4"]; // What are the other two parts for?
case ObjectType.BigCCADoor:
case ObjectType.BigCcaDoor:
return ["", "-2", "-3", "-4"];
case ObjectType.BigCCADoorSwitch:
case ObjectType.BigCcaDoorSwitch:
return ["", "-2"];
case ObjectType.LaserDetect:
return ["", "-2"]; // TODO: use correct part.