Geospatiale Nashorn (AnalyticalEngine) is the subset branch of Geospatiale and a version of Geospatiale Nashorn used in AnalyticalEngine, a Java game engine primarily focused on grand-strategy games (though it may be used for other applications) developed as part of an effort to open-source AOC3.
It is primarily housed in AnalyticalEngine/GameFramework/core/map/map_scripting.js, where you can find the functions listed below in the Documentation section. Note that it is recommended to use either HYDE data, or Eoscala/Velkscala data when populating economic/population values.
- getNumberOfProvinces() - Fetches the current number of provinces from a map editor's ProvincePoints.json file.
- arg0_file_path: (String) - The file path to that map editor's ProvincePoints.json.
- Returns: (Number)
- loadEconomyNumberData() - Sets in-game Economy data from a GeoPNG and Provinces raster.
- arg0_provinces_file_path: (String) - The file path containing a province bitmap.
- arg1_numbers_file_path: (String) - The file path to a GeoPNG.
- Returns: (Object<Number: Number>) - Province ID to Economy value dictionary.
- loadNumberDataFromImage() - Loads in number data from a GeoPNG and Provinces raster and returns it as a Province ID to Value dictionary.
- arg0_provinces_file_path: (String) - The file path containing a province bitmap.
- arg1_numbers_file_path: (String) - The file path to a GeoPNG.
- Returns: (Object<Number: Number>) - Province ID to Value dictionary.
- loadPercentageDataFromImage() - Loads in percentage data from a GeoPNG and Provinces raster and returns the percentage values per province.
- arg0_provinces_file_path: (String) - The file path containing a province bitmap.
- arg1_percentages_file_path: (String) - The file path to a GeoPNG of a percentages type.
- arg2_max_value: (Number) - The maximum value in-game. 1 by default.
- Returns: (Object<Number: Number>) - Province ID to Percentage Value dictionary.
- loadPopulationNumberData() - Sets in-game Population data from a GeoPNG and Provinces raster.
- arg0_provinces_file_path: (String) - The file path containing a province bitmap.
- arg1_numbers_file_path: (String) - The file path to a GeoPNG.
- Returns: (Object<Number: Number>) - Province ID to Population value dictionary.
- loadPopulationPercentageData() - Sets in-game Population Growth Rate data from a GeoPNG Percentages and Provinces raster.
- arg0_provinces_file_path: (String) - The file path containing a province bitmap.
- arg1_numbers_file_path: (String) - The file path to a GeoPNG of a percentages type.
- Returns: (Object<Number: Number>) - Province ID to Population Growth Rate value dictionary.
- saveProvinceFileAsImage() - Saves a province file as an image in the base folder.
- arg0_province_name: (Number/Object<Province>/String) - The province name/ID to save as an image.
- Returns: (Array<Object>)
- (Object):
- province_id: (String)
- x: (Number)
- y: (Number)
- file_path: (String)
- saveProvinceFilesAsImage() - Saves multiple province files as a single image bitmap in the base folder.
- arg0_province_name: (Array<Number/Object<Province>/String>) - The province names/IDs to save as an image.
- arg1_options: (Object)
- output_file_path: (String) - Optional. ‘province_map.png' by default.
- Returns: (Array<Object>)
- province_id: (String)
- x: (Number)
- y: (Number)
- file_path: (String)
- saveProvinceMap() - Saves the currently loaded map as an output province map.
- arg0_file_path: (String) - The output file path.
- Returns: (Same as saveProvinceFilesAsImage()).
- writeASCFileToImage() - Used to write a .asc file to a valid image.
- arg0_input_file_path: (String) - The file path of the ASC file to translate to a PNG.
- arg1_options: (Object)
- mode: (String) - Optional. What the mode should be. Either ‘absolute’/'percentage'. ‘percentage’ by default.
- output_file_path: (String) - Optional. The output file path in the base directory. ‘asc_output.png’ by default.
- scalar: (Number) - Optional. The scalar to divide the max_value by. 2 by default.
- Returns: (Object)
- dataframe: (Array<Array<Number>>)
- max_value: (Number)
- writeProvincesToFile() - Writes a map editor's ProvincePoints.json to an AOC3-compatible ProvincePoints.json.
- arg0_input_file_path: (String) - The input ProvincePoints.json to transform.
- arg1_output_file_path: (String) - Optional. The output ProvincePoints.json file name. ‘ProvincePoints.json’ by default.
- Returns: (String) - The JSON string of the processed data.