@shipload/sdk 2.0.0-rc3 → 2.0.0-rc5

package/lib/shipload.d.ts

@@ -261,6 +261,7 @@ declare namespace Types {
         ship_loaders: loader_stats;
         ship_trade: trade_stats;
         ship_extractor: extractor_stats;
+        ship_warp: warp_stats;
         warehouse_capacity: UInt32;
         warehouse_z: UInt16;
         warehouse_loaders: loader_stats;
@@ -398,6 +399,11 @@ declare namespace Types {
     }
     class getstarter extends Struct {
     }
+    class getstratum extends Struct {
+        x: Int64;
+        y: Int64;
+        stratum: UInt16;
+    }
     class getsummaries extends Struct {
         owner: Name;
         entity_type?: Name;
@@ -438,6 +444,7 @@ declare namespace Types {
     class location_derived extends Struct {
         static_props: location_static;
         epoch_props: location_epoch;
+        size: UInt16;
     }
     class location_item extends Struct {
         id: UInt16;
@@ -535,6 +542,11 @@ declare namespace Types {
         entitygroup?: UInt64;
         group_members?: entity_ref[];
     }
+    class resource_stats extends Struct {
+        stat1: UInt16;
+        stat2: UInt16;
+        stat3: UInt16;
+    }
     class salt extends Struct {
         salt: UInt64;
     }
@@ -578,6 +590,16 @@ declare namespace Types {
         seed: Checksum256;
         commit: Checksum256;
     }
+    class stratum_info extends Struct {
+        item_id: UInt16;
+        seed: UInt64;
+        richness: UInt16;
+        reserve: UInt32;
+    }
+    class stratum_data extends Struct {
+        stratum: stratum_info;
+        stats: resource_stats;
+    }
     class supply_row extends Struct {
         id: UInt64;
         coordinates: coordinates;
@@ -631,6 +653,12 @@ declare namespace Types {
         loaders: loader_stats;
         schedule?: schedule;
     }
+    class warp extends Struct {
+        entity_type: Name;
+        id: UInt64;
+        x: Int64;
+        y: Int64;
+    }
     class wipe extends Struct {
     }
     class wipesequence extends Struct {
@@ -683,6 +711,7 @@ declare namespace ActionParams {
             ship_loaders: Type.loader_stats;
             ship_trade: Type.trade_stats;
             ship_extractor: Type.extractor_stats;
+            ship_warp: Type.warp_stats;
             warehouse_capacity: UInt32Type;
             warehouse_z: UInt16Type;
             warehouse_loaders: Type.loader_stats;
@@ -713,6 +742,9 @@ declare namespace ActionParams {
             depth: UInt16Type;
             drill: UInt16Type;
         }
+        interface warp_stats {
+            range: UInt32Type;
+        }
         interface item_def {
             id: UInt16Type;
             base_price: UInt32Type;
@@ -839,6 +871,11 @@ declare namespace ActionParams {
     }
     interface getstarter {
     }
+    interface getstratum {
+        x: Int64Type;
+        y: Int64Type;
+        stratum: UInt16Type;
+    }
     interface getsummaries {
         owner: NameType;
         entity_type?: NameType;
@@ -916,6 +953,12 @@ declare namespace ActionParams {
         account: NameType;
         amount: Int64Type;
     }
+    interface warp {
+        entity_type: NameType;
+        id: UInt64Type;
+        x: Int64Type;
+        y: Int64Type;
+    }
     interface wipe {
     }
     interface wipesequence {
@@ -943,6 +986,7 @@ interface ActionNameParams {
     getnearby: ActionParams.getnearby;
     getplayer: ActionParams.getplayer;
     getstarter: ActionParams.getstarter;
+    getstratum: ActionParams.getstratum;
     getsummaries: ActionParams.getsummaries;
     grouptravel: ActionParams.grouptravel;
     hash: ActionParams.hash;
@@ -961,6 +1005,7 @@ interface ActionNameParams {
     travel: ActionParams.travel;
     updatecredit: ActionParams.updatecredit;
     updatedebt: ActionParams.updatedebt;
+    warp: ActionParams.warp;
     wipe: ActionParams.wipe;
     wipesequence: ActionParams.wipesequence;
 }
@@ -978,6 +1023,7 @@ interface ActionReturnValues {
     getnearby: Types.nearby_info;
     getplayer: Types.player_info;
     getstarter: Types.starter_info;
+    getstratum: Types.stratum_data;
     getsummaries: Types.entity_summary[];
     grouptravel: Types.task_results;
     hash: Checksum256;
@@ -987,6 +1033,7 @@ interface ActionReturnValues {
     sellitems: Types.task_results;
     transfer: Types.task_results;
     travel: Types.task_results;
+    warp: Types.task_results;
 }
 type ActionReturnNames = keyof ActionReturnValues;
 declare class Contract extends Contract$2 {
@@ -1150,8 +1197,8 @@ interface Distance {
     destination: ActionParams.Type.coordinates;
     distance: UInt16;
 }
-type ResourceCategory = 'metal' | 'gas' | 'mineral' | 'organic';
-type ResourceRarity = 'common' | 'uncommon' | 'rare' | 'epic' | 'legendary';
+type ResourceCategory = 'metal' | 'precious' | 'gas' | 'mineral' | 'organic';
+type ResourceTier = 't1' | 't2' | 't3' | 't4' | 't5';
 declare class Item extends Struct {
     id: UInt16;
     name: string;
@@ -1159,7 +1206,7 @@ declare class Item extends Struct {
     base_price: UInt32;
     mass: UInt32;
     category: ResourceCategory;
-    rarity: ResourceRarity;
+    tier: ResourceTier;
     color: string;
 }
 declare class ItemPrice extends Struct {
@@ -2441,6 +2488,7 @@ interface Rarity {
     maxMultiplier: number;
 }
 declare function getRarity(gameSeed: Checksum256Type, epochSeed: Checksum256Type, location: CoordinatesType, goodId: UInt16Type): Rarity;
+declare function getRarityMultiplier(gameSeed: Checksum256Type, epochSeed: Checksum256Type, location: CoordinatesType, goodId: UInt16Type): number;
 declare function marketPrice(location: ActionParams.Type.coordinates, goodId: UInt16Type, gameSeed: Checksum256Type, state: Types.state_row): ItemPrice;
 declare function marketPrices(location: ActionParams.Type.coordinates, gameSeed: Checksum256Type, state: Types.state_row): ItemPrice[];
 
@@ -2459,21 +2507,20 @@ interface StratumInfo {
     reserve: number;
 }
 interface ResourceStats {
-    purity: number;
-    density: number;
-    reactivity: number;
-    resonance: number;
+    stat1: number;
+    stat2: number;
+    stat3: number;
 }
 declare function deriveStratum(epochSeed: Checksum256Type, coords: CoordinatesType, stratum: number, locationType: number, subtype: number, _maxDepth: number): StratumInfo;
 declare function deriveResourceStats(seed: bigint): ResourceStats;
 
 declare function deriveLocationSize(loc: Types.location_static): number;
 
-declare const DEPTH_THRESHOLD_COMMON = 0;
-declare const DEPTH_THRESHOLD_UNCOMMON = 2000;
-declare const DEPTH_THRESHOLD_RARE = 10000;
-declare const DEPTH_THRESHOLD_EPIC = 30000;
-declare const DEPTH_THRESHOLD_LEGENDARY = 55000;
+declare const DEPTH_THRESHOLD_T1 = 0;
+declare const DEPTH_THRESHOLD_T2 = 2000;
+declare const DEPTH_THRESHOLD_T3 = 10000;
+declare const DEPTH_THRESHOLD_T4 = 30000;
+declare const DEPTH_THRESHOLD_T5 = 55000;
 declare const LOCATION_MIN_DEPTH = 500;
 declare const LOCATION_MAX_DEPTH = 65535;
 declare const PLANET_SUBTYPE_GAS_GIANT = 0;
@@ -2482,13 +2529,32 @@ declare const PLANET_SUBTYPE_TERRESTRIAL = 2;
 declare const PLANET_SUBTYPE_ICY = 3;
 declare const PLANET_SUBTYPE_OCEAN = 4;
 declare const PLANET_SUBTYPE_INDUSTRIAL = 5;
-declare function getDepthThreshold(rarity: ResourceRarity): number;
-declare function getResourceRarity(itemId: number): ResourceRarity;
+declare function getDepthThreshold(tier: ResourceTier): number;
+declare function getResourceTier(itemId: number): ResourceTier;
 declare function getResourceWeight(itemId: number, stratum: number): number;
 declare function getLocationCandidates(locationType: number, subtype: number): number[];
 declare function getEligibleResources(locationType: number, subtype: number, stratum: number): number[];
 declare function depthScaleFactor(stratum: number): number;
 
+interface StatDefinition {
+    key: string;
+    label: string;
+    abbreviation: string;
+    purpose: string;
+    inverted?: boolean;
+}
+declare function getStatDefinitions(category: ResourceCategory): StatDefinition[];
+declare function getStatName(category: ResourceCategory, index: 0 | 1 | 2): StatDefinition;
+interface NamedStats {
+    definitions: StatDefinition[];
+    values: [number, number, number];
+}
+declare function resolveStats(category: ResourceCategory, stats: {
+    stat1: number;
+    stat2: number;
+    stat3: number;
+}): NamedStats;
+
 declare function hash(seed: Checksum256Type, string: string): Checksum256;
 declare function hash512(seed: Checksum256Type, string: string): Checksum512;
 
@@ -2619,4 +2685,4 @@ type location_epoch = Types.location_epoch;
 type location_derived = Types.location_derived;
 type location_row = Types.location_row;
 
-export { ActionsManager, AnyEntity, BetterSaleLocation, COMMIT_ALREADY_SET, COMMIT_CANNOT_MATCH, COMMIT_NOT_SET, COMPANY_NOT_FOUND, CONTAINER_Z, CargoData, CargoMassInfo, CargoSaleItem, CollectActionType, CollectAnalysis, CollectAnalysisCallbacks, CollectAnalysisOptions, CollectOption, Container, ContainerEntity, ContainerStateInput, Coordinates, CoordinatesType, DEPTH_THRESHOLD_COMMON, DEPTH_THRESHOLD_EPIC, DEPTH_THRESHOLD_LEGENDARY, DEPTH_THRESHOLD_RARE, DEPTH_THRESHOLD_UNCOMMON, Deal, DiscountedItemInfo, Distance, EPOCH_NON_ZERO, EPOCH_NOT_READY, ERROR_SYSTEM_ALREADY_INITIALIZED, ERROR_SYSTEM_DISABLED, ERROR_SYSTEM_NOT_INITIALIZED, EnergyCapability, EntitiesManager, Entity, EntityCapabilities, EntityInventory, EntityRefInput, EntityState, EntityType, EntityTypeName, EpochInfo, EpochsManager, EstimateTravelTimeOptions, EstimatedTravelTime, ExtractorCapability, FindDealsOptions, GAME_NOT_FOUND, GAME_SEED_NOT_SET, GameState, HasCapacity, HasCargo, HasCargomass, HasScheduleAndLocation, INITIAL_CONTAINER_CAPACITY, INITIAL_CONTAINER_HULLMASS, INITIAL_EXTRACTOR_DRAIN, INITIAL_EXTRACTOR_EFFICIENCY, INITIAL_EXTRACTOR_RATE, INITIAL_LOADER_MASS, INITIAL_LOADER_QUANTITY, INITIAL_LOADER_THRUST, INITIAL_SHIP_CAPACITY, INITIAL_SHIP_DRAIN, INITIAL_SHIP_ENERGY, INITIAL_SHIP_GENERATOR_CAPACITY, INITIAL_SHIP_HULLMASS, INITIAL_SHIP_MASS, INITIAL_SHIP_RECHARGE, INITIAL_SHIP_THRUST, INITIAL_SHIP_Z, INITIAL_WAREHOUSE_CAPACITY, INSUFFICIENT_BALANCE, INSUFFICIENT_ITEM_QUANTITY, INSUFFICIENT_ITEM_SUPPLY, INVALID_AMOUNT, ITEM_DOES_NOT_EXIST, ITEM_NOT_AVAILABLE_AT_LOCATION, InventoryAccessor, Item, ItemPrice, LOCATION_MAX_DEPTH, LOCATION_MIN_DEPTH, LoadTimeBreakdown, LoaderCapability, Location, LocationType, LocationsManager, MAX_ORBITAL_ALTITUDE, MIN_ORBITAL_ALTITUDE, MassCapability, MovementCapability, NO_SCHEDULE, PLANET_SUBTYPE_GAS_GIANT, PLANET_SUBTYPE_ICY, PLANET_SUBTYPE_INDUSTRIAL, PLANET_SUBTYPE_OCEAN, PLANET_SUBTYPE_ROCKY, PLANET_SUBTYPE_TERRESTRIAL, PLAYER_ALREADY_JOINED, PLAYER_NOT_FOUND, PRECISION, platform as PlatformContract, Player, PlayerStateInput, PlayersManager, PotentialDeal, Projectable, ProjectedEntity, REQUIRES_MORE_THAN_ONE, REQUIRES_POSITIVE_VALUE, Rarities, Rarity, RepositionLocation, ResourceCategory, ResourceRarity, ResourceStats, SHIP_ALREADY_THERE, SHIP_ALREADY_TRAVELING, SHIP_CANNOT_BUY_TRAVELING, SHIP_CANNOT_CANCEL_TASK, SHIP_CANNOT_UPDATE_TRAVELING, SHIP_CARGO_NOT_LOADED, SHIP_CARGO_NOT_OWNED, SHIP_INVALID_CARGO, SHIP_INVALID_DESTINATION, SHIP_INVALID_TRAVEL_DURATION, SHIP_NOT_ARRIVED, SHIP_NOT_ENOUGH_ENERGY, SHIP_NOT_ENOUGH_ENERGY_CAPACITY, SHIP_NOT_FOUND, SHIP_NOT_IDLE, SHIP_NOT_OWNED, SHIP_NO_COMPLETED_TASKS, SHIP_NO_TASKS_TO_CANCEL, ScheduleAccessor, ScheduleCapability, ScheduleData, Scheduleable, server as ServerContract, Ship, ShipEntity, ShipLike, ShipStateInput, Shipload, StorageCapability, StratumInfo, TRAVEL_MAX_DURATION, TaskCancelable, TaskType, TradeCalculation, TradeCapability, TradeProfitResult, TradesManager, TransferEntity, WAREHOUSE_ALREADY_AT_LOCATION, WAREHOUSE_CAPACITY_EXCEEDED, WAREHOUSE_NOT_FOUND, WAREHOUSE_Z, Warehouse, WarehouseEntity, WarehouseStateInput, analyzeCargoSale, analyzeCollectOptions, availableCapacity$1 as availableCapacity, availableCapacityFromMass, calcCargoMass, calcCargoValue, calcEnergyUsage, calcLoadDuration, calc_acceleration, calc_energyusage, calc_extraction_duration, calc_extraction_energy, calc_flighttime, calc_loader_acceleration, calc_loader_flighttime, calc_orbital_altitude, calc_rechargetime, calc_ship_acceleration, calc_ship_flighttime, calc_ship_mass, calc_ship_rechargetime, calc_transfer_duration, calculateBreakEvenPrice, calculateFlightTime, calculateLoadTimeBreakdown, calculateMaxTradeQuantity, calculateProfitPerMass, calculateProfitPerSecond, calculateROI, calculateRefuelingTime, calculateTradeProfit, calculateTransferTime, calculateUpdatedCargoCost, canMove, capsHasExtractor, capsHasLoaders, capsHasMass, capsHasMovement, capsHasStorage, capsHasTrade, cargoUtils, cargo_item, container_row, coordsToLocationId, createExploreOption, createInventoryAccessor, createProjectedEntity, createScheduleAccessor, createSellAndRepositionOption, createSellAndStayOption, createSellAndTradeOption, createTravelToSellOption, Shipload as default, depthScaleFactor, deriveLocation, deriveLocationEpoch, deriveLocationSize, deriveLocationStatic, deriveResourceStats, deriveStratum, distanceBetweenCoordinates, distanceBetweenPoints, energyPercent, energy_stats, estimateDealTravelTime, estimateTravelTime, extractor_stats, findBestDeal, findBestItemToTrade, findDealsForShip, findNearbyPlanets, getCurrentEpoch, getDepthThreshold, getDestinationLocation, getEligibleResources, getEpochInfo, getFlightOrigin, getItem, getItems, getLocationCandidates, getLocationType, getPositionAt, getRarity, getResourceRarity, getResourceWeight, getSystemName, hasEnergy, hasEnergyForDistance, hasExtractor, hasLoaders, hasMass, hasSchedule, hasSpace$1 as hasSpace, hasSpaceForMass, hasStorage, hasSystem, hasTrade, hash, hash512, isExtractableLocation, isFull$1 as isFull, isFullFromMass, isProfitable, itemIds, lerp, loader_stats, location_derived, location_epoch, location_row, location_static, makeContainer, makeShip, makeWarehouse, marketPrice, marketPrices, maxTravelDistance, movement_stats, needsRecharge, projectEntity, projectEntityAt, rotation, schedule, task, toLocation, warehouse_row };
+export { ActionsManager, AnyEntity, BetterSaleLocation, COMMIT_ALREADY_SET, COMMIT_CANNOT_MATCH, COMMIT_NOT_SET, COMPANY_NOT_FOUND, CONTAINER_Z, CargoData, CargoMassInfo, CargoSaleItem, CollectActionType, CollectAnalysis, CollectAnalysisCallbacks, CollectAnalysisOptions, CollectOption, Container, ContainerEntity, ContainerStateInput, Coordinates, CoordinatesType, DEPTH_THRESHOLD_T1, DEPTH_THRESHOLD_T2, DEPTH_THRESHOLD_T3, DEPTH_THRESHOLD_T4, DEPTH_THRESHOLD_T5, Deal, DiscountedItemInfo, Distance, EPOCH_NON_ZERO, EPOCH_NOT_READY, ERROR_SYSTEM_ALREADY_INITIALIZED, ERROR_SYSTEM_DISABLED, ERROR_SYSTEM_NOT_INITIALIZED, EnergyCapability, EntitiesManager, Entity, EntityCapabilities, EntityInventory, EntityRefInput, EntityState, EntityType, EntityTypeName, EpochInfo, EpochsManager, EstimateTravelTimeOptions, EstimatedTravelTime, ExtractorCapability, FindDealsOptions, GAME_NOT_FOUND, GAME_SEED_NOT_SET, GameState, HasCapacity, HasCargo, HasCargomass, HasScheduleAndLocation, INITIAL_CONTAINER_CAPACITY, INITIAL_CONTAINER_HULLMASS, INITIAL_EXTRACTOR_DRAIN, INITIAL_EXTRACTOR_EFFICIENCY, INITIAL_EXTRACTOR_RATE, INITIAL_LOADER_MASS, INITIAL_LOADER_QUANTITY, INITIAL_LOADER_THRUST, INITIAL_SHIP_CAPACITY, INITIAL_SHIP_DRAIN, INITIAL_SHIP_ENERGY, INITIAL_SHIP_GENERATOR_CAPACITY, INITIAL_SHIP_HULLMASS, INITIAL_SHIP_MASS, INITIAL_SHIP_RECHARGE, INITIAL_SHIP_THRUST, INITIAL_SHIP_Z, INITIAL_WAREHOUSE_CAPACITY, INSUFFICIENT_BALANCE, INSUFFICIENT_ITEM_QUANTITY, INSUFFICIENT_ITEM_SUPPLY, INVALID_AMOUNT, ITEM_DOES_NOT_EXIST, ITEM_NOT_AVAILABLE_AT_LOCATION, InventoryAccessor, Item, ItemPrice, LOCATION_MAX_DEPTH, LOCATION_MIN_DEPTH, LoadTimeBreakdown, LoaderCapability, Location, LocationType, LocationsManager, MAX_ORBITAL_ALTITUDE, MIN_ORBITAL_ALTITUDE, MassCapability, MovementCapability, NO_SCHEDULE, NamedStats, PLANET_SUBTYPE_GAS_GIANT, PLANET_SUBTYPE_ICY, PLANET_SUBTYPE_INDUSTRIAL, PLANET_SUBTYPE_OCEAN, PLANET_SUBTYPE_ROCKY, PLANET_SUBTYPE_TERRESTRIAL, PLAYER_ALREADY_JOINED, PLAYER_NOT_FOUND, PRECISION, platform as PlatformContract, Player, PlayerStateInput, PlayersManager, PotentialDeal, Projectable, ProjectedEntity, REQUIRES_MORE_THAN_ONE, REQUIRES_POSITIVE_VALUE, Rarities, Rarity, RepositionLocation, ResourceCategory, ResourceStats, ResourceTier, SHIP_ALREADY_THERE, SHIP_ALREADY_TRAVELING, SHIP_CANNOT_BUY_TRAVELING, SHIP_CANNOT_CANCEL_TASK, SHIP_CANNOT_UPDATE_TRAVELING, SHIP_CARGO_NOT_LOADED, SHIP_CARGO_NOT_OWNED, SHIP_INVALID_CARGO, SHIP_INVALID_DESTINATION, SHIP_INVALID_TRAVEL_DURATION, SHIP_NOT_ARRIVED, SHIP_NOT_ENOUGH_ENERGY, SHIP_NOT_ENOUGH_ENERGY_CAPACITY, SHIP_NOT_FOUND, SHIP_NOT_IDLE, SHIP_NOT_OWNED, SHIP_NO_COMPLETED_TASKS, SHIP_NO_TASKS_TO_CANCEL, ScheduleAccessor, ScheduleCapability, ScheduleData, Scheduleable, server as ServerContract, Ship, ShipEntity, ShipLike, ShipStateInput, Shipload, StatDefinition, StorageCapability, StratumInfo, TRAVEL_MAX_DURATION, TaskCancelable, TaskType, TradeCalculation, TradeCapability, TradeProfitResult, TradesManager, TransferEntity, WAREHOUSE_ALREADY_AT_LOCATION, WAREHOUSE_CAPACITY_EXCEEDED, WAREHOUSE_NOT_FOUND, WAREHOUSE_Z, Warehouse, WarehouseEntity, WarehouseStateInput, analyzeCargoSale, analyzeCollectOptions, availableCapacity$1 as availableCapacity, availableCapacityFromMass, calcCargoMass, calcCargoValue, calcEnergyUsage, calcLoadDuration, calc_acceleration, calc_energyusage, calc_extraction_duration, calc_extraction_energy, calc_flighttime, calc_loader_acceleration, calc_loader_flighttime, calc_orbital_altitude, calc_rechargetime, calc_ship_acceleration, calc_ship_flighttime, calc_ship_mass, calc_ship_rechargetime, calc_transfer_duration, calculateBreakEvenPrice, calculateFlightTime, calculateLoadTimeBreakdown, calculateMaxTradeQuantity, calculateProfitPerMass, calculateProfitPerSecond, calculateROI, calculateRefuelingTime, calculateTradeProfit, calculateTransferTime, calculateUpdatedCargoCost, canMove, capsHasExtractor, capsHasLoaders, capsHasMass, capsHasMovement, capsHasStorage, capsHasTrade, cargoUtils, cargo_item, container_row, coordsToLocationId, createExploreOption, createInventoryAccessor, createProjectedEntity, createScheduleAccessor, createSellAndRepositionOption, createSellAndStayOption, createSellAndTradeOption, createTravelToSellOption, Shipload as default, depthScaleFactor, deriveLocation, deriveLocationEpoch, deriveLocationSize, deriveLocationStatic, deriveResourceStats, deriveStratum, distanceBetweenCoordinates, distanceBetweenPoints, energyPercent, energy_stats, estimateDealTravelTime, estimateTravelTime, extractor_stats, findBestDeal, findBestItemToTrade, findDealsForShip, findNearbyPlanets, getCurrentEpoch, getDepthThreshold, getDestinationLocation, getEligibleResources, getEpochInfo, getFlightOrigin, getItem, getItems, getLocationCandidates, getLocationType, getPositionAt, getRarity, getRarityMultiplier, getResourceTier, getResourceWeight, getStatDefinitions, getStatName, getSystemName, hasEnergy, hasEnergyForDistance, hasExtractor, hasLoaders, hasMass, hasSchedule, hasSpace$1 as hasSpace, hasSpaceForMass, hasStorage, hasSystem, hasTrade, hash, hash512, isExtractableLocation, isFull$1 as isFull, isFullFromMass, isProfitable, itemIds, lerp, loader_stats, location_derived, location_epoch, location_row, location_static, makeContainer, makeShip, makeWarehouse, marketPrice, marketPrices, maxTravelDistance, movement_stats, needsRecharge, projectEntity, projectEntityAt, resolveStats, rotation, schedule, task, toLocation, warehouse_row };