@shipload/sdk 1.0.0-next.7 → 1.0.0-next.9

package/src/types/entity-traits.ts

@@ -1,10 +1,53 @@
 import {Name} from '@wharfkit/antelope'
+import {
+    ITEM_CONTAINER_T1_PACKED,
+    ITEM_CONTAINER_T2_PACKED,
+    ITEM_EXTRACTOR_T1_PACKED,
+    ITEM_SHIP_T1_PACKED,
+    ITEM_WAREHOUSE_T1_PACKED,
+} from '../data/item-ids'
 
 export const ENTITY_SHIP = Name.from('ship')
 export const ENTITY_WAREHOUSE = Name.from('warehouse')
+export const ENTITY_EXTRACTOR = Name.from('extractor')
 export const ENTITY_CONTAINER = Name.from('container')
 
-export type EntityTypeName = 'ship' | 'warehouse' | 'container'
+export enum EntityClass {
+    OrbitalVessel = 0,
+    PlanetaryStructure = 1,
+}
+
+export function getEntityClass(entityType: Name | EntityTypeName): EntityClass {
+    const typeName = typeof entityType === 'string' ? entityType : entityType.toString()
+    switch (typeName) {
+        case 'ship':
+        case 'container':
+            return EntityClass.OrbitalVessel
+        case 'warehouse':
+        case 'extractor':
+            return EntityClass.PlanetaryStructure
+        default:
+            throw new Error(`Entity type has no class: ${typeName}`)
+    }
+}
+
+export function getPackedEntityType(itemId: number): Name | null {
+    switch (itemId) {
+        case ITEM_SHIP_T1_PACKED:
+            return ENTITY_SHIP
+        case ITEM_CONTAINER_T1_PACKED:
+        case ITEM_CONTAINER_T2_PACKED:
+            return ENTITY_CONTAINER
+        case ITEM_WAREHOUSE_T1_PACKED:
+            return ENTITY_WAREHOUSE
+        case ITEM_EXTRACTOR_T1_PACKED:
+            return ENTITY_EXTRACTOR
+        default:
+            return null
+    }
+}
+
+export type EntityTypeName = 'ship' | 'warehouse' | 'extractor' | 'container'
 
 export interface EntityTraits {
     typeName: Name
@@ -32,6 +75,15 @@ export const warehouseTraits: EntityTraits = {
     notFoundError: 'warehouse not found',
 }
 
+export const extractorTraits: EntityTraits = {
+    typeName: ENTITY_EXTRACTOR,
+    isMovable: false,
+    hasEnergy: true,
+    hasLoaders: false,
+
+    notFoundError: 'extractor not found',
+}
+
 export const containerTraits: EntityTraits = {
     typeName: ENTITY_CONTAINER,
     isMovable: true,
@@ -49,6 +101,8 @@ export function getEntityTraits(entityType: Name | EntityTypeName): EntityTraits
             return shipTraits
         case 'warehouse':
             return warehouseTraits
+        case 'extractor':
+            return extractorTraits
         case 'container':
             return containerTraits
         default:
@@ -64,6 +118,10 @@ export function isWarehouse(entity: {type?: Name}): boolean {
     return entity.type?.equals(ENTITY_WAREHOUSE) ?? false
 }
 
+export function isExtractor(entity: {type?: Name}): boolean {
+    return entity.type?.equals(ENTITY_EXTRACTOR) ?? false
+}
+
 export function isContainer(entity: {type?: Name}): boolean {
     return entity.type?.equals(ENTITY_CONTAINER) ?? false
 }

package/src/types.ts

@@ -12,7 +12,7 @@ import {ServerContract} from './contracts'
 export const PRECISION = 10000
 export const CRAFT_ENERGY_DIVISOR = 150000
 
-export const WAREHOUSE_Z = 500
+export const PLANETARY_STRUCTURE_Z = 0
 
 export const CONTAINER_Z = 300
 
@@ -23,6 +23,8 @@ export const MAX_ORBITAL_ALTITUDE = 3000
 
 export const BASE_ORBITAL_MASS = 100000
 
+export const MIN_TRANSFER_DISTANCE = 100
+
 export interface ShipLike {
     coordinates: ServerContract.Types.coordinates
     hullmass?: UInt32

package/src/utils/system.ts

@@ -150,6 +150,13 @@ export function deriveLocationStatic(
     return loc
 }
 
+export function isLocationBuildable(
+    gameSeed: Checksum256Type,
+    coordinates: CoordinatesType
+): boolean {
+    return getLocationType(gameSeed, coordinates) === LocationType.PLANET
+}
+
 export function deriveLocation(
     gameSeed: Checksum256Type,
     coordinates: CoordinatesType