private static void AddMobSpawn(SpawnMetadata mobSpawnDataBox, MapEntityMetadata metadata, IMS2RegionBoxSpawn boxSpawn)
{
int mobNpcCountBox = mobSpawnDataBox?.Population ?? 6;
int mobSpawnRadiusBox = 150;
// TODO: This previously relied in "NpcList" to be set. NpcList is impossible to be set on
// MS2RegionSpawn, it's only set for SpawnPointNPC.
List <int> mobNpcListBox = new()
{
21000025 // Placeholder
};
metadata.MobSpawns.Add(new(boxSpawn.SpawnPointID, CoordS.FromVector3(boxSpawn.Position),
mobNpcCountBox, mobNpcListBox, mobSpawnRadiusBox, mobSpawnDataBox));
// "QR_10000264_" is Quest Reward Chest? This is tied to a MS2TriggerAgent making this object appear.
}
private static void BuildWaypoints(List <IMS2PatrolData> tempPatrolData, List <IMS2WayPoint> tempWaypoints, MapEntityMetadata mapEntity)
{
foreach (IMS2PatrolData patrolData in tempPatrolData)
{
List <string> wayPointIds = patrolData.WayPoints.Select(entry => entry.Value.Replace("-", string.Empty)).ToList();
List <string> approachAnimations = patrolData.ApproachAnims.Select(entry => entry.Value).ToList();
List <string> arriveAnimations = patrolData.ArriveAnims.Select(entry => entry.Value).ToList();
List <int> arriveAnimationTimes = patrolData.ArriveAnimsTime.Select(entry => (int)entry.Value).ToList();
List <WayPoint> wayPoints = new();
for (int i = 0; i < wayPointIds.Count; i++)
{
string wayPointId = wayPointIds.ElementAtOrDefault(i);
string approachAnimation = approachAnimations.ElementAtOrDefault(i);
string arriveAnimation = arriveAnimations.ElementAtOrDefault(i);
int arriveAnimationTime = arriveAnimationTimes.ElementAtOrDefault(i);
IMS2WayPoint waypoint = tempWaypoints.FirstOrDefault(x => x.EntityId == wayPointId);
if (waypoint is null)
{
continue;
}
wayPoints.Add(new(wayPointId, waypoint.IsVisible,
CoordS.FromVector3(waypoint.Position),
CoordS.FromVector3(waypoint.Rotation),
approachAnimation,
arriveAnimation,
arriveAnimationTime));
}
mapEntity.PatrolDatas.Add(new(patrolData.EntityId,
patrolData.EntityName,
patrolData.IsAirWayPoint,
(int)patrolData.PatrolSpeed,
patrolData.IsLoop,
wayPoints));
}
}
private void BuildMetadata(string xblock, IEnumerable <IMapEntity> mapEntities)
{
if (xblock.EndsWith("_cn") || xblock.EndsWith("_jp") || xblock.EndsWith("_kr"))
{
return;
}
Match isParsableField = Regex.Match(xblock, @"^(\d{8})");
if (!isParsableField.Success)
{
// TODO: Handle these later, if we need them. They're xblock files with some other names like
// character_test.xblock, login.xblock,
return;
}
string mapId = isParsableField.Groups[1].Value;
if (Maps.ContainsKey(mapId))
{
return;
}
Maps.Add(mapId, xblock); // Only used to check if we've visited this node before.
// TODO: metadata should be keyed on xblock name, not mapId
MapEntityMetadata metadata = new(int.Parse(mapId));
foreach (IMapEntity entity in mapEntities)
{
switch (entity)
{
case IMS2Bounding bounding:
if (bounding.EntityName.EndsWith("0") && metadata.BoundingBox0.Equals(CoordS.From(0, 0, 0)))
{
metadata.BoundingBox0 = CoordS.FromVector3(bounding.Position);
}
else if (bounding.EntityName.EndsWith("1") && metadata.BoundingBox1.Equals(CoordS.From(0, 0, 0)))
{
metadata.BoundingBox1 = CoordS.FromVector3(bounding.Position);
}
break;
case IMS2PatrolData patrolData:
string patrolDataName = patrolData.EntityName.Replace("-", string.Empty);
List <string> wayPointIds = new();
foreach (KeyValuePair <string, string> entry in patrolData.WayPoints)
{
string wayPointId = entry.Value.Replace("-", string.Empty);
wayPointIds.Add(wayPointId);
}
List <string> arriveAnimations = new();
foreach (KeyValuePair <string, string> entry in patrolData.ArriveAnims)
{
arriveAnimations.Add(entry.Value);
}
List <string> approachAnimations = new();
foreach (KeyValuePair <string, string> entry in patrolData.ApproachAnims)
{
approachAnimations.Add(entry.Value);
}
List <int> arriveAnimationTimes = new();
foreach (KeyValuePair <string, uint> entry in patrolData.ArriveAnimsTime)
{
arriveAnimationTimes.Add((int)entry.Value);
}
metadata.PatrolDatas.Add(new(patrolDataName, wayPointIds, (int)patrolData.PatrolSpeed, patrolData.IsLoop, patrolData.IsAirWayPoint,
arriveAnimations, approachAnimations, arriveAnimationTimes));
break;
case IMS2WayPoint wayPoint:
metadata.WayPoints.Add(new(wayPoint.EntityId, wayPoint.IsVisible, CoordS.FromVector3(wayPoint.Position),
CoordS.FromVector3(wayPoint.Rotation)));
break;
// TODO: This can probably be more generally handled as IMS2RegionSkill
case IMS2HealingRegionSkillSound healingRegion:
if (healingRegion.Position == default)
{
continue;
}
metadata.HealingSpot.Add(CoordS.FromVector3(healingRegion.Position));
break;
case IMS2InteractObject interact:
InteractObjectType type = GetInteractObjectType(interact.interactID);
if (type == InteractObjectType.None)
{
continue;
}
switch (interact)
{
case IMS2SimpleUiObject uiObject:
metadata.InteractObjects.Add(new(uiObject.EntityId, uiObject.interactID, uiObject.Enabled, type));
break;
case IMS2InteractMesh interactMesh:
metadata.InteractObjects.Add(new(interactMesh.EntityId, interactMesh.interactID, interactMesh.IsVisible, type));
break;
case IMS2Telescope telescope:
metadata.InteractObjects.Add(new(telescope.EntityId, telescope.interactID, telescope.Enabled, type));
break;
case IMS2InteractActor interactActor:
metadata.InteractObjects.Add(new(interactActor.EntityId, interactActor.interactID, interactActor.IsVisible, type));
break;
case IMS2InteractDisplay interactDisplay:
metadata.InteractObjects.Add(new(interactDisplay.EntityId, interactDisplay.interactID, interactDisplay.IsVisible, type));
break;
}
break;
case ISpawnPoint spawn:
switch (spawn)
{
// TODO: Parse "value" from NPCList.
case IEventSpawnPointNPC eventSpawnNpc: // trigger mob/npc spawns
List <string> npcIds = new();
npcIds.AddRange(eventSpawnNpc.NpcList.Keys);
metadata.EventNpcSpawnPoints.Add(new(eventSpawnNpc.SpawnPointID, eventSpawnNpc.NpcCount, npcIds, eventSpawnNpc.SpawnAnimation,
eventSpawnNpc.SpawnRadius,
CoordF.FromVector3(eventSpawnNpc.Position), CoordF.FromVector3(eventSpawnNpc.Rotation)));
break;
case ISpawnPointPC pcSpawn:
metadata.PlayerSpawns.Add(
new(CoordS.FromVector3(pcSpawn.Position), CoordS.FromVector3(pcSpawn.Rotation)));
break;
case ISpawnPointNPC npcSpawn:
// These tend to be vendors, shops, etc.
// If the name tag begins with SpawnPointNPC, I think these are mob spawn locations. Skipping these.
string npcIdStr = npcSpawn.NpcList.FirstOrDefault().Key ?? "0";
if (npcIdStr == "0" || !int.TryParse(npcIdStr, out int npcId))
{
continue;
}
MapNpc npc = new(npcId, npcSpawn.ModelName, npcSpawn.EntityName, CoordS.FromVector3(npcSpawn.Position),
CoordS.FromVector3(npcSpawn.Rotation), npcSpawn.IsSpawnOnFieldCreate, npcSpawn.dayDie, npcSpawn.nightDie);
// Parse some additional flat supplemented data about this NPC.
metadata.Npcs.Add(npc);
break;
}
break;
case IMS2RegionSpawnBase spawnBase:
switch (spawnBase)
{
case IMS2RegionBoxSpawn boxSpawn:
SpawnMetadata mobSpawnDataBox = SpawnTagMap.ContainsKey(mapId) && SpawnTagMap[mapId].ContainsKey(boxSpawn.SpawnPointID)
? SpawnTagMap[mapId][boxSpawn.SpawnPointID]
: null;
if (boxSpawn.ModelName.Contains("chest", StringComparison.CurrentCultureIgnoreCase))
{
metadata.MapChests.Add(new()
{
IsGolden = boxSpawn.ModelName.Contains("rare", StringComparison.CurrentCultureIgnoreCase),
Position = CoordF.FromVector3(boxSpawn.Position),
Rotation = CoordF.FromVector3(boxSpawn.Rotation),
});
continue;
}
AddMobSpawn(mobSpawnDataBox, metadata, boxSpawn);
break;
case IMS2RegionSpawn regionSpawn:
SpawnMetadata mobSpawnData = SpawnTagMap.ContainsKey(mapId) && SpawnTagMap[mapId].ContainsKey(regionSpawn.SpawnPointID)
? SpawnTagMap[mapId][regionSpawn.SpawnPointID]
: null;
int mobNpcCount = mobSpawnData?.Population ?? 6;
// TODO: This previously relied in "NpcList" to be set. NpcList is impossible to be set on
// MS2RegionSpawn, it's only set for SpawnPointNPC.
List <int> mobNpcList = new()
{
21000025 // Placeholder
};
metadata.MobSpawns.Add(new(regionSpawn.SpawnPointID, CoordS.FromVector3(regionSpawn.Position),
mobNpcCount, mobNpcList, (int)regionSpawn.SpawnRadius, mobSpawnData));
break;
}
break;
case IPortal portal:
metadata.Portals.Add(new(portal.PortalID, portal.ModelName, portal.PortalEnable, portal.IsVisible, portal.MinimapIconVisible,
portal.TargetFieldSN,
CoordS.FromVector3(portal.Position), CoordS.FromVector3(portal.Rotation), portal.TargetPortalID, (PortalTypes)portal.PortalType));
break;
case IMS2Breakable breakable:
switch (breakable)
{
case IMS2BreakableActor actor:
metadata.BreakableActors.Add(new(actor.EntityId, actor.Enabled, actor.hideTimer, actor.resetTimer));
break;
case IMS2BreakableNIF nif:
metadata.BreakableNifs.Add(new(nif.EntityId, nif.Enabled, (int)nif.TriggerBreakableID, nif.hideTimer, nif.resetTimer));
break;
}
break;
case IMS2TriggerObject triggerObject:
switch (triggerObject)
{
case IMS2TriggerMesh triggerMesh:
metadata.TriggerMeshes.Add(new(triggerMesh.TriggerObjectID, triggerMesh.IsVisible));
break;
case IMS2TriggerEffect triggerEffect:
metadata.TriggerEffects.Add(new(triggerEffect.TriggerObjectID, triggerEffect.IsVisible));
break;
case IMS2TriggerCamera triggerCamera:
metadata.TriggerCameras.Add(new(triggerCamera.TriggerObjectID, triggerCamera.Enabled));
break;
case IMS2TriggerBox triggerBox:
metadata.TriggerBoxes.Add(new(triggerBox.TriggerObjectID, CoordF.FromVector3(triggerBox.Position),
CoordF.FromVector3(triggerBox.ShapeDimensions)));
break;
case IMS2TriggerLadder triggerLadder: // TODO: Find which parameters correspond to animationeffect (bool) and animation delay (int?)
metadata.TriggerLadders.Add(new(triggerLadder.TriggerObjectID, triggerLadder.IsVisible));
break;
case IMS2TriggerRope triggerRope: // TODO: Find which parameters correspond to animationeffect (bool) and animation delay (int?)
metadata.TriggerRopes.Add(new(triggerRope.TriggerObjectID, triggerRope.IsVisible));
break;
case IMS2TriggerPortal triggerPortal:
metadata.Portals.Add(new(triggerPortal.PortalID, triggerPortal.ModelName, triggerPortal.PortalEnable, triggerPortal.IsVisible,
triggerPortal.MinimapIconVisible,
triggerPortal.TargetFieldSN, CoordS.FromVector3(triggerPortal.Position), CoordS.FromVector3(triggerPortal.Rotation),
triggerPortal.TargetPortalID, (PortalTypes)triggerPortal.PortalType, triggerPortal.TriggerObjectID));
break;
case IMS2TriggerActor triggerActor:
metadata.TriggerActors.Add(new(triggerActor.TriggerObjectID, triggerActor.IsVisible, triggerActor.InitialSequence));
break;
case IMS2TriggerCube triggerCube:
metadata.TriggerCubes.Add(new(triggerCube.TriggerObjectID, triggerCube.IsVisible));
break;
case IMS2TriggerSound triggerSound:
metadata.TriggerSounds.Add(new(triggerSound.TriggerObjectID, triggerSound.Enabled));
break;
case IMS2TriggerSkill triggerSkill:
metadata.TriggerSkills.Add(new(triggerSkill.TriggerObjectID, triggerSkill.skillID,
(short)triggerSkill.skillLevel, (byte)triggerSkill.count, CoordF.FromVector3(triggerSkill.Position)));
break;
}
break;
case IMS2Liftable liftable:
metadata.LiftableObjects.Add(new(liftable.EntityId, (int)liftable.ItemID, liftable.EffectQuestID, liftable.EffectQuestState,
liftable.ItemLifeTime, liftable.LiftableRegenCheckTime));
break;
case IMS2LiftableTargetBox liftableTargetBox:
metadata.LiftableTargets.Add(new(liftableTargetBox.liftableTarget, CoordF.FromVector3(liftableTargetBox.Position),
CoordF.FromVector3(liftableTargetBox.ShapeDimensions)));
break;
case IMS2CubeProp prop:
if (prop.IsObjectWeapon)
{
List <int> weaponIds = prop.ObjectWeaponItemCode.Split(",").Select(int.Parse).ToList();
metadata.WeaponObjects.Add(new(CoordB.FromVector3(prop.Position), weaponIds));
}
break;
case IMS2Vibrate vibrate:
metadata.VibrateObjects.Add(new(vibrate.EntityId));
break;
}
/* NPC Objects have a modelName of 8 digits followed by an underscore and a name that's the same thing,
* but with a number (for each instance on that map) after it
*
* IM_ Prefixed items are Interactable Meshes supplemented by data in "xml/table/interactobject.xml"
* IA_ prefixed items are Interactable Actors (Doors, etc). Have an interactID, which is an event on interact.
* "mixinMS2MapProperties" is generic field items
* "mixinMS2SalePost" - is for sale signs. Does a packet need to respond to this item?
*/
/*
*
* // Unhandled Items:
* // "mixinEventSpawnPointNPC",
* // "mixinMS2Actor" as in "fa_fi_funct_irondoor_A01_"
* // MS2RegionSkill as in "SkillObj_co_Crepper_C03_" (Only on 8xxxx and 9xxxxx maps)
* // "mixinMS2FunctionCubeKFM" as in "ry_functobj_lamp_B01_", "ke_functobj_bath_B01_"
* // "mixinMS2FunctionCubeNIF"
* // "MS2MapProperties"->"MS2PhysXProp" that's not a weapon. Standard
*
* /*
* if (Regex.Match(modelName, @"^\d{8}_").Success && Regex.Match(name, @"\d{1,3}").Success)
* {
* // Parse non-permanent NPCs. These have no .flat files to supplement them.
* string npcListIndex = node.SelectSingleNode("property[@name='NpcList']")?.FirstChild.Attributes["index"].Value ?? "-1";
* if (npcListIndex == "-1")
* {
* continue;
* }
* string npcPositionValue = node.SelectSingleNode("property[@name='Position']")?.FirstChild.Attributes["value"].Value ?? "0, 0, 0";
* string npcRotationValue = node.SelectSingleNode("property[@name='Rotation']")?.FirstChild.Attributes["value"].Value ?? "0, 0, 0";
* // metadata.Npcs.Add(new MapNpc(int.Parse(npcListIndex), modelName, name, ParseCoord(npcPositionValue), ParseCoord(npcRotationValue)));
* }
*/
}
// No data on this map
if (metadata.Npcs.Count == 0 && metadata.Portals.Count == 0 && metadata.PlayerSpawns.Count == 0)
{
return;
}
Entities.Add(metadata);
}
private void BuildMetadata(string xblock, IEnumerable <IMapEntity> mapEntities)
{
if (xblock.EndsWith("_cn") || xblock.EndsWith("_jp") || xblock.EndsWith("_kr"))
{
return;
}
Match isParsableField = Regex.Match(xblock, @"^(\d{8})");
if (!isParsableField.Success)
{
// TODO: Handle these later, if we need them. They're xblock files with some other names like
// character_test.xblock, login.xblock,
return;
}
string mapId = isParsableField.Groups[1].Value;
if (Maps.ContainsKey(mapId))
{
return;
}
Maps.Add(mapId, xblock); // Only used to check if we've visited this node before.
// TODO: metadata should be keyed on xblock name, not mapId
MapEntityMetadata metadata = new MapEntityMetadata(int.Parse(mapId));
foreach (IMapEntity entity in mapEntities)
{
switch (entity)
{
case IMS2Bounding bounding:
if (bounding.EntityName.EndsWith("0") && metadata.BoundingBox0.Equals(CoordS.From(0, 0, 0)))
{
metadata.BoundingBox0 = CoordS.FromVector3(bounding.Position);
}
else if (bounding.EntityName.EndsWith("1") && metadata.BoundingBox1.Equals(CoordS.From(0, 0, 0)))
{
metadata.BoundingBox1 = CoordS.FromVector3(bounding.Position);
}
break;
case IMS2PatrolData patrolData:
string patrolDataName = patrolData.EntityName.Replace("-", string.Empty);
List <string> wayPointIds = new List <string>();
foreach (KeyValuePair <string, string> entry in patrolData.WayPoints)
{
string wayPointId = entry.Value.Replace("-", string.Empty);
wayPointIds.Add(wayPointId);
}
List <string> arriveAnimations = new List <string>();
foreach (KeyValuePair <string, string> entry in patrolData.ArriveAnims)
{
arriveAnimations.Add(entry.Value);
}
List <string> approachAnimations = new List <string>();
foreach (KeyValuePair <string, string> entry in patrolData.ApproachAnims)
{
approachAnimations.Add(entry.Value);
}
List <int> arriveAnimationTimes = new List <int>();
foreach (KeyValuePair <string, uint> entry in patrolData.ArriveAnimsTime)
{
arriveAnimationTimes.Add((int)entry.Value);
}
metadata.PatrolDatas.Add(new PatrolData(patrolDataName, wayPointIds, (int)patrolData.PatrolSpeed, patrolData.IsLoop, patrolData.IsAirWayPoint, arriveAnimations, approachAnimations, arriveAnimationTimes));
break;
case IMS2WayPoint wayPoint:
metadata.WayPoints.Add(new WayPoint(wayPoint.EntityId, wayPoint.IsVisible, CoordS.FromVector3(wayPoint.Position), CoordS.FromVector3(wayPoint.Rotation)));
break;
// TODO: This can probably be more generally handled as IMS2RegionSkill
case IMS2HealingRegionSkillSound healingRegion:
if (healingRegion.Position == default)
{
continue;
}
metadata.HealingSpot.Add(CoordS.FromVector3(healingRegion.Position));
break;
case IMS2InteractObject interact: // TODO: this one is kinda f****d
if (interact.interactID == 0)
{
continue;
}
if (interact.ModelName.Contains("funct_extract_"))
{
metadata.InteractObjects.Add(new MapInteractObject(interact.EntityId, interact.EntityName,
InteractObjectType.Extractor, interact.interactID));
continue;
}
if (entity is IMS2Telescope)
{
metadata.InteractObjects.Add(new MapInteractObject(interact.EntityId, interact.EntityName,
InteractObjectType.Binoculars, interact.interactID));
continue;
}
if (interact.ModelName.EndsWith("hub") || interact.ModelName.EndsWith("vein"))
{
if (InteractRecipeMap.TryGetValue(interact.interactID, out int recipeId))
{
metadata.InteractObjects.Add(new MapInteractObject(interact.EntityId, interact.EntityName,
InteractObjectType.Gathering, recipeId));
}
continue;
}
if (entity is IMS2InteractDisplay)
{
// TODO: Implement Interactive Displays like 02000183, Dark Wind Wanted Board (7bb334fe41f94182a9569ab884004c32)
// "mixinMS2InteractDisplay" ("ID_19100003_")
}
if (entity is IMS2InteractMesh)
{
// TODO: InteractMesh IS InteractObject, maybe shouldn't separate them...
metadata.InteractMeshes.Add(new MapInteractMesh(entity.EntityId, entity.EntityName));
}
metadata.InteractObjects.Add(new MapInteractObject(interact.EntityId, interact.EntityName,
InteractObjectType.Unknown, interact.interactID));
break;
case ISpawnPoint spawn:
switch (spawn)
{
// TODO: Parse "value" from NPCList.
case IEventSpawnPointNPC eventSpawnNpc: // trigger mob/npc spawns
List <string> npcIds = new List <string>();
npcIds.AddRange(eventSpawnNpc.NpcList.Keys);
metadata.EventNpcSpawnPoints.Add(new MapEventNpcSpawnPoint(eventSpawnNpc.SpawnPointID, eventSpawnNpc.NpcCount, npcIds, eventSpawnNpc.SpawnAnimation, eventSpawnNpc.SpawnRadius,
CoordF.FromVector3(eventSpawnNpc.Position), CoordF.FromVector3(eventSpawnNpc.Rotation)));
break;
case ISpawnPointPC pcSpawn:
metadata.PlayerSpawns.Add(
new MapPlayerSpawn(CoordS.FromVector3(pcSpawn.Position), CoordS.FromVector3(pcSpawn.Rotation)));
break;
case ISpawnPointNPC npcSpawn:
// These tend to be vendors, shops, etc.
// If the name tag begins with SpawnPointNPC, I think these are mob spawn locations. Skipping these.
string npcIdStr = npcSpawn.NpcList.FirstOrDefault().Key ?? "0";
if (npcIdStr == "0" || !int.TryParse(npcIdStr, out int npcId))
{
continue;
}
MapNpc npc = new MapNpc(npcId, npcSpawn.ModelName, npcSpawn.EntityName, CoordS.FromVector3(npcSpawn.Position),
CoordS.FromVector3(npcSpawn.Rotation), npcSpawn.IsSpawnOnFieldCreate, npcSpawn.dayDie, npcSpawn.nightDie);
// Parse some additional flat supplemented data about this NPC.
metadata.Npcs.Add(npc);
break;
}
break;
case IMS2RegionSpawnBase spawnBase:
switch (spawnBase)
{
case IMS2RegionBoxSpawn boxSpawn:
SpawnMetadata mobSpawnDataBox =
(SpawnTagMap.ContainsKey(mapId) && SpawnTagMap[mapId].ContainsKey(boxSpawn.SpawnPointID))
? SpawnTagMap[mapId][boxSpawn.SpawnPointID]
: null;
int mobNpcCountBox = mobSpawnDataBox?.Population ?? 6;
int mobSpawnRadiusBox = 150;
// TODO: This previously relied in "NpcList" to be set. NpcList is impossible to be set on
// MS2RegionSpawn, it's only set for SpawnPointNPC.
List <int> mobNpcListBox = new List <int>
{
21000025 // Placeholder
};
metadata.MobSpawns.Add(new MapMobSpawn(boxSpawn.SpawnPointID, CoordS.FromVector3(boxSpawn.Position),
mobNpcCountBox, mobNpcListBox, mobSpawnRadiusBox, mobSpawnDataBox));
// "QR_10000264_" is Quest Reward Chest? This is tied to a MS2TriggerAgent making this object appear.
break;
case IMS2RegionSpawn regionSpawn:
SpawnMetadata mobSpawnData =
(SpawnTagMap.ContainsKey(mapId) && SpawnTagMap[mapId].ContainsKey(regionSpawn.SpawnPointID))
? SpawnTagMap[mapId][regionSpawn.SpawnPointID]
: null;
int mobNpcCount = mobSpawnData?.Population ?? 6;
// TODO: This previously relied in "NpcList" to be set. NpcList is impossible to be set on
// MS2RegionSpawn, it's only set for SpawnPointNPC.
List <int> mobNpcList = new List <int>
{
21000025 // Placeholder
};
metadata.MobSpawns.Add(new MapMobSpawn(regionSpawn.SpawnPointID, CoordS.FromVector3(regionSpawn.Position),
mobNpcCount, mobNpcList, (int)regionSpawn.SpawnRadius, mobSpawnData));
break;
}
break;
case IPortal portal:
metadata.Portals.Add(new MapPortal(portal.PortalID, portal.ModelName, portal.PortalEnable, portal.IsVisible, portal.MinimapIconVisible, portal.TargetFieldSN,
CoordS.FromVector3(portal.Position), CoordS.FromVector3(portal.Rotation), portal.TargetPortalID, (byte)portal.PortalType));
break;
case IMS2Breakable breakable:
switch (breakable)
{
case IMS2BreakableActor actor:
metadata.BreakableActors.Add(new MapBreakableActorObject(actor.EntityId, actor.Enabled, actor.hideTimer, actor.resetTimer));
break;
case IMS2BreakableNIF nif:
metadata.BreakableNifs.Add(new MapBreakableNifObject(nif.EntityId, nif.Enabled, (int)nif.TriggerBreakableID, nif.hideTimer, nif.resetTimer));
break;
}
break;
case IMS2TriggerObject triggerObject:
switch (triggerObject)
{
case IMS2TriggerMesh triggerMesh:
metadata.TriggerMeshes.Add(new MapTriggerMesh(triggerMesh.TriggerObjectID, triggerMesh.IsVisible));
break;
case IMS2TriggerEffect triggerEffect:
metadata.TriggerEffects.Add(new MapTriggerEffect(triggerEffect.TriggerObjectID, triggerEffect.IsVisible));
break;
case IMS2TriggerCamera triggerCamera:
metadata.TriggerCameras.Add(new MapTriggerCamera(triggerCamera.TriggerObjectID, triggerCamera.Enabled));
break;
case IMS2TriggerBox triggerBox:
metadata.TriggerBoxes.Add(new MapTriggerBox(triggerBox.TriggerObjectID, CoordF.FromVector3(triggerBox.Position), CoordF.FromVector3(triggerBox.ShapeDimensions)));
break;
case IMS2TriggerLadder triggerLadder: // TODO: Find which parameters correspond to animationeffect (bool) and animation delay (int?)
metadata.TriggerLadders.Add(new MapTriggerLadder(triggerLadder.TriggerObjectID, triggerLadder.IsVisible));
break;
case IMS2TriggerRope triggerRope: // TODO: Find which parameters correspond to animationeffect (bool) and animation delay (int?)
metadata.TriggerRopes.Add(new MapTriggerRope(triggerRope.TriggerObjectID, triggerRope.IsVisible));
break;
case IMS2TriggerPortal triggerPortal:
metadata.Portals.Add(new MapPortal(triggerPortal.PortalID, triggerPortal.ModelName, triggerPortal.PortalEnable, triggerPortal.IsVisible, triggerPortal.MinimapIconVisible,
triggerPortal.TargetFieldSN, CoordS.FromVector3(triggerPortal.Position), CoordS.FromVector3(triggerPortal.Rotation), triggerPortal.TargetPortalID, (byte)triggerPortal.PortalType, triggerPortal.TriggerObjectID));
break;
case IMS2TriggerActor triggerActor:
metadata.TriggerActors.Add(new MapTriggerActor(triggerActor.TriggerObjectID, triggerActor.IsVisible, triggerActor.InitialSequence));
break;
case IMS2TriggerCube triggerCube:
metadata.TriggerCubes.Add(new MapTriggerCube(triggerCube.TriggerObjectID, triggerCube.IsVisible));
break;
case IMS2TriggerSound triggerSound:
metadata.TriggerSounds.Add(new MapTriggerSound(triggerSound.TriggerObjectID, triggerSound.Enabled));
break;
}
break;
case IMS2Vibrate vibrate:
metadata.VibrateObjects.Add(new MapVibrateObject(vibrate.EntityId));
break;
case IPlaceable placeable: // TODO: placeable might be too generic
// These are objects which you can place in the world
string nameCoord = placeable.EntityName.ToLower();
Match coordMatch = Regex.Match(nameCoord, @"-?\d+, -?\d+, -?\d+");
if (!coordMatch.Success)
{
continue;
}
// Only MS2MapProperties has ObjectWeaponItemCode
if (entity is not IMS2MapProperties mapProperties)
{
continue;
}
try
//TODO: The parser will output errors here, which are non-critical, yet need resolving later.
{
CoordB coord = CoordB.Parse(coordMatch.Value, ", ");
metadata.Objects.Add(new MapObject(coord, int.Parse(mapProperties.ObjectWeaponItemCode)));
}
catch (FormatException)
{
// ignored
//byte[] bytes = System.Text.Encoding.UTF8.GetBytes(mapProperties.ObjectWeaponItemCode);
//Console.WriteLine($"String in bytes: {Convert.ToHexString(bytes)}");
}
catch (OverflowException)
{
//byte[] bytes = System.Text.Encoding.UTF8.GetBytes(mapProperties.ObjectWeaponItemCode);
//Console.WriteLine($"String in bytes: {Convert.ToHexString(bytes)}");
}
break;
}
/* NPC Objects have a modelName of 8 digits followed by an underscore and a name that's the same thing,
* but with a number (for each instance on that map) after it
*
* IM_ Prefixed items are Interactable Meshes supplemented by data in "xml/table/interactobject.xml"
* IA_ prefixed items are Interactable Actors (Doors, etc). Have an interactID, which is an event on interact.
* "mixinMS2MapProperties" is generic field items
* "mixinMS2SalePost" - is for sale signs. Does a packet need to respond to this item?
*/
/*
*
* // Unhandled Items:
* // "mixinEventSpawnPointNPC",
* // "mixinMS2Actor" as in "fa_fi_funct_irondoor_A01_"
* // MS2RegionSkill as in "SkillObj_co_Crepper_C03_" (Only on 8xxxx and 9xxxxx maps)
* // "mixinMS2FunctionCubeKFM" as in "ry_functobj_lamp_B01_", "ke_functobj_bath_B01_"
* // "mixinMS2FunctionCubeNIF"
* // "MS2MapProperties"->"MS2PhysXProp" that's not a weapon. Standard
*
* /*
* if (Regex.Match(modelName, @"^\d{8}_").Success && Regex.Match(name, @"\d{1,3}").Success)
* {
* // Parse non-permanent NPCs. These have no .flat files to supplement them.
* string npcListIndex = node.SelectSingleNode("property[@name='NpcList']")?.FirstChild.Attributes["index"].Value ?? "-1";
* if (npcListIndex == "-1")
* {
* continue;
* }
* string npcPositionValue = node.SelectSingleNode("property[@name='Position']")?.FirstChild.Attributes["value"].Value ?? "0, 0, 0";
* string npcRotationValue = node.SelectSingleNode("property[@name='Rotation']")?.FirstChild.Attributes["value"].Value ?? "0, 0, 0";
* // metadata.Npcs.Add(new MapNpc(int.Parse(npcListIndex), modelName, name, ParseCoord(npcPositionValue), ParseCoord(npcRotationValue)));
* }
*/
}
// No data on this map
if (metadata.Npcs.Count == 0 && metadata.Portals.Count == 0 && metadata.PlayerSpawns.Count == 0)
{
return;
}
Entities.Add(metadata);
}
private void BuildMetadata(string xblock, IEnumerable <IMapEntity> mapEntities)
{
if (xblock.EndsWith("_cn") || xblock.EndsWith("_jp") || xblock.EndsWith("_kr"))
{
return;
}
MapMetadata mapMetadata = MapMetadatas.FirstOrDefault(x => x.XBlockName == xblock);
if (mapMetadata is null)
{
return;
}
MapEntityMetadata mapEntity = mapMetadata.Entities;
List <IMS2WayPoint> tempWaypoints = new();
List <IMS2PatrolData> tempPatrolData = new();
foreach (IMapEntity entity in mapEntities)
{
if (entity is IMS2CubeProp cube)
{
MapBlock mapBlock = new()
{
Coord = CoordS.FromVector3(cube.Position),
Type = cube.CubeType,
SaleableGroup = cube.CubeSalableGroup,
Attribute = cube.MapAttribute
};
mapMetadata.Blocks.TryAdd(mapBlock.Coord, mapBlock);
}
switch (entity)
{
case IMS2Bounding bounding:
if (bounding.EntityName.EndsWith("0") && mapEntity.BoundingBox0.Equals(CoordS.From(0, 0, 0)))
{
mapEntity.BoundingBox0 = CoordS.FromVector3(bounding.Position);
}
else if (bounding.EntityName.EndsWith("1") && mapEntity.BoundingBox1.Equals(CoordS.From(0, 0, 0)))
{
mapEntity.BoundingBox1 = CoordS.FromVector3(bounding.Position);
}
break;
case IMS2PatrolData patrolData:
tempPatrolData.Add(patrolData);
break;
case IMS2WayPoint wayPoint:
tempWaypoints.Add(wayPoint);
break;
// TODO: This can probably be more generally handled as IMS2RegionSkill
case IMS2HealingRegionSkillSound healingRegion:
if (healingRegion.Position == default)
{
continue;
}
mapEntity.HealingSpot.Add(CoordS.FromVector3(healingRegion.Position));
break;
case IMS2InteractObject interact:
InteractObjectType type = GetInteractObjectType(interact.interactID);
if (type == InteractObjectType.None)
{
continue;
}
switch (interact)
{
case IMS2SimpleUiObject uiObject:
mapEntity.InteractObjects.Add(new(uiObject.EntityId, uiObject.interactID, uiObject.Enabled, type,
CoordF.FromVector3(uiObject.Position),
CoordF.FromVector3(uiObject.Rotation)));
break;
case IMS2InteractMesh interactMesh:
mapEntity.InteractObjects.Add(new(interactMesh.EntityId, interactMesh.interactID, interactMesh.IsVisible, type,
CoordF.FromVector3(interactMesh.Position),
CoordF.FromVector3(interactMesh.Rotation)));
break;
case IMS2Telescope telescope:
mapEntity.InteractObjects.Add(new(telescope.EntityId, telescope.interactID, telescope.Enabled, type,
CoordF.FromVector3(telescope.Position),
CoordF.FromVector3(telescope.Rotation)));
break;
case IMS2InteractActor interactActor:
mapEntity.InteractObjects.Add(new(interactActor.EntityId, interactActor.interactID, interactActor.IsVisible, type
, CoordF.FromVector3(interactActor.Position),
CoordF.FromVector3(interactActor.Rotation)));
break;
case IMS2InteractDisplay interactDisplay:
mapEntity.InteractObjects.Add(new(interactDisplay.EntityId, interactDisplay.interactID, interactDisplay.IsVisible, type,
CoordF.FromVector3(interactDisplay.Position),
CoordF.FromVector3(interactDisplay.Rotation)));
break;
}
break;
case ISpawnPoint spawn:
switch (spawn)
{
// TODO: Parse "value" from NPCList.
case IEventSpawnPointNPC eventSpawnNpc: // trigger mob/npc spawns
List <string> npcIds = new();
npcIds.AddRange(eventSpawnNpc.NpcList.Keys);
mapEntity.EventNpcSpawnPoints.Add(new(eventSpawnNpc.SpawnPointID, eventSpawnNpc.NpcCount, npcIds, eventSpawnNpc.SpawnAnimation,
eventSpawnNpc.SpawnRadius,
CoordF.FromVector3(eventSpawnNpc.Position), CoordF.FromVector3(eventSpawnNpc.Rotation)));
break;
case ISpawnPointPC pcSpawn:
mapEntity.PlayerSpawns.Add(new(CoordS.FromVector3(pcSpawn.Position), CoordS.FromVector3(pcSpawn.Rotation)));
break;
case ISpawnPointNPC npcSpawn:
// These tend to be vendors, shops, etc.
// If the name tag begins with SpawnPointNPC, I think these are mob spawn locations. Skipping these.
string npcIdStr = npcSpawn.NpcList.FirstOrDefault().Key ?? "0";
if (npcIdStr == "0" || !int.TryParse(npcIdStr, out int npcId))
{
continue;
}
MapNpc npc = new(npcId, npcSpawn.ModelName, npcSpawn.EntityName, CoordS.FromVector3(npcSpawn.Position),
CoordS.FromVector3(npcSpawn.Rotation), npcSpawn.IsSpawnOnFieldCreate, npcSpawn.dayDie, npcSpawn.nightDie, npcSpawn.PatrolData);
// Parse some additional flat supplemented data about this NPC.
mapEntity.Npcs.Add(npc);
break;
}
break;
case IMS2RegionSpawnBase spawnBase:
SpawnMetadata spawnData = SpawnTagMap.ContainsKey(mapMetadata.Id) && SpawnTagMap[mapMetadata.Id].ContainsKey(spawnBase.SpawnPointID)
? SpawnTagMap[mapMetadata.Id][spawnBase.SpawnPointID]
: null;
switch (spawnBase)
{
case IMS2RegionBoxSpawn boxSpawn:
if (boxSpawn.ModelName.Contains("chest", StringComparison.CurrentCultureIgnoreCase))
{
mapEntity.MapChests.Add(new()
{
IsGolden = boxSpawn.ModelName.Contains("rare", StringComparison.CurrentCultureIgnoreCase),
Position = CoordF.FromVector3(boxSpawn.Position),
Rotation = CoordF.FromVector3(boxSpawn.Rotation)
});
continue;
}
AddMobSpawn(spawnData, mapEntity, boxSpawn);
break;
case IMS2RegionSpawn regionSpawn:
int mobNpcCount = spawnData?.Population ?? 6;
// TODO: This previously relied in "NpcList" to be set. NpcList is impossible to be set on
// MS2RegionSpawn, it's only set for SpawnPointNPC.
List <int> mobNpcList = new()
{
21000025 // Placeholder
};
mapEntity.MobSpawns.Add(new(regionSpawn.SpawnPointID, CoordS.FromVector3(regionSpawn.Position),
mobNpcCount, mobNpcList, (int)regionSpawn.SpawnRadius, spawnData));
break;
}
break;
case IPortal portal:
mapEntity.Portals.Add(new(portal.PortalID, portal.ModelName, portal.PortalEnable, portal.IsVisible, portal.MinimapIconVisible,
portal.TargetFieldSN,
CoordS.FromVector3(portal.Position), CoordS.FromVector3(portal.Rotation), portal.TargetPortalID, (PortalTypes)portal.PortalType));
break;
case IMS2Breakable breakable:
switch (breakable)
{
case IMS2BreakableActor actor:
mapEntity.BreakableActors.Add(new(actor.EntityId, actor.Enabled, actor.hideTimer, actor.resetTimer));
break;
case IMS2BreakableNIF nif:
mapEntity.BreakableNifs.Add(new(nif.EntityId, nif.Enabled, (int)nif.TriggerBreakableID, nif.hideTimer, nif.resetTimer));
break;
}
break;
case IMS2TriggerObject triggerObject:
switch (triggerObject)
{
case IMS2TriggerMesh triggerMesh:
mapEntity.TriggerMeshes.Add(new(triggerMesh.TriggerObjectID, triggerMesh.IsVisible));
break;
case IMS2TriggerEffect triggerEffect:
mapEntity.TriggerEffects.Add(new(triggerEffect.TriggerObjectID, triggerEffect.IsVisible));
break;
case IMS2TriggerCamera triggerCamera:
mapEntity.TriggerCameras.Add(new(triggerCamera.TriggerObjectID, triggerCamera.Enabled));
break;
case IMS2TriggerBox triggerBox:
mapEntity.TriggerBoxes.Add(new(triggerBox.TriggerObjectID, CoordF.FromVector3(triggerBox.Position),
CoordF.FromVector3(triggerBox.ShapeDimensions)));
break;
case IMS2TriggerLadder triggerLadder: // TODO: Find which parameters correspond to animationeffect (bool) and animation delay (int?)
mapEntity.TriggerLadders.Add(new(triggerLadder.TriggerObjectID, triggerLadder.IsVisible));
break;
case IMS2TriggerRope triggerRope: // TODO: Find which parameters correspond to animationeffect (bool) and animation delay (int?)
mapEntity.TriggerRopes.Add(new(triggerRope.TriggerObjectID, triggerRope.IsVisible));
break;
case IMS2TriggerPortal triggerPortal:
mapEntity.Portals.Add(new(triggerPortal.PortalID, triggerPortal.ModelName, triggerPortal.PortalEnable, triggerPortal.IsVisible,
triggerPortal.MinimapIconVisible,
triggerPortal.TargetFieldSN, CoordS.FromVector3(triggerPortal.Position), CoordS.FromVector3(triggerPortal.Rotation),
triggerPortal.TargetPortalID, (PortalTypes)triggerPortal.PortalType, triggerPortal.TriggerObjectID));
break;
case IMS2TriggerActor triggerActor:
mapEntity.TriggerActors.Add(new(triggerActor.TriggerObjectID, triggerActor.IsVisible, triggerActor.InitialSequence));
break;
case IMS2TriggerCube triggerCube:
mapEntity.TriggerCubes.Add(new(triggerCube.TriggerObjectID, triggerCube.IsVisible));
break;
case IMS2TriggerSound triggerSound:
mapEntity.TriggerSounds.Add(new(triggerSound.TriggerObjectID, triggerSound.Enabled));
break;
case IMS2TriggerSkill triggerSkill:
mapEntity.TriggerSkills.Add(new(triggerSkill.TriggerObjectID, triggerSkill.skillID,
(short)triggerSkill.skillLevel, (byte)triggerSkill.count, CoordF.FromVector3(triggerSkill.Position)));
break;
}
break;
case IMS2LiftableTargetBox liftableTargetBox:
mapEntity.LiftableTargets.Add(new(liftableTargetBox.liftableTarget, CoordF.FromVector3(liftableTargetBox.Position),
CoordF.FromVector3(liftableTargetBox.ShapeDimensions)));
break;
case IMS2PhysXProp physXProp:
switch (physXProp)
{
case IMS2CubeProp prop:
if (!prop.IsObjectWeapon)
{
break;
}
List <int> weaponIds = prop.ObjectWeaponItemCode.SplitAndParseToInt(',').ToList();
mapEntity.WeaponObjects.Add(new(CoordB.FromVector3(prop.Position), weaponIds));
break;
case IMS2Liftable liftable:
mapEntity.LiftableObjects.Add(new(liftable.EntityId, (int)liftable.ItemID, liftable.ItemStackCount, liftable.MaskQuestID,
liftable.MaskQuestState, liftable.EffectQuestID, liftable.EffectQuestState, liftable.ItemLifeTime,
liftable.LiftableRegenCheckTime, liftable.LiftableFinishTime, CoordF.FromVector3(liftable.Position),
CoordF.FromVector3(liftable.Rotation)));
break;
case IMS2Vibrate vibrate:
mapEntity.VibrateObjects.Add(new(vibrate.EntityId, CoordF.FromVector3(physXProp.Position)));
break;
}
break;
}
}
BuildWaypoints(tempPatrolData, tempWaypoints, mapEntity);
}
