Data Reference¶
Note
The following documents every data class modelled by the library in regards to data dumps and all its potential attributes, it will only have the attributes queried, attempting to access unqueried (and therefore non-existent) attributes will result in it raising an AttributeError
or a KeyError
depending on the context.
Alliance¶
- class pnwkit.ext.dumps.data.DumpAlliance(data: Mapping[str, Any])¶
Represents an alliance.
- alliance_id¶
The alliance ID.
- Type
str
- date_created¶
The date the alliance was created.
- Type
str
- name¶
The alliance name.
- Type
str
- acronym¶
The alliance acronym.
- Type
str
- color¶
The color of the alliance.
- Type
str
- continent¶
The continent the alliance is in.
- Type
str
- discord_server¶
The invite link to the alliance’s Discord server.
- Type
str
- score¶
The current score of the alliance.
- Type
float
- flag_url¶
The URL to the alliance’s flag.
- Type
str
- to_dict() → Dict[str, Any]¶
Get a dict representation of this data.
- Returns
A dictionary of the data on the object.
- Return type
Dict[str, Any]
City¶
- aluminum_refineries
- banks
- barracks
- bauxite_mines
- capital
- city_id
- coal_mines
- coal_power_plants
- date_created
- drydocks
- factories
- farms
- hangars
- hospitals
- infrastructure
- iron_mines
- land
- last_nuke_date
- lead_mines
- maxinfra
- munitions_factories
- name
- nation_id
- nuclear_power_plants
- oil_power_plants
- oil_refineries
- oil_wells
- police_stations
- recycling_centers
- shopping_malls
- stadiums
- steel_mills
- subway
- supermarkets
- uranium_mines
- wind_power_plants
- class pnwkit.ext.dumps.data.DumpCity(data: Mapping[str, Any])¶
Represents a city.
- city_id¶
The city ID.
- Type
str
- nation_id¶
The nation ID of the city’s nation.
- Type
str
- date_created¶
The date the city was created.
- Type
str
- name¶
The name of the city.
- Type
str
- capital¶
Whether the city is the capital of its nation or not.
- Type
bool
- infrastructure¶
The amount of infrastructure in the city.
- Type
float
- maxinfra¶
The maximum amount of infrastructure in the city.
- Type
float
- land¶
The amount of land in the city.
- Type
float
- oil_power_plants¶
The amount of Oil Power Plants in the city.
- Type
int
- wind_power_plants¶
The amount of Wind Power Plants in the city.
- Type
int
- coal_power_plants¶
The amount of Coal Power Plants in the city.
- Type
int
- nuclear_power_plants¶
The amount of Nuclear Power Plants in the city.
- Type
int
- coal_mines¶
The amount of Coal Mines in the city.
- Type
int
- oil_wells¶
The amount of Oil Wells in the city.
- Type
int
- uranium_mines¶
The amount of Uranium Mines in the city.
- Type
int
- iron_mines¶
The amount of Iron Mines in the city.
- Type
int
- lead_mines¶
The amount of Lead Mines in the city.
- Type
int
- bauxite_mines¶
The amount of Bauxite Mines in the city.
- Type
int
- farms¶
The amount of Farms in the city.
- Type
int
- police_stations¶
The amount of Police Stations in the city.
- Type
int
- hospitals¶
The amount of Hospitals in the city.
- Type
int
- recycling_centers¶
The amount of Recycling Centers in the city.
- Type
int
- subway¶
The amount of Subways in the city.
- Type
int
- supermarkets¶
The amount of Supermarkets in the city.
- Type
int
- banks¶
The amount of Banks in the city.
- Type
int
- shopping_malls¶
The amount of Shopping Malls in the city.
- Type
int
- stadiums¶
The amount of Stadiums in the city.
- Type
int
- oil_refineries¶
The amount of Oil Refineries in the city.
- Type
int
- aluminum_refineries¶
The amount of Aluminum Refineries in the city.
- Type
int
- steel_mills¶
The amount of Steel Mill in the city.
- Type
int
- munitions_factories¶
The amount of Munitions Factories in the city.
- Type
int
- barracks¶
The amount of Barracks in the city.
- Type
int
- factories¶
The amount of Factories in the city.
- Type
int
- hangars¶
The amount of Hangars in the city.
- Type
int
- drydocks¶
The amount of Drydocks in the city.
- Type
int
- last_nuke_date¶
The date the city was last nuked.
- Type
str
- to_dict() → Dict[str, Any]¶
Get a dict representation of this data.
- Returns
A dictionary of the data on the object.
- Return type
Dict[str, Any]
Nation¶
- advanced_engineering_corps_np
- advanced_urban_planning_np
- aircraft
- alliance
- alliance_id
- alliance_position
- arable_land_agency_np
- arms_stockpile_np
- bauxiteworks_np
- beige_turns_remaining
- center_for_civil_engineering_np
- cities
- clinical_research_center_np
- color
- continent
- currency
- date_created
- domestic_policy
- emergency_gasoline_reserve_np
- flag_url
- gdp
- green_technologies_np
- intelligence_agency_np
- international_trade_center_np
- iron_dome_np
- ironworks_np
- latitude
- leader_name
- leader_title
- longitude
- mass_irrigation_np
- missile_launch_pad_np
- missiles
- moon_landing_np
- nation_id
- nation_name
- nation_title
- nuclear_research_facility_np
- nukes
- pirate_economy_np
- population
- portrait_url
- projects
- propaganda_bureau_np
- recycling_initiative_np
- score
- ships
- soldiers
- space_program_np
- specialized_police_training_program_np
- spy_satellite_np
- tanks
- telecommunications_satellite_np
- uranium_enrichment_program_np
- urban_planning_np
- vital_defense_system_np
- vm_turns
- war_policy
- wars_lost
- wars_won
- class pnwkit.ext.dumps.data.DumpNation(data: Mapping[str, Any])¶
Represents a nation.
- nation_id¶
The nation ID.
- Type
str
- nation_name¶
The nation name.
- Type
str
- leader_name¶
The nation’s leader name.
- Type
str
- date_created¶
When the nation was created.
- Type
str
- continent¶
The nation’s continent.
- Type
str
- latitude¶
The nation’s latitude.
- Type
float
- longitude¶
The nation’s longitude.
- Type
float
- leader_title¶
The nation’s leader title.
- Type
str
- nation_title¶
The nation’s title.
- Type
str
- score¶
The nation’s score.
- Type
float
- population¶
The nation’s population.
- Type
int
- flag_url¶
The URL of the nation’s flag.
- Type
str
- color¶
The nation’s color.
- Type
str
- beige_turns_remaining¶
The number of turns the nation has on beige.
- Type
int
- portrait_url¶
The URL of the nation’s portrait.
- Type
str
- cities¶
The nation’s cities.
- Type
int
- gdp¶
The nation’s GDP.
- Type
int
- currency¶
The nation’s currency.
- Type
str
- wars_won¶
The number of wars the nation has won.
- Type
int
- wars_lost¶
The number of wars the nation has lost.
- Type
int
- alliance¶
The nation’s alliance.
- Type
str
- alliance_id¶
The nation’s alliance ID.
- Type
str
- alliance_position¶
The nation’s alliance position.
- Type
int
- soldiers¶
The amount of soldiers the nation has.
- Type
int
- tanks¶
The amount of tanks the nation has.
- Type
int
- aircraft¶
The amount of aircraft the nation has.
- Type
int
- ships¶
The amount of ships the nation has.
- Type
int
- missiles¶
The amount of missiles the nation has.
- Type
int
- nukes¶
The amount of nukes the nation has.
- Type
int
- domestic_policy¶
The nation’s domestic policy.
- Type
str
- war_policy¶
The nation’s war policy.
- Type
str
- projects¶
The amount of projects the nation has.
- Type
int
- ironworks_np¶
Whether the nation has the Ironworks project or not.
- Type
bool
- bauxiteworks_np¶
Whether the nation has the Bauxiteworks project or not.
- Type
bool
- arms_stockpile_np¶
Whether the nation has the Arms Stockpile project or not.
- Type
bool
- emergency_gasoline_reserve_np¶
Whether the nation has the Emergency Gasoline Reserve project or not.
- Type
bool
- mass_irrigation_np¶
Whether the nation has the Mass Irrigation project or not.
- Type
bool
- international_trade_center_np¶
Whether the nation has the International Trade Center project or not.
- Type
bool
- missile_launch_pad_np¶
Whether the nation has the Missile Launch Pad project or not.
- Type
bool
- nuclear_research_facility_np¶
Whether the nation has the Nuclear Research Facility project or not.
- Type
bool
- iron_dome_np¶
Whether the nation has the Iron Dome project or not.
- Type
bool
- vital_defense_system_np¶
Whether the nation has the Vital Defense System project or not.
- Type
bool
- intelligence_agency_np¶
Whether the nation has the Intelligence Agency project or not.
- Type
bool
- center_for_civil_engineering_np¶
Whether the nation has the Center for Civil Engineering project or not.
- Type
bool
- propaganda_bureau_np¶
Whether the nation has the Propaganda Bureau project or not.
- Type
bool
- uranium_enrichment_program_np¶
Whether the nation has the Uranium Enrichment Program project or not.
- Type
bool
- urban_planning_np¶
Whether the nation has the Urban Planning project or not.
- Type
bool
- advanced_urban_planning_np¶
Whether the nation has the Advanced Urban Planning project or not.
- Type
bool
- space_program_np¶
Whether the nation has the Space Program project or not.
- Type
bool
- moon_landing_np¶
Whether the nation has the Moon Landing project or not.
- Type
bool
- spy_satellite_np¶
Whether the nation has the Spy Satellite project or not.
- Type
bool
- pirate_economy_np¶
Whether the nation has the Pirate Economy project or not.
- Type
bool
- recycling_initiative_np¶
Whether the nation has the Recycling Initiative project or not.
- Type
bool
- telecommunications_satellite_np¶
Whether the nation has the Telecommunication Satellite project or not.
- Type
bool
- green_technologies_np¶
Whether the nation has the Green Technologies project or not.
- Type
bool
- clinical_research_center_np¶
Whether the nation has the Clinical Research Center project or not.
- Type
bool
- specialized_police_training_program_np¶
Whether the nation has the Specialized Police Training Program project or not.
- Type
bool
- arable_land_agency_np¶
Whether the nation has the Arable Land Agency project or not.
- Type
bool
- advanced_engineering_corps_np¶
Whether the nation has the Advanced Engineering Corps project or not.
- Type
bool
- vm_turns¶
The number of turns the nation has on Vacation Mode.
- Type
int
- to_dict() → Dict[str, Any]¶
Get a dict representation of this data.
- Returns
A dictionary of the data on the object.
- Return type
Dict[str, Any]
Trade¶
- class pnwkit.ext.dumps.data.DumpTrade(data: Mapping[str, Any])¶
Represents a trade
- trade_id¶
The trade ID.
- Type
str
- date_created¶
The date the trade was created.
- Type
str
- offerer_nation_id¶
The nation ID of the offerer.
- Type
str
- receiver_nation_id¶
The nation ID of the receiver.
- Type
str
- offer_type¶
The type of offer.
- Type
str
- buy_or_sell¶
Whether the offer was a buy or sell offer.
- Type
str
- resource¶
The resource being offered.
- Type
str
- quantity¶
The amount being offered.
- Type
int
- price¶
The price per unit of the offer.
- Type
int
- accepted¶
Whether or not the offer has been accepted.
- Type
bool
- original_trade_id¶
The trade ID of the original trade.
- Type
str
- date_accepted¶
The date the offer was accepted.
- Type
str
- to_dict() → Dict[str, Any]¶
Get a dict representation of this data.
- Returns
A dictionary of the data on the object.
- Return type
Dict[str, Any]
War¶
- aggressor_alliance_id
- aggressor_alliance_name
- aggressor_alliance_position
- aggressor_nation_id
- aggressor_offering_peace
- aggressor_resistance
- aggressor_war_policy
- air_superiority
- att_aircraft_killed
- att_alum_used
- att_attacks
- att_gas_used
- att_infra_destroyed
- att_infra_destroyed_value
- att_missiles_used
- att_money_looted
- att_mun_used
- att_nukes_used
- att_ships_killed
- att_soldiers_killed
- att_steel_used
- att_tanks_killed
- blockade
- date_declared
- def_aircraft_killed
- def_alum_used
- def_attacks
- def_gas_used
- def_infra_destroyed
- def_infra_destroyed_value
- def_missiles_used
- def_money_looted
- def_mun_used
- def_nukes_used
- def_ships_killed
- def_soldiers_killed
- def_steel_used
- def_tanks_killed
- defender_alliance_id
- defender_alliance_name
- defender_alliance_position
- defender_nation_id
- defender_offering_peace
- defender_resistance
- defender_war_policy
- ground_control
- reason
- turnsleft
- war_id
- war_type
- class pnwkit.ext.dumps.data.DumpWar(data: Mapping[str, Any])¶
Represents a war.
- war_id¶
The war ID.
- Type
str
- date_declared¶
The date the war was declared.
- Type
str
- aggressor_nation_id¶
The attacker ID.
- Type
str
- defender_nation_id¶
The defender ID.
- Type
str
- aggressor_alliance_name¶
The aggressor’s alliance name.
- Type
str
- aggressor_alliance_id¶
The aggressor’s alliance ID.
- Type
str
- aggressor_alliance_position¶
The position of the aggressor’s alliance.
- Type
int
- defender_alliance_name¶
The defender’s alliance name.
- Type
str
- defender_alliance_id¶
The defender’s alliance ID.
- Type
str
- defender_alliance_position¶
The position of the defender’s alliance.
- Type
int
- aggressor_offering_peace¶
Whether the aggressor is offering peace or not.
- Type
bool
- defender_offering_peace¶
Whether the defender is offering peace or not.
- Type
bool
- reason¶
The war reason.
- Type
str
- ground_control¶
The ID of the nation that has Ground Control.
- Type
str
- air_superiority¶
The ID of the nation that has Air Superiority.
- Type
str
- blockade¶
The ID of the nation that has a Naval Blockade.
- Type
str
- turnsleft¶
The turns left in the war.
- Type
int
- aggressor_resistance¶
The aggressor’s resistance.
- Type
int
- defender_resistance¶
The defender’s resistance.
- Type
int
- war_type¶
The war type.
- Type
str
- aggressor_war_policy¶
The aggressor’s war policy.
- Type
str
- defender_war_policy¶
The defender’s war policy.
- Type
str
- att_attacks¶
The number of attacks the aggressor has made.
- Type
int
- def_attacks¶
The number of attacks the defender has made.
- Type
int
- att_gas_used¶
The amount of gasoline used by the attacker.
- Type
float
- def_gas_used¶
The amount of gasoline used by the defender.
- Type
float
- att_mun_used¶
The amount of munitions used by the attacker.
- Type
float
- def_mun_used¶
The amount of munitions used by the defender.
- Type
float
- att_alum_used¶
The amount of aluminum used by the attacker.
- Type
int
- def_alum_used¶
The amount of aluminum used by the defender.
- Type
int
- att_steel_used¶
The amount of steel used by the attacker.
- Type
int
- def_steel_used¶
The amount of steel used by the defender.
- Type
int
- att_infra_destroyed¶
The amount of infrastructure destroyed by the attacker.
- Type
float
- def_infra_destroyed¶
The amount of infrastructure destroyed by the defender.
- Type
float
- att_money_looted¶
The amount of money looted by the attacker.
- Type
float
- def_money_looted¶
The amount of money looted by the attacker.
- Type
float
- att_soldiers_killed¶
The amount of soldiers killed by the attacker.
- Type
int
- def_soldiers_killed¶
The amount of soldiers killed by the defender.
- Type
int
- att_tanks_killed¶
The amount of tanks killed by the attacker.
- Type
int
- def_tanks_killed¶
The amount of tanks killed by the defender.
- Type
int
- att_aircraft_killed¶
The amount of aircraft killed by the attacker.
- Type
int
- def_aircraft_killed¶
The amount of aircraft killed by the defender.
- Type
int
- att_ships_killed¶
The amount of ships killed by the attacker.
- Type
int
- def_ships_killed¶
The amount of ships killed by the defender.
- Type
int
- att_missiles_used¶
The amount of missiles used by the attacker.
- Type
int
- def_missiles_used¶
The amount of missiles killed by the defender.
- Type
int
- att_nukes_used¶
The amount of nukes used by the attacker.
- Type
int
- def_nukes_used¶
The amount of nukes killed by the defender.
- Type
int
- att_infra_destroyed_value¶
The value of infrastructure destroyed by the attacker.
- Type
float
- def_infra_destroyed_value¶
The value of infrastructure destroyed by the defender.
- Type
float
- to_dict() → Dict[str, Any]¶
Get a dict representation of this data.
- Returns
A dictionary of the data on the object.
- Return type
Dict[str, Any]