-
-
Notifications
You must be signed in to change notification settings - Fork 991
/
types.cpp
1320 lines (1139 loc) · 39.3 KB
/
types.cpp
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
/*
Copyright (C) 2003 - 2016 by David White <dave@whitevine.net>
Part of the Battle for Wesnoth Project http://www.wesnoth.org/
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 2 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.
See the COPYING file for more details.
*/
/**
* @file
* Handle unit-type specific attributes, animations, advancement.
*/
#include "global.hpp"
#include "units/types.hpp"
#include "game_config.hpp"
#include "game_errors.hpp" //thrown sometimes
//#include "gettext.hpp"
#include "log.hpp"
#include "utils/make_enum.hpp"
#include "units/unit.hpp"
#include "units/abilities.hpp"
#include "units/animation.hpp"
#include "util.hpp"
#include "gui/auxiliary/formula.hpp"
#include "gui/dialogs/loadscreen.hpp"
#include <boost/foreach.hpp>
#include <boost/static_assert.hpp>
#include <boost/regex.hpp>
static lg::log_domain log_config("config");
#define ERR_CF LOG_STREAM(err, log_config)
#define WRN_CF LOG_STREAM(warn, log_config)
#define LOG_CONFIG LOG_STREAM(info, log_config)
#define DBG_CF LOG_STREAM(debug, log_config)
static lg::log_domain log_unit("unit");
#define DBG_UT LOG_STREAM(debug, log_unit)
#define ERR_UT LOG_STREAM(err, log_unit)
/* ** unit_type ** */
unit_type::unit_type(const unit_type& o) :
cfg_(o.cfg_),
unit_cfg_(), // Not copied; will be re-created if needed.
built_unit_cfg_(false),
id_(o.id_),
debug_id_(o.debug_id_),
base_id_(o.base_id_),
type_name_(o.type_name_),
description_(o.description_),
hitpoints_(o.hitpoints_),
hp_bar_scaling_(o.hp_bar_scaling_),
xp_bar_scaling_(o.xp_bar_scaling_),
level_(o.level_),
recall_cost_(o.recall_cost_),
movement_(o.movement_),
vision_(o.vision_),
jamming_(o.jamming_),
max_attacks_(o.max_attacks_),
cost_(o.cost_),
usage_(o.usage_),
undead_variation_(o.undead_variation_),
image_(o.image_),
icon_(o.icon_),
small_profile_(o.small_profile_),
profile_(o.profile_),
flag_rgb_(o.flag_rgb_),
num_traits_(o.num_traits_),
variations_(o.variations_),
default_variation_(o.default_variation_),
race_(o.race_),
alpha_(o.alpha_),
abilities_(o.abilities_),
adv_abilities_(o.adv_abilities_),
ability_tooltips_(o.ability_tooltips_),
adv_ability_tooltips_(o.adv_ability_tooltips_),
zoc_(o.zoc_),
hide_help_(o.hide_help_),
do_not_list_(o.do_not_list_),
advances_to_(o.advances_to_),
experience_needed_(o.experience_needed_),
in_advancefrom_(o.in_advancefrom_),
alignment_(o.alignment_),
movement_type_(o.movement_type_),
possible_traits_(o.possible_traits_),
genders_(o.genders_),
animations_(o.animations_),
build_status_(o.build_status_)
{
gender_types_[0] = o.gender_types_[0] != NULL ? new unit_type(*o.gender_types_[0]) : NULL;
gender_types_[1] = o.gender_types_[1] != NULL ? new unit_type(*o.gender_types_[1]) : NULL;
for(variations_map::const_iterator i = o.variations_.begin(); i != o.variations_.end(); ++i) {
variations_[i->first] = new unit_type(*i->second);
}
}
unit_type::unit_type(const config &cfg, const std::string & parent_id) :
cfg_(cfg),
unit_cfg_(),
built_unit_cfg_(false),
id_(cfg_.has_attribute("id") ? cfg_["id"].str() : parent_id),
debug_id_(),
base_id_(!parent_id.empty() ? parent_id : id_),
type_name_(cfg_["name"].t_str()),
description_(),
hitpoints_(0),
hp_bar_scaling_(0.0),
xp_bar_scaling_(0.0),
level_(0),
recall_cost_(),
movement_(0),
vision_(-1),
jamming_(0),
max_attacks_(0),
cost_(0),
usage_(),
undead_variation_(),
image_(cfg_["image"].str()),
icon_(),
small_profile_(),
profile_(),
flag_rgb_(cfg_["flag_rgb"].str()),
num_traits_(0),
gender_types_(),
variations_(),
default_variation_(cfg_["variation"]),
variation_name_(cfg_["variation_name"].t_str()),
race_(&unit_race::null_race),
alpha_(ftofxp(1.0)),
abilities_(),
adv_abilities_(),
ability_tooltips_(),
adv_ability_tooltips_(),
zoc_(false),
hide_help_(false),
do_not_list_(cfg_["do_not_list"].to_bool(false)),
advances_to_(),
experience_needed_(0),
in_advancefrom_(false),
alignment_(unit_type::ALIGNMENT::NEUTRAL),
movement_type_(),
possible_traits_(),
genders_(),
animations_(),
build_status_(NOT_BUILT)
{
gender_types_[0] = NULL;
gender_types_[1] = NULL;
}
unit_type::~unit_type()
{
delete gender_types_[0];
delete gender_types_[1];
for(variations_map::iterator i = variations_.begin(); i != variations_.end(); ++i) {
delete i->second;
}
}
/**
* Load data into an empty unit_type (build to FULL).
*/
void unit_type::build_full(const movement_type_map &mv_types,
const race_map &races, const config::const_child_itors &traits)
{
// Don't build twice.
if ( FULL <= build_status_ )
return;
// Make sure we are built to the preceding build level.
build_help_index(mv_types, races, traits);
for (int i = 0; i < 2; ++i) {
if (gender_types_[i])
gender_types_[i]->build_full(mv_types, races, traits);
}
if ( race_ != &unit_race::null_race )
{
if (!race_->uses_global_traits()) {
possible_traits_.clear();
}
if ( cfg_["ignore_race_traits"].to_bool() ) {
possible_traits_.clear();
} else {
BOOST_FOREACH(const config &t, race_->additional_traits())
{
if (alignment_ != unit_type::ALIGNMENT::NEUTRAL || t["id"] != "fearless")
possible_traits_.add_child("trait", t);
}
}
if (undead_variation_.empty()) {
undead_variation_ = race_->undead_variation();
}
}
// Insert any traits that are just for this unit type
BOOST_FOREACH(const config &trait, cfg_.child_range("trait"))
{
possible_traits_.add_child("trait", trait);
}
zoc_ = cfg_["zoc"].to_bool(level_ > 0);
const config::attribute_value & alpha_blend = cfg_["alpha"];
if(alpha_blend.empty() == false) {
alpha_ = ftofxp(alpha_blend.to_double());
}
game_config::add_color_info(cfg_);
hp_bar_scaling_ = cfg_["hp_bar_scaling"].to_double(game_config::hp_bar_scaling);
xp_bar_scaling_ = cfg_["xp_bar_scaling"].to_double(game_config::xp_bar_scaling);
// Propagate the build to the variations.
BOOST_FOREACH(variations_map::value_type & variation, variations_) {
variation.second->build_full(mv_types, races, traits);
}
// Deprecation messages, only seen when unit is parsed for the first time.
build_status_ = FULL;
}
/**
* Partially load data into an empty unit_type (build to HELP_INDEXED).
*/
void unit_type::build_help_index(const movement_type_map &mv_types,
const race_map &races, const config::const_child_itors &traits)
{
// Don't build twice.
if ( HELP_INDEXED <= build_status_ )
return;
// Make sure we are built to the preceding build level.
build_created(mv_types, races, traits);
type_name_ = cfg_["name"];
description_ = cfg_["description"];
hitpoints_ = cfg_["hitpoints"].to_int(1);
level_ = cfg_["level"];
recall_cost_ = cfg_["recall_cost"].to_int(-1);
movement_ = cfg_["movement"].to_int(1);
vision_ = cfg_["vision"].to_int(-1);
jamming_ = cfg_["jamming"].to_int(0);
max_attacks_ = cfg_["attacks"].to_int(1);
cost_ = cfg_["cost"].to_int(1);
usage_ = cfg_["usage"].str();
undead_variation_ = cfg_["undead_variation"].str();
image_ = cfg_["image"].str();
icon_ = cfg_["image_icon"].str();
small_profile_ = cfg_["small_profile"].str();
profile_ = cfg_["profile"].str();
adjust_profile(profile_);
alignment_ = unit_type::ALIGNMENT::NEUTRAL;
alignment_.parse(cfg_["alignment"].str());
for (int i = 0; i < 2; ++i) {
if (gender_types_[i])
gender_types_[i]->build_help_index(mv_types, races, traits);
}
const race_map::const_iterator race_it = races.find(cfg_["race"]);
if(race_it != races.end()) {
race_ = &race_it->second;
} else {
race_ = &unit_race::null_race;
}
// if num_traits is not defined, we use the num_traits from race
num_traits_ = cfg_["num_traits"].to_int(race_->num_traits());
const std::vector<std::string> genders = utils::split(cfg_["gender"]);
for(std::vector<std::string>::const_iterator g = genders.begin(); g != genders.end(); ++g) {
genders_.push_back(string_gender(*g));
}
// For simplicity in other parts of the code, we must have at least one gender.
if(genders_.empty()) {
genders_.push_back(unit_race::MALE);
}
if (const config &abil_cfg = cfg_.child("abilities"))
{
BOOST_FOREACH(const config::any_child &ab, abil_cfg.all_children_range()) {
const config::attribute_value &name = ab.cfg["name"];
if (!name.empty()) {
abilities_.push_back(name.t_str());
ability_tooltips_.push_back( ab.cfg["description"].t_str() );
}
}
}
BOOST_FOREACH(const config &adv, cfg_.child_range("advancement"))
{
BOOST_FOREACH(const config &effect, adv.child_range("effect"))
{
const config &abil_cfg = effect.child("abilities");
if (!abil_cfg || effect["apply_to"] != "new_ability") {
continue;
}
BOOST_FOREACH(const config::any_child &ab, abil_cfg.all_children_range()) {
const config::attribute_value &name = ab.cfg["name"];
if (!name.empty()) {
adv_abilities_.push_back(name.t_str());
adv_ability_tooltips_.push_back( ab.cfg["description"].t_str() );
}
}
}
}
// Set the movement type.
const std::string move_type = cfg_["movement_type"];
const movement_type_map::const_iterator find_it = mv_types.find(move_type);
if ( find_it != mv_types.end() ) {
DBG_UT << "inheriting from movement_type '" << move_type << "'\n";
movement_type_ = find_it->second;
}
else if ( !move_type.empty() ) {
DBG_UT << "movement_type '" << move_type << "' not found\n";
}
// Override parts of the movement type with what is in our config.
movement_type_.merge(cfg_);
BOOST_FOREACH(const config &t, traits)
{
possible_traits_.add_child("trait", t);
}
BOOST_FOREACH(const config &var_cfg, cfg_.child_range("variation"))
{
const std::string& var_id = var_cfg["variation_id"].empty() ?
var_cfg["variation_name"] : var_cfg["variation_id"];
unit_type *ut = new unit_type(var_cfg, id_);
ut->debug_id_ = debug_id_ + " [" + var_id + "]";
ut->base_id_ = base_id_; // In case this is not id_.
ut->build_help_index(mv_types, races, traits);
variations_.insert(std::make_pair(var_id, ut));
}
hide_help_= cfg_["hide_help"].to_bool();
build_status_ = HELP_INDEXED;
}
/**
* Load the most needed data into an empty unit_type (build to CREATE).
* This creates the gender-specific types (if needed) and also defines how much
* experience is needed to advance as well as what this advances to.
*/
void unit_type::build_created(const movement_type_map &mv_types,
const race_map &races, const config::const_child_itors &traits)
{
// Don't build twice.
if ( CREATED <= build_status_ )
return;
// There is no preceding build level (other than being constructed).
// These should still be NULL from the constructor.
assert(gender_types_[0] == NULL);
assert(gender_types_[1] == NULL);
if ( const config &male_cfg = cfg_.child("male") ) {
gender_types_[0] = new unit_type(male_cfg, id_);
gender_types_[0]->debug_id_ = debug_id_ + " (male)";
}
if ( const config &female_cfg = cfg_.child("female") ) {
gender_types_[1] = new unit_type(female_cfg, id_);
gender_types_[1]->debug_id_ = debug_id_ + " (female)";
}
for (int i = 0; i < 2; ++i) {
if (gender_types_[i])
gender_types_[i]->build_created(mv_types, races, traits);
}
const std::string& advances_to_val = cfg_["advances_to"];
if(advances_to_val != "null" && advances_to_val != "")
advances_to_ = utils::split(advances_to_val);
DBG_UT << "unit_type '" << log_id() << "' advances to : " << advances_to_val << "\n";
experience_needed_ = cfg_["experience"].to_int(500);
build_status_ = CREATED;
}
/**
* Performs a build of this to the indicated stage.
*/
void unit_type::build(BUILD_STATUS status, const movement_type_map &movement_types,
const race_map &races, const config::const_child_itors &traits)
{
DBG_UT << "Building unit type " << log_id() << ", level " << status << '\n';
switch (status) {
case NOT_BUILT:
// Already done in the constructor.
return;
case CREATED:
// Build the basic data.
build_created(movement_types, races, traits);
return;
case VARIATIONS: // Implemented as part of HELP_INDEXED
case HELP_INDEXED:
// Build the data needed to feed the help index.
build_help_index(movement_types, races, traits);
return;
case FULL:
build_full(movement_types, races, traits);
return;
default:
ERR_UT << "Build of unit_type to unrecognized status (" << status << ") requested." << std::endl;
// Build as much as possible.
build_full(movement_types, races, traits);
return;
}
}
const unit_type& unit_type::get_gender_unit_type(std::string gender) const
{
if (gender == unit_race::s_female) return get_gender_unit_type(unit_race::FEMALE);
else if (gender == unit_race::s_male) return get_gender_unit_type(unit_race::MALE);
else return *this;
}
const unit_type& unit_type::get_gender_unit_type(unit_race::GENDER gender) const
{
const size_t i = gender;
if(i < sizeof(gender_types_)/sizeof(*gender_types_)
&& gender_types_[i] != NULL) {
return *gender_types_[i];
}
return *this;
}
const unit_type& unit_type::get_variation(const std::string& id) const
{
const variations_map::const_iterator i = variations_.find(id);
if(i != variations_.end()) {
return *i->second;
} else {
return *this;
}
}
t_string unit_type::unit_description() const
{
if(description_.empty()) {
return (_("No description available."));
} else {
return description_;
}
}
const std::vector<unit_animation>& unit_type::animations() const {
if (animations_.empty()) {
unit_animation::fill_initial_animations(animations_,cfg_);
}
return animations_;
}
std::vector<attack_type> unit_type::attacks() const
{
std::vector<attack_type> res;
BOOST_FOREACH(const config &att, cfg_.child_range("attack")) {
res.push_back(attack_type(att));
}
return res;
}
namespace {
int experience_modifier = 100;
}
unit_experience_accelerator::unit_experience_accelerator(int modifier) : old_value_(experience_modifier)
{
experience_modifier = modifier;
}
unit_experience_accelerator::~unit_experience_accelerator()
{
experience_modifier = old_value_;
}
int unit_experience_accelerator::get_acceleration()
{
return experience_modifier;
}
int unit_type::experience_needed(bool with_acceleration) const
{
if(with_acceleration) {
int exp = (experience_needed_ * experience_modifier + 50) /100;
if(exp < 1) exp = 1;
return exp;
}
return experience_needed_;
}
/*
const char* unit_type::alignment_description(unit_type::ALIGNMENT align, unit_race::GENDER gender)
{
static const char* aligns[] = { N_("lawful"), N_("neutral"), N_("chaotic"), N_("liminal") };
static const char* aligns_female[] = { N_("female^lawful"), N_("female^neutral"), N_("female^chaotic"), N_("female^liminal") };
const char** tlist = (gender == unit_race::MALE ? aligns : aligns_female);
return (translation::sgettext(tlist[align]));
}*/
bool unit_type::has_ability_by_id(const std::string& ability) const
{
if (const config &abil = cfg_.child("abilities"))
{
BOOST_FOREACH(const config::any_child &ab, abil.all_children_range()) {
if (ab.cfg["id"] == ability)
return true;
}
}
return false;
}
std::vector<std::string> unit_type::get_ability_list() const
{
std::vector<std::string> res;
const config &abilities = cfg_.child("abilities");
if (!abilities) return res;
BOOST_FOREACH(const config::any_child &ab, abilities.all_children_range()) {
const std::string &id = ab.cfg["id"];
if (!id.empty())
res.push_back(id);
}
return res;
}
bool unit_type::hide_help() const {
return hide_help_ || unit_types.hide_help(id_, race_->id());
}
void unit_type::add_advancement(const unit_type &to_unit,int xp)
{
const std::string &to_id = to_unit.id_;
// Add extra advancement path to this unit type
LOG_CONFIG << "adding advancement from " << log_id() << " to " << to_unit.log_id() << "\n";
if(std::find(advances_to_.begin(), advances_to_.end(), to_id) == advances_to_.end()) {
advances_to_.push_back(to_id);
} else {
LOG_CONFIG << "advancement from " << log_id() << " to "
<< to_unit.log_id() << " already known, ignoring.\n";
return;
}
if(xp > 0) {
//xp is 0 in case experience= wasn't given.
if(!in_advancefrom_) {
//This function is called for and only for an [advancefrom] tag in a unit_type referencing this unit_type.
in_advancefrom_ = true;
experience_needed_ = xp;
DBG_UT << "Changing experience_needed from " << experience_needed_
<< " to " << xp << " due to (first) [advancefrom] of "
<< to_unit.log_id() << "\n";
}
else if(experience_needed_ > xp) {
experience_needed_ = xp;
DBG_UT << "Lowering experience_needed from " << experience_needed_
<< " to " << xp << " due to (multiple, lower) [advancefrom] of "
<< to_unit.log_id() << "\n";
}
else
DBG_UT << "Ignoring experience_needed change from " << experience_needed_
<< " to " << xp << " due to (multiple, higher) [advancefrom] of "
<< to_unit.log_id() << "\n";
}
// Add advancements to gendered subtypes, if supported by to_unit
for(int gender=0; gender<=1; ++gender) {
if(gender_types_[gender] == NULL) continue;
if(to_unit.gender_types_[gender] == NULL) {
WRN_CF << to_unit.log_id() << " does not support gender " << gender << std::endl;
continue;
}
LOG_CONFIG << "gendered advancement " << gender << ": ";
gender_types_[gender]->add_advancement(*(to_unit.gender_types_[gender]),xp);
}
if ( cfg_.has_child("variation") ) {
// Make sure the variations are created.
unit_types.build_unit_type(*this, VARIATIONS);
// Add advancements to variation subtypes.
// Since these are still a rare and special-purpose feature,
// we assume that the unit designer knows what they're doing,
// and don't block advancements that would remove a variation.
for(variations_map::iterator v=variations_.begin();
v!=variations_.end(); ++v) {
LOG_CONFIG << "variation advancement: ";
v->second->add_advancement(to_unit,xp);
}
}
}
static void advancement_tree_internal(const std::string& id, std::set<std::string>& tree)
{
const unit_type *ut = unit_types.find(id);
if (!ut)
return;
BOOST_FOREACH(const std::string& adv, ut->advances_to()) {
if (tree.insert(adv).second) {
// insertion succeed, expand the new type
advancement_tree_internal(adv, tree);
}
}
}
std::set<std::string> unit_type::advancement_tree() const
{
std::set<std::string> tree;
advancement_tree_internal(id_, tree);
return tree;
}
const std::vector<std::string> unit_type::advances_from() const
{
// currently not needed (only help call us and already did it)
unit_types.build_all(unit_type::HELP_INDEXED);
std::vector<std::string> adv_from;
BOOST_FOREACH(const unit_type_data::unit_type_map::value_type &ut, unit_types.types())
{
BOOST_FOREACH(const std::string& adv, ut.second.advances_to()) {
if (adv == id_)
adv_from.push_back(ut.second.id());
}
}
return adv_from;
}
// This function is only meant to return the likely state a given status
// for a new recruit of this type. It should not be used to check if
// a particular unit has it, use get_state(status_name) for that.
bool unit_type::musthave_status(const std::string& status_name) const
{
// Statuses default to absent.
bool current_status = false;
// Look at all of the "musthave" traits to see if the
// status gets changed. In the unlikely event it gets changed
// multiple times, we want to try to do it in the same order
// that unit::apply_modifications does things.
BOOST_FOREACH(const config &mod, possible_traits())
{
if (mod["availability"] != "musthave")
continue;
BOOST_FOREACH(const config &effect, mod.child_range("effect"))
{
// See if the effect only applies to
// certain unit types But don't worry
// about gender checks, since we don't
// know what the gender of the
// hypothetical recruit is.
const std::string &ut = effect["unit_type"];
if (!ut.empty()) {
const std::vector<std::string> &types = utils::split(ut);
if(std::find(types.begin(), types.end(), id()) == types.end())
continue;
}
// We're only interested in status changes.
if (effect["apply_to"] != "status") {
continue;
}
if (effect["add"] == status_name) {
current_status = true;
}
if (effect["remove"] == status_name) {
current_status = false;
}
}
}
return current_status;
}
bool unit_type::has_random_traits() const
{
if (num_traits() == 0) return false;
config::const_child_itors t = possible_traits();
while(t.first != t.second) {
const config::attribute_value& availability = (*t.first)["availability"];
if(availability.blank()) return true;
if(strcmp(availability.str().c_str(), "musthave") != 0) return true;
++t.first;
}
return false;
}
std::vector<std::string> unit_type::variations() const
{
std::vector<std::string> retval;
retval.reserve(variations_.size());
BOOST_FOREACH(const variations_map::value_type &val, variations_) {
retval.push_back(val.first);
}
return retval;
}
bool unit_type::has_variation(const std::string& variation_id) const
{
return variations_.find(variation_id) != variations_.end();
}
bool unit_type::show_variations_in_help() const
{
BOOST_FOREACH(const variations_map::value_type &val, variations_) {
assert(val.second != NULL);
if (!val.second->hide_help()) {
return true;
}
}
return false;
}
/**
* Generates (and returns) a trimmed config suitable for use with units.
*/
const config & unit_type::build_unit_cfg() const
{
// We start with all attributes.
assert(unit_cfg_.empty());
unit_cfg_.append_attributes(cfg_);
// Remove "pure" unit_type attributes (attributes that do not get directly
// copied to units; some do get copied, but under different keys).
static char const *unit_type_attrs[] = { "attacks", "base_ids", "die_sound",
"experience", "flies", "healed_sound", "hide_help", "hitpoints",
"id", "ignore_race_traits", "inherit", "movement", "movement_type",
"name", "num_traits", "variation_id", "variation_name", "recall_cost",
"cost", "level", "gender", "flag_rgb", "alignment", "advances_to", "do_not_list"
};
BOOST_FOREACH(const char *attr, unit_type_attrs) {
unit_cfg_.remove_attribute(attr);
}
built_unit_cfg_ = true;
return unit_cfg_;
}
int unit_type::resistance_against(const std::string& damage_name, bool attacker) const
{
int resistance = movement_type_.resistance_against(damage_name);
unit_ability_list resistance_abilities;
if (const config &abilities = cfg_.child("abilities")) {
BOOST_FOREACH(const config& cfg, abilities.child_range("resistance")) {
if (!cfg["affect_self"].to_bool(true)) {
continue;
}
if (!resistance_filter_matches(cfg, attacker, damage_name, 100 - resistance)) {
continue;
}
resistance_abilities.push_back(unit_ability(&cfg, map_location::null_location()));
}
}
if (!resistance_abilities.empty()) {
unit_abilities::effect resist_effect(resistance_abilities, 100 - resistance, false);
resistance = 100 - std::min<int>(resist_effect.get_composite_value(),
resistance_abilities.highest("max_value").first);
}
return resistance;
}
bool unit_type::resistance_filter_matches(const config& cfg, bool attacker, const std::string& damage_name, int res) const
{
if(!(cfg["active_on"].empty() || (attacker && cfg["active_on"]=="offense") || (!attacker && cfg["active_on"]=="defense"))) {
return false;
}
const std::string& apply_to = cfg["apply_to"];
if(!apply_to.empty()) {
if(damage_name != apply_to) {
if ( apply_to.find(',') != std::string::npos &&
apply_to.find(damage_name) != std::string::npos ) {
const std::vector<std::string>& vals = utils::split(apply_to);
if(std::find(vals.begin(),vals.end(),damage_name) == vals.end()) {
return false;
}
} else {
return false;
}
}
}
if (!unit_abilities::filter_base_matches(cfg, res)) return false;
return true;
}
/** Implementation detail of unit_type::alignment_description */
MAKE_ENUM (ALIGNMENT_FEMALE_VARIATION,
(LAWFUL, N_("female^lawful"))
(FEMALE_NEUTRAL, N_("female^neutral"))
(CHAOTIC, N_("female^chaotic"))
(LIMINAL, N_("female^liminal"))
)
std::string unit_type::alignment_description(ALIGNMENT align, unit_race::GENDER gender)
{
BOOST_STATIC_ASSERT(ALIGNMENT_FEMALE_VARIATION::count == ALIGNMENT::count);
assert(align.valid());
std::string str = std::string();
if (gender == unit_race::FEMALE) {
ALIGNMENT_FEMALE_VARIATION fem = align.cast<ALIGNMENT_FEMALE_VARIATION::type>();
str = lexical_cast<std::string>(fem);
} else {
str = lexical_cast<std::string>(align);
}
return translation::sgettext(str.c_str());
}
/* ** unit_type_data ** */
unit_type_data::unit_type_data() :
types_(),
movement_types_(),
races_(),
hide_help_all_(false),
hide_help_type_(),
hide_help_race_(),
unit_cfg_(NULL),
build_status_(unit_type::NOT_BUILT)
{
}
namespace { // Helpers for set_config()
/**
* Spits out an error message and throws a config::error.
* Called when apply_base_unit() detects a cycle.
* (This exists merely to take the error message out of that function.)
*/
void throw_base_unit_recursion_error(
const std::vector<std::string> & base_tree, const std::string & base_id)
{
std::stringstream ss;
ss << "[base_unit] recursion loop in [unit_type] ";
BOOST_FOREACH(const std::string &step, base_tree)
ss << step << "->";
ss << base_id;
ERR_CF << ss.str() << '\n';
throw config::error(ss.str());
}
/**
* Locates the config for the unit type with id= @a key within @a all_types.
* Throws a config::error if the unit type cannot be found.
*/
config & find_unit_type_config(const std::string & key, config & all_types)
{
config & cfg = all_types.find_child("unit_type", "id", key);
if ( cfg )
return cfg;
// Bad WML!
ERR_CF << "unit type not found: " << key << std::endl;
ERR_CF << all_types << std::endl;
throw config::error("unit type not found: " + key);
}
/**
* Modifies the provided config by merging all base units into it.
* The @a base_tree parameter is used solely for detecting and reporting
* cycles of base units; it is no longer needed to prevent infinite loops.
*/
void apply_base_unit(config & ut_cfg, config & all_types,
std::vector<std::string> &base_tree)
{
// Get a list of base units to apply.
std::vector<std::string> base_ids;
BOOST_FOREACH (config & base, ut_cfg.child_range("base_unit") )
base_ids.push_back(base["id"]);
if ( base_ids.empty() )
// Nothing to do.
return;
// Store the base ids for the help system.
ut_cfg["base_ids"] = utils::join(base_ids);
// Clear the base units (otherwise they could interfere with the merge).
// This has the side-effect of breaking cycles, hence base_tree is
// merely for error detection, not error recovery.
ut_cfg.clear_children("base_unit");
// Merge the base units, in order.
BOOST_FOREACH(const std::string & base_id, base_ids) {
// Detect recursion so the WML author is made aware of an error.
if ( std::find(base_tree.begin(), base_tree.end(), base_id) != base_tree.end() )
throw_base_unit_recursion_error(base_tree, base_id);
// Find the base unit.
config & base_cfg = find_unit_type_config(base_id, all_types);
// Make sure the base unit has had its base units accounted for.
base_tree.push_back(base_id);
apply_base_unit(base_cfg, all_types, base_tree);
base_tree.pop_back();
// Merge the base unit "under" our config.
ut_cfg.inherit_from(base_cfg);
}
}
/**
* Handles inheritance for configs of [male], [female], and [variation].
* Also removes gendered children, as those serve no purpose.
* @a default_inherit is the default value for inherit=.
*/
void fill_unit_sub_type(config & var_cfg, const config & parent,
bool default_inherit)
{
if ( var_cfg["inherit"].to_bool(default_inherit) ) {
var_cfg.inherit_from(parent);
}
var_cfg.clear_children("male");
var_cfg.clear_children("female");
}
/**
* Processes [variation] tags of @a ut_cfg, handling inheritance and
* child clearing.
*/
void handle_variations(config & ut_cfg)
{
// Most unit types do not have variations.
if ( !ut_cfg.has_child("variation") )
return;
// Pull the variations out of the base unit type.
config variations;
variations.splice_children(ut_cfg, "variation");
// Handle each variation's inheritance.
BOOST_FOREACH (config &var_cfg, variations.child_range("variation"))
fill_unit_sub_type(var_cfg, ut_cfg, false);
// Restore the variations.
ut_cfg.splice_children(variations, "variation");
}
const boost::regex fai_identifier("[a-zA-Z_]+");
template<typename MoveT>
void patch_movetype(MoveT& mt, const std::string& new_key, const std::string& formula_str, int default_val, bool replace) {
config temp_cfg, original_cfg;
mt.write(original_cfg);
if (!replace && !original_cfg[new_key].blank()) {
// Don't replace if the key already exists in the config (even if empty).
return;
}
gui2::tformula<int> formula(formula_str);
game_logic::map_formula_callable original;
boost::sregex_iterator m(formula_str.begin(), formula_str.end(), fai_identifier);
BOOST_FOREACH(const boost::sregex_iterator::value_type& p, std::make_pair(m, boost::sregex_iterator())) {
const std::string var_name = p.str();
variant val(original_cfg[var_name].to_int(default_val));
original.add(var_name, val);
}
temp_cfg[new_key] = formula(original);
mt.merge(temp_cfg, true);
}
}// unnamed namespace
/**