/
FactionFile.cs
1214 lines (1023 loc) · 38.3 KB
/
FactionFile.cs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Project: Daggerfall Unity
// Copyright: Copyright (C) 2009-2023 Daggerfall Workshop
// Web Site: http://www.dfworkshop.net
// License: MIT License (http://www.opensource.org/licenses/mit-license.php)
// Source Code: https://github.com/Interkarma/daggerfall-unity
// Original Author: Gavin Clayton (interkarma@dfworkshop.net)
// Contributors:
//
// Notes:
//
#region Using Statements
using System;
using System.Text;
using System.Collections.Generic;
using System.IO;
using DaggerfallConnect.Utility;
using DaggerfallConnect.Save;
using DaggerfallWorkshop;
#endregion
namespace DaggerfallConnect.Arena2
{
/// <summary>
/// Connects to FACTION.TXT and reads faction data.
/// </summary>
public class FactionFile
{
#region Fields
readonly FileProxy factionFile = new FileProxy();
readonly Dictionary<int, FactionData> factionDict = new Dictionary<int, FactionData>();
readonly Dictionary<string, int> factionNameToIDDict = new Dictionary<string, int>();
#endregion
#region Properties
public Dictionary<int, FactionData> FactionDict
{
get { return factionDict; }
}
public Dictionary<string, int> FactionNameToIDDict
{
get { return factionNameToIDDict; }
}
#endregion
#region Enums
/// <summary>
/// Faction IDs in Daggerfall's FACTION.TXT file.
/// </summary>
public enum FactionIDs
{
Clavicus_Vile = 1,
Mehrunes_Dagon = 2,
Molag_Bal = 3,
Hircine = 4,
Sanguine = 5,
Peryite = 6,
Malacath = 7,
Hermaeus_Mora = 8,
Sheogorath = 9,
Boethiah = 10,
Namira = 11,
Meridia = 12,
Vaernima = 13,
Nocturnal = 14,
Mephala = 15,
Azura = 16,
Oblivion = 17,
Arkay = 21,
Zen = 22,
Mara = 24,
Ebonarm = 25,
Akatosh = 26,
Julianos = 27,
Dibella = 29,
Stendarr = 33,
Kynareth = 35,
The_Temple_of_Kynareth = 36,
The_Kynaran_Order = 37,
The_Mages_Guild = 40,
The_Fighters_Guild = 41,
The_Thieves_Guild = 42,
The_Academics = 60,
The_Patricians = 61,
The_Travelers_League = 62,
The_Mercenary_Mages = 63,
The_Isolationists = 64,
The_Utility_Mages = 65,
The_Cabal = 66,
The_Order_of_the_Lamp = 67,
The_Archmagister = 68,
The_Guildmagister = 69,
The_Master_of_Academia = 70,
The_Master_of_Incunabula = 71,
The_Master_at_Arms = 72,
The_Palatinus = 73,
The_Master_of_the_Scry = 74,
The_Master_of_Initiates = 76,
The_Guildmaster = 77, // A second "The Master of Initiates" in FACTION.TXT is also 77
The_Order_of_Arkay = 82,
The_Knights_of_the_Circle = 83,
The_Resolution_of_Zen = 84,
The_Knights_of_Iron = 85,
The_Benevolence_of_Mara = 88,
The_Maran_Knights = 89,
The_Citadel_of_Ebonarm = 90,
The_Battlelords = 91,
The_Akatosh_Chantry = 92,
The_Order_of_the_Hour = 93,
The_Schools_of_Julianos = 94,
The_Knights_Mentor = 95,
The_House_of_Dibella = 98,
The_Order_of_the_Lily = 99,
The_Temple_of_Stendarr = 106,
The_Crusaders = 107,
The_Dark_Brotherhood = 108,
The_Blades = 129,
The_Vraseth = 150,
The_Haarvenu = 151,
The_Thrafey = 152,
The_Lyrezi = 153,
The_Montalion = 154,
The_Khulari = 155,
The_Garlythi = 156,
The_Anthotis = 157,
The_Selenu = 158,
People_of_Glenumbra_Moors = 194,
Court_of_Glenumbra_Moors = 195,
Glenumbra_Moors = 196,
People_of_Balfiera = 198,
Isle_of_Balfiera = 199,
Dwynnen = 200,
Daggerfall = 201,
Glenpoint = 202,
Betony = 203,
Sentinel = 204,
Anticlere = 205,
Lainlyn = 206,
Wayrest = 207,
Northmoor = 208,
Menevia = 209,
Alcaire = 210,
Koegria = 211,
Bhoriane = 212,
Kambria = 213,
Phrygia = 214,
Urvaius = 215,
Ykalon = 216,
Daenia = 217,
Shalgora = 218,
Abibon_Gora = 219,
Kairou = 220,
Pothago = 221,
Myrkwasa = 222,
Ayasofya = 223,
Tigonus = 224,
Kozanset = 225,
Satakalaam = 226,
Totambu = 227,
Mournoth = 228,
Ephesus = 229,
Santaki = 230,
Antiphyllos = 231,
Bergama = 232,
Gavaudon = 233,
Tulune = 234,
Ilessan_Hills = 235,
Cybiades = 236,
Temple_Missionaries = 240,
Teachers_of_Arkay = 241,
Random_Noble = 242,
Teachers_of_Zen = 243,
Court_of_Balfiera = 244,
Teachers_of_Mara = 245,
Court_of_Lainlyn = 246,
Teachers_of_Akatosh = 247,
Teachers_of_Julianos = 249,
Teachers_of_Dibella = 250,
Teachers_of_Stendarr = 252,
Teachers_of_Kynareth = 254,
The_Oracle = 301,
The_Acolyte = 302,
Nulfaga = 303,
Skakmat = 304,
King_of_Worms = 305,
The_Necromancers = 306,
The_Septim_Empire = 350,
The_Great_Knight = 351,
Lady_Brisienna = 352,
The_Underking = 353,
Agents_of_The_Underking = 354,
Lord_Harth = 355,
The_Night_Mother = 356,
Gortwog = 357,
Orsinium = 358,
Lord_Plessington = 359,
Lord_Kilbar = 360,
Chulmore_Quill = 361,
The_Quill_Circus = 362,
Medora = 363,
King_Gothryd = 364,
Queen_Aubki = 365,
Mynisera = 366,
Lord_Bridwell = 367,
The_Knights_of_the_Dragon = 368,
Popudax = 369,
Lord_Coulder = 370,
Mobar = 371,
The_Royal_Guard = 372,
The_Crow = 373,
Thyr_Topfield = 374,
Lord_Bertram_Spode = 375,
Baltham_Greyman = 376,
Lady_Bridwell = 377,
Sylch_Greenwood = 378,
Baron_Shrike = 379,
Queen_Akorithi = 380,
Prince_Greklith = 381,
Prince_Lhotun = 382,
Lord_Vhosek = 383,
The_Royal_Guards = 384,
Charvek_si = 385,
Lord_Kavar = 386,
Lord_Provlith = 387,
Thaik = 388,
Whitka = 389,
King_Eadwyre = 390,
Queen_Barenziah = 391,
Princess_Elysana = 392,
Prince_Helseth = 393,
Princess_Morgiah = 394,
Lord_Castellian = 395,
Karethys = 396,
Lord_Darkworth = 397,
Lord_Woodborne = 398,
The_Squid = 399,
Lady_Doryanna_Flyte = 400,
Lord_Auberon_Flyte = 401,
Lord_Quistley = 402,
Farrington = 403,
Lord_Perwright = 404,
Baroness_Dhemka = 405,
Lord_Khane = 406,
Britsa = 407,
The_Order_of_the_Candle = 408,
The_Knights_of_the_Rose = 409,
The_Knights_of_the_Flame = 410,
The_Host_of_the_Horn = 411,
The_Host_of_the_True_Horn = 412,
The_Knights_of_the_Owl = 413,
The_Order_of_the_Raven = 414,
The_Knights_of_the_Wheel = 415,
The_Order_of_the_Scarab = 416,
The_Knights_of_the_Hawk = 417,
The_Order_of_the_Cup = 418,
The_Glenmoril_Witches = 419,
The_Dust_Witches = 420,
The_Witches_of_Devilrock = 421,
The_Tamarilyn_Witches = 422,
The_Sisters_of_the_Bluff = 423,
The_Daughters_of_Wroth = 424,
The_Skeffington_Witches = 425,
The_Witches_of_the_Marsh = 426,
The_Mountain_Witches = 427,
The_Daggerfall_Witches = 428,
The_Beldama = 429,
The_Sisters_of_Kykos = 430,
The_Tide_Witches = 431,
The_Witches_of_Alcaire = 432,
Generic_Temple = 450,
Apothecaries_of_Arkay = 453,
Mixers_of_Arkay = 454,
Binders_of_Arkay = 455,
Summoners_of_Arkay = 456,
Apothecaries_of_Zen = 462,
Mixers_of_Zen = 463,
Summonists_of_Zen = 464,
Apothecaries_of_Mara = 468,
Mixers_of_Mara = 469,
Summoners_of_Mara = 470,
Apothecaries_of_Akatosh = 473,
Mixers_of_Akatosh = 474,
Summoners_of_Akatosh = 475,
Crafters_of_Julianos = 480,
Smiths_of_Julianos = 481,
Summoners_of_Julianos = 482,
Apothecaries_of_Dibella = 485,
Mixers_of_Dibella = 487,
Summoners_of_Dibella = 488,
Apothecaries_of_Stendarr = 490,
Mixers_of_Stendarr = 491,
Summoners_of_Stendarr = 492,
Enchanters_of_Kynareth = 496,
Spellsmiths_of_Kynareth = 497,
Summoners_of_Kynareth = 498,
Court_of_Wayrest = 499,
Cyndassa = 500,
Lady_Northbridge = 501,
Wrothgaria = 502,
Court_of_Wrothgaria = 503,
People_of_Wrothgaria = 504,
Dragontail = 505,
Court_of_Dragontail = 506,
People_of_Dragontail = 507,
Alikra = 508,
Court_of_Alikra = 509,
The_Merchants = 510,
The_Bards = 511,
The_Prostitutes = 512,
The_Fey = 513,
Children = 514,
Dancers = 515,
Court_of_Dwynnen = 516,
People_of_Dwynnen = 517,
People_of_Daggerfall = 518,
Court_of_Betony = 519,
People_of_Betony = 520,
Court_of_Glenpoint = 521,
People_of_Glenpoint = 522,
People_of_Sentinel = 523,
People_of_Anticlere = 524,
People_of_Lainlyn = 525,
People_of_Wayrest = 526,
Court_of_Northmoor = 527,
People_of_Northmoor = 528,
Court_of_Menevia = 529,
People_of_Menevia = 530,
Court_of_Alcaire = 531,
People_of_Alcaire = 532,
Court_of_Koegria = 533,
People_of_Koegria = 534,
Court_of_Bhoriane = 535,
People_of_Bhoriane = 536,
Court_of_Kambria = 537,
People_of_Kambria = 538,
Court_of_Phrygia = 539,
People_of_Phrygia = 540,
Court_of_Urvaius = 541,
People_of_Urvaius = 542,
Court_of_Ykalon = 543,
People_of_Ykalon = 544,
Court_of_Daenia = 545,
People_of_Daenia = 546,
Court_of_Shalgora = 547, // Name is duplicate "Court of Koegria" in FACTION.TXT
People_of_Shalgora = 548, // Name is duplicate "People of Koegria" in FACTION.TXT
Court_of_Abibon_Gora = 549,
People_of_Abibon_Gora = 550,
Court_of_Kairou = 551,
People_of_Kairou = 552,
Court_of_Pothago = 553,
People_of_Pothago = 554,
Court_of_Myrkwasa = 555,
People_of_Myrkwasa = 556,
Court_of_Ayasofya = 557,
People_of_Ayasofya = 558,
Court_of_Tigonus = 559,
People_of_Tigonus = 560,
Court_of_Kozanset = 561,
People_of_Kozanset = 562,
Court_of_Satakalaam = 563,
People_of_Satakalaam = 564,
Court_of_Totambu = 565,
People_of_Totambu = 566,
Court_of_Mournoth = 567,
People_of_Mournoth = 568,
Court_of_Ephesus = 569,
People_of_Ephesus = 570,
Court_of_Santaki = 571,
People_of_Santaki = 572,
Court_of_Antiphyllos = 573,
People_of_Antiphyllos = 574,
Court_of_Bergama = 575,
People_of_Bergama = 576,
Court_of_Gavaudon = 577,
People_of_Gavaudon = 578,
Court_of_Tulune = 579,
People_of_Tulune = 580,
Court_of_Ilessen_Hills = 581,
People_of_Ilessen_Hills = 582,
Court_of_Cybiades = 583,
People_of_Cybiades = 584,
People_of_Alikra = 590,
Dakfron = 591,
Court_of_Dakfron = 592,
People_of_Dakfron = 593,
Court_of_Daggerfall = 595,
Court_of_Sentinel = 596,
Court_of_Anticlere = 597,
Court_of_Orsinium = 598,
People_of_Orsinium = 599,
The_Odylic_Mages = 801,
The_Crafters = 802,
The_Shadow_Trainers = 803,
The_Shadow_Schemers = 804,
The_Shadow_Appraisers = 805,
The_Shadow_Spies = 806,
Dark_Slayers = 807,
Temple_Treasurers = 810,
Temple_Blessers = 811,
Temple_Healers = 813,
Dark_Trainers = 839,
Dark_Mixers = 840,
Venom_Masters = 841,
Dark_Plotters = 842,
Dark_Binders = 843,
Generic_Knightly_Order = 844,
Smiths = 845,
Questers = 846,
Healers = 847,
Seneschal = 848,
Fighter_Trainers = 849,
Fighter_Equippers = 850,
Fighter_Questers = 851,
Random_Ruler = 852,
Random_Knight = 853,
Secret_of_Oblivion = 977,
}
public enum FactionTypes
{
None = -1,
Daedra = 0,
God = 1,
Group = 2,
Subgroup = 3,
Individual = 4,
Official = 5,
VampireClan = 6,
Province = 7,
WitchesCoven = 8,
Temple = 9,
KnightlyGuard = 10,
MagicUser = 11,
Generic = 12,
Thieves = 13,
Courts = 14,
People = 15,
}
public enum SocialGroups
{
None = -1,
Commoners = 0,
Merchants = 1,
Scholars = 2,
Nobility = 3,
Underworld = 4,
SGroup5 = 5,
SupernaturalBeings = 6,
GuildMembers = 7,
SGroup8 = 8,
SGroup9 = 9,
SGroup10 = 10,
}
public enum GuildGroups
{
None = -1,
GGroup0 = 0,
GGroup1 = 1,
Oblivion = 2,
DarkBrotherHood = 3,
GeneralPopulace = 4, // ThievesGuild when socialGroup = Underworld
Bards = 5,
TheFey = 6,
Prostitutes = 7,
GGroup8 = 8,
KnightlyOrder = 9,
MagesGuild = 10,
FightersGuild = 11,
GGroup12 = 12,
GGroup13 = 13,
Necromancers = 14,
Region = 15,
GGroup16 = 16,
HolyOrder = 17,
GGroup18 = 18,
GGroup19 = 19,
GGroup20 = 20,
GGroup21 = 21,
Witches = 22,
Vampires = 23,
Orsinium = 24,
}
/// <summary>
/// Faction race value does not map to usual race ID but maps
/// to oath selection and is used only for this. Values above 7
/// are not used in-game but are guessed from FACTION.TXT.
/// </summary>
public enum FactionRaces
{
None = -1,
Nord = 0,
Khajiit = 1,
Redguard = 2,
Breton = 3,
Argonian = 4,
WoodElf = 5,
HighElf = 6,
DarkElf = 7,
Skakmat = 11, // Only used on #304 "Skakmat"
Orc = 17, // Only used on #358 "Orsinium" in the original file
Vampire = 18,
Fey = 19, // Only used on #513 "The Fey" a.k.a. Le Fay :)
}
/// <summary>
/// Faction flags bitmask values.
/// </summary>
public enum Flags
{
RulerImmune = 0x10,
Summoned = 0x40,
}
#endregion
#region Structures
[Serializable]
public struct FactionData
{
public int id;
public int parent;
public int type;
public string name;
public int rep;
public int summon;
public int region;
public int power;
public int flags;
public int ruler;
public int ally1;
public int ally2;
public int ally3;
public int enemy1;
public int enemy2;
public int enemy3;
public int face;
public int race;
public int flat1;
public int flat2;
public int sgroup;
public int ggroup;
public int minf;
public int maxf;
public int vam;
public int rank;
public uint rulerNameSeed;
public int rulerPowerBonus;
public int ptrToNextFactionAtSameHierarchyLevel;
public int ptrToFirstChildFaction;
public int ptrToParentFaction;
public List<int> children;
}
public struct FlatData
{
public int archive;
public int record;
}
#endregion
#region Static Properties
/// <summary>
/// Gets default FACTION.TXT filename.
/// </summary>
static public string Filename
{
get { return "FACTION.TXT"; }
}
public static Dictionary<int, FactionData> CustomFactions { get { return customFactions; } }
#endregion
#region Custom faction registration
// Registry for custom factions.
private static Dictionary<int, FactionData> customFactions = new Dictionary<int, FactionData>();
/// <summary>
/// Register a custom faction not in the DF FACTION.TXT file
/// </summary>
/// <param name="factionId">faction id for the new faction</param>
/// <param name="factionData">faction data struct for new faction, including child list</param>
/// <returns>true if faction was registered, false if the faction id is already in use</returns>
public static bool RegisterCustomFaction(int factionId, FactionData factionData)
{
DaggerfallUnity.LogMessage("RegisterCustomFaction: " + factionId, true);
if (!customFactions.ContainsKey(factionId))
{
customFactions.Add(factionId, factionData);
return true;
}
return false;
}
#endregion
#region Constructors
public FactionFile()
{
}
public FactionFile(string filePath, FileUsage usage, bool readOnly)
{
Load(filePath, usage, readOnly);
}
#endregion
#region Public Methods
/// <summary>
/// Load from FACTION.TXT file.
/// </summary>
/// <param name="filePath">Absolute path to FACTION.TXT file.</param>
/// <param name="usage">Specify if file will be accessed from disk, or loaded into RAM.</param>
/// <param name="readOnly">File will be read-only if true, read-write if false.</param>
public void Load(string filePath, FileUsage usage, bool readOnly)
{
// Validate filename
if (!filePath.EndsWith(Filename, StringComparison.InvariantCultureIgnoreCase))
return;
// Load file
if (!factionFile.Load(filePath, usage, readOnly))
return;
// Parse faction file
byte[] buffer = factionFile.Buffer;
string txt = Encoding.UTF8.GetString(buffer, 0, buffer.Length);
ParseFactions(txt);
RelinkChildren(factionDict);
}
/// <summary>
/// Merges faction data from savevars into a new faction dictionary.
/// Does not affect factions as read from FACTIONS.TXT.
/// This resultant set of factions is the character's live faction setup.
/// This is only used when importing a classic save.
/// Daggerfall Unity uses a different method of storing faction data with saves.
/// </summary>
/// <param name="saveVars"></param>
public Dictionary<int, FactionData> Merge(SaveVars saveVars)
{
// Create clone of base faction dictionary
Dictionary<int, FactionData> dict = new Dictionary<int, FactionData>();
foreach (var kvp in factionDict)
{
dict.Add(kvp.Key, kvp.Value);
}
// Merge save faction data from savevars
FactionData[] factions = saveVars.Factions;
foreach (var srcFaction in factions)
{
if (dict.ContainsKey(srcFaction.id))
{
FactionData dstFaction = dict[srcFaction.id];
// First a quick sanity check to ensure IDs are the same
if (dstFaction.id != srcFaction.id)
throw new Exception(string.Format("ID mismatch while merging faction data. SrcFaction=#{0}, DstFaction=#{1}", srcFaction.id, dstFaction.id));
// Copy live reputation value from SAVEVARS.DAT
// Other values remain as pre-generated from faction.txt
// This is to prevent bad save data polluting faction structure
dstFaction.rep = srcFaction.rep;
// May migrate other values later
//dstFaction.type = srcFaction.type;
//dstFaction.name = srcFaction.name;
//dstFaction.region = srcFaction.region;
//dstFaction.power = srcFaction.power;
//dstFaction.flags = srcFaction.flags;
//dstFaction.ruler = srcFaction.ruler;
//dstFaction.ally1 = srcFaction.ally1;
//dstFaction.ally2 = srcFaction.ally2;
//dstFaction.ally3 = srcFaction.ally3;
//dstFaction.enemy1 = srcFaction.enemy1;
//dstFaction.enemy2 = srcFaction.enemy2;
//dstFaction.enemy3 = srcFaction.enemy3;
//dstFaction.face = srcFaction.face;
//dstFaction.race = srcFaction.race;
//dstFaction.flat1 = srcFaction.flat1;
//dstFaction.flat2 = srcFaction.flat2;
//dstFaction.sgroup = srcFaction.sgroup;
//dstFaction.ggroup = srcFaction.ggroup;
//dstFaction.vam = srcFaction.vam;
// Store merged data back in new dictionary
dict[srcFaction.id] = dstFaction;
}
}
RelinkChildren(dict);
return dict;
}
/// <summary>
/// Gets faction data from faction ID.
/// This method returns static faction data from FACTION.TXT file.
/// Does not represent current state of faction simulation and is not localized.
/// Use PlayerEntity.FactionData.GetFactionData() for faction data used during gameplay.
/// </summary>
/// <param name="factionID">Faction ID.</param>
/// <param name="factionDataOut">Receives faction data.</param>
/// <returns>True if successful.</returns>
public bool GetFactionData(int factionID, out FactionData factionDataOut)
{
factionDataOut = new FactionData();
if (factionDict.ContainsKey(factionID))
{
factionDataOut = factionDict[factionID];
return true;
}
return false;
}
/// <summary>
/// Gets faction ID from name. Experimental.
/// Do not use for gameplay purposes.
/// Use only for development and testing with unmodified FACTION.TXT.
/// </summary>
/// <param name="name">Name of faction to get ID of.</param>
/// <returns>Faction ID if name found, otherwise -1.</returns>
public int GetFactionID(string name)
{
if (factionNameToIDDict.ContainsKey(name))
return factionNameToIDDict[name];
return -1;
}
/// <summary>
/// Turns a flat int back into archive/record format
/// </summary>
/// <param name="flat"></param>
/// <returns></returns>
public static FlatData GetFlatData(int flat)
{
FlatData flatData = new FlatData();
flatData.archive = flat >> 7;
flatData.record = flat & 0x7f;
return flatData;
}
/// <summary>
/// Relink parent factions to their child faction.
/// </summary>
public static void RelinkChildren(Dictionary<int, FactionData> dict)
{
List<FactionData> factionValues = new List<FactionData>(dict.Values);
foreach (FactionData faction in factionValues)
{
if (dict.ContainsKey(faction.parent))
{
FactionData parent = dict[faction.parent];
if (parent.children == null)
parent.children = new List<int>();
parent.children.Add(faction.id);
dict[faction.parent] = parent;
}
}
}
/// <summary>
/// Check if a faction is another faction ally.
/// </summary>
/// <param name="firstFaction">The faction to check the allies of.</param>
/// <param name="secondFaction">The potential allied faction.</param>
/// <returns>True if factions are allied, otherwise false.</returns>
public static bool IsAlly(ref FactionData firstFaction, ref FactionData secondFaction)
{
return firstFaction.ally1 == secondFaction.id || firstFaction.ally2 == secondFaction.id ||
firstFaction.ally3 == secondFaction.id;
}
/// <summary>
/// Check if a faction is another faction enemy.
/// </summary>
/// <param name="firstFaction">The faction to check the enemies of.</param>
/// <param name="secondFaction">The potential enemy faction.</param>
/// <returns></returns>
public static bool IsEnemy(ref FactionData firstFaction, ref FactionData secondFaction)
{
return firstFaction.enemy1 == secondFaction.id || firstFaction.enemy2 == secondFaction.id ||
firstFaction.enemy3 == secondFaction.id;
}
#endregion
#region Private Methods
void ParseFactions(string txt)
{
// Unmodded faction.txt contains multiples of same id
// This resolver counter is used to give a faction a unique id if needed
int resolverId = 980;
// Clear existing dictionary
factionDict.Clear();
// First pass reads each faction text block in order
List<string[]> factionBlocks = new List<string[]>();
using (StringReader reader = new StringReader(txt))
{
List<string> currentblock = new List<string>();
while (true)
{
// Handle end of file
string line = reader.ReadLine();
if (line == null)
{
// Store final block
if (currentblock.Count > 0)
factionBlocks.Add(currentblock.ToArray());
break;
}
// Ignore comment lines and empty lines
if (line.StartsWith(";") || string.IsNullOrEmpty(line))
continue;
// All factions blocks start with a '#' character
if (line.Contains("#"))
{
// Store current block
if (currentblock.Count > 0)
factionBlocks.Add(currentblock.ToArray());
// Start new block
currentblock.Clear();
}
// Add line to current faction block
currentblock.Add(line);
}
}
// Second pass parses the text block into FactionData
int lastPrecedingTabs = 0;
FactionData previousFaction = new FactionData();
Stack<int> parentStack = new Stack<int>();
for (int i = 0; i < factionBlocks.Count; i++)
{
// Start a new faction
FactionData faction = new FactionData();
string[] block = factionBlocks[i];
// Parent child relationship determined by preceding tabs
int precedingTabs = CountPrecedingTabs(block[0]);
if (precedingTabs > lastPrecedingTabs)
{
parentStack.Push(previousFaction.id);
}
else if (precedingTabs < lastPrecedingTabs)
{
while (parentStack.Count > precedingTabs)
parentStack.Pop();
}
lastPrecedingTabs = precedingTabs;
// Set parent from top of stack
if (parentStack.Count > 0)
faction.parent = parentStack.Peek();
// Parse faction block
ParseFactionData(ref block, ref faction);
// Store faction just read
if (!factionDict.ContainsKey(faction.id))
{
factionDict.Add(faction.id, faction);
}
else
{