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 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460
|
#include "ServerWrapper.h"
#include "ServerApp.h"
#include "UniverseGenerator.h"
#include "../universe/Condition.h"
#include "../universe/ScriptingContext.h"
#include "../universe/Species.h"
#include "../universe/Special.h"
#include "../universe/System.h"
#include "../universe/Planet.h"
#include "../universe/Building.h"
#include "../universe/BuildingType.h"
#include "../universe/Fleet.h"
#include "../universe/FleetPlan.h"
#include "../universe/Ship.h"
#include "../universe/ShipDesign.h"
#include "../universe/Field.h"
#include "../universe/FieldType.h"
#include "../universe/Tech.h"
#include "../universe/Pathfinder.h"
#include "../universe/Universe.h"
#include "../universe/UnlockableItem.h"
#include "../universe/ValueRef.h"
#include "../util/Directories.h"
#include "../util/Logger.h"
#include "../util/Random.h"
#include "../util/i18n.h"
#include "../util/OptionsDB.h"
#include "../util/SitRepEntry.h"
#include "../Empire/Empire.h"
#include "../Empire/EmpireManager.h"
#include "../python/SetWrapper.h"
#include "../python/CommonWrappers.h"
#include <vector>
#include <map>
#include <string>
#include <utility>
#include <boost/python.hpp>
#include <boost/python/list.hpp>
#include <boost/python/tuple.hpp>
#include <boost/python/extract.hpp>
#include <boost/python/stl_iterator.hpp>
#include <boost/date_time/posix_time/time_formatters.hpp>
#ifdef FREEORION_MACOSX
#include <sys/param.h>
#endif
namespace py = boost::python;
// Helper stuff (classes, functions etc.) exposed to the
// server side Python scripts
namespace {
// Wrapper for getting empire objects
auto GetAllEmpires() -> py::list
{
const ScriptingContext context;
py::list empire_list;
for (const auto id : context.EmpireIDs())
empire_list.append(id);
return empire_list;
}
// Wrappers for generating sitrep messages
void GenerateSitRep(int empire_id, const std::string& template_string,
const py::dict& py_params, const std::string& icon)
{
ScriptingContext context;
int sitrep_turn = context.current_turn + 1;
std::vector<std::pair<std::string, std::string>> params;
if (py_params) {
params.reserve(len(py_params));
for (int i = 0; i < len(py_params); i++) {
std::string k = py::extract<std::string>(py_params.keys()[i]);
std::string v = py::extract<std::string>(py_params.values()[i]);
params.emplace_back(std::move(k), std::move(v));
}
}
if (empire_id == ALL_EMPIRES) {
for (const auto& empire : context.Empires() | range_values) {
empire->AddSitRepEntry(CreateSitRep(
template_string, sitrep_turn, icon, params)); // copy params for each...
}
} else {
auto empire = context.GetEmpire(empire_id);
if (!empire) {
ErrorLogger() << "GenerateSitRep: couldn't get empire with ID " << empire_id;
return;
}
empire->AddSitRepEntry(CreateSitRep(template_string, sitrep_turn, icon,
std::move(params)));
}
}
// Wrappers for Species / SpeciesManager class (member) functions
auto SpeciesDefaultFocus(const std::string& species_name) -> py::object
{
const ScriptingContext context;
const Species* species = context.species.GetSpecies(species_name);
if (!species) {
ErrorLogger() << "SpeciesDefaultFocus: couldn't get species " << species_name;
return py::object("");
}
return py::object(species->DefaultFocus());
}
auto SpeciesGetPlanetEnvironment(const std::string& species_name, PlanetType planet_type) -> PlanetEnvironment
{
const ScriptingContext context;
const Species* species = context.species.GetSpecies(species_name);
if (!species) {
ErrorLogger() << "SpeciesGetPlanetEnvironment: couldn't get species " << species_name;
return PlanetEnvironment::INVALID_PLANET_ENVIRONMENT;
}
return species->GetPlanetEnvironment(planet_type);
}
void SpeciesAddHomeworld(const std::string& species_name, int homeworld_id)
{
const ScriptingContext context;
const Species* species = context.species.GetSpecies(species_name);
if (!species) {
ErrorLogger() << "SpeciesAddHomeworld: couldn't get species " << species_name;
return;
}
GetSpeciesManager().AddSpeciesHomeworld(species_name, homeworld_id);
}
void SpeciesRemoveHomeworld(const std::string& species_name, int homeworld_id)
{
const ScriptingContext context;
const Species* species = context.species.GetSpecies(species_name);
if (!species) {
ErrorLogger() << "SpeciesAddHomeworld: couldn't get species " << species_name;
return;
}
GetSpeciesManager().RemoveSpeciesHomeworld(species_name, homeworld_id);
}
auto SpeciesCanColonize(const std::string& species_name) -> bool
{
const ScriptingContext context;
const Species* species = context.species.GetSpecies(species_name);
if (!species) {
ErrorLogger() << "SpeciesCanColonize: couldn't get species " << species_name;
return false;
}
return species->CanColonize();
}
auto GetAllSpecies() -> py::list
{
py::list species_list;
const ScriptingContext context;
for (const auto& entry : context.species)
species_list.append(py::object(entry.first));
return species_list;
}
auto GetPlayableSpecies() -> py::list
{
py::list species_list;
const ScriptingContext context;
SpeciesManager& species_manager = context.species;
for (auto it = species_manager.playable_begin(); it != species_manager.playable_end(); ++it)
species_list.append(py::object(it->first)); // TODO: add GetPlayable() and use range for loop here
return species_list;
}
auto GetNativeSpecies() -> py::list
{
py::list species_list;
const ScriptingContext context;
SpeciesManager& species_manager = context.species;
for (auto it = species_manager.native_begin(); it != species_manager.native_end(); ++it)
species_list.append(py::object(it->first));
return species_list;
}
//Checks the condition against many objects at once.
//Checking many systems is more efficient because for example monster fleet plans
//typically uses WithinStarLaneJumps to exclude placement near empires.
auto FilterIDsWithCondition(const Condition::Condition* cond, const py::list& obj_ids) -> py::list
{
py::list permitted_ids;
if (!cond)
DebugLogger() << "FilterIDsWithCondition passed null condition";
Condition::ObjectSet objs;
py::stl_input_iterator<int> end;
for (py::stl_input_iterator<int> id(obj_ids); id != end; ++id) {
if (auto obj = Objects().getRaw(*id))
objs.push_back(obj);
else
ErrorLogger() << "FilterIDsWithCondition:: Passed an invalid universe object id " << *id;
}
if (objs.empty()) {
ErrorLogger() << "FilterIDsWithCondition:: Couldn't get any valid objects";
return permitted_ids;
}
Condition::ObjectSet permitted_objs;
// get location condition and evaluate it with the specified universe object
// if no location condition has been defined, all objects matches
if (cond && cond->SourceInvariant()) {
ScriptingContext context;
cond->Eval(context, permitted_objs, objs);
} else {
permitted_objs = std::move(objs);
}
for (auto &obj : permitted_objs)
permitted_ids.append(obj->ID());
return permitted_ids;
}
// Wrappers for Specials / SpecialManager functions
auto SpecialSpawnRate(const std::string special_name) -> double
{
const Special* special = GetSpecial(special_name);
if (!special) {
ErrorLogger() << "SpecialSpawnRate: couldn't get special " << special_name;
return 0.0;
}
return special->SpawnRate();
}
auto SpecialSpawnLimit(const std::string special_name) -> int
{
const Special* special = GetSpecial(special_name);
if (!special) {
ErrorLogger() << "SpecialSpawnLimit: couldn't get special " << special_name;
return 0;
}
return special->SpawnLimit();
}
auto SpecialLocations(const std::string special_name, const py::list& object_ids) -> py::list
{
// get special and check if it exists
const Special* special = GetSpecial(special_name);
if (!special) {
ErrorLogger() << "SpecialLocation: couldn't get special " << special_name;
return py::list();
}
return FilterIDsWithCondition(special->Location(), object_ids);
}
auto SpecialHasLocation(const std::string special_name) -> bool
{
// get special and check if it exists
const Special* special = GetSpecial(special_name);
if (!special) {
ErrorLogger() << "SpecialHasLocation: couldn't get special " << special_name;
return false;
}
return special->Location();
}
auto GetAllSpecials() -> py::list
{
py::list py_specials;
for (const auto& special_name : SpecialNames())
py_specials.append(py::object(std::string{special_name}));
return py_specials;
}
// Wrappers for Empire class member functions
void EmpireSetName(int empire_id, std::string name)
{
ScriptingContext context;
auto empire = context.GetEmpire(empire_id);
if (!empire) {
ErrorLogger() << "EmpireSetName: couldn't get empire with ID " << empire_id;
return;
}
empire->SetName(std::move(name));
}
auto EmpireSetHomeworld(int empire_id, int planet_id, const std::string& species_name) -> bool
{
ScriptingContext context;
auto empire = context.GetEmpire(empire_id);
if (!empire) {
ErrorLogger() << "EmpireSetHomeworld: couldn't get empire with ID " << empire_id;
return false;
}
return SetEmpireHomeworld(empire.get(), planet_id, species_name, context);
}
void EmpireUnlockItem(int empire_id, UnlockableItemType item_type,
const std::string& item_name)
{
ScriptingContext context;
auto empire = context.GetEmpire(empire_id);
if (!empire) {
ErrorLogger() << "EmpireUnlockItem: couldn't get empire with ID " << empire_id;
return;
}
auto item = UnlockableItem{item_type, item_name};
empire->UnlockItem(item, context.ContextUniverse(), context.current_turn);
}
void EmpireAddShipDesign(int empire_id, const std::string& design_name) {
ScriptingContext context;
auto empire = context.GetEmpire(empire_id);
if (!empire) {
ErrorLogger() << "EmpireAddShipDesign: couldn't get empire with ID " << empire_id;
return;
}
// check if a ship design with ID ship_design_id has been added to the universe
const ShipDesign* ship_design = context.ContextUniverse().GetGenericShipDesign(design_name);
if (!ship_design) {
ErrorLogger() << "EmpireAddShipDesign: no ship design with name " << design_name << " has been added to the universe";
return;
}
context.ContextUniverse().SetEmpireKnowledgeOfShipDesign(ship_design->ID(), empire_id);
empire->AddShipDesign(ship_design->ID(), context.ContextUniverse());
}
void EmpireSetStockpile(int empire_id, ResourceType resource_type, double value) {
ScriptingContext context;
auto empire = context.GetEmpire(empire_id);
if (!empire) {
ErrorLogger() << "EmpireSetStockpile: couldn't get empire with ID " << empire_id;
return;
}
try {
empire->SetResourceStockpile(resource_type, value);
} catch (...) {
ErrorLogger() << "EmpireSetStockpile: empire has no resource pool of type " << resource_type;
return;
}
}
void EmpireSetDiplomacy(int empire1_id, int empire2_id, DiplomaticStatus status)
{ ScriptingContext{}.Empires().SetDiplomaticStatus(empire1_id, empire2_id, status); }
// Wrapper for preunlocked items
auto LoadUnlockableItemList() -> py::list
{
py::list py_items;
for (const auto& item : ScriptingContext{}.ContextUniverse().InitiallyUnlockedItems())
py_items.append(py::object(item));
return py_items;
}
// Wrapper for starting buildings
auto LoadStartingBuildings() -> py::list
{
py::list py_items;
for (auto building : ScriptingContext{}.ContextUniverse().InitiallyUnlockedBuildings()) {
if (GetBuildingType(building.name))
py_items.append(py::object(building));
else
ErrorLogger() << "The item " << building.name << " in the starting building list is not a building.";
}
return py_items;
}
// Wrappers for ship designs and premade ship designs
auto ShipDesignCreate(const std::string& name, const std::string& description,
const std::string& hull, const py::list& py_parts,
const std::string& icon, const std::string& model,
bool monster) -> bool
{
ScriptingContext context;
Universe& universe = context.ContextUniverse();
// Check for empty name
if (name.empty()) {
ErrorLogger() << "CreateShipDesign: tried to create ship design without a name";
return false;
}
// check if a ship design with the same name has already been added to the universe
if (universe.GetGenericShipDesign(name)) {
ErrorLogger() << "CreateShipDesign: a ship design with the name " << name
<< " has already been added to the universe";
return false;
}
// copy parts list from Python list to C++ vector
std::vector<std::string> parts;
for (int i = 0; i < len(py_parts); i++)
parts.push_back(py::extract<std::string>(py_parts[i]));
// Create the design and add it to the universe
try {
ShipDesign design(std::invalid_argument(""), name, description, BEFORE_FIRST_TURN,
ALL_EMPIRES, hull, parts, icon, model, true, monster);
const auto new_id = universe.InsertShipDesign(design);
if (new_id == INVALID_DESIGN_ID) {
ErrorLogger() << "CreateShipDesign: couldn't insert ship design into universe";
return false;
}
} catch (const std::invalid_argument&) {
ErrorLogger() << "CreateShipDesign: invalid ship design";
return false;
}
return true;
}
auto ShipDesignGetPremadeList() -> py::list
{
py::list py_ship_designs;
for (const auto& design : GetPredefinedShipDesignManager().GetOrderedShipDesigns())
py_ship_designs.append(py::object(design->Name(false)));
return py::list(py_ship_designs);
}
auto ShipDesignGetMonsterList() -> py::list
{
py::list py_monster_designs;
const auto& manager = GetPredefinedShipDesignManager();
for (const auto& monster : manager.GetOrderedMonsterDesigns())
py_monster_designs.append(py::object(monster->Name(false)));
return py::list(py_monster_designs);
}
// Wrappers for starting fleet plans
class FleetPlanWrapper {
public:
// name ctors
FleetPlanWrapper(FleetPlan&& fleet_plan) :
m_fleet_plan(std::make_shared<FleetPlan>(std::move(fleet_plan)))
{}
FleetPlanWrapper(std::string fleet_name, const py::list& py_designs) {
std::vector<std::string> designs;
for (int i = 0; i < len(py_designs); i++)
designs.push_back(py::extract<std::string>(py_designs[i]));
m_fleet_plan = std::make_shared<FleetPlan>(std::move(fleet_name), designs, false);
}
// name accessors
py::object Name() const
{ return py::object(m_fleet_plan->Name()); }
py::list ShipDesigns() {
py::list py_designs;
for (const auto& design_name : m_fleet_plan->ShipDesigns())
py_designs.append(py::object(design_name));
return py::list(py_designs);
}
const auto& GetFleetPlan() const noexcept { return *m_fleet_plan; }
private:
// Use shared_ptr insead of unique_ptr because boost::python requires a deleter
std::shared_ptr<const FleetPlan> m_fleet_plan;
};
auto LoadFleetPlanList() -> py::list {
py::list py_fleet_plans;
auto&& fleet_plans = GetUniverse().InitiallyUnlockedFleetPlans();
for (auto fleet_plan : fleet_plans)
py_fleet_plans.append(FleetPlanWrapper(FleetPlan(*fleet_plan)));
return py_fleet_plans;
}
// Wrappers for starting monster fleet plans
class MonsterFleetPlanWrapper {
public:
// name ctors
MonsterFleetPlanWrapper(MonsterFleetPlan&& monster_fleet_plan) :
m_monster_fleet_plan(std::make_shared<MonsterFleetPlan>(std::move(monster_fleet_plan)))
{}
MonsterFleetPlanWrapper(std::string fleet_name, const py::list& py_designs,
double spawn_rate, int spawn_limit)
{
std::vector<std::string> designs;
for (int i = 0; i < len(py_designs); i++)
designs.push_back(py::extract<std::string>(py_designs[i]));
m_monster_fleet_plan =
std::make_shared<MonsterFleetPlan>(std::move(fleet_name), designs, spawn_rate,
spawn_limit, nullptr, false);
}
// name accessors
py::object Name() const
{ return py::object(m_monster_fleet_plan->Name()); }
py::list ShipDesigns() const{
py::list py_designs;
for (const auto& design_name : m_monster_fleet_plan->ShipDesigns())
py_designs.append(py::object(design_name));
return py::list(py_designs);
}
double SpawnRate() const noexcept
{ return m_monster_fleet_plan->SpawnRate(); }
int SpawnLimit() const noexcept
{ return m_monster_fleet_plan->SpawnLimit(); }
py::list Locations(py::list systems) const
{ return FilterIDsWithCondition(m_monster_fleet_plan->Location(), systems); }
const MonsterFleetPlan& GetMonsterFleetPlan() const noexcept
{ return *m_monster_fleet_plan; }
private:
// Use shared_ptr insead of unique_ptr because boost::python requires a deleter
std::shared_ptr<const MonsterFleetPlan> m_monster_fleet_plan;
};
auto LoadMonsterFleetPlanList() -> py::list
{
py::list py_monster_fleet_plans;
const auto monster_fleet_plans = GetUniverse().MonsterFleetPlans();
for (auto* fleet_plan : monster_fleet_plans)
py_monster_fleet_plans.append(MonsterFleetPlanWrapper(MonsterFleetPlan(*fleet_plan)));
return py_monster_fleet_plans;
}
// Wrappers for the various universe object classes member funtions
// This should provide a more safe and consistent set of server side
// functions to scripters. All wrapper functions work with object ids, so
// handling with object references and passing them between the languages is
// avoided.
//
// Wrappers for common UniverseObject class member funtions
auto GetName(int object_id) -> py::object
{
auto obj = Objects().getRaw(object_id);
if (!obj) {
ErrorLogger() << "GetName: Couldn't get object with ID " << object_id;
return py::object("");
}
return py::object(obj->Name());
}
void SetName(int object_id, std::string name)
{
auto obj = Objects().getRaw(object_id);
if (!obj) {
ErrorLogger() << "RenameUniverseObject: Couldn't get object with ID " << object_id;
return;
}
obj->Rename(std::move(name));
}
auto GetX(int object_id) -> double
{
auto obj = Objects().getRaw(object_id);
if (!obj) {
ErrorLogger() << "GetX: Couldn't get object with ID " << object_id;
return UniverseObject::INVALID_POSITION;
}
return obj->X();
}
auto GetY(int object_id) -> double
{
auto obj = Objects().getRaw(object_id);
if (!obj) {
ErrorLogger() << "GetY: Couldn't get object with ID " << object_id;
return UniverseObject::INVALID_POSITION;
}
return obj->Y();
}
auto GetPos(int object_id) -> py::tuple
{
auto obj = Objects().getRaw(object_id);
if (!obj) {
ErrorLogger() << "GetPos: Couldn't get object with ID " << object_id;
return py::make_tuple(UniverseObject::INVALID_POSITION,
UniverseObject::INVALID_POSITION);
}
return py::make_tuple(obj->X(), obj->Y());
}
auto GetOwner(int object_id) -> int
{
auto obj = Objects().getRaw(object_id);
if (!obj) {
ErrorLogger() << "GetOwner: Couldn't get object with ID " << object_id;
return ALL_EMPIRES;
}
return obj->Owner();
}
void AddSpecial(int object_id, std::string special_name) {
ScriptingContext context;
// get the universe object and check if it exists
auto obj = context.ContextObjects().getRaw(object_id);
if (!obj) {
ErrorLogger() << "AddSpecial: Couldn't get object with ID " << object_id;
return;
}
// check if the special exists
const Special* special = GetSpecial(special_name);
if (!special) {
ErrorLogger() << "AddSpecial: couldn't get special " << special_name;
return;
}
float capacity = special->InitialCapacity(object_id, context);
obj->AddSpecial(std::move(special_name), capacity, context.current_turn);
}
void RemoveSpecial(int object_id, const std::string special_name) {
ScriptingContext context;
// get the universe object and check if it exists
auto obj = context.ContextObjects().getRaw(object_id);
if (!obj) {
ErrorLogger() << "RemoveSpecial: Couldn't get object with ID " << object_id;
return;
}
// check if the special exists
if (!GetSpecial(special_name)) {
ErrorLogger() << "RemoveSpecial: couldn't get special " << special_name;
return;
}
obj->RemoveSpecial(special_name);
}
auto GetAllObjects() -> py::list
{
py::list py_all_objects;
for (const auto& object : Objects().all())
py_all_objects.append(object->ID());
return py_all_objects;
}
auto GetSystems() -> py::list
{
py::list py_systems;
for (const auto* system : Objects().allRaw<System>())
py_systems.append(system->ID());
return py_systems;
}
auto CreateSystem(StarType star_type, const std::string& star_name, double x, double y) -> int
{
ScriptingContext context;
// Check if star type is set to valid value
if ((star_type == StarType::INVALID_STAR_TYPE) || (star_type == StarType::NUM_STAR_TYPES)) {
ErrorLogger() << "CreateSystem : Can't create a system with a star of type " << star_type;
return INVALID_OBJECT_ID;
}
// Create system and insert it into the object map
auto& universe = context.ContextUniverse();
const int turn = context.current_turn;
auto system = universe.InsertNew<System>(star_type, star_name, x, y, turn);
if (!system) {
ErrorLogger() << "CreateSystem : Attempt to insert system into the object map failed";
return INVALID_OBJECT_ID;
}
return system->SystemID();
}
auto CreatePlanet(PlanetSize size, PlanetType planet_type, int system_id,
int orbit, const std::string& name) -> int
{
ScriptingContext context;
auto system = context.ContextObjects().getRaw<System>(system_id);
// Perform some validity checks
// Check if system with id system_id exists
if (!system) {
ErrorLogger() << "CreatePlanet : Couldn't get system with ID " << system_id;
return INVALID_OBJECT_ID;
}
// Check if orbit number is within allowed range
if ((orbit < 0) || (orbit >= static_cast<int>(system->Orbits()))) {
ErrorLogger() << "CreatePlanet : There is no orbit " << orbit << " in system " << system_id;
return INVALID_OBJECT_ID;
}
// Check if desired orbit is still empty
if (system->OrbitOccupied(orbit)) {
ErrorLogger() << "CreatePlanet : Orbit " << orbit << " of system " << system_id << " already occupied";
return INVALID_OBJECT_ID;
}
// Check if planet size is set to valid value
if ((size < PlanetSize::SZ_TINY) || (size > PlanetSize::SZ_GASGIANT)) {
ErrorLogger() << "CreatePlanet : Can't create a planet of size " << size;
return INVALID_OBJECT_ID;
}
// Check if planet type is set to valid value
if ((planet_type < PlanetType::PT_SWAMP) || (planet_type > PlanetType::PT_GASGIANT)) {
ErrorLogger() << "CreatePlanet : Can't create a planet of type " << planet_type;
return INVALID_OBJECT_ID;
}
// Check if planet type and size match
// if type is gas giant, size must be too, same goes for asteroids
if (((planet_type == PlanetType::PT_GASGIANT) && (size != PlanetSize::SZ_GASGIANT)) ||
((planet_type == PlanetType::PT_ASTEROIDS) && (size != PlanetSize::SZ_ASTEROIDS)))
{
ErrorLogger() << "CreatePlanet : Planet of type " << planet_type << " can't have size " << size;
return INVALID_OBJECT_ID;
}
// Create planet and insert it into the object map
auto& universe = context.ContextUniverse();
auto planet = universe.InsertNew<Planet>(planet_type, size, context.current_turn);
if (!planet) {
ErrorLogger() << "CreateSystem : Attempt to insert planet into the object map failed";
return INVALID_OBJECT_ID;
}
// Add planet to system map
system->Insert(planet, orbit, context.current_turn, context.ContextObjects());
// If a name has been specified, set planet name
if (!(name.empty()))
planet->Rename(name);
return planet->ID();
}
auto CreateBuilding(const std::string& building_type, int planet_id, int empire_id) -> int
{
ScriptingContext context;
ObjectMap& objects = context.ContextObjects();
auto planet = objects.getRaw<Planet>(planet_id);
if (!planet) {
ErrorLogger() << "CreateBuilding: couldn't get planet with ID " << planet_id;
return INVALID_OBJECT_ID;
}
auto system = objects.getRaw<System>(planet->SystemID());
if (!system) {
ErrorLogger() << "CreateBuilding: couldn't get system for planet";
return INVALID_OBJECT_ID;
}
auto empire = context.GetEmpire(empire_id);
if (!empire) {
ErrorLogger() << "CreateBuilding: couldn't get empire with ID " << empire_id;
return INVALID_OBJECT_ID;
}
auto building = context.ContextUniverse().InsertNew<Building>(
empire_id, building_type, empire_id, context.current_turn);
if (!building) {
ErrorLogger() << "CreateBuilding: couldn't create building";
return INVALID_OBJECT_ID;
}
system->Insert(building, System::NO_ORBIT, context.current_turn, context.ContextObjects());
planet->AddBuilding(building->ID());
building->SetPlanetID(planet_id);
return building->ID();
}
auto CreateFleet(const std::string& name, int system_id, int empire_id, bool aggressive = false) -> int
{
// Get system and check if it exists
auto system = Objects().get<System>(system_id);
if (!system) {
ErrorLogger() << "CreateFleet: couldn't get system with ID " << system_id;
return INVALID_OBJECT_ID;
}
// Create new fleet at the position of the specified system
auto& universe = GetUniverse();
auto fleet = universe.InsertNew<Fleet>(name, system->X(), system->Y(),
empire_id, CurrentTurn());
if (!fleet) {
ErrorLogger() << "CreateFleet: couldn't create new fleet";
return INVALID_OBJECT_ID;
}
// Insert fleet into specified system
int turn = CurrentTurn();
system->Insert(fleet, System::NO_ORBIT, turn, Objects());
// check if we got a fleet name...
if (name.empty()) {
// ...no name has been specified, so we have to generate one using the new fleet id
fleet->Rename(UserString("OBJ_FLEET") + " " + std::to_string(fleet->ID()));
}
fleet->SetAggression(aggressive ? FleetDefaults::FLEET_DEFAULT_ARMED : FleetDefaults::FLEET_DEFAULT_UNARMED);
// return fleet ID
return fleet->ID();
}
auto CreateShip(const std::string& name, const std::string& design_name,
const std::string& species, int fleet_id) -> int
{
ScriptingContext context;
Universe& universe = context.ContextUniverse();
ObjectMap& objects = context.ContextObjects();
// check if we got a species name, if yes, check if species exists
if (!species.empty() && !context.species.GetSpecies(species)) {
ErrorLogger() << "CreateShip: invalid species specified";
return INVALID_OBJECT_ID;
}
// get ship design and check if it exists
const ShipDesign* ship_design = universe.GetGenericShipDesign(design_name);
if (!ship_design) {
ErrorLogger() << "CreateShip: couldn't get ship design " << design_name;
return INVALID_OBJECT_ID;
}
// get fleet and check if it exists
auto fleet = objects.get<Fleet>(fleet_id);
if (!fleet) {
ErrorLogger() << "CreateShip: couldn't get fleet with ID " << fleet_id;
return INVALID_OBJECT_ID;
}
auto system = objects.get<System>(fleet->SystemID());
if (!system) {
ErrorLogger() << "CreateShip: couldn't get system for fleet";
return INVALID_OBJECT_ID;
}
// get owner empire of specified fleet
int empire_id = fleet->Owner();
// if we got the id of an actual empire, get the empire object and check if it exists
std::shared_ptr<Empire> empire;
if (empire_id != ALL_EMPIRES) {
empire = context.GetEmpire(empire_id);
if (!empire) {
ErrorLogger() << "CreateShip: couldn't get empire with ID " << empire_id;
return INVALID_OBJECT_ID;
}
}
// create new ship
int turn = CurrentTurn();
auto ship = universe.InsertNew<Ship>(empire_id, ship_design->ID(), species, universe,
GetSpeciesManager(), empire_id, turn);
if (!ship) {
ErrorLogger() << "CreateShip: couldn't create new ship";
return INVALID_OBJECT_ID;
}
system->Insert(ship, System::NO_ORBIT, turn, objects);
// set ship name
// check if we got a ship name...
if (name.empty()) {
// ...no name has been specified, so we have to generate one
// check if the owner empire we got earlier is actually an empire...
if (empire) {
// ...yes, so construct a name using the empires NewShipName member function
ship->Rename(empire->NewShipName());
} else {
// ...no, so construct a name using the new ships id
ship->Rename(UserString("OBJ_SHIP") + " " + std::to_string(ship->ID()));
}
} else {
// ...yes, name has been specified, so use it
ship->Rename(name);
}
// add ship to fleet, this also moves the ship to the
// fleets location and inserts it into the system
fleet->AddShips({ship->ID()});
ship->SetFleetID(fleet->ID());
// set the meters of the ship to max values
ship->ResetTargetMaxUnpairedMeters();
ship->ResetPairedActiveMeters();
ship->SetShipMetersToMax();
ship->BackPropagateMeters();
//return the new ships id
return ship->ID();
}
auto CreateFieldImpl(const std::string& field_type_name, double x, double y, double size) -> std::shared_ptr<Field>
{
// check if a field type with the specified field type name exists and get the field type
const FieldType* field_type = GetFieldType(field_type_name);
if (!field_type) {
ErrorLogger() << "CreateFieldImpl: couldn't get field type with name: " << field_type_name;
return nullptr;
}
// check if the specified size is within sane limits, and reset its value if not
if (size < 1.0) {
ErrorLogger() << "CreateFieldImpl given very small / negative size: " << size << ", resetting to 1.0";
size = 1.0;
}
if (size > 10000.0) {
ErrorLogger() << "CreateFieldImpl given very large size: " << size << ", so resetting to 10000.0";
size = 10000.0;
}
// create the new field
auto& universe = GetUniverse();
auto field = universe.InsertNew<Field>(field_type_name, x, y, size, CurrentTurn());
if (!field) {
ErrorLogger() << "CreateFieldImpl: couldn't create field";
return nullptr;
}
// get the localized version of the field type name and set that as the fields name
field->Rename(UserString(field_type->Name()));
return field;
}
auto CreateField(const std::string& field_type_name, double x, double y, double size) -> int
{
if (auto field = CreateFieldImpl(field_type_name, x, y, size))
return field->ID();
else
return INVALID_OBJECT_ID;
}
auto CreateFieldInSystem(const std::string& field_type_name, double size, int system_id) -> int
{
// check if system exists and get system
auto system = Objects().getRaw<System>(system_id);
if (!system) {
ErrorLogger() << "CreateFieldInSystem: couldn't get system with ID " << system_id;
return INVALID_OBJECT_ID;
}
// create the field with the coordinates of the system
auto field = CreateFieldImpl(field_type_name, system->X(), system->Y(), size);
if (!field)
return INVALID_OBJECT_ID;
int field_id = field->ID();
int turn = CurrentTurn();
system->Insert(std::move(field), System::NO_ORBIT, turn, Objects());
return field_id;
}
// Return a list of system ids of universe objects with @p obj_ids.
auto ObjectsGetSystems(const py::list& obj_ids) -> py::list
{
py::list py_systems;
py::stl_input_iterator<int> end;
for (py::stl_input_iterator<int> id(obj_ids);
id != end; ++id) {
if (auto obj = Objects().getRaw(*id)) {
py_systems.append(obj->SystemID());
} else {
ErrorLogger() << "Passed an invalid universe object id " << *id;
py_systems.append(INVALID_OBJECT_ID);
}
}
return py_systems;
}
// Return all systems within \p jumps of \p sys_ids
auto SystemsWithinJumps(std::size_t jumps, const py::list& sys_ids) -> py::list
{
py::list py_systems;
py::stl_input_iterator<int> end;
std::vector<int> systems{py::stl_input_iterator<int>(sys_ids), end};
auto systems_in_vicinity = GetUniverse().GetPathfinder()->WithinJumps(jumps, std::move(systems));
TraceLogger() << "within " << jumps << " jumps: " << systems_in_vicinity.size() << " systems";
for (auto system_id : systems_in_vicinity)
py_systems.append(system_id);
return py_systems;
}
// Wrappers for System class member functions
auto SystemGetStarType(int system_id) -> StarType
{
auto system = Objects().getRaw<const System>(system_id);
if (!system) {
ErrorLogger() << "SystemGetStarType: couldn't get system with ID " << system_id;
return StarType::INVALID_STAR_TYPE;
}
return system->GetStarType();
}
void SystemSetStarType(int system_id, StarType star_type) {
// Check if star type is set to valid value
if ((star_type == StarType::INVALID_STAR_TYPE) || (star_type == StarType::NUM_STAR_TYPES)) {
ErrorLogger() << "SystemSetStarType : Can't create a system with a star of type " << star_type;
return;
}
auto system = Objects().getRaw<System>(system_id);
if (!system) {
ErrorLogger() << "SystemSetStarType : Couldn't get system with ID " << system_id;
return;
}
system->SetStarType(star_type);
}
auto SystemGetNumOrbits(int system_id) -> int
{
auto system = Objects().getRaw<const System>(system_id);
if (!system) {
ErrorLogger() << "SystemGetNumOrbits : Couldn't get system with ID " << system_id;
return 0;
}
return system->Orbits();
}
auto SystemFreeOrbits(int system_id) -> py::list
{
py::list py_orbits;
auto system = Objects().getRaw<const System>(system_id);
if (!system) {
ErrorLogger() << "SystemFreeOrbits : Couldn't get system with ID " << system_id;
return py_orbits;
}
for (int orbit_idx : system->FreeOrbits())
py_orbits.append(orbit_idx);
return py_orbits;
}
auto SystemOrbitOccupied(int system_id, int orbit) -> bool
{
auto system = Objects().getRaw<const System>(system_id);
if (!system) {
ErrorLogger() << "SystemOrbitOccupied : Couldn't get system with ID " << system_id;
return 0;
}
return system->OrbitOccupied(orbit);
}
auto SystemOrbitOfPlanet(int system_id, int planet_id) -> int
{
auto system = Objects().getRaw<const System>(system_id);
if (!system) {
ErrorLogger() << "SystemOrbitOfPlanet : Couldn't get system with ID " << system_id;
return 0;
}
return system->OrbitOfPlanet(planet_id);
}
auto SystemGetPlanets(int system_id) -> py::list
{
py::list py_planets;
auto system = Objects().getRaw<const System>(system_id);
if (!system) {
ErrorLogger() << "SystemGetPlanets : Couldn't get system with ID " << system_id;
return py_planets;
}
for (int planet_id : system->PlanetIDs())
py_planets.append(planet_id);
return py_planets;
}
auto SystemGetFleets(int system_id) -> py::list
{
py::list py_fleets;
auto system = Objects().getRaw<const System>(system_id);
if (!system) {
ErrorLogger() << "SystemGetFleets : Couldn't get system with ID " << system_id;
return py_fleets;
}
for (int fleet_id : system->FleetIDs())
py_fleets.append(fleet_id);
return py_fleets;
}
auto SystemGetStarlanes(int system_id) -> py::list
{
py::list py_starlanes;
// get source system
auto system = Objects().getRaw<const System>(system_id);
if (!system) {
ErrorLogger() << "SystemGetStarlanes : Couldn't get system with ID " << system_id;
return py_starlanes;
}
// get list of systems the source system has starlanes to
for (const auto lane_to_id : system->Starlanes())
py_starlanes.append(lane_to_id);
return py_starlanes;
}
void SystemAddStarlane(int from_sys_id, int to_sys_id)
{
// get source and destination system, check that both exist
auto from_sys = Objects().getRaw<System>(from_sys_id);
if (!from_sys) {
ErrorLogger() << "SystemAddStarlane : Couldn't find system with ID " << from_sys_id;
return;
}
auto to_sys = Objects().getRaw<System>(to_sys_id);
if (!to_sys) {
ErrorLogger() << "SystemAddStarlane : Couldn't find system with ID " << to_sys_id;
return;
}
// add the starlane on both ends
from_sys->AddStarlane(to_sys_id);
to_sys->AddStarlane(from_sys_id);
}
void SystemRemoveStarlane(int from_sys_id, int to_sys_id)
{
// get source and destination system, check that both exist
auto from_sys = Objects().getRaw<System>(from_sys_id);
if (!from_sys) {
ErrorLogger() << "SystemRemoveStarlane : Couldn't find system with ID " << from_sys_id;
return;
}
auto to_sys = Objects().getRaw<System>(to_sys_id);
if (!to_sys) {
ErrorLogger() << "SystemRemoveStarlane : Couldn't find system with ID " << to_sys_id;
return;
}
// remove the starlane from both ends
from_sys->RemoveStarlane(to_sys_id);
to_sys->RemoveStarlane(from_sys_id);
}
// Wrapper for Planet class member functions
auto PlanetGetType(int planet_id) -> PlanetType
{
auto planet = Objects().getRaw<const Planet>(planet_id);
if (!planet) {
ErrorLogger() << "PlanetGetType: Couldn't get planet with ID " << planet_id;
return PlanetType::INVALID_PLANET_TYPE;
}
return planet->Type();
}
void PlanetSetType(int planet_id, PlanetType planet_type)
{
auto planet = Objects().getRaw<Planet>(planet_id);
if (!planet) {
ErrorLogger() << "PlanetSetType: Couldn't get planet with ID " << planet_id;
return;
}
planet->SetType(planet_type);
if (planet_type == PlanetType::PT_ASTEROIDS)
planet->SetSize(PlanetSize::SZ_ASTEROIDS);
else if (planet_type == PlanetType::PT_GASGIANT)
planet->SetSize(PlanetSize::SZ_GASGIANT);
else if (planet->Size() == PlanetSize::SZ_ASTEROIDS)
planet->SetSize(PlanetSize::SZ_TINY);
else if (planet->Size() == PlanetSize::SZ_GASGIANT)
planet->SetSize(PlanetSize::SZ_HUGE);
}
auto PlanetGetSize(int planet_id) -> PlanetSize
{
auto planet = Objects().getRaw<const Planet>(planet_id);
if (!planet) {
ErrorLogger() << "PlanetGetSize: Couldn't get planet with ID " << planet_id;
return PlanetSize::INVALID_PLANET_SIZE;
}
return planet->Size();
}
void PlanetSetSize(int planet_id, PlanetSize planet_size)
{
auto planet = Objects().getRaw<Planet>(planet_id);
if (!planet) {
ErrorLogger() << "PlanetSetSize: Couldn't get planet with ID " << planet_id;
return;
}
planet->SetSize(planet_size);
if (planet_size == PlanetSize::SZ_ASTEROIDS)
planet->SetType(PlanetType::PT_ASTEROIDS);
else if (planet_size == PlanetSize::SZ_GASGIANT)
planet->SetType(PlanetType::PT_GASGIANT);
else if ((planet->Type() == PlanetType::PT_ASTEROIDS) || (planet->Type() == PlanetType::PT_GASGIANT))
planet->SetType(PlanetType::PT_BARREN);
}
auto PlanetGetSpecies(int planet_id) -> py::object
{
auto planet = Objects().getRaw<const Planet>(planet_id);
if (!planet) {
ErrorLogger() << "PlanetGetSpecies: Couldn't get planet with ID " << planet_id;
return py::object("");
}
return py::object(planet->SpeciesName());
}
void PlanetSetSpecies(int planet_id, const std::string& species_name)
{
ScriptingContext context;
auto planet = context.ContextObjects().getRaw<Planet>(planet_id);
if (!planet) {
ErrorLogger() << "PlanetSetSpecies: Couldn't get planet with ID " << planet_id;
return;
}
planet->SetSpecies(species_name, context.current_turn, context.species);
}
auto PlanetGetFocus(int planet_id) -> py::object
{
auto planet = Objects().get<Planet>(planet_id);
if (!planet) {
ErrorLogger() << "PlanetGetFocus: Couldn't get planet with ID " << planet_id;
return py::object("");
}
return py::object(planet->Focus());
}
void PlanetSetFocus(int planet_id, const std::string& focus)
{
ScriptingContext context;
auto planet = context.ContextObjects().getRaw<Planet>(planet_id);
if (!planet) {
ErrorLogger() << "PlanetSetSpecies: Couldn't get planet with ID " << planet_id;
return;
}
planet->SetFocus(focus, context);
}
auto PlanetAvailableFoci(int planet_id) -> py::list
{
const ScriptingContext context;
py::list py_foci;
auto planet = context.ContextObjects().getRaw<Planet>(planet_id);
if (!planet) {
ErrorLogger() << "PlanetAvailableFoci: Couldn't get planet with ID " << planet_id;
return py_foci;
}
for (const auto& focus : planet->AvailableFoci(context))
py_foci.append(py::object(std::string{focus}));
return py_foci;
}
auto PlanetMakeOutpost(int planet_id, int empire_id) -> bool
{
ScriptingContext context;
auto planet = context.ContextObjects().get<Planet>(planet_id);
if (!planet) {
ErrorLogger() << "PlanetMakeOutpost: couldn't get planet with ID:" << planet_id;
return false;
}
if (!context.GetEmpire(empire_id)) {
ErrorLogger() << "PlanetMakeOutpost: couldn't get empire with ID " << empire_id;
return false;
}
return planet->Colonize(empire_id, "", 0.0, context);
}
auto PlanetMakeColony(int planet_id, int empire_id, const std::string& species, double population) -> bool
{
ScriptingContext context;
auto planet = context.ContextObjects().get<Planet>(planet_id);
if (!planet) {
ErrorLogger() << "PlanetMakeColony: couldn't get planet with ID:" << planet_id;
return false;
}
if (!context.GetEmpire(empire_id)) {
ErrorLogger() << "PlanetMakeColony: couldn't get empire with ID " << empire_id;
return false;
}
if (!context.species.GetSpecies(species)) {
ErrorLogger() << "PlanetMakeColony: couldn't get species with name: " << species;
return false;
}
if (population < 0.0)
population = 0.0;
return planet->Colonize(empire_id, species, population, context);
}
auto PlanetCardinalSuffix(int planet_id) -> py::object
{
const ScriptingContext context;
auto planet = context.ContextObjects().get<Planet>(planet_id);
if (!planet) {
ErrorLogger() << "PlanetCardinalSuffix: couldn't get planet with ID:" << planet_id;
return py::object(UserString("ERROR"));
}
return py::object(planet->CardinalSuffix(context.ContextObjects()));
}
auto PlayerEmpireColor(const PlayerSetupData* psd) -> py::tuple
{
EmpireColor color = psd->empire_color;
return py::make_tuple(
std::get<0>(color),
std::get<1>(color),
std::get<2>(color),
std::get<3>(color));
}
}
namespace FreeOrionPython {
void WrapServer() {
py::class_<PlayerSetupData>("PlayerSetupData")
.def_readwrite("player_name", &PlayerSetupData::player_name)
.def_readwrite("empire_name", &PlayerSetupData::empire_name)
.add_property("empire_color", PlayerEmpireColor)
.def_readwrite("starting_species", &PlayerSetupData::starting_species_name)
.def_readwrite("starting_team", &PlayerSetupData::starting_team);
py::class_<FleetPlanWrapper>("FleetPlan", py::init<const std::string&, const py::list&>())
.def("name", &FleetPlanWrapper::Name)
.def("ship_designs", &FleetPlanWrapper::ShipDesigns);
py::class_<MonsterFleetPlanWrapper>("MonsterFleetPlan", py::init<const std::string&, const py::list&, double, int>())
.def("name", &MonsterFleetPlanWrapper::Name)
.def("ship_designs", &MonsterFleetPlanWrapper::ShipDesigns)
.def("spawn_rate", &MonsterFleetPlanWrapper::SpawnRate)
.def("spawn_limit", &MonsterFleetPlanWrapper::SpawnLimit)
.def("locations", &MonsterFleetPlanWrapper::Locations);
py::def("get_universe", GetUniverse, py::return_value_policy<py::reference_existing_object>());
py::def("get_all_empires", GetAllEmpires);
py::def("get_empire", GetEmpire, py::return_value_policy<py::reference_existing_object>());
py::def("userString",
+[](const std::string& key) -> const std::string& { return UserString(key); },
py::return_value_policy<py::copy_const_reference>());
py::def("userStringExists",
+[](const std::string& key) -> bool { return UserStringExists(key); });
//py::def("userStringList", &GetUserStringList); // could be copied from AIWrapper
py::def("roman_number", RomanNumber);
py::def("get_resource_dir", +[]() -> py::object { return py::object(PathToString(GetResourceDir())); });
py::def("all_empires", +[]() -> int { return ALL_EMPIRES; });
py::def("invalid_object", +[]() -> int { return INVALID_OBJECT_ID; });
py::def("large_meter_value", +[]() -> float { return Meter::LARGE_VALUE; });
py::def("invalid_position", +[]() -> double { return UniverseObject::INVALID_POSITION; });
py::def("get_galaxy_setup_data", GetGalaxySetupData, py::return_value_policy<py::reference_existing_object>());
py::def("current_turn", CurrentTurn); // TODO: replace these with ScriptingContext calls?
py::def("generate_sitrep", GenerateSitRep);
py::def("generate_sitrep", +[](int empire_id, const std::string& template_string, const std::string& icon) { GenerateSitRep(empire_id, template_string, py::dict(), icon); });
py::def("generate_starlanes", +[](int max_jumps_between_systems, int max_starlane_length) { ScriptingContext context; GenerateStarlanes(max_jumps_between_systems, max_starlane_length, context.ContextUniverse(), context.Empires()); });
py::def("species_preferred_focus", SpeciesDefaultFocus);
py::def("species_get_planet_environment", SpeciesGetPlanetEnvironment);
py::def("species_add_homeworld", SpeciesAddHomeworld);
py::def("species_remove_homeworld", SpeciesRemoveHomeworld);
py::def("species_can_colonize", SpeciesCanColonize);
py::def("get_all_species", GetAllSpecies);
py::def("get_playable_species", GetPlayableSpecies);
py::def("get_native_species", GetNativeSpecies);
py::def("special_spawn_rate", SpecialSpawnRate);
py::def("special_spawn_limit", SpecialSpawnLimit);
py::def("special_locations", SpecialLocations);
py::def("special_has_location", SpecialHasLocation);
py::def("get_all_specials", GetAllSpecials);
py::def("empire_set_name", EmpireSetName);
py::def("empire_set_homeworld", EmpireSetHomeworld);
py::def("empire_unlock_item", EmpireUnlockItem);
py::def("empire_add_ship_design", EmpireAddShipDesign);
py::def("empire_set_stockpile", EmpireSetStockpile);
py::def("empire_set_diplomacy", EmpireSetDiplomacy);
py::def("design_create", ShipDesignCreate);
py::def("design_get_premade_list", ShipDesignGetPremadeList);
py::def("design_get_monster_list", ShipDesignGetMonsterList);
py::def("load_unlockable_item_list", LoadUnlockableItemList);
py::def("load_starting_buildings", LoadStartingBuildings);
py::def("load_fleet_plan_list", LoadFleetPlanList);
py::def("load_monster_fleet_plan_list", LoadMonsterFleetPlanList);
py::def("get_name", GetName, "Returns the name (string) of the universe object with the specified object id (int). If there is no such object, returns an empty string and logs an error to the error log.");
py::def("set_name", SetName, "Sets the name (string) of the universe object with the specified object id (int). If there is no such object, just logs an error to the error log.");
py::def("get_x", GetX);
py::def("get_y", GetY);
py::def("get_pos", GetPos);
py::def("get_owner", GetOwner);
py::def("add_special", AddSpecial);
py::def("remove_special", RemoveSpecial);
py::def("get_universe_width", +[]() -> double { return GetUniverse().UniverseWidth(); });
py::def("set_universe_width", +[](double width) { GetUniverse().SetUniverseWidth(width); });
py::def("linear_distance", +[](int system1_id, int system2_id) -> double { return GetUniverse().GetPathfinder()->LinearDistance(system1_id, system2_id, Objects()); });
py::def("jump_distance", +[](int system1_id, int system2_id) -> int { return GetUniverse().GetPathfinder()->JumpDistanceBetweenSystems(system1_id, system2_id); });
py::def("get_all_objects", GetAllObjects);
py::def("get_systems", GetSystems);
py::def("create_system", CreateSystem);
py::def("create_planet", CreatePlanet);
py::def("create_building", CreateBuilding);
py::def("create_fleet", CreateFleet);
py::def("create_ship", CreateShip);
py::def("create_monster_fleet", +[](int system_id) -> int { return CreateFleet(UserString("MONSTERS"), system_id, ALL_EMPIRES, true); });
py::def("create_monster", +[](const std::string& design_name, int fleet_id) -> int { return CreateShip(NewMonsterName(), design_name, "", fleet_id); });
py::def("create_field", CreateField);
py::def("create_field_in_system", CreateFieldInSystem);
py::def("objs_get_systems", ObjectsGetSystems);
py::def("systems_within_jumps_unordered", SystemsWithinJumps, "Return all systems within ''jumps'' of the systems with ids ''sys_ids''");
py::def("sys_get_star_type", SystemGetStarType);
py::def("sys_set_star_type", SystemSetStarType);
py::def("sys_get_num_orbits", SystemGetNumOrbits);
py::def("sys_free_orbits", SystemFreeOrbits);
py::def("sys_orbit_occupied", SystemOrbitOccupied);
py::def("sys_orbit_of_planet", SystemOrbitOfPlanet);
py::def("sys_get_planets", SystemGetPlanets);
py::def("sys_get_fleets", SystemGetFleets);
py::def("sys_get_starlanes", SystemGetStarlanes);
py::def("sys_add_starlane", SystemAddStarlane);
py::def("sys_remove_starlane", SystemRemoveStarlane);
py::def("planet_get_type", PlanetGetType);
py::def("planet_set_type", PlanetSetType);
py::def("planet_get_size", PlanetGetSize);
py::def("planet_set_size", PlanetSetSize);
py::def("planet_get_species", PlanetGetSpecies);
py::def("planet_set_species", PlanetSetSpecies);
py::def("planet_get_focus", PlanetGetFocus);
py::def("planet_set_focus", PlanetSetFocus);
py::def("planet_available_foci", PlanetAvailableFoci);
py::def("planet_make_outpost", PlanetMakeOutpost);
py::def("planet_make_colony", PlanetMakeColony);
py::def("planet_cardinal_suffix", PlanetCardinalSuffix);
}
}
|