@shipload/sdk 1.0.0-next.11 → 1.0.0-next.12

package/src/entities/ship.ts

@@ -1,221 +0,0 @@
-import {type UInt16, type UInt16Type, UInt32, UInt64, type UInt64Type} from '@wharfkit/antelope'
-import {ServerContract} from '../contracts'
-import {Coordinates, type CoordinatesType} from '../types'
-import {
-    type FloatPosition,
-    getDestinationLocation,
-    getInterpolatedPosition,
-    getPositionAt,
-    getFlightOrigin as travelGetFlightOrigin,
-} from '../travel/travel'
-import {
-    type ProjectedEntity,
-    projectFromCurrentState as sharedProjectFromCurrentState,
-    projectFromCurrentStateAt as sharedProjectFromCurrentStateAt,
-} from '../scheduling/projection'
-import {Location} from './location'
-import {ScheduleAccessor} from '../scheduling/accessor'
-import {InventoryAccessor} from './inventory-accessor'
-import type {EntityInventory} from './entity-inventory'
-import {
-    energyPercent as calcEnergyPercent,
-    needsRecharge as calcNeedsRecharge,
-    hasEnergyForDistance,
-    maxTravelDistance,
-} from '../capabilities/movement'
-import * as schedule from '../scheduling/schedule'
-
-export interface PackedModuleInput {
-    itemId: UInt16Type
-    stats: UInt64Type
-}
-
-export interface ShipStateInput {
-    id: UInt64Type
-    owner: string
-    name: string
-    coordinates: CoordinatesType | {x: number; y: number; z?: number}
-    hullmass?: number
-    capacity?: number
-    energy?: number
-    modules?: PackedModuleInput[]
-    schedule?: ServerContract.Types.schedule
-    cargo?: ServerContract.Types.cargo_item[]
-}
-
-type MovementEntity = {
-    engines: ServerContract.Types.movement_stats
-    generator: ServerContract.Types.energy_stats
-    energy: UInt16
-}
-
-export class Ship extends ServerContract.Types.entity_info {
-    private _sched?: ScheduleAccessor
-    private _inv?: InventoryAccessor
-
-    get name(): string {
-        return this.entity_name
-    }
-
-    get entityClass(): 'orbital' {
-        return 'orbital'
-    }
-
-    get canUndeploy(): boolean {
-        return true
-    }
-
-    get inv(): InventoryAccessor {
-        this._inv ??= new InventoryAccessor(this)
-        return this._inv
-    }
-
-    get inventory(): EntityInventory[] {
-        return this.inv.items
-    }
-
-    get sched(): ScheduleAccessor {
-        this._sched ??= new ScheduleAccessor(this)
-        return this._sched
-    }
-
-    get maxDistance(): UInt32 {
-        if (!this.generator || !this.engines) return UInt32.from(0)
-        return maxTravelDistance(this as MovementEntity)
-    }
-
-    get isIdle(): boolean {
-        return this.is_idle
-    }
-
-    getFlightOrigin(flightTaskIndex: number): Coordinates {
-        return Coordinates.from(travelGetFlightOrigin(this, flightTaskIndex))
-    }
-
-    destinationLocation(): Coordinates | undefined {
-        const dest = getDestinationLocation(this)
-        return dest ? Coordinates.from(dest) : undefined
-    }
-
-    /** Chain-tile coordinates at `now`. For smooth visual position use interpolatedPositionAt. */
-    positionAt(now: Date): Coordinates {
-        const taskIndex = this.sched.currentTaskIndex(now)
-        const progress = this.sched.currentTaskProgress(now)
-        return Coordinates.from(getPositionAt(this, taskIndex, progress))
-    }
-
-    interpolatedPositionAt(now: Date): FloatPosition {
-        const taskIndex = this.sched.currentTaskIndex(now)
-        const progress = this.sched.currentTaskProgressFloat(now)
-        return getInterpolatedPosition(this, taskIndex, progress)
-    }
-
-    isInFlight(now: Date): boolean {
-        return schedule.isInFlight(this, now)
-    }
-
-    isRecharging(now: Date): boolean {
-        return schedule.isRecharging(this, now)
-    }
-
-    isLoading(now: Date): boolean {
-        return schedule.isLoading(this, now)
-    }
-
-    isUnloading(now: Date): boolean {
-        return schedule.isUnloading(this, now)
-    }
-
-    isGathering(now: Date): boolean {
-        return schedule.isGathering(this, now)
-    }
-
-    get hasEngines(): boolean {
-        return this.engines !== undefined
-    }
-
-    get hasGenerator(): boolean {
-        return this.generator !== undefined
-    }
-
-    get hasGatherer(): boolean {
-        return this.gatherer !== undefined
-    }
-
-    get hasWarp(): boolean {
-        return this.warp !== undefined
-    }
-
-    project(): ProjectedEntity {
-        return sharedProjectFromCurrentState(this)
-    }
-
-    projectAt(now: Date): ProjectedEntity {
-        return sharedProjectFromCurrentStateAt(this, now)
-    }
-
-    get location(): Location {
-        return Location.from(this.coordinates)
-    }
-
-    get totalCargoMass(): UInt64 {
-        return this.inv.totalMass
-    }
-
-    get totalMass(): UInt64 {
-        let mass = UInt64.from(this.hullmass ?? 0).adding(this.totalCargoMass)
-        if (this.loaders) {
-            mass = mass.adding(UInt64.from(this.loaders.mass).multiplying(this.loaders.quantity))
-        }
-        return mass
-    }
-
-    get maxCapacity(): UInt64 {
-        return UInt64.from(this.capacity)
-    }
-
-    hasSpace(goodMass: UInt64, quantity: number): boolean {
-        return this.totalMass.adding(goodMass.multiplying(quantity)).lte(this.maxCapacity)
-    }
-
-    get availableCapacity(): UInt64 {
-        return this.totalMass.gte(this.maxCapacity)
-            ? UInt64.from(0)
-            : this.maxCapacity.subtracting(this.totalMass)
-    }
-
-    getCargoForItem(goodId: UInt64Type): EntityInventory | undefined {
-        return this.inv.forItem(goodId)
-    }
-
-    get sellableCargo(): EntityInventory[] {
-        return this.inv.sellable
-    }
-
-    get hasSellableCargo(): boolean {
-        return this.inv.hasSellable
-    }
-
-    get sellableGoodsCount(): number {
-        return this.inv.sellableCount
-    }
-
-    get isFull(): boolean {
-        return this.totalMass.gte(this.maxCapacity)
-    }
-
-    get energyPercent(): number {
-        if (!this.generator || this.energy === undefined) return 0
-        return calcEnergyPercent(this as MovementEntity)
-    }
-
-    get needsRecharge(): boolean {
-        if (!this.generator || this.energy === undefined) return false
-        return calcNeedsRecharge(this as MovementEntity)
-    }
-
-    hasEnergyFor(distance: UInt64): boolean {
-        if (!this.engines || !this.generator || this.energy === undefined) return false
-        return hasEnergyForDistance(this as MovementEntity, distance)
-    }
-}

