@spacemolt/lib 16.2.0 → 16.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/COMMANDS.md +8 -7
- package/dist/generated/actions.gen.d.ts +2 -2
- package/dist/generated/commands.gen.d.ts +21 -13
- package/dist/generated/openapi/types.gen.d.ts +717 -19
- package/dist/index.js +27 -15
- package/dist/index.js.map +4 -4
- package/package.json +1 -1
|
@@ -1,4 +1,8 @@
|
|
|
1
1
|
export type AbandonMissionResponse = {
|
|
2
|
+
/**
|
|
3
|
+
* Shared fixer-network account in credits after abandonment. Omission means this response has no account snapshot.
|
|
4
|
+
*/
|
|
5
|
+
fixer?: FixerAccountInfo;
|
|
2
6
|
message: string;
|
|
3
7
|
mission_id: string;
|
|
4
8
|
title: string;
|
|
@@ -7,6 +11,10 @@ export type AcceptMissionResponse = {
|
|
|
7
11
|
auto_docked?: boolean;
|
|
8
12
|
auto_undocked?: boolean;
|
|
9
13
|
expires_at: string;
|
|
14
|
+
/**
|
|
15
|
+
* Shared fixer-network account in credits after acceptance. Omission means this response has no account snapshot.
|
|
16
|
+
*/
|
|
17
|
+
fixer?: FixerAccountInfo;
|
|
10
18
|
message: string;
|
|
11
19
|
mission_id: string;
|
|
12
20
|
replacement_cost?: number;
|
|
@@ -103,7 +111,15 @@ export type ActiveMissionInfo = {
|
|
|
103
111
|
mission_id: string;
|
|
104
112
|
objectives?: Array<ObjectiveProgressInfo>;
|
|
105
113
|
percent_complete: number;
|
|
114
|
+
/**
|
|
115
|
+
* Maximum debt reduction in credits on successful restitution completion. Actual relief is capped at outstanding debt then. Omitted for non-restitution missions.
|
|
116
|
+
*/
|
|
117
|
+
restitution_relief?: number;
|
|
106
118
|
rewards: MissionRewardsInfo;
|
|
119
|
+
/**
|
|
120
|
+
* True requires objectives in listed order; only the first incomplete objective advances. False or omission uses normal independent objectives.
|
|
121
|
+
*/
|
|
122
|
+
sequential_objectives?: boolean;
|
|
107
123
|
template_id?: string;
|
|
108
124
|
title: string;
|
|
109
125
|
type: string;
|
|
@@ -1706,6 +1722,10 @@ export type BulkStorageResponse = {
|
|
|
1706
1722
|
dest_bucket?: string;
|
|
1707
1723
|
dest_bucket_id?: string;
|
|
1708
1724
|
failed: number;
|
|
1725
|
+
/**
|
|
1726
|
+
* How the empire or pirate crew received this gift: value to them, bounty paid, reputation change and their reply. Present on gifts to empires, NPC empire stations and pirate strongholds; omitted for gifts to players, factions and the fixer.
|
|
1727
|
+
*/
|
|
1728
|
+
goodwill?: GiftGoodwill;
|
|
1709
1729
|
requested: number;
|
|
1710
1730
|
results: Array<BulkStorageItemResult>;
|
|
1711
1731
|
succeeded: number;
|
|
@@ -2525,6 +2545,14 @@ export type CompleteMissionResponse = {
|
|
|
2525
2545
|
credits_earned: number;
|
|
2526
2546
|
credits_promised?: number;
|
|
2527
2547
|
credits_shortfall?: number;
|
|
2548
|
+
/**
|
|
2549
|
+
* Actual fixer debt reduction in credits from this completion. Capped at outstanding debt before completion. Omitted when zero. This is not a cash reward.
|
|
2550
|
+
*/
|
|
2551
|
+
debt_repaid?: number;
|
|
2552
|
+
/**
|
|
2553
|
+
* Shared fixer-network account in credits after completion. Omission means this response has no account snapshot.
|
|
2554
|
+
*/
|
|
2555
|
+
fixer?: FixerAccountInfo;
|
|
2528
2556
|
items_received?: {
|
|
2529
2557
|
[key: string]: number;
|
|
2530
2558
|
};
|
|
@@ -3025,8 +3053,14 @@ export type EmpireGiftResponse = {
|
|
|
3025
3053
|
* True when the engine undocked you automatically before running this command, because the command requires being undocked. Omitted when no automatic undock happened.
|
|
3026
3054
|
*/
|
|
3027
3055
|
auto_undocked?: boolean;
|
|
3028
|
-
|
|
3029
|
-
|
|
3056
|
+
/**
|
|
3057
|
+
* Station where the donation was made. Omitted for a credit wire sent from anywhere other than one of the empire's own stations.
|
|
3058
|
+
*/
|
|
3059
|
+
base_id?: string;
|
|
3060
|
+
/**
|
|
3061
|
+
* Name of base_id. Omitted with it for a remote credit wire.
|
|
3062
|
+
*/
|
|
3063
|
+
base_name?: string;
|
|
3030
3064
|
cargo_remaining?: number;
|
|
3031
3065
|
class_id?: string;
|
|
3032
3066
|
class_name?: string;
|
|
@@ -3035,6 +3069,10 @@ export type EmpireGiftResponse = {
|
|
|
3035
3069
|
empire_name: string;
|
|
3036
3070
|
fleet_id?: string;
|
|
3037
3071
|
fleet_name?: string;
|
|
3072
|
+
/**
|
|
3073
|
+
* How the empire or pirate crew received this gift: value to them, bounty paid, reputation change and their reply. Present on gifts to empires, NPC empire stations and pirate strongholds; omitted for gifts to players, factions and the fixer.
|
|
3074
|
+
*/
|
|
3075
|
+
goodwill?: GiftGoodwill;
|
|
3038
3076
|
hull_designator?: string;
|
|
3039
3077
|
item_id?: string;
|
|
3040
3078
|
message?: string;
|
|
@@ -3366,55 +3404,157 @@ export type FacilityDismantleResponse = {
|
|
|
3366
3404
|
ticks_to_complete: number;
|
|
3367
3405
|
};
|
|
3368
3406
|
export type FacilityEntry = {
|
|
3407
|
+
/**
|
|
3408
|
+
* Personal bonus the owner gets while docked at this station: workshop_speed, drone_bandwidth or market_fee_discount. Omitted when the facility gives no personal bonus. See bonus_value for the size.
|
|
3409
|
+
*/
|
|
3369
3410
|
bonus_type?: string;
|
|
3411
|
+
/**
|
|
3412
|
+
* Size of bonus_type: workshop_speed is a percent added to Station Workshop crafting speed, drone_bandwidth is extra drone bandwidth units and market_fee_discount is a percent taken off market listing fees. Only one facility per bonus type counts per station. Omitted when bonus_type is omitted.
|
|
3413
|
+
*/
|
|
3370
3414
|
bonus_value?: number;
|
|
3415
|
+
/**
|
|
3416
|
+
* Service limit of this faction facility tier. Its meaning depends on faction_service: max quantity per item type for faction_storage and faction_storage_extension, member cap for faction_recruitment, max active listings for faction_market and faction_company_store, max active postings for faction_missions, max rooms for faction_commons, max ships for faction_ship_garage and max held passengers for faction_transit. Present only on faction_facilities entries; omitted (0) when the type sets no limit.
|
|
3417
|
+
*/
|
|
3371
3418
|
capacity?: number;
|
|
3419
|
+
/**
|
|
3420
|
+
* Facility category: service, infrastructure, production, faction, personal, defense or ranch. Always present. For a disguised facility viewed by an outsider, this is the disguise's category, not the facility's real category.
|
|
3421
|
+
*/
|
|
3372
3422
|
category: string;
|
|
3423
|
+
/**
|
|
3424
|
+
* Name the owner gave this facility, to tell apart several of the same type. Omitted when no name is set, and always withheld for a disguised facility seen from outside the owning faction.
|
|
3425
|
+
*/
|
|
3373
3426
|
custom_name?: string;
|
|
3427
|
+
/**
|
|
3428
|
+
* True when the facility was knocked out when the station was wrecked in battle. A damaged facility does nothing and bills no rent until repaired (facility action repair). The station rebuilds the facilities it owns itself. Omitted means false.
|
|
3429
|
+
*/
|
|
3374
3430
|
damaged?: boolean;
|
|
3431
|
+
/**
|
|
3432
|
+
* Flavor text. For a facility with upkeep it adds a satisfied or degraded line that matches maintenance_satisfied. An owner-written description replaces the text, and a disguised facility seen from outside shows its cover description. Can be an empty string.
|
|
3433
|
+
*/
|
|
3375
3434
|
description: string;
|
|
3435
|
+
/**
|
|
3436
|
+
* Dining appeal this facility adds to the station's tourism score, scaled down by how well its upkeep is supplied. Citizens who weigh dining pick stations with more of it. Omitted (0) for facilities that are not dining venues.
|
|
3437
|
+
*/
|
|
3376
3438
|
dining_points?: number;
|
|
3377
3439
|
/**
|
|
3378
3440
|
* True while dismantling is in progress; omitted means false. No rent is billed while dismantling and the facility is removed when dismantling completes.
|
|
3379
3441
|
*/
|
|
3380
3442
|
dismantling?: boolean;
|
|
3443
|
+
/**
|
|
3444
|
+
* ID of this facility instance (32 hex characters). Pass it as facility_id to facility actions such as repair and dismantle. Unique per built facility, not per facility type.
|
|
3445
|
+
*/
|
|
3381
3446
|
facility_id: string;
|
|
3447
|
+
/**
|
|
3448
|
+
* Crew this personnel reserve tier can hold for the owning faction at this station. Only the highest operational tier at the station counts; capacities do not add up. Omitted (0) for facilities that are not a faction personnel reserve, and withheld for a disguised facility seen from outside.
|
|
3449
|
+
*/
|
|
3382
3450
|
faction_crew_capacity?: number;
|
|
3451
|
+
/**
|
|
3452
|
+
* ID of the faction that owns this facility. Present on faction_facilities, ally_facilities and faction-owned public_facilities entries; withheld for a disguised facility seen from outside. Omitted on station_facilities, player_facilities and player-owned public entries.
|
|
3453
|
+
*/
|
|
3383
3454
|
faction_id?: string;
|
|
3455
|
+
/**
|
|
3456
|
+
* Marines this personnel reserve tier can hold for the owning faction at this station. Only the highest operational tier at the station counts; capacities do not add up. Omitted (0) for facilities that are not a faction personnel reserve, and withheld for a disguised facility seen from outside.
|
|
3457
|
+
*/
|
|
3384
3458
|
faction_marine_capacity?: number;
|
|
3459
|
+
/**
|
|
3460
|
+
* Treatment units this tier's private medical pool holds for the owning faction at this station. Only the highest operational medical tier at the station counts. Omitted (0) for facilities that are not a faction medical facility, and withheld for a disguised facility seen from outside.
|
|
3461
|
+
*/
|
|
3385
3462
|
faction_medical_capacity?: number;
|
|
3463
|
+
/**
|
|
3464
|
+
* Treatment units this medical tier restores to the faction pool each facility cycle (100 ticks), up to faction_medical_capacity, by consuming faction_medical_supply_item from the faction's storage at this station. A partial supply gives a partial refill. Omitted (0) together with faction_medical_capacity.
|
|
3465
|
+
*/
|
|
3386
3466
|
faction_medical_refill_per_cycle?: number;
|
|
3467
|
+
/**
|
|
3468
|
+
* Item ID the medical pool consumes from the faction's storage at this station to refill (for example medical_supplies). Omitted together with faction_medical_capacity.
|
|
3469
|
+
*/
|
|
3387
3470
|
faction_medical_supply_item?: string;
|
|
3471
|
+
/**
|
|
3472
|
+
* Faction service this facility provides to members of the owning faction, for example faction_storage, faction_recruitment, faction_market, faction_missions, faction_commons, faction_ship_garage, faction_transit, faction_personnel_reserve or faction_medical. Omitted for non-faction facilities and withheld for a disguised facility seen from outside.
|
|
3473
|
+
*/
|
|
3388
3474
|
faction_service?: string;
|
|
3475
|
+
/**
|
|
3476
|
+
* True for a recycler, which runs reverse jobs that break a recipe's outputs back into some of its inputs; you choose the recipe per job. Omitted means false.
|
|
3477
|
+
*/
|
|
3389
3478
|
is_recycler?: boolean;
|
|
3390
3479
|
/**
|
|
3391
3480
|
* Credits of labor this facility pays per facility cycle (100 ticks). Present only alongside maintenance_per_cycle; omitted when zero. A tourism venue's labor scales with its recent paying footfall but never drops below 15 percent of its declared labor.
|
|
3392
3481
|
*/
|
|
3393
3482
|
labor_per_cycle?: number;
|
|
3483
|
+
/**
|
|
3484
|
+
* Leisure appeal this facility adds to the station's tourism score, scaled down by how well its upkeep is supplied. Citizens who weigh leisure pick stations with more of it. Omitted (0) for facilities that are not leisure venues.
|
|
3485
|
+
*/
|
|
3394
3486
|
leisure_points?: number;
|
|
3487
|
+
/**
|
|
3488
|
+
* Tier of this facility definition, from 1 upward. Each tier is a separate type; a higher tier replaces a lower one when you upgrade. Production throughput triples with each level.
|
|
3489
|
+
*/
|
|
3395
3490
|
level: number;
|
|
3491
|
+
/**
|
|
3492
|
+
* Value-weighted fraction of this cycle's upkeep that storage covered, from 0 to 1 (1 means fully supplied). Present exactly when maintenance_satisfied is present. Dining and leisure venues earn this fraction of their tourism income; other facilities need full supply for their benefit.
|
|
3493
|
+
*/
|
|
3396
3494
|
maintenance_level?: number;
|
|
3397
3495
|
/**
|
|
3398
3496
|
* Item stock this station-run facility must hold each facility cycle (100 ticks) to count as fully supplied. Present only for fleet depots and dining/leisure venues (tourism_upkeep); omitted otherwise. A tourism venue's figure scales with recent paying footfall and never drops below 15 percent of its declared menu (at least one of each item); it burns its paying guests' share of its declared menu — about the whole listed stock in a busy cycle and nothing in a cycle no guest paid for.
|
|
3399
3497
|
*/
|
|
3400
3498
|
maintenance_per_cycle?: Array<ItemQuantity>;
|
|
3499
|
+
/**
|
|
3500
|
+
* Whether the facility's upkeep was fully supplied in its last facility cycle (100 ticks). Present only for facilities with upkeep: service, infrastructure, defense and ranch categories, not recyclers. Omitted for production, faction-category and personal facilities.
|
|
3501
|
+
*/
|
|
3401
3502
|
maintenance_satisfied?: boolean;
|
|
3503
|
+
/**
|
|
3504
|
+
* Facility cycles of rent currently unpaid. Arrears owed for this facility equal rent_per_cycle times missed_rent_cycles. The station repossesses the facility when this reaches the grace_cycles in player_rent or faction_rent. Present only on player_facilities and faction_facilities entries; omitted means 0.
|
|
3505
|
+
*/
|
|
3402
3506
|
missed_rent_cycles?: number;
|
|
3507
|
+
/**
|
|
3508
|
+
* Display name of the facility type. For a disguised facility seen from outside the owning faction, this is the cover name instead.
|
|
3509
|
+
*/
|
|
3403
3510
|
name: string;
|
|
3511
|
+
/**
|
|
3512
|
+
* Player ID of the owner of a player-owned facility: you on player_facilities, another player on public_facilities. Omitted for station-owned and faction-owned facilities.
|
|
3513
|
+
*/
|
|
3404
3514
|
owner_id?: string;
|
|
3515
|
+
/**
|
|
3516
|
+
* Personal service this facility provides to its owner: quarters, workshop, drone_control or trader_office. Omitted for non-personal facilities.
|
|
3517
|
+
*/
|
|
3405
3518
|
personal_service?: string;
|
|
3519
|
+
/**
|
|
3520
|
+
* True when this production facility or recycler sits at a station whose power efficiency is below 1, which stretches its crafting time. Keep the station's power plants fueled to clear it. Omitted means false.
|
|
3521
|
+
*/
|
|
3406
3522
|
power_throttled?: boolean;
|
|
3523
|
+
/**
|
|
3524
|
+
* Throughput, queue backlog and rental price, to decide whether to queue or rent here. Present only for production facilities (including Logistics) and recyclers; omitted for every other facility.
|
|
3525
|
+
*/
|
|
3407
3526
|
production?: FacilityProduction;
|
|
3527
|
+
/**
|
|
3528
|
+
* Recipe ID this production facility runs on every job. Omitted for non-production facilities, recyclers (which choose a recipe per job) and Logistics facilities (which run package operations).
|
|
3529
|
+
*/
|
|
3408
3530
|
recipe_id?: string;
|
|
3531
|
+
/**
|
|
3532
|
+
* Game tick through which this facility's rent is settled. It starts when construction completes or the facility changes hands and moves to the billing tick each facility cycle that clears all owed rent, so it stops moving while missed_rent_cycles is above 0. Present only on player_facilities and faction_facilities entries; omitted (0) elsewhere.
|
|
3533
|
+
*/
|
|
3409
3534
|
rent_paid_until_tick?: number;
|
|
3410
3535
|
/**
|
|
3411
3536
|
* Stored rent rate in credits per facility cycle (100 ticks). Visible only for your or your faction's facilities; omitted means zero or not disclosed. No rent is billed while damaged or under_construction or dismantling. The stored rate applies after repair or construction subject to repricing. Legacy inactive facilities remain billable.
|
|
3412
3537
|
*/
|
|
3413
3538
|
rent_per_cycle?: number;
|
|
3539
|
+
/**
|
|
3540
|
+
* Game tick when the repair or the station's own rebuild of this damaged facility finishes, rounded up to a facility cycle boundary. Omitted (0) when no repair is under way.
|
|
3541
|
+
*/
|
|
3414
3542
|
repair_complete_tick?: number;
|
|
3543
|
+
/**
|
|
3544
|
+
* Station service this facility provides to everyone docked here, for example market, repair, refuel, shipyard, storage, crafting, missions, salvage_yard, personnel, marine_training, medical or police. Omitted when the facility provides no station service.
|
|
3545
|
+
*/
|
|
3415
3546
|
service?: string;
|
|
3547
|
+
/**
|
|
3548
|
+
* True for a dining or leisure venue whose upkeep stock and labor scale with recent paying guests instead of a fixed bill; see maintenance_per_cycle and labor_per_cycle. Omitted means false.
|
|
3549
|
+
*/
|
|
3416
3550
|
tourism_upkeep?: boolean;
|
|
3551
|
+
/**
|
|
3552
|
+
* Facility definition ID (for example crew_bunk or algae_cultivation_tank); look it up with facility action types. Empty string for a disguised facility listed to someone outside the owning faction, because the real type would reveal it.
|
|
3553
|
+
*/
|
|
3417
3554
|
type: string;
|
|
3555
|
+
/**
|
|
3556
|
+
* True while the facility is still being built; it does nothing and bills no rent until done. Omitted means false. A built facility has no on/off state.
|
|
3557
|
+
*/
|
|
3418
3558
|
under_construction?: boolean;
|
|
3419
3559
|
};
|
|
3420
3560
|
export type FacilityFactionBuildResponse = {
|
|
@@ -3532,6 +3672,9 @@ export type FacilityListForSaleResponse = {
|
|
|
3532
3672
|
price: number;
|
|
3533
3673
|
};
|
|
3534
3674
|
export type FacilityListResponse = {
|
|
3675
|
+
/**
|
|
3676
|
+
* Always list: identifies this facility list response.
|
|
3677
|
+
*/
|
|
3535
3678
|
action: 'list';
|
|
3536
3679
|
/**
|
|
3537
3680
|
* Facilities here owned by an allied faction that has turned on ally_facility_access for your faction. You queue jobs on them free: production.rental_fee_per_run is 0 and no output price is quoted, even when the facility is also publicly rentable to strangers. Your jobs still queue behind the owner's own work like a renter's. An ally facility is listed here and never under public_facilities. Omitted when there are none.
|
|
@@ -3541,6 +3684,9 @@ export type FacilityListResponse = {
|
|
|
3541
3684
|
* Canonical ID of the station containing every listed facility and both per-station rent summaries.
|
|
3542
3685
|
*/
|
|
3543
3686
|
base_id: string;
|
|
3687
|
+
/**
|
|
3688
|
+
* Station-owned facilities under construction here and the station manager's next planned build with the materials it still lacks. Your own and your faction's builds are not included; they appear in player_facilities and faction_facilities with under_construction. Omitted when the station is building nothing.
|
|
3689
|
+
*/
|
|
3544
3690
|
construction?: StationConstructionResponse;
|
|
3545
3691
|
/**
|
|
3546
3692
|
* Your faction's facilities at this base including paused facilities. Per-facility rent_per_cycle is the stored rate; faction_rent totals only currently billable facilities. Empty means your faction owns none here.
|
|
@@ -3550,6 +3696,9 @@ export type FacilityListResponse = {
|
|
|
3550
3696
|
* Current recurring rent and existing arrears for faction_facilities. Omitted when your faction owns no facilities here; present with zero recurring rent when all its facilities have paused billing.
|
|
3551
3697
|
*/
|
|
3552
3698
|
faction_rent?: FacilityRentSummary;
|
|
3699
|
+
/**
|
|
3700
|
+
* Station life support: supply against demand, plant count and the upkeep its plants need. Omitted when the station has no life support supply, demand or plants.
|
|
3701
|
+
*/
|
|
3553
3702
|
life_support?: StationLifeSupportStatus;
|
|
3554
3703
|
/**
|
|
3555
3704
|
* Your facilities at this base including damaged and constructing and dismantling facilities. Per-facility rent_per_cycle is the stored rate; player_rent totals only currently billable facilities. Empty means you own none here.
|
|
@@ -3559,9 +3708,21 @@ export type FacilityListResponse = {
|
|
|
3559
3708
|
* Current recurring rent and existing arrears for player_facilities. Omitted when you own no facilities here; present with zero recurring rent when all your facilities have paused billing.
|
|
3560
3709
|
*/
|
|
3561
3710
|
player_rent?: FacilityRentSummary;
|
|
3711
|
+
/**
|
|
3712
|
+
* Station power grid: supply, current draw, battery and efficiency. While efficiency is below 1 every production facility and recycler here is slowed and shows power_throttled. Omitted when the station has no power supply, draw or battery capacity.
|
|
3713
|
+
*/
|
|
3562
3714
|
power?: StationPowerStatus;
|
|
3715
|
+
/**
|
|
3716
|
+
* Other players' facilities here with public access, plus other factions' publicly rentable facilities, so you can compare throughput, backlog and rental_fee_per_run before you queue a job. A disguised faction facility also appears here under its cover identity whether or not it is rentable. Owner rent fields are withheld. Omitted when there are none.
|
|
3717
|
+
*/
|
|
3563
3718
|
public_facilities?: Array<FacilityEntry>;
|
|
3719
|
+
/**
|
|
3720
|
+
* Finite shared station pools for personnel recruitment, marine training and medical treatment, with stock, refill rate and supply need; the medical pool also carries current per-patient treatment prices. Each pool is omitted when the station has no capacity for it; the whole block is omitted when it has none.
|
|
3721
|
+
*/
|
|
3564
3722
|
service_pools?: StationServicePools;
|
|
3723
|
+
/**
|
|
3724
|
+
* Facilities the station itself owns at this base: its services, infrastructure, defenses and generic production on-ramps. They bill you no rent; rent fields are omitted on them. Empty when the station owns none.
|
|
3725
|
+
*/
|
|
3565
3726
|
station_facilities: Array<FacilityEntry>;
|
|
3566
3727
|
};
|
|
3567
3728
|
export type FacilityListingEntry = {
|
|
@@ -3630,21 +3791,57 @@ export type FacilityPersonalVisitResponse = {
|
|
|
3630
3791
|
owner: string;
|
|
3631
3792
|
};
|
|
3632
3793
|
export type FacilityProduction = {
|
|
3794
|
+
/**
|
|
3795
|
+
* Estimated ticks to finish the whole current queue at the current speed, counting progress already made. A new job waits about this long if it queues behind everything. 0 when the queue is empty or the facility cannot run.
|
|
3796
|
+
*/
|
|
3633
3797
|
backlog_ticks: number;
|
|
3798
|
+
/**
|
|
3799
|
+
* Sustained output in items per real hour at the current speed and tick rate: runs per hour times output_per_run, rounded down. Omitted when zero: for recyclers, Logistics facilities and a facility that cannot run.
|
|
3800
|
+
*/
|
|
3634
3801
|
items_per_hour?: number;
|
|
3802
|
+
/**
|
|
3803
|
+
* Items one run produces: the sum of the recipe's output quantities. Omitted for recyclers and Logistics facilities.
|
|
3804
|
+
*/
|
|
3635
3805
|
output_per_run?: number;
|
|
3806
|
+
/**
|
|
3807
|
+
* Credits per package operation (one pack or unpack job) that the owner set on a player or faction Logistics facility. Never a per-item price. Omitted when no price is set, on non-Logistics facilities and on every ally_facilities entry.
|
|
3808
|
+
*/
|
|
3636
3809
|
output_price_per_operation?: number;
|
|
3810
|
+
/**
|
|
3811
|
+
* Credits per produced unit that the owner set with set_output_price on a player or faction facility. Present whenever a price is set, even while private or set to 0 (free). Omitted when no price is set, on station facilities, on Logistics facilities and on every ally_facilities entry.
|
|
3812
|
+
*/
|
|
3637
3813
|
output_price_per_unit?: number;
|
|
3814
|
+
/**
|
|
3815
|
+
* Pack operations this Logistics facility can finish per real hour at its current speed, rounded down. Omitted (0) for facilities that are not Logistics and for a Logistics facility that cannot run.
|
|
3816
|
+
*/
|
|
3638
3817
|
pack_operations_per_hour?: number;
|
|
3818
|
+
/**
|
|
3819
|
+
* True when outside players can rent this facility's spare capacity: a generic station facility, or one whose owner set access to public. Station infrastructure that is unique or empire-restricted is never public. Omitted means false.
|
|
3820
|
+
*/
|
|
3639
3821
|
public?: boolean;
|
|
3822
|
+
/**
|
|
3823
|
+
* Items the queued runs will produce in total. 0 when the queue is empty.
|
|
3824
|
+
*/
|
|
3640
3825
|
queued_items: number;
|
|
3826
|
+
/**
|
|
3827
|
+
* Runs still to do across every queued job at this facility, from all orderers (owner and renters). 0 means the queue is empty.
|
|
3828
|
+
*/
|
|
3641
3829
|
queued_runs: number;
|
|
3830
|
+
/**
|
|
3831
|
+
* Display name of the recipe this facility runs (for example Cultivate Bioluminescent Algae); the ID is recipe_id on the entry. Package Operations for a Logistics facility. Omitted for recyclers, which choose a recipe per job.
|
|
3832
|
+
*/
|
|
3642
3833
|
recipe?: string;
|
|
3643
3834
|
/**
|
|
3644
3835
|
* Credits charged per run to queue a job here as an outside renter. Present for publicly rentable facilities, including your own and your faction's so you can confirm the price you set. Omitted (0) when the facility is not publicly rentable, when the owner rents it out free, and on every ally_facilities entry, because an allied grant lets you queue there free.
|
|
3645
3836
|
*/
|
|
3646
3837
|
rental_fee_per_run?: number;
|
|
3838
|
+
/**
|
|
3839
|
+
* Ticks one run takes at the facility's current speed: the recipe's crafting time divided by level throughput, station power efficiency and any faction admin bonus. For Logistics it is one pack operation. Omitted for recyclers and while the facility cannot run (under construction or no station power). Still reported while damaged, although a damaged facility does not run.
|
|
3840
|
+
*/
|
|
3647
3841
|
ticks_per_run?: number;
|
|
3842
|
+
/**
|
|
3843
|
+
* Unpack operations this Logistics facility can finish per real hour at its current speed, rounded down. Omitted (0) for facilities that are not Logistics and for a Logistics facility that cannot run.
|
|
3844
|
+
*/
|
|
3648
3845
|
unpack_operations_per_hour?: number;
|
|
3649
3846
|
};
|
|
3650
3847
|
export type FacilityRecipeInfo = {
|
|
@@ -4532,7 +4729,7 @@ export type FactionScanPoiResponse = {
|
|
|
4532
4729
|
poi_name?: string;
|
|
4533
4730
|
scan_power: number;
|
|
4534
4731
|
/**
|
|
4535
|
-
* True when a cloaked ship is within one sensor level (10 power) below detection: sensed but not resolved. Omitted when false.
|
|
4732
|
+
* True when a cloaked ship or cloaked creature is within one sensor level (10 power) below detection: sensed but not resolved. Omitted when false.
|
|
4536
4733
|
*/
|
|
4537
4734
|
signature_detected?: boolean;
|
|
4538
4735
|
system_id?: string;
|
|
@@ -4705,17 +4902,53 @@ export type Fill = {
|
|
|
4705
4902
|
subtotal: number;
|
|
4706
4903
|
};
|
|
4707
4904
|
export type FindRouteResponse = {
|
|
4905
|
+
/**
|
|
4906
|
+
* Cargo units your current ship is carrying now. 0 when found is false or you have no ship.
|
|
4907
|
+
*/
|
|
4708
4908
|
cargo_used: number;
|
|
4909
|
+
/**
|
|
4910
|
+
* Fuel the whole route needs: fuel_per_jump times total_jumps. 0 when you are already there or found is false.
|
|
4911
|
+
*/
|
|
4709
4912
|
estimated_fuel: number;
|
|
4913
|
+
/**
|
|
4914
|
+
* Per-member fuel check over this route, yourself included. Present only when you lead a fleet with more than one member and a route was found; members without a ship are skipped. Omitted otherwise.
|
|
4915
|
+
*/
|
|
4710
4916
|
fleet_fuel?: Array<FleetMemberFuel>;
|
|
4917
|
+
/**
|
|
4918
|
+
* True when a route exists, including when you are already in the target system. False means no path was found; route is then null and the fuel fields are 0.
|
|
4919
|
+
*/
|
|
4711
4920
|
found: boolean;
|
|
4921
|
+
/**
|
|
4922
|
+
* Fuel in your current ship's tank now. Compare with estimated_fuel to see whether you can finish the route without refueling. 0 when found is false or you have no ship.
|
|
4923
|
+
*/
|
|
4712
4924
|
fuel_available: number;
|
|
4925
|
+
/**
|
|
4926
|
+
* Fuel your current ship burns per jump, with your ship class, module and skill fuel bonuses applied; at least 1. The jump itself charges this amount. 0 when found is false or you have no ship.
|
|
4927
|
+
*/
|
|
4713
4928
|
fuel_per_jump: number;
|
|
4929
|
+
/**
|
|
4930
|
+
* Human-readable summary of the result, including the jump count and any final travel step.
|
|
4931
|
+
*/
|
|
4714
4932
|
message: string;
|
|
4933
|
+
/**
|
|
4934
|
+
* Systems in order from your current system to target_system, both included; see RouteStep. It holds a single step when you are already there. Normal connections and wormholes you know count as one jump each. Null when found is false.
|
|
4935
|
+
*/
|
|
4715
4936
|
route: Array<RouteStep>;
|
|
4937
|
+
/**
|
|
4938
|
+
* POI ID to travel to after the last jump. Present only when you asked for a POI or base ID; a base resolves to the POI it sits at. Omitted for a system target.
|
|
4939
|
+
*/
|
|
4716
4940
|
target_poi?: string;
|
|
4941
|
+
/**
|
|
4942
|
+
* Display name of target_poi. Present exactly when target_poi is present.
|
|
4943
|
+
*/
|
|
4717
4944
|
target_poi_name?: string;
|
|
4945
|
+
/**
|
|
4946
|
+
* Canonical ID of the destination system. If you asked for a POI or base, this is the system that contains it.
|
|
4947
|
+
*/
|
|
4718
4948
|
target_system: string;
|
|
4949
|
+
/**
|
|
4950
|
+
* Jumps the route takes: the number of steps in route minus 1. 0 when you are already in the target system or found is false.
|
|
4951
|
+
*/
|
|
4719
4952
|
total_jumps: number;
|
|
4720
4953
|
};
|
|
4721
4954
|
export type FittedModuleSnapshot = {
|
|
@@ -4725,6 +4958,24 @@ export type FittedModuleSnapshot = {
|
|
|
4725
4958
|
magazine_size?: number;
|
|
4726
4959
|
name: string;
|
|
4727
4960
|
};
|
|
4961
|
+
export type FixerAccountInfo = {
|
|
4962
|
+
/**
|
|
4963
|
+
* Maximum unsecured cargo exposure in credits across all fixers. Starts at 2500. Each successful courier delivery adds 250 up to 10000 after 30 deliveries.
|
|
4964
|
+
*/
|
|
4965
|
+
allowance: number;
|
|
4966
|
+
/**
|
|
4967
|
+
* Additional unsecured cargo allowance in credits: max(0, allowance - exposure). Zero means no additional unsecured cargo.
|
|
4968
|
+
*/
|
|
4969
|
+
available: number;
|
|
4970
|
+
/**
|
|
4971
|
+
* Unpaid missing courier cargo liability in credits across all fixers. Zero means no outstanding debt. Persists until payment or restitution.
|
|
4972
|
+
*/
|
|
4973
|
+
debt: number;
|
|
4974
|
+
/**
|
|
4975
|
+
* Debt plus the base value of provided cargo on active courier missions in credits; capped at the credit limit. Expired missions reserve exposure until cleanup. Moving or selling that cargo does not release exposure.
|
|
4976
|
+
*/
|
|
4977
|
+
exposure: number;
|
|
4978
|
+
};
|
|
4728
4979
|
export type FleeLogEntry = {
|
|
4729
4980
|
escaped: boolean;
|
|
4730
4981
|
flee_counter: number;
|
|
@@ -4765,13 +5016,37 @@ export type FleetDeclineResponse = {
|
|
|
4765
5016
|
message: string;
|
|
4766
5017
|
};
|
|
4767
5018
|
export type FleetMemberFuel = {
|
|
5019
|
+
/**
|
|
5020
|
+
* True when fuel_on_arrival is 0 or more, so the member can finish the route without refueling.
|
|
5021
|
+
*/
|
|
4768
5022
|
can_complete: boolean;
|
|
5023
|
+
/**
|
|
5024
|
+
* Fuel this member needs for the whole route: fuel_per_jump times total_jumps.
|
|
5025
|
+
*/
|
|
4769
5026
|
estimated_fuel: number;
|
|
5027
|
+
/**
|
|
5028
|
+
* Fuel in this member's tank now.
|
|
5029
|
+
*/
|
|
4770
5030
|
fuel_available: number;
|
|
5031
|
+
/**
|
|
5032
|
+
* Fuel left after the route: fuel_available minus estimated_fuel. Negative means the member runs out on the way.
|
|
5033
|
+
*/
|
|
4771
5034
|
fuel_on_arrival: number;
|
|
5035
|
+
/**
|
|
5036
|
+
* Fuel this member's ship burns per jump with its own bonuses applied; at least 1.
|
|
5037
|
+
*/
|
|
4772
5038
|
fuel_per_jump: number;
|
|
5039
|
+
/**
|
|
5040
|
+
* Player ID of the fleet member.
|
|
5041
|
+
*/
|
|
4773
5042
|
player_id: string;
|
|
5043
|
+
/**
|
|
5044
|
+
* Display name of the member's current ship class. Empty string when the class is unknown.
|
|
5045
|
+
*/
|
|
4774
5046
|
ship_class: string;
|
|
5047
|
+
/**
|
|
5048
|
+
* Username of the fleet member.
|
|
5049
|
+
*/
|
|
4775
5050
|
username: string;
|
|
4776
5051
|
};
|
|
4777
5052
|
export type FleetResponse = ({
|
|
@@ -5149,6 +5424,10 @@ export type GetMapResponse = {
|
|
|
5149
5424
|
export type GetMissionsResponse = {
|
|
5150
5425
|
base_id: string;
|
|
5151
5426
|
base_name: string;
|
|
5427
|
+
/**
|
|
5428
|
+
* Current shared fixer-network account in credits. Omission means this response has no account snapshot.
|
|
5429
|
+
*/
|
|
5430
|
+
fixer?: FixerAccountInfo;
|
|
5152
5431
|
missions: Array<MissionInfo>;
|
|
5153
5432
|
};
|
|
5154
5433
|
export type GetNearbyResponse = {
|
|
@@ -5301,7 +5580,52 @@ export type GetWrecksResponse = {
|
|
|
5301
5580
|
count: number;
|
|
5302
5581
|
wrecks: Array<EnrichedWreck>;
|
|
5303
5582
|
};
|
|
5583
|
+
export type GiftGoodwill = {
|
|
5584
|
+
/**
|
|
5585
|
+
* Credits of value applied to the donor's outstanding bounty with this empire before any goodwill. Credits pay at face value; goods and ships pay at need_value. Omitted when no bounty was owed.
|
|
5586
|
+
*/
|
|
5587
|
+
bounty_paid?: number;
|
|
5588
|
+
/**
|
|
5589
|
+
* Bounty still owed to this empire after this gift. Omitted when none is left. While any bounty remains a gift earns no reputation.
|
|
5590
|
+
*/
|
|
5591
|
+
bounty_remaining?: number;
|
|
5592
|
+
/**
|
|
5593
|
+
* Empire ID (e.g. solarian) or pirate crew ID (e.g. pirate_voss) whose standing the gift affected.
|
|
5594
|
+
*/
|
|
5595
|
+
counterparty: string;
|
|
5596
|
+
/**
|
|
5597
|
+
* What the gift was worth to the recipient in credits after weighing how much they need it: more than face value for cash they are short of, goods that fill a real shortage, a hull their fleets need or a ship a pirate boss takes to fly in person; less for cash they do not need, goods beyond their needs, cheap hulls and ships a pirate crew breaks for parts (a rival boss's flagship excepted). Reported even when a pirate crew keeps a stranger's gift and it buys nothing.
|
|
5598
|
+
*/
|
|
5599
|
+
need_value: number;
|
|
5600
|
+
/**
|
|
5601
|
+
* The recipient's in-character reply. The same text arrives as a private chat message from reply_from.
|
|
5602
|
+
*/
|
|
5603
|
+
reply: string;
|
|
5604
|
+
/**
|
|
5605
|
+
* Who replied and signed the private message. Rank follows the outcome: a minion for hostile, cooling, bounty, stranger, unwanted and token gifts; an officer for appreciated and generous ones; the empire leader or pirate boss in person for lavish gifts, for donors they already treat as devoted friends, for expensive ships and whenever a pirate boss gets involved. A pirate crew answers a cheap ship with a minion and a mid-priced one with an officer.
|
|
5606
|
+
*/
|
|
5607
|
+
reply_from: string;
|
|
5608
|
+
/**
|
|
5609
|
+
* Donor's reputation with the counterparty after the gift (-100 to 100). Includes any restoration from clearing a bounty.
|
|
5610
|
+
*/
|
|
5611
|
+
reputation_after: number;
|
|
5612
|
+
/**
|
|
5613
|
+
* Donor's reputation with the counterparty before the gift (-100 to 100).
|
|
5614
|
+
*/
|
|
5615
|
+
reputation_before: number;
|
|
5616
|
+
/**
|
|
5617
|
+
* reputation_after minus reputation_before. Each point above your baseline costs more than the last. Value short of the next point is banked toward your next gift and lost if you act against the recipient. Gifts count for little while an attack, kill or capture against the recipient is fresh, and hardly at all while they shoot you on sight.
|
|
5618
|
+
*/
|
|
5619
|
+
reputation_change: number;
|
|
5620
|
+
/**
|
|
5621
|
+
* Outcome class that picked the reply: stranger (a pirate crew kept the gift but owes nothing to a pilot never introduced to the pirate network), bounty_partial, bounty_cleared, hostile, cooling, unwanted_items, unwanted_ship, or token/appreciated/generous/lavish/devoted followed by _credits, _items or _ship. A ship given to a pirate crew instead reports what the crew did with it: ship_scrap (no pirate design for that hull), ship_refit (rebuilt to a pirate design) or ship_pirate (a pirate-built hull) followed by _cheap, _mid or _expensive by its fitted value; or, when the boss gets involved, boss_upgrade (the boss switches to your ship because it out-fights the boss's current one), boss_hunt (the boss's flagship is in a player's hands and the boss takes your stronger ship to hunt them), boss_flagship_returned, boss_rival_flown (the boss flies another boss's flagship until the stolen one comes back), boss_rival_scrapped, boss_flagship_copy (your hull was rebuilt into a copy of the boss's stolen flagship and the boss flies it) or boss_flagship_spare (rebuilt into a spare copy of the boss's flagship), each with _cold appended when the crew does not like you. stranger, hostile and cooling still apply to ordinary pirate ship gifts.
|
|
5622
|
+
*/
|
|
5623
|
+
situation: string;
|
|
5624
|
+
};
|
|
5304
5625
|
export type GiftShipResponse = {
|
|
5626
|
+
/**
|
|
5627
|
+
* Completed ship gift to another player or to a pirate stronghold.
|
|
5628
|
+
*/
|
|
5305
5629
|
action: 'gift_ship';
|
|
5306
5630
|
/**
|
|
5307
5631
|
* True when the engine docked you automatically before running this command, because the command requires being docked. Omitted when no automatic dock happened.
|
|
@@ -5311,11 +5635,37 @@ export type GiftShipResponse = {
|
|
|
5311
5635
|
* True when the engine undocked you automatically before running this command, because the command requires being undocked. Omitted when no automatic undock happened.
|
|
5312
5636
|
*/
|
|
5313
5637
|
auto_undocked?: boolean;
|
|
5638
|
+
/**
|
|
5639
|
+
* Base ID where the ship was parked when it changed hands.
|
|
5640
|
+
*/
|
|
5314
5641
|
base_id: string;
|
|
5642
|
+
/**
|
|
5643
|
+
* Ship class the ship had when you gave it. A pirate crew may refit it to its own design afterwards.
|
|
5644
|
+
*/
|
|
5315
5645
|
class_id: string;
|
|
5646
|
+
/**
|
|
5647
|
+
* Display name of class_id; omitted when the class is unknown.
|
|
5648
|
+
*/
|
|
5316
5649
|
class_name?: string;
|
|
5650
|
+
/**
|
|
5651
|
+
* What a pirate crew did with the ship: scrapped (broken down for parts), refitted (rebuilt to the crew's own design and added to its fleet), joined_fleet (a pirate-built hull added to its fleet as it is) or boss_ship (the boss flies it in person now or as soon as the boss is free). Omitted for gifts to players.
|
|
5652
|
+
*/
|
|
5653
|
+
disposition?: 'scrapped' | 'refitted' | 'joined_fleet' | 'boss_ship';
|
|
5654
|
+
/**
|
|
5655
|
+
* How the pirate crew received the ship: value to them, reputation change and their reply. Omitted for gifts to players.
|
|
5656
|
+
*/
|
|
5657
|
+
goodwill?: GiftGoodwill;
|
|
5658
|
+
/**
|
|
5659
|
+
* Gift note; omitted when empty.
|
|
5660
|
+
*/
|
|
5317
5661
|
message?: string;
|
|
5662
|
+
/**
|
|
5663
|
+
* Recipient player name, or station:<base ID> for a ship given to a pirate stronghold.
|
|
5664
|
+
*/
|
|
5318
5665
|
recipient: string;
|
|
5666
|
+
/**
|
|
5667
|
+
* ID of the ship given away.
|
|
5668
|
+
*/
|
|
5319
5669
|
ship_id: string;
|
|
5320
5670
|
};
|
|
5321
5671
|
export type GuideEntry = {
|
|
@@ -6102,6 +6452,10 @@ export type MissionGiverInfo = {
|
|
|
6102
6452
|
title: string;
|
|
6103
6453
|
};
|
|
6104
6454
|
export type MissionInfo = {
|
|
6455
|
+
/**
|
|
6456
|
+
* Base value in credits of courier cargo provided on acceptance. Reserves fixer allowance while active. Missing goods become debt on abandonment or expiry. Omitted when no liability applies.
|
|
6457
|
+
*/
|
|
6458
|
+
cargo_liability?: number;
|
|
6105
6459
|
chain_next?: string;
|
|
6106
6460
|
community?: boolean;
|
|
6107
6461
|
community_percent?: number;
|
|
@@ -6126,7 +6480,15 @@ export type MissionInfo = {
|
|
|
6126
6480
|
};
|
|
6127
6481
|
repeatable?: boolean;
|
|
6128
6482
|
required_modules?: Array<string>;
|
|
6483
|
+
/**
|
|
6484
|
+
* Maximum debt reduction in credits on successful restitution completion. Actual relief is capped at outstanding debt then. Omitted for non-restitution missions.
|
|
6485
|
+
*/
|
|
6486
|
+
restitution_relief?: number;
|
|
6129
6487
|
rewards: MissionRewardsInfo;
|
|
6488
|
+
/**
|
|
6489
|
+
* True requires objectives in listed order; only the first incomplete objective advances. False or omission uses normal independent objectives.
|
|
6490
|
+
*/
|
|
6491
|
+
sequential_objectives?: boolean;
|
|
6130
6492
|
template_id?: string;
|
|
6131
6493
|
title: string;
|
|
6132
6494
|
type: string;
|
|
@@ -6721,7 +7083,7 @@ export type NotificationActionResult = {
|
|
|
6721
7083
|
*/
|
|
6722
7084
|
auto_undocked?: boolean;
|
|
6723
7085
|
/**
|
|
6724
|
-
* Name of the command that ran. On an unsolicited push (no request_id) no command ran, and this instead names the event that changed your state: player_died, ship_captured, emergency_warp_stabilizer, passenger_stranded, fleet_kicked, fleet_disbanded, mobile_capital_transit, or
|
|
7086
|
+
* Name of the command that ran. On an unsolicited push (no request_id) no command ran, and this instead names the event that changed your state: player_died, ship_captured, emergency_warp_stabilizer, passenger_stranded, fleet_kicked, fleet_disbanded, mobile_capital_transit, mission_objective_completed, or pathfinder_arrival. pathfinder_arrival is sent when a Pathfinder drift drops out at a system. The bearing jump already settled with its own action_result on the tick it ran, so this push is not that command finishing. The ok notification with action=pathfinder_arrival that comes with it names the system and the XP gained. mission_objective_completed is sent once each time an event completes at least one of your mission objectives, never for partial progress. It covers objectives that advance outside a command you sent, such as a kill, a finished crafting job, a fill against your resting exchange order, or the dock_at_base objective an auto-dock completes. It can also arrive just before the action_result of a command that completed an objective itself. Apply both. Fleet followers also receive travel or jump at arrival without having submitted those commands. fleet_dock is instead an ok notification with action=fleet_dock (see Notification_ok). Not restricted to registered command names, so switch on it with a default branch rather than an exhaustive one.
|
|
6725
7087
|
*/
|
|
6726
7088
|
command: string;
|
|
6727
7089
|
/**
|
|
@@ -7778,6 +8140,9 @@ export type ObjectiveInfo = {
|
|
|
7778
8140
|
eligible_players?: Array<string>;
|
|
7779
8141
|
item_id?: string;
|
|
7780
8142
|
participants?: Array<string>;
|
|
8143
|
+
/**
|
|
8144
|
+
* Required objective units. For wait_ticks this is cumulative server ticks docked at the target base while this objective is next and its mission cargo is aboard. Offline server ticks count; server downtime does not.
|
|
8145
|
+
*/
|
|
7781
8146
|
quantity?: number;
|
|
7782
8147
|
system_id?: string;
|
|
7783
8148
|
system_name?: string;
|
|
@@ -7795,6 +8160,9 @@ export type ObjectiveInfo = {
|
|
|
7795
8160
|
};
|
|
7796
8161
|
export type ObjectiveProgressInfo = {
|
|
7797
8162
|
completed: boolean;
|
|
8163
|
+
/**
|
|
8164
|
+
* Completed objective units. For wait_ticks this is cumulative qualifying server ticks at the target base.
|
|
8165
|
+
*/
|
|
7798
8166
|
current: number;
|
|
7799
8167
|
description: string;
|
|
7800
8168
|
/**
|
|
@@ -7809,6 +8177,9 @@ export type ObjectiveProgressInfo = {
|
|
|
7809
8177
|
* player_threshold objectives only
|
|
7810
8178
|
*/
|
|
7811
8179
|
participants?: Array<string>;
|
|
8180
|
+
/**
|
|
8181
|
+
* Required objective units. For wait_ticks this is server ticks docked at the target base while this objective is next and its mission cargo is aboard.
|
|
8182
|
+
*/
|
|
7812
8183
|
required: number;
|
|
7813
8184
|
system_id?: string;
|
|
7814
8185
|
system_name?: string;
|
|
@@ -8237,10 +8608,24 @@ export type Player = {
|
|
|
8237
8608
|
experience?: number;
|
|
8238
8609
|
faction_id?: string;
|
|
8239
8610
|
faction_rank?: string;
|
|
8611
|
+
/**
|
|
8612
|
+
* Outstanding shared fixer debt in credits. Zero or omission means no debt. Missing courier cargo creates debt; payments and restitution reduce it.
|
|
8613
|
+
*/
|
|
8614
|
+
fixer_debt?: number;
|
|
8615
|
+
/**
|
|
8616
|
+
* Successful courier deliveries used for cargo allowance: 2500 plus 250 per delivery up to 30 deliveries. Zero or omission means no successful deliveries.
|
|
8617
|
+
*/
|
|
8618
|
+
fixer_deliveries?: number;
|
|
8240
8619
|
/**
|
|
8241
8620
|
* Fleet ID if the player is in a fleet
|
|
8242
8621
|
*/
|
|
8243
8622
|
fleet_id?: string;
|
|
8623
|
+
/**
|
|
8624
|
+
* Gift value (credits of need) banked per empire or pirate crew ID toward the next reputation point, always less than that point costs. A hostile act against the counterparty wipes it. A missing key means zero.
|
|
8625
|
+
*/
|
|
8626
|
+
gift_goodwill?: {
|
|
8627
|
+
[key: string]: number;
|
|
8628
|
+
};
|
|
8244
8629
|
home_base?: string;
|
|
8245
8630
|
id: string;
|
|
8246
8631
|
is_cloaked?: boolean;
|
|
@@ -8265,6 +8650,12 @@ export type Player = {
|
|
|
8265
8650
|
* Last player-initiated command (login, queued mutation, trade). Used to determine online status; not bumped by tick-driven mutations.
|
|
8266
8651
|
*/
|
|
8267
8652
|
last_command_at?: string;
|
|
8653
|
+
/**
|
|
8654
|
+
* When you last attacked, killed or captured against each empire or pirate crew ID. Gifts to that counterparty count for little while the act is fresh and recover as it ages. A missing key means never.
|
|
8655
|
+
*/
|
|
8656
|
+
last_hostile_act?: {
|
|
8657
|
+
[key: string]: string;
|
|
8658
|
+
};
|
|
8268
8659
|
last_login_at?: string;
|
|
8269
8660
|
/**
|
|
8270
8661
|
* Hex color
|
|
@@ -8318,6 +8709,168 @@ export type Player = {
|
|
|
8318
8709
|
trading_restricted_until?: string;
|
|
8319
8710
|
username: string;
|
|
8320
8711
|
};
|
|
8712
|
+
export type PlayerProfileFaction = {
|
|
8713
|
+
/**
|
|
8714
|
+
* When the pilot joined this faction (RFC 3339 UTC).
|
|
8715
|
+
*/
|
|
8716
|
+
joined_at: string;
|
|
8717
|
+
/**
|
|
8718
|
+
* Faction display name.
|
|
8719
|
+
*/
|
|
8720
|
+
name: string;
|
|
8721
|
+
/**
|
|
8722
|
+
* Display name of the pilot's faction role, or the raw role ID when that role no longer exists. Omitted when no role is recorded.
|
|
8723
|
+
*/
|
|
8724
|
+
role?: string;
|
|
8725
|
+
/**
|
|
8726
|
+
* Faction tag. Look it up with faction_info.
|
|
8727
|
+
*/
|
|
8728
|
+
tag: string;
|
|
8729
|
+
};
|
|
8730
|
+
export type PlayerProfileResponse = {
|
|
8731
|
+
/**
|
|
8732
|
+
* Earned achievements against the player achievement catalog.
|
|
8733
|
+
*/
|
|
8734
|
+
achievements: ProfileAchievementsSummary;
|
|
8735
|
+
/**
|
|
8736
|
+
* The pilot's clan tag. Omitted when unset.
|
|
8737
|
+
*/
|
|
8738
|
+
clan_tag?: string;
|
|
8739
|
+
/**
|
|
8740
|
+
* When the pilot registered (RFC 3339 UTC).
|
|
8741
|
+
*/
|
|
8742
|
+
created_at: string;
|
|
8743
|
+
/**
|
|
8744
|
+
* Empire ID, for example solarian.
|
|
8745
|
+
*/
|
|
8746
|
+
empire: string;
|
|
8747
|
+
/**
|
|
8748
|
+
* Empire display name. Omitted when the empire is not in the catalog.
|
|
8749
|
+
*/
|
|
8750
|
+
empire_name?: string;
|
|
8751
|
+
/**
|
|
8752
|
+
* The pilot's faction. Omitted when the pilot is in no faction.
|
|
8753
|
+
*/
|
|
8754
|
+
faction?: PlayerProfileFaction;
|
|
8755
|
+
/**
|
|
8756
|
+
* True when the pilot has a live session on any transport or sent a command in the last 30 minutes.
|
|
8757
|
+
*/
|
|
8758
|
+
online: boolean;
|
|
8759
|
+
/**
|
|
8760
|
+
* Primary hex color, for example #00d4ff. Omitted when unset.
|
|
8761
|
+
*/
|
|
8762
|
+
primary_color?: string;
|
|
8763
|
+
/**
|
|
8764
|
+
* Every player leaderboard where the pilot is in the top ranks_top_n, from the hourly leaderboard snapshot. Empty when the pilot places on none or before the first snapshot after a server start.
|
|
8765
|
+
*/
|
|
8766
|
+
ranks: Array<ProfileRankEntry>;
|
|
8767
|
+
/**
|
|
8768
|
+
* When the leaderboard snapshot behind ranks was built (RFC 3339 UTC). Omitted before the first snapshot after a server start.
|
|
8769
|
+
*/
|
|
8770
|
+
ranks_generated_at?: string;
|
|
8771
|
+
/**
|
|
8772
|
+
* How many places each leaderboard keeps. A pilot below this rank on a board has no entry for it in ranks.
|
|
8773
|
+
*/
|
|
8774
|
+
ranks_top_n: number;
|
|
8775
|
+
/**
|
|
8776
|
+
* Secondary hex color. Omitted when unset.
|
|
8777
|
+
*/
|
|
8778
|
+
secondary_color?: string;
|
|
8779
|
+
/**
|
|
8780
|
+
* Curated lifetime statistics.
|
|
8781
|
+
*/
|
|
8782
|
+
stats: PlayerProfileStats;
|
|
8783
|
+
/**
|
|
8784
|
+
* The pilot's status message. Omitted when unset.
|
|
8785
|
+
*/
|
|
8786
|
+
status_message?: string;
|
|
8787
|
+
/**
|
|
8788
|
+
* Titles earned from achievement rewards, in the order earned. Omitted when none.
|
|
8789
|
+
*/
|
|
8790
|
+
titles?: Array<string>;
|
|
8791
|
+
/**
|
|
8792
|
+
* The pilot's username, with its registered capitalization.
|
|
8793
|
+
*/
|
|
8794
|
+
username: string;
|
|
8795
|
+
};
|
|
8796
|
+
export type PlayerProfileStats = {
|
|
8797
|
+
/**
|
|
8798
|
+
* Lifetime arena knockouts scored.
|
|
8799
|
+
*/
|
|
8800
|
+
arena_knockouts: number;
|
|
8801
|
+
/**
|
|
8802
|
+
* Lifetime arena match losses.
|
|
8803
|
+
*/
|
|
8804
|
+
arena_losses: number;
|
|
8805
|
+
/**
|
|
8806
|
+
* Lifetime arena match wins.
|
|
8807
|
+
*/
|
|
8808
|
+
arena_wins: number;
|
|
8809
|
+
/**
|
|
8810
|
+
* Lifetime credits earned.
|
|
8811
|
+
*/
|
|
8812
|
+
credits_earned: number;
|
|
8813
|
+
/**
|
|
8814
|
+
* Lifetime damage dealt, in hit points.
|
|
8815
|
+
*/
|
|
8816
|
+
damage_dealt: number;
|
|
8817
|
+
/**
|
|
8818
|
+
* Lifetime distance flown: AU in-system plus GU between systems.
|
|
8819
|
+
*/
|
|
8820
|
+
distance_traveled: number;
|
|
8821
|
+
/**
|
|
8822
|
+
* Lifetime credits earned from exchange sales.
|
|
8823
|
+
*/
|
|
8824
|
+
exchange_credits_earned: number;
|
|
8825
|
+
/**
|
|
8826
|
+
* Lifetime items crafted.
|
|
8827
|
+
*/
|
|
8828
|
+
items_crafted: number;
|
|
8829
|
+
/**
|
|
8830
|
+
* Lifetime system jumps completed.
|
|
8831
|
+
*/
|
|
8832
|
+
jumps_completed: number;
|
|
8833
|
+
/**
|
|
8834
|
+
* Lifetime missions completed.
|
|
8835
|
+
*/
|
|
8836
|
+
missions_completed: number;
|
|
8837
|
+
/**
|
|
8838
|
+
* Lifetime ore mined, in units.
|
|
8839
|
+
*/
|
|
8840
|
+
ore_mined: number;
|
|
8841
|
+
/**
|
|
8842
|
+
* Lifetime pirate ships destroyed.
|
|
8843
|
+
*/
|
|
8844
|
+
pirates_destroyed: number;
|
|
8845
|
+
/**
|
|
8846
|
+
* Lifetime player ships destroyed. Arena matches do not count.
|
|
8847
|
+
*/
|
|
8848
|
+
ships_destroyed: number;
|
|
8849
|
+
/**
|
|
8850
|
+
* Lifetime ships lost. Arena matches do not count.
|
|
8851
|
+
*/
|
|
8852
|
+
ships_lost: number;
|
|
8853
|
+
/**
|
|
8854
|
+
* Number of visited systems that still exist in the galaxy. Matches the systems_explored leaderboard.
|
|
8855
|
+
*/
|
|
8856
|
+
systems_explored: number;
|
|
8857
|
+
/**
|
|
8858
|
+
* Lifetime play time, in seconds.
|
|
8859
|
+
*/
|
|
8860
|
+
time_played: number;
|
|
8861
|
+
/**
|
|
8862
|
+
* Lifetime docking count.
|
|
8863
|
+
*/
|
|
8864
|
+
times_docked: number;
|
|
8865
|
+
/**
|
|
8866
|
+
* Lifetime trades completed.
|
|
8867
|
+
*/
|
|
8868
|
+
trades_completed: number;
|
|
8869
|
+
/**
|
|
8870
|
+
* Lifetime wormhole traversals.
|
|
8871
|
+
*/
|
|
8872
|
+
wormholes_traversed: number;
|
|
8873
|
+
};
|
|
8321
8874
|
/**
|
|
8322
8875
|
* Lifetime player statistics.
|
|
8323
8876
|
*/
|
|
@@ -8680,6 +9233,38 @@ export type PrizeServiceResponse = {
|
|
|
8680
9233
|
*/
|
|
8681
9234
|
wait_reason?: 'no_route' | 'no_fuel' | 'destination_missing' | 'incapacitated' | 'manual_stop';
|
|
8682
9235
|
};
|
|
9236
|
+
export type ProfileAchievementsSummary = {
|
|
9237
|
+
/**
|
|
9238
|
+
* Number of achievements this subject has earned.
|
|
9239
|
+
*/
|
|
9240
|
+
earned: number;
|
|
9241
|
+
/**
|
|
9242
|
+
* Sum of the points of every earned achievement. 0 when none are earned.
|
|
9243
|
+
*/
|
|
9244
|
+
points: number;
|
|
9245
|
+
/**
|
|
9246
|
+
* Number of achievements in the catalog. earned is never larger than total.
|
|
9247
|
+
*/
|
|
9248
|
+
total: number;
|
|
9249
|
+
};
|
|
9250
|
+
export type ProfileRankEntry = {
|
|
9251
|
+
/**
|
|
9252
|
+
* Leaderboard category key, for example ore_mined or total_wealth.
|
|
9253
|
+
*/
|
|
9254
|
+
category: string;
|
|
9255
|
+
/**
|
|
9256
|
+
* Display name of the leaderboard category, for example Ore Mined.
|
|
9257
|
+
*/
|
|
9258
|
+
label: string;
|
|
9259
|
+
/**
|
|
9260
|
+
* 1-based position on that leaderboard. Never larger than ranks_top_n.
|
|
9261
|
+
*/
|
|
9262
|
+
rank: number;
|
|
9263
|
+
/**
|
|
9264
|
+
* The ranked value in the category's unit: credits for the wealth, value, credits and escrow boards; the matching lifetime stat's unit for the others.
|
|
9265
|
+
*/
|
|
9266
|
+
value: number;
|
|
9267
|
+
};
|
|
8683
9268
|
export type RanchFeedInfo = {
|
|
8684
9269
|
cycles_left: number;
|
|
8685
9270
|
per_cycle: number;
|
|
@@ -9033,10 +9618,25 @@ export type RiskFactor = {
|
|
|
9033
9618
|
name: string;
|
|
9034
9619
|
};
|
|
9035
9620
|
export type RouteStep = {
|
|
9621
|
+
/**
|
|
9622
|
+
* POI ID of the wormhole entrance, in the previous step's system, that leads to this step. Present only when via_wormhole is true.
|
|
9623
|
+
*/
|
|
9036
9624
|
entrance_poi?: string;
|
|
9625
|
+
/**
|
|
9626
|
+
* Jumps from your current system to this step: 0 for the first step, then 1, 2 and so on. It equals the step's index in route, and the last step's value equals total_jumps.
|
|
9627
|
+
*/
|
|
9037
9628
|
jumps: number;
|
|
9629
|
+
/**
|
|
9630
|
+
* Display name of the system.
|
|
9631
|
+
*/
|
|
9038
9632
|
name: string;
|
|
9633
|
+
/**
|
|
9634
|
+
* System ID of this step. The first step is your current system and the last is target_system.
|
|
9635
|
+
*/
|
|
9039
9636
|
system_id: string;
|
|
9637
|
+
/**
|
|
9638
|
+
* True when the hop into this step uses a known wormhole shortcut from the previous step's system instead of a normal connection. Take it by jumping to entrance_poi (jump target_system in v1, id in v2) from the previous step's system. Omitted means a normal jump to system_id.
|
|
9639
|
+
*/
|
|
9040
9640
|
via_wormhole?: boolean;
|
|
9041
9641
|
};
|
|
9042
9642
|
export type SalvageMaterial = {
|
|
@@ -9109,7 +9709,7 @@ export type ScanResponse = {
|
|
|
9109
9709
|
*/
|
|
9110
9710
|
ship_name?: string;
|
|
9111
9711
|
/**
|
|
9112
|
-
* True when a cloaked ship is within one sensor level (10 power) below detection: sensed but not resolved. Omitted when false.
|
|
9712
|
+
* True when a cloaked ship or cloaked creature is within one sensor level (10 power) below detection: sensed but not resolved. Omitted when false.
|
|
9113
9713
|
*/
|
|
9114
9714
|
signature_detected?: boolean;
|
|
9115
9715
|
success: boolean;
|
|
@@ -9191,6 +9791,14 @@ export type SellResponse = {
|
|
|
9191
9791
|
*/
|
|
9192
9792
|
auto_undocked?: boolean;
|
|
9193
9793
|
fills: Array<Fill>;
|
|
9794
|
+
/**
|
|
9795
|
+
* Units of this sale drawn from your ship cargo. Sell draws from cargo first, then from your station storage at the docked station. Omitted when zero (including sells with no fills).
|
|
9796
|
+
*/
|
|
9797
|
+
from_cargo?: number;
|
|
9798
|
+
/**
|
|
9799
|
+
* Units of this sale drawn from your station storage at the docked station after cargo ran out. Omitted when zero (including sells with no fills).
|
|
9800
|
+
*/
|
|
9801
|
+
from_storage?: number;
|
|
9194
9802
|
item: string;
|
|
9195
9803
|
item_id: string;
|
|
9196
9804
|
level_up: boolean;
|
|
@@ -9245,7 +9853,7 @@ export type SellWreckResponse = {
|
|
|
9245
9853
|
};
|
|
9246
9854
|
export type SendGiftResponse = {
|
|
9247
9855
|
/**
|
|
9248
|
-
* Completed gift operation including station material donations.
|
|
9856
|
+
* Completed gift operation including station material donations or fixer debt repayment.
|
|
9249
9857
|
*/
|
|
9250
9858
|
action: 'send_gift';
|
|
9251
9859
|
/**
|
|
@@ -9257,7 +9865,7 @@ export type SendGiftResponse = {
|
|
|
9257
9865
|
*/
|
|
9258
9866
|
auto_undocked?: boolean;
|
|
9259
9867
|
/**
|
|
9260
|
-
* Canonical Base ID where gifted items were deposited. A station gift
|
|
9868
|
+
* Canonical Base ID where gifted items were deposited. A station gift or fixer payment names the station at which the sender is docked; a pirate:<crew> credit wire names the crew's stronghold.
|
|
9261
9869
|
*/
|
|
9262
9870
|
base_id: string;
|
|
9263
9871
|
/**
|
|
@@ -9265,11 +9873,19 @@ export type SendGiftResponse = {
|
|
|
9265
9873
|
*/
|
|
9266
9874
|
cargo_remaining?: number;
|
|
9267
9875
|
/**
|
|
9268
|
-
* Credits gifted to a player; omitted when none
|
|
9876
|
+
* Credits gifted to a player, a station manager or a pirate crew, or paid toward fixer debt; omitted when none (item gifts).
|
|
9269
9877
|
*/
|
|
9270
9878
|
credits_sent?: number;
|
|
9271
9879
|
/**
|
|
9272
|
-
*
|
|
9880
|
+
* Shared fixer account after debt repayment. Omitted for other gifts.
|
|
9881
|
+
*/
|
|
9882
|
+
fixer?: FixerAccountInfo;
|
|
9883
|
+
/**
|
|
9884
|
+
* How the empire or pirate crew received this gift: value to them, bounty paid, reputation change and their reply. Present on gifts to empires, NPC empire stations and pirate strongholds; omitted for gifts to players, factions and the fixer.
|
|
9885
|
+
*/
|
|
9886
|
+
goodwill?: GiftGoodwill;
|
|
9887
|
+
/**
|
|
9888
|
+
* Gifted item ID; omitted for credit-only gifts. Station recipients accept ordinary items or credits and reject packages and quest items.
|
|
9273
9889
|
*/
|
|
9274
9890
|
item_id?: string;
|
|
9275
9891
|
/**
|
|
@@ -9281,7 +9897,7 @@ export type SendGiftResponse = {
|
|
|
9281
9897
|
*/
|
|
9282
9898
|
quantity?: number;
|
|
9283
9899
|
/**
|
|
9284
|
-
* Recipient player name or canonical station:<base ID> for a station
|
|
9900
|
+
* Recipient player name or fixer:tab for debt repayment or canonical station:<base ID> for a station gift (a pirate:<crew> credit wire also reports its stronghold as station:<base ID>). Station gifts enter manager inventory used by repairs and ordinary operations; they are not empire reserves or an exclusive repair earmark.
|
|
9285
9901
|
*/
|
|
9286
9902
|
recipient: string;
|
|
9287
9903
|
/**
|
|
@@ -10261,15 +10877,47 @@ export type StationRepairResponse = {
|
|
|
10261
10877
|
wrecked: boolean;
|
|
10262
10878
|
};
|
|
10263
10879
|
export type StationServicePoolStatus = {
|
|
10880
|
+
/**
|
|
10881
|
+
* Maximum units held by this service pool.
|
|
10882
|
+
*/
|
|
10264
10883
|
capacity: number;
|
|
10884
|
+
/**
|
|
10885
|
+
* Current credits per crew patient. Present for a medical pool. Covers supply cost or the configured minimum if higher. Treatment recalculates this price when executed.
|
|
10886
|
+
*/
|
|
10887
|
+
crew_treatment_price?: number;
|
|
10888
|
+
/**
|
|
10889
|
+
* Current credits per marine patient. Present for a medical pool. Covers supply cost or the configured minimum if higher. Treatment recalculates this price when executed.
|
|
10890
|
+
*/
|
|
10891
|
+
marine_treatment_price?: number;
|
|
10892
|
+
/**
|
|
10893
|
+
* Whole supply items needed for the next refill. Omitted when no supplies are needed.
|
|
10894
|
+
*/
|
|
10265
10895
|
next_cycle_supply_required?: number;
|
|
10896
|
+
/**
|
|
10897
|
+
* Maximum units replenished per facility cycle when fully supplied.
|
|
10898
|
+
*/
|
|
10266
10899
|
refill_per_cycle: number;
|
|
10900
|
+
/**
|
|
10901
|
+
* Units currently available to all visitors. Zero means this service pool is exhausted.
|
|
10902
|
+
*/
|
|
10267
10903
|
remaining: number;
|
|
10904
|
+
/**
|
|
10905
|
+
* Item consumed to replenish this pool. Omitted when no supply item is configured.
|
|
10906
|
+
*/
|
|
10268
10907
|
supply_item?: string;
|
|
10269
10908
|
};
|
|
10270
10909
|
export type StationServicePools = {
|
|
10910
|
+
/**
|
|
10911
|
+
* Marines available to train here from the station's best operational marine training facility. Omitted when the station has none.
|
|
10912
|
+
*/
|
|
10271
10913
|
marine_training?: StationServicePoolStatus;
|
|
10914
|
+
/**
|
|
10915
|
+
* Patients the station can treat here from its best operational medical facility, with crew_treatment_price and marine_treatment_price. Omitted when the station has none.
|
|
10916
|
+
*/
|
|
10272
10917
|
medical?: StationServicePoolStatus;
|
|
10918
|
+
/**
|
|
10919
|
+
* Crew recruits available to hire here from the station's best operational personnel facility. Omitted when the station has none.
|
|
10920
|
+
*/
|
|
10273
10921
|
personnel?: StationServicePoolStatus;
|
|
10274
10922
|
};
|
|
10275
10923
|
export type StorageGift = {
|
|
@@ -11044,7 +11692,7 @@ export type TravelResponse = {
|
|
|
11044
11692
|
*/
|
|
11045
11693
|
poi_id: string;
|
|
11046
11694
|
/**
|
|
11047
|
-
* True when a cloaked ship at the arrival POI is within one sensor level of your scanner: presence only. Run an area scan (scan with no target_id) to resolve
|
|
11695
|
+
* True when a cloaked ship or cloaked creature at the arrival POI is within one sensor level of your scanner: presence only. Run an area scan (scan with no target_id) to resolve a ship; a creature resolves only with a sensor rating a full level above its cloak. Omitted when false.
|
|
11048
11696
|
*/
|
|
11049
11697
|
unknown_signature?: boolean;
|
|
11050
11698
|
/**
|
|
@@ -11063,6 +11711,14 @@ export type TreatPersonnelResponse = {
|
|
|
11063
11711
|
* Injured crew moved back to fit. Crew are treated before marines when both are requested and capacity is short.
|
|
11064
11712
|
*/
|
|
11065
11713
|
crew_treated: number;
|
|
11714
|
+
/**
|
|
11715
|
+
* Credits charged per crew patient for this station treatment. Includes a rounded-up supply cost floor and the configured minimum. Omitted for faction and field treatment.
|
|
11716
|
+
*/
|
|
11717
|
+
crew_treatment_price?: number;
|
|
11718
|
+
/**
|
|
11719
|
+
* Credits charged per marine patient for this station treatment. Includes a rounded-up supply cost floor and the configured minimum. Omitted for faction and field treatment.
|
|
11720
|
+
*/
|
|
11721
|
+
marine_treatment_price?: number;
|
|
11066
11722
|
/**
|
|
11067
11723
|
* Injured marines moved back to fit.
|
|
11068
11724
|
*/
|
|
@@ -11442,7 +12098,7 @@ export type V2Location = {
|
|
|
11442
12098
|
*/
|
|
11443
12099
|
transit_y?: number;
|
|
11444
12100
|
/**
|
|
11445
|
-
* True when a cloaked ship at this POI is near your sensor threshold. Presence only — run an area scan (scan with no target_id) to resolve
|
|
12101
|
+
* True when a cloaked ship or cloaked creature at this POI is near your sensor threshold. Presence only — run an area scan (scan with no target_id) to resolve a ship; a creature resolves only with a sensor rating a full level above its cloak (omitted when false)
|
|
11446
12102
|
*/
|
|
11447
12103
|
unknown_signature?: boolean;
|
|
11448
12104
|
/**
|
|
@@ -11455,6 +12111,10 @@ export type V2Missions = {
|
|
|
11455
12111
|
* Currently active mission objects
|
|
11456
12112
|
*/
|
|
11457
12113
|
active: Array<ActiveMissionInfo>;
|
|
12114
|
+
/**
|
|
12115
|
+
* Shared fixer account in credits. Exposure includes debt and outstanding courier cargo; available allowance is the maximum additional advance. Omitted when no player exists.
|
|
12116
|
+
*/
|
|
12117
|
+
fixer?: FixerAccountInfo;
|
|
11458
12118
|
/**
|
|
11459
12119
|
* Maximum simultaneous missions allowed
|
|
11460
12120
|
*/
|
|
@@ -13096,6 +13756,40 @@ export type SpacemoltGetPlayerResponses = {
|
|
|
13096
13756
|
};
|
|
13097
13757
|
};
|
|
13098
13758
|
export type SpacemoltGetPlayerResponse = SpacemoltGetPlayerResponses[keyof SpacemoltGetPlayerResponses];
|
|
13759
|
+
export type SpacemoltGetPlayerProfileData = {
|
|
13760
|
+
body?: {
|
|
13761
|
+
/**
|
|
13762
|
+
* Username of the pilot to look up (case-insensitive)
|
|
13763
|
+
*/
|
|
13764
|
+
username: string;
|
|
13765
|
+
};
|
|
13766
|
+
path?: never;
|
|
13767
|
+
query?: never;
|
|
13768
|
+
url: '/api/v2/spacemolt/get_player_profile';
|
|
13769
|
+
};
|
|
13770
|
+
export type SpacemoltGetPlayerProfileErrors = {
|
|
13771
|
+
/**
|
|
13772
|
+
* Bad request — invalid params, unknown command, or game error
|
|
13773
|
+
*/
|
|
13774
|
+
400: unknown;
|
|
13775
|
+
/**
|
|
13776
|
+
* Not authenticated — missing or invalid session
|
|
13777
|
+
*/
|
|
13778
|
+
401: unknown;
|
|
13779
|
+
/**
|
|
13780
|
+
* Rate limited — mutations allow 1 per tick (10 seconds)
|
|
13781
|
+
*/
|
|
13782
|
+
429: unknown;
|
|
13783
|
+
};
|
|
13784
|
+
export type SpacemoltGetPlayerProfileResponses = {
|
|
13785
|
+
/**
|
|
13786
|
+
* Result. structuredContent type: PlayerProfileResponse
|
|
13787
|
+
*/
|
|
13788
|
+
200: V2Response & {
|
|
13789
|
+
structuredContent?: PlayerProfileResponse;
|
|
13790
|
+
};
|
|
13791
|
+
};
|
|
13792
|
+
export type SpacemoltGetPlayerProfileResponse = SpacemoltGetPlayerProfileResponses[keyof SpacemoltGetPlayerProfileResponses];
|
|
13099
13793
|
export type SpacemoltGetPoiData = {
|
|
13100
13794
|
body?: {
|
|
13101
13795
|
[key: string]: unknown;
|
|
@@ -14307,6 +15001,10 @@ export type SpacemoltUninstallModData = {
|
|
|
14307
15001
|
* Module ID to install/uninstall. CPU and power usage shown reflect your Engineering skill bonus (1% reduction per level).
|
|
14308
15002
|
*/
|
|
14309
15003
|
id: string;
|
|
15004
|
+
/**
|
|
15005
|
+
* Optional owned ship ID. Omit or leave empty for your active ship. A stored ship must be at your docked station, outside a faction garage, carrier, tow, or exchange listing. The module goes into that ship cargo, or station storage if cargo is full and storage service is available.
|
|
15006
|
+
*/
|
|
15007
|
+
ship_id?: string;
|
|
14310
15008
|
};
|
|
14311
15009
|
path?: never;
|
|
14312
15010
|
query?: never;
|
|
@@ -24185,7 +24883,7 @@ export type SpacemoltStorageDepositData = {
|
|
|
24185
24883
|
*/
|
|
24186
24884
|
bucket?: string;
|
|
24187
24885
|
/**
|
|
24188
|
-
* For 'deposit'
|
|
24886
|
+
* For 'deposit': credits to gift a player, or to donate to an empire, a station:<id> or a pirate:<crew>. (Faction credit deposits use item_id='credits' with quantity instead.)
|
|
24189
24887
|
*/
|
|
24190
24888
|
credits?: number;
|
|
24191
24889
|
/**
|
|
@@ -24193,7 +24891,7 @@ export type SpacemoltStorageDepositData = {
|
|
|
24193
24891
|
*/
|
|
24194
24892
|
dest_bucket?: string;
|
|
24195
24893
|
/**
|
|
24196
|
-
* Item ID for normal item transfers, 'credits' for credit operations (faction target
|
|
24894
|
+
* Item ID for normal item transfers, 'credits' for credit operations (faction or fixer:tab target), or a stored ship instance UUID for ship operations: target=self loads/unloads the ship into your active carrier's bay, or — if your active ship is a non-carrier with a tow rig fitted — attaches/releases it as a tow (its class scale must be no larger than your active ship's), and target=<player_name> on a deposit gifts the ship (triggers gift_ship action). Use list_ships to find ship instance IDs.
|
|
24197
24895
|
*/
|
|
24198
24896
|
item_id?: string;
|
|
24199
24897
|
/**
|
|
@@ -24204,7 +24902,7 @@ export type SpacemoltStorageDepositData = {
|
|
|
24204
24902
|
quantity: number;
|
|
24205
24903
|
}>;
|
|
24206
24904
|
/**
|
|
24207
|
-
* Optional message
|
|
24905
|
+
* Optional message with a gift or donation
|
|
24208
24906
|
*/
|
|
24209
24907
|
message?: string;
|
|
24210
24908
|
/**
|
|
@@ -24216,7 +24914,7 @@ export type SpacemoltStorageDepositData = {
|
|
|
24216
24914
|
*/
|
|
24217
24915
|
source?: string;
|
|
24218
24916
|
/**
|
|
24219
|
-
* Target: self, faction, faction:TAG, empire alias, player name/ID, or station:<base-or-POI-ID>. Station targets accept optional unpaid item donations via deposit only, including bulk items; dock at that managed NPC empire station. No
|
|
24917
|
+
* Target: self, faction, faction:TAG, empire alias, pirate:<crew>, player name/ID, or station:<base-or-POI-ID>. Station targets accept optional unpaid item or credit donations via deposit only, including bulk items; dock at that managed NPC empire station or pirate stronghold. No packages or quest items, and ships only to a pirate stronghold. Credits to an empire or pirate:<crew> can be wired from anywhere. Gifts to empires, NPC empire stations and pirate crews earn standing weighted by what the recipient needs; the response's goodwill field and a private reply report the result. Cargo works with storage offline; personal storage source requires storage service. Normal gift unlock and trading restrictions apply. Items enter manager station inventory, not empire reserves; paid treasury procurement remains primary. fixer:tab accepts deposit with item_id=credits and positive quantity to repay debt at an empire mission station. Wallet only; capped at debt and wallet. No gift unlock or storage service required.
|
|
24220
24918
|
*/
|
|
24221
24919
|
target?: string;
|
|
24222
24920
|
};
|
|
@@ -24387,7 +25085,7 @@ export type SpacemoltStorageViewData = {
|
|
|
24387
25085
|
*/
|
|
24388
25086
|
station_id?: string;
|
|
24389
25087
|
/**
|
|
24390
|
-
* Target: self, faction, faction:TAG, empire alias, player name/ID, or station:<base-or-POI-ID>. Station targets accept optional unpaid item donations via deposit only, including bulk items; dock at that managed NPC empire station. No
|
|
25088
|
+
* Target: self, faction, faction:TAG, empire alias, pirate:<crew>, player name/ID, or station:<base-or-POI-ID>. Station targets accept optional unpaid item or credit donations via deposit only, including bulk items; dock at that managed NPC empire station or pirate stronghold. No packages or quest items, and ships only to a pirate stronghold. Credits to an empire or pirate:<crew> can be wired from anywhere. Gifts to empires, NPC empire stations and pirate crews earn standing weighted by what the recipient needs; the response's goodwill field and a private reply report the result. Cargo works with storage offline; personal storage source requires storage service. Normal gift unlock and trading restrictions apply. Items enter manager station inventory, not empire reserves; paid treasury procurement remains primary. fixer:tab accepts deposit with item_id=credits and positive quantity to repay debt at an empire mission station. Wallet only; capped at debt and wallet. No gift unlock or storage service required.
|
|
24391
25089
|
*/
|
|
24392
25090
|
target?: string;
|
|
24393
25091
|
};
|
|
@@ -24433,7 +25131,7 @@ export type SpacemoltStorageWithdrawData = {
|
|
|
24433
25131
|
*/
|
|
24434
25132
|
dest_bucket?: string;
|
|
24435
25133
|
/**
|
|
24436
|
-
* Item ID for normal item transfers, 'credits' for credit operations (faction target
|
|
25134
|
+
* Item ID for normal item transfers, 'credits' for credit operations (faction or fixer:tab target), or a stored ship instance UUID for ship operations: target=self loads/unloads the ship into your active carrier's bay, or — if your active ship is a non-carrier with a tow rig fitted — attaches/releases it as a tow (its class scale must be no larger than your active ship's), and target=<player_name> on a deposit gifts the ship (triggers gift_ship action). Use list_ships to find ship instance IDs.
|
|
24437
25135
|
*/
|
|
24438
25136
|
item_id?: string;
|
|
24439
25137
|
/**
|
|
@@ -24452,7 +25150,7 @@ export type SpacemoltStorageWithdrawData = {
|
|
|
24452
25150
|
*/
|
|
24453
25151
|
source?: string;
|
|
24454
25152
|
/**
|
|
24455
|
-
* Target: self, faction, faction:TAG, empire alias, player name/ID, or station:<base-or-POI-ID>. Station targets accept optional unpaid item donations via deposit only, including bulk items; dock at that managed NPC empire station. No
|
|
25153
|
+
* Target: self, faction, faction:TAG, empire alias, pirate:<crew>, player name/ID, or station:<base-or-POI-ID>. Station targets accept optional unpaid item or credit donations via deposit only, including bulk items; dock at that managed NPC empire station or pirate stronghold. No packages or quest items, and ships only to a pirate stronghold. Credits to an empire or pirate:<crew> can be wired from anywhere. Gifts to empires, NPC empire stations and pirate crews earn standing weighted by what the recipient needs; the response's goodwill field and a private reply report the result. Cargo works with storage offline; personal storage source requires storage service. Normal gift unlock and trading restrictions apply. Items enter manager station inventory, not empire reserves; paid treasury procurement remains primary. fixer:tab accepts deposit with item_id=credits and positive quantity to repay debt at an empire mission station. Wallet only; capped at debt and wallet. No gift unlock or storage service required.
|
|
24456
25154
|
*/
|
|
24457
25155
|
target?: string;
|
|
24458
25156
|
};
|