package/src/entities/warehouse.ts

@@ -1,136 +0,0 @@
-import {UInt64, type UInt64Type} from '@wharfkit/antelope'
-import {ServerContract} from '../contracts'
-import type {CoordinatesType} from '../types'
-import {Location} from './location'
-import {ScheduleAccessor} from '../scheduling/accessor'
-import {InventoryAccessor} from './inventory-accessor'
-import type {EntityInventory} from './entity-inventory'
-import * as schedule from '../scheduling/schedule'
-import type {PackedModuleInput} from './ship'
-import {decodeCraftedItemStats} from '../derivation/crafting'
-import {getModuleCapabilityType, MODULE_LOADER} from '../capabilities/modules'
-import {computeLoaderCapabilities} from './ship-deploy'
-import {applySlotMultiplier, clampUint16, getSlotAmp, type InstalledModule} from './slot-multiplier'
-import type {EntitySlot} from '../data/recipes-runtime'
-
-export interface WarehouseStateInput {
-    id: UInt64Type
-    owner: string
-    name: string
-    coordinates: CoordinatesType | {x: number; y: number; z?: number}
-    hullmass?: number
-    capacity: number
-    modules?: PackedModuleInput[]
-    schedule?: ServerContract.Types.schedule
-    cargo?: ServerContract.Types.cargo_item[]
-}
-
-export class Warehouse extends ServerContract.Types.entity_info {
-    private _sched?: ScheduleAccessor
-    private _inv?: InventoryAccessor
-
-    get name(): string {
-        return this.entity_name
-    }
-
-    get entityClass(): 'planetary' {
-        return 'planetary'
-    }
-
-    get canDemolish(): boolean {
-        return true
-    }
-
-    get inv(): InventoryAccessor {
-        this._inv ??= new InventoryAccessor(this)
-        return this._inv
-    }
-
-    get inventory(): EntityInventory[] {
-        return this.inv.items
-    }
-
-    get sched(): ScheduleAccessor {
-        this._sched ??= new ScheduleAccessor(this)
-        return this._sched
-    }
-
-    get isIdle(): boolean {
-        return this.is_idle
-    }
-
-    isLoading(now: Date): boolean {
-        return schedule.isLoading(this, now)
-    }
-
-    isUnloading(now: Date): boolean {
-        return schedule.isUnloading(this, now)
-    }
-
-    get location(): Location {
-        return Location.from(this.coordinates)
-    }
-
-    get totalCargoMass(): UInt64 {
-        return this.inv.totalMass
-    }
-
-    get maxCapacity(): UInt64 {
-        return UInt64.from(this.capacity)
-    }
-
-    get availableCapacity(): UInt64 {
-        const cargo = this.totalCargoMass
-        return cargo.gte(this.maxCapacity) ? UInt64.from(0) : this.maxCapacity.subtracting(cargo)
-    }
-
-    hasSpace(goodMass: UInt64, quantity: number): boolean {
-        return this.totalCargoMass.adding(goodMass.multiplying(quantity)).lte(this.maxCapacity)
-    }
-
-    get isFull(): boolean {
-        return this.totalCargoMass.gte(this.maxCapacity)
-    }
-
-    getCargoForItem(goodId: UInt64Type): EntityInventory | undefined {
-        return this.inv.forItem(goodId)
-    }
-
-    get orbitalAltitude(): number {
-        return this.coordinates.z?.toNumber() || 0
-    }
-
-    get totalMass(): UInt64 {
-        const hull = this.hullmass ? UInt64.from(this.hullmass) : UInt64.from(0)
-        return hull.adding(this.totalCargoMass)
-    }
-}
-
-export function computeWarehouseCapabilities(
-    modules: InstalledModule[],
-    layout: EntitySlot[]
-): {
-    loaders?: {mass: number; thrust: number; quantity: number}
-} {
-    const warehouse: {loaders?: {mass: number; thrust: number; quantity: number}} = {}
-
-    const loaderModules = modules.filter((m) => getModuleCapabilityType(m.itemId) === MODULE_LOADER)
-    if (loaderModules.length > 0) {
-        let totalMass = 0
-        let totalThrust = 0
-        let totalQuantity = 0
-        for (const m of loaderModules) {
-            const caps = computeLoaderCapabilities(decodeCraftedItemStats(m.itemId, m.stats))
-            totalMass += caps.mass
-            totalThrust += applySlotMultiplier(caps.thrust, getSlotAmp(layout, m.slotIndex))
-            totalQuantity += caps.quantity
-        }
-        warehouse.loaders = {
-            mass: totalMass,
-            thrust: clampUint16(totalThrust),
-            quantity: totalQuantity,
-        }
-    }
-
-    return warehouse
-}

package/src/types/entity-traits.ts

@@ -1,171 +0,0 @@
-import {Name} from '@wharfkit/antelope'
-import {
-    ITEM_CONTAINER_T1_PACKED,
-    ITEM_CONTAINER_T2_PACKED,
-    ITEM_EXTRACTOR_T1_PACKED,
-    ITEM_FACTORY_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_FACTORY = Name.from('factory')
-export const ENTITY_CONTAINER = Name.from('container')
-export const ENTITY_NEXUS = Name.from('nexus')
-
-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':
-        case 'nexus':
-            return EntityClass.OrbitalVessel
-        case 'warehouse':
-        case 'extractor':
-        case 'factory':
-            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
-        case ITEM_FACTORY_T1_PACKED:
-            return ENTITY_FACTORY
-        default:
-            return null
-    }
-}
-
-export type EntityTypeName = 'ship' | 'warehouse' | 'extractor' | 'factory' | 'container' | 'nexus'
-
-export interface EntityTraits {
-    typeName: Name
-    isMovable: boolean
-    hasEnergy: boolean
-    hasLoaders: boolean
-    hasModules: boolean
-    notFoundError: string
-}
-
-export const shipTraits: EntityTraits = {
-    typeName: ENTITY_SHIP,
-    isMovable: true,
-    hasEnergy: true,
-    hasLoaders: true,
-    hasModules: true,
-
-    notFoundError: 'ship not found',
-}
-
-export const warehouseTraits: EntityTraits = {
-    typeName: ENTITY_WAREHOUSE,
-    isMovable: false,
-    hasEnergy: false,
-    hasLoaders: true,
-    hasModules: true,
-
-    notFoundError: 'warehouse not found',
-}
-
-export const extractorTraits: EntityTraits = {
-    typeName: ENTITY_EXTRACTOR,
-    isMovable: false,
-    hasEnergy: true,
-    hasLoaders: false,
-    hasModules: true,
-
-    notFoundError: 'extractor not found',
-}
-
-export const factoryTraits: EntityTraits = {
-    typeName: ENTITY_FACTORY,
-    isMovable: false,
-    hasEnergy: true,
-    hasLoaders: false,
-    hasModules: true,
-
-    notFoundError: 'factory not found',
-}
-
-export const containerTraits: EntityTraits = {
-    typeName: ENTITY_CONTAINER,
-    isMovable: true,
-    hasEnergy: false,
-    hasLoaders: false,
-    hasModules: false,
-
-    notFoundError: 'container not found',
-}
-
-export const nexusTraits: EntityTraits = {
-    typeName: ENTITY_NEXUS,
-    isMovable: false,
-    hasEnergy: false,
-    hasLoaders: false,
-    hasModules: false,
-
-    notFoundError: 'nexus not found',
-}
-
-export function getEntityTraits(entityType: Name | EntityTypeName): EntityTraits {
-    const typeName = typeof entityType === 'string' ? entityType : entityType.toString()
-
-    switch (typeName) {
-        case 'ship':
-            return shipTraits
-        case 'warehouse':
-            return warehouseTraits
-        case 'extractor':
-            return extractorTraits
-        case 'factory':
-            return factoryTraits
-        case 'container':
-            return containerTraits
-        case 'nexus':
-            return nexusTraits
-        default:
-            throw new Error(`Unknown entity type: ${typeName}`)
-    }
-}
-
-export function isShip(entity: {type?: Name}): boolean {
-    return entity.type?.equals(ENTITY_SHIP) ?? false
-}
-
-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 isFactory(entity: {type?: Name}): boolean {
-    return entity.type?.equals(ENTITY_FACTORY) ?? false
-}
-
-export function isContainer(entity: {type?: Name}): boolean {
-    return entity.type?.equals(ENTITY_CONTAINER) ?? false
-}
-
-export function isNexus(entity: {type?: Name}): boolean {
-    return entity.type?.equals(ENTITY_NEXUS) ?? false
-}