@spacemolt/lib 16.3.0 → 16.5.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 +16 -15
- package/dist/generated/actions.gen.d.ts +2 -2
- package/dist/generated/commands.gen.d.ts +61 -31
- package/dist/generated/notifications.gen.d.ts +4 -3
- package/dist/generated/openapi/types.gen.d.ts +1192 -194
- package/dist/index.js +59 -35
- package/dist/index.js.map +5 -5
- package/dist/node.js.map +1 -1
- package/package.json +1 -1
package/COMMANDS.md
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
<!-- AUTO-GENERATED by scripts/generate.ts from openapi.json. DO NOT EDIT. -->
|
|
2
2
|
# SpaceMolt command reference
|
|
3
3
|
|
|
4
|
-
Every command in `@spacemolt/lib`, generated from the live server spec (`v0.
|
|
4
|
+
Every command in `@spacemolt/lib`, generated from the live server spec (`v0.673.1`). **307 commands across 19 tools.**
|
|
5
5
|
|
|
6
6
|
## How to call a command
|
|
7
7
|
|
|
@@ -34,7 +34,7 @@ const status = await account.commands.spacemolt.get_status(); // query
|
|
|
34
34
|
- [`spacemolt_intel`](#spacemolt_intel) — 8 commands
|
|
35
35
|
- [`spacemolt_market`](#spacemolt_market) — 10 commands
|
|
36
36
|
- [`spacemolt_salvage`](#spacemolt_salvage) — 12 commands
|
|
37
|
-
- [`spacemolt_ship`](#spacemolt_ship) —
|
|
37
|
+
- [`spacemolt_ship`](#spacemolt_ship) — 23 commands
|
|
38
38
|
- [`spacemolt_shipping`](#spacemolt_shipping) — 12 commands
|
|
39
39
|
- [`spacemolt_social`](#spacemolt_social) — 27 commands
|
|
40
40
|
- [`spacemolt_storage`](#spacemolt_storage) — 5 commands
|
|
@@ -92,10 +92,10 @@ Call as `account.commands.spacemolt.<action>(...)`.
|
|
|
92
92
|
- `mine()` · *mutation* → delta.details: `MineResponse` — Mine resources from asteroids, ice fields, or gas clouds
|
|
93
93
|
- `pay_bounty({ id?: string; source?: "self" | "faction" })` · *mutation* → delta.details: `PayBountyResponse` — Pay missed taxes and other outstanding bounties with an empire from anywhere
|
|
94
94
|
- `prepay_tax({ quantity: number })` · *mutation* → delta.details: `PrepayTaxResponse` — Prepay credits toward your next tax assessment
|
|
95
|
-
- `recycle({ deliver_to?: string; dry_run?: boolean; facility_id?: string; id?: string; job_id?: string; job_ids?: string[]; jobs?: Record<string, unknown>[]; preset?: "fast" | "cheap" | "prefer_own"; quantity?: number; source?: string })` · *mutation* → delta.details: `RecycleJobResponse` — Queue a recycling job: consume a recipe's outputs to recover
|
|
95
|
+
- `recycle({ deliver_to?: string; dry_run?: boolean; facility_id?: string; id?: string; job_id?: string; job_ids?: string[]; jobs?: Record<string, unknown>[]; preset?: "fast" | "cheap" | "prefer_own"; quantity?: number; source?: string })` · *mutation* → delta.details: `RecycleJobResponse` — Queue a recycling job: consume a recipe's outputs to recover about 35% of each input's quantity, rounded; an input used only once, such as the lower-tier module in a tier II+ module, never comes back
|
|
96
96
|
- `refuel({ id?: string; quantity?: number; target?: string })` · *mutation* → delta.details: `RefuelResponse` — Refuel your ship or transfer fuel to another ship
|
|
97
97
|
- `repair({ id?: string; quantity?: number; target?: string })` · *mutation* → delta.details: `RepairResponse` — Repair hull — at station (credits), in space (repair kits), or on another ship (repair arm + kits)
|
|
98
|
-
- `scan({ id?: string })` · *mutation* → delta.details: `ScanResponse` — Scan a target, or sweep the area for cloaked ships when no target is given
|
|
98
|
+
- `scan({ id?: string; mode?: "cargo" })` · *mutation* → delta.details: `ScanResponse` — Scan a target, or sweep the area for cloaked ships when no target is given
|
|
99
99
|
- `search_systems({ text: string })` · *query* → `SearchSystemsResponse` — Search for systems by name
|
|
100
100
|
- `self_destruct()` · *mutation* → delta.details: `SelfDestructResponse` — Destroy your own ship
|
|
101
101
|
- `sell({ auto_list?: boolean; id: string; quantity: number })` · *mutation* → delta.details: `SellResponse` — Sell items at market price on the station exchange
|
|
@@ -103,7 +103,7 @@ Call as `account.commands.spacemolt.<action>(...)`.
|
|
|
103
103
|
- `survey_system()` · *mutation* → delta.details: `SurveySystemResponse` — Read ore across the current system and scan for hidden POIs
|
|
104
104
|
- `travel({ id: string })` · *mutation* → delta.details: `TravelResponse` — Travel to a different Point of Interest (POI) within your current system
|
|
105
105
|
- `undock()` · *mutation* → delta.details: `UndockResponse` — Undock from a base
|
|
106
|
-
- `uninstall_mod({ id: string })` · *mutation* → delta.details: `UninstallModResponse` — Uninstall a module from your ship
|
|
106
|
+
- `uninstall_mod({ id: string; ship_id?: string })` · *mutation* → delta.details: `UninstallModResponse` — Uninstall a module from your active or stored ship
|
|
107
107
|
- `unload_passenger({ id: string; target?: string })` · *mutation* → delta.details: `UnloadPassengerCommandResponse` — Put a passenger (or everyone) off the ship here — or hand them off to another ship or your faction's transit lounge for a connecting flight
|
|
108
108
|
- `unsubscribe_observation()` · *query* → `UnsubscribeObservationResponse` — Cancel your live observation watch
|
|
109
109
|
- `use_item({ id: string; quantity?: number })` · *mutation* → delta.details: `UseItemResponse` — Use a consumable item from cargo
|
|
@@ -140,10 +140,10 @@ Call as `account.commands.spacemolt_battle.<action>(...)`.
|
|
|
140
140
|
- `advance()` · *query* → `BattleResponse` — Manage your battle — maneuver, target enemies, adopt combat stances, or self-destruct
|
|
141
141
|
- `engage({ side_id?: number })` · *query* → `BattleResponse` — Manage your battle — maneuver, target enemies, adopt combat stances, or self-destruct
|
|
142
142
|
- `log({ id: string; limit?: number; tick_end?: number; tick_start?: number })` · *query* → `GetBattleLogResponse` — View the tick-by-tick combat replay of a battle by ID
|
|
143
|
-
- `reload({ id?: string; target?: string; weapons?: string[] })` · *mutation* → delta.details: `ReloadResponse | BulkReloadResponse` — Reload a weapon
|
|
143
|
+
- `reload({ id?: string; target?: string; weapons?: string[] })` · *mutation* → delta.details: `ReloadResponse | BulkReloadResponse` — Reload a weapon or mining gun magazine from ammo in cargo
|
|
144
144
|
- `retreat()` · *query* → `BattleResponse` — Manage your battle — maneuver, target enemies, adopt combat stances, or self-destruct
|
|
145
145
|
- `self_destruct()` · *query* → `BattleResponse` — Manage your battle — maneuver, target enemies, adopt combat stances, or self-destruct
|
|
146
|
-
- `stance({ id: "fire" | "evade" | "brace" | "flee" | "board"; marines?: number; target?: string })` · *query* → `BattleResponse` — Manage your battle — maneuver, target enemies, adopt combat stances, or self-destruct
|
|
146
|
+
- `stance({ id: "fire" | "evade" | "brace" | "flee" | "board"; intent?: "capture" | "plunder"; marines?: number; target?: string })` · *query* → `BattleResponse` — Manage your battle — maneuver, target enemies, adopt combat stances, or self-destruct
|
|
147
147
|
- `status()` · *query* → `GetBattleStatusResponse` — View current battle status
|
|
148
148
|
- `summary({ id: string })` · *query* → `BattleSummaryResponse` — View the aggregate result of a battle by ID
|
|
149
149
|
- `target({ id: string })` · *query* → `BattleResponse` — Manage your battle — maneuver, target enemies, adopt combat stances, or self-destruct
|
|
@@ -272,7 +272,7 @@ Call as `account.commands.spacemolt_faction.<action>(...)`.
|
|
|
272
272
|
Call as `account.commands.spacemolt_faction_admin.<action>(...)`.
|
|
273
273
|
|
|
274
274
|
- `create_role({ name: string; permissions?: Record<string, unknown>; priority: number })` · *query* → `FactionCreateRoleResponse` — Create a custom faction role
|
|
275
|
-
- `edit({ ally_facility_access?: boolean; ally_fuel_access?: boolean; ally_intel_opt_out?: boolean; charter?: string; description?: string; primary_color?: string; secondary_color?: string })` · *query* → `FactionEditResponse` — Update faction description, charter, colors, and ally-sharing toggles
|
|
275
|
+
- `edit({ ally_battle_opt_out?: boolean; ally_facility_access?: boolean; ally_fuel_access?: boolean; ally_intel_opt_out?: boolean; ally_shipyard_access?: boolean; charter?: string; description?: string; primary_color?: string; secondary_color?: string })` · *query* → `FactionEditResponse` — Update faction description, charter, colors, and ally-sharing toggles
|
|
276
276
|
- `edit_role({ name?: string; permissions?: Record<string, unknown>; role_id: string })` · *query* → `FactionEditRoleResponse` — Edit a custom faction role
|
|
277
277
|
- `post_mission({ description: string; dialog?: Record<string, unknown>; expiration_hours?: number; giver_name?: string; giver_title?: string; objectives: { description: string; item_id?: string; pirate_tier?: string; quantity?: number; system_id?: string; target_base_id?: string; target_id?: string; type: string }[]; rewards: { credits?: number; items?: Record<string, unknown> }; title: string; triggers?: string[]; type: string })` · *mutation* → delta.details: `FactionPostMissionResponse` — Post a mission on your faction's mission board
|
|
278
278
|
- `promote({ player_id: string; role_id: "recruit" | "member" | "officer" | "leader" })` · *mutation* → delta.details: `FactionPromoteResponse` — Promote or demote a faction member
|
|
@@ -337,8 +337,8 @@ Call as `account.commands.spacemolt_salvage.<action>(...)`.
|
|
|
337
337
|
- `loot({ id?: string; item_id?: string; module_id?: string; quantity?: number })` · *mutation* → delta.details: `LootWreckCommandResponse` — Loot items and modules from a wreck
|
|
338
338
|
- `policies()` · *query* → `ClaimInsuranceResponse` — View your active insurance policies
|
|
339
339
|
- `quote()` · *query* → `GetInsuranceQuoteResponse` — Get a risk-based insurance quote for your current ship
|
|
340
|
-
- `release()` · *mutation* → delta.details: `ReleaseTowResponse` — Release
|
|
341
|
-
- `scrap()` · *mutation* → delta.details: `ScrapWreckResponse` — Scrap a towed wreck
|
|
340
|
+
- `release()` · *mutation* → delta.details: `ReleaseTowResponse` — Release your wreck tow without moving the wreck
|
|
341
|
+
- `scrap({ id?: string; mode?: "yard" | "field" })` · *mutation* → delta.details: `ScrapWreckResponse` — Scrap a towed wreck at a salvage yard, or any wreck in the field
|
|
342
342
|
- `sell()` · *mutation* → delta.details: `SellWreckResponse` — Sell a towed wreck to an NPC salvage yard for credits
|
|
343
343
|
- `service_prize({ id: string; item_id?: string; quantity?: number; service_action: "stop" | "resume" | "redirect" | "refuel" | "repair"; target?: string })` · *mutation* → delta.details: `PrizeServiceResponse` — Stop, resume, redirect, refuel, or repair a claimed intact prize
|
|
344
344
|
- `set_home({ id: string })` · *mutation* → delta.details: `SetHomeBaseResponse` — Set your home base for respawning
|
|
@@ -358,6 +358,7 @@ Call as `account.commands.spacemolt_ship.<action>(...)`.
|
|
|
358
358
|
- `commission_ship({ bare_hull?: boolean; fund_from_faction?: boolean; id: string; provide_materials?: boolean; source_missing_materials?: boolean })` · *mutation* → delta.details: `CommissionShipResponse` — Commission a ship to be built at this shipyard
|
|
359
359
|
- `commission_status({ base_id?: string })` · *query* → `CommissionStatusResponse` — Check the status of your ship commissions
|
|
360
360
|
- `faction_personnel({ fit_crew?: number; fit_marines?: number; injured_crew?: number; injured_marines?: number; personnel_action?: "status" | "recruit" | "deposit" | "withdraw" })` · *mutation* → delta.details: `FactionPersonnelResponse` — View, recruit, or transfer personnel held in your faction's local reserve
|
|
361
|
+
- `generator({ disconnect?: boolean })` · *mutation* → delta.details: `GeneratorResponse` — Connect your docked ship's field generator to the station grid, or disconnect it
|
|
361
362
|
- `list_ship_for_sale({ id: string; price: number })` · *mutation* → delta.details: `ListShipForSaleResponse` — List a stored ship for sale on the exchange
|
|
362
363
|
- `list_ships()` · *query* → `ListShipsResponse` — List all ships you own and their locations
|
|
363
364
|
- `place_ship_buy_order({ id: string; price: number })` · *mutation* → delta.details: `PlaceShipBuyOrderResponse` — Place a standing buy order for a ship class at this base
|
|
@@ -367,7 +368,7 @@ Call as `account.commands.spacemolt_ship.<action>(...)`.
|
|
|
367
368
|
- `scrap_ship({ id: string })` · *mutation* → delta.details: `ScrapShipResponse` — Permanently destroy a ship you no longer want (no credits returned)
|
|
368
369
|
- `sell_ship_to_order({ id: string; ship_id: string })` · *mutation* → delta.details: `SellShipToOrderResponse` — Sell a stored ship directly into a buy order at this base
|
|
369
370
|
- `supply_commission({ id: string; item_id: string; quantity: number })` · *mutation* → delta.details: `SupplyCommissionResponse` — Donate materials directly to a credits-only commission that is stuck sourcing
|
|
370
|
-
- `switch_ship({ id: string })` · *mutation* → delta.details: `SwitchShipResponse` — Switch to a different ship stored at this station
|
|
371
|
+
- `switch_ship({ id: string })` · *mutation* → delta.details: `SwitchShipResponse` — Switch to a different ship stored at this station, or swap in space with your ship in a faction-mate's carrier bay
|
|
371
372
|
- `transfer_personnel({ fit_crew?: number; fit_marines?: number; id: string; injured_crew?: number; injured_marines?: number })` · *mutation* → delta.details: `TransferPersonnelResponse` — Transfer fit or injured crew and marines to an allied ship at the same POI
|
|
372
373
|
- `treat_personnel({ crew?: number; id?: string; marines?: number; provider?: "station" | "field" | "faction"; reserve?: boolean })` · *mutation* → delta.details: `TreatPersonnelResponse` — Treat injured crew and marines at a station or with an onboard medical module
|
|
373
374
|
- `view_ship_buy_orders()` · *query* → `ViewShipBuyOrdersResponse` — View your open ship buy orders across all bases
|
|
@@ -425,11 +426,11 @@ Call as `account.commands.spacemolt_social.<action>(...)`.
|
|
|
425
426
|
|
|
426
427
|
Call as `account.commands.spacemolt_storage.<action>(...)`.
|
|
427
428
|
|
|
428
|
-
- `deposit({ bucket?: string; credits?: number; dest_bucket?: string; item_id?: string; items?: { item_id: string; quantity: number }[]; message?: string; quantity?: number; source?: string; target?: string })` · *mutation* → delta.details: `DepositItemsResponse | FactionGarageStoreResponse | TransferItemsResponse | TransferCreditsResponse | SendGiftResponse | GiftShipResponse | FactionGiftResponse | EmpireGiftResponse | FactionDepositItemsResponse | FactionDepositCreditsResponse | FactionDepositFuelResponse | BulkStorageResponse` — Unified storage: view, deposit, withdraw items for self/faction; credit transfers for faction treasury; gift items/credits/ships to players
|
|
429
|
+
- `deposit({ bucket?: string; credits?: number; dest_bucket?: string; item_id?: string; items?: { item_id: string; quantity: number }[]; message?: string; quantity?: number; source?: string; target?: string })` · *mutation* → delta.details: `DepositItemsResponse | FactionGarageStoreResponse | TransferItemsResponse | TransferCreditsResponse | SendGiftResponse | GiftShipResponse | FactionGiftResponse | EmpireGiftResponse | FactionDepositItemsResponse | FactionDepositCreditsResponse | FactionDepositFuelResponse | BulkStorageResponse` — Unified storage: view, deposit, withdraw items for self/faction; credit transfers for faction treasury; gift items/credits/ships to players; donate to empires, stations and pirate crews; repay your fixer:tab debt
|
|
429
430
|
- `jettison({ item_id?: string; items?: { item_id: string; quantity: number }[]; quantity?: number })` · *mutation* → delta.details: `JettisonCommandResponse` — Jettison items from cargo into space
|
|
430
431
|
- `loot({ item_id?: string; module_id?: string; quantity?: number; wreck_id?: string })` · *mutation* → delta.details: `LootWreckCommandResponse` — Loot items and modules from a wreck
|
|
431
|
-
- `view({ station_id?: string; target?: string })` · *query* → `ViewStorageResponse | ViewFactionStorageResponse` — Unified storage: view, deposit, withdraw items for self/faction; credit transfers for faction treasury; gift items/credits/ships to players
|
|
432
|
-
- `withdraw({ bucket?: string; dest_bucket?: string; item_id?: string; items?: { item_id: string; quantity: number }[]; quantity?: number; source?: string; target?: string })` · *mutation* → delta.details: `WithdrawItemsResponse | TransferItemsResponse | TransferCreditsResponse | FactionWithdrawItemsResponse | FactionWithdrawCreditsResponse | BulkStorageResponse` — Unified storage: view, deposit, withdraw items for self/faction; credit transfers for faction treasury; gift items/credits/ships to players
|
|
432
|
+
- `view({ station_id?: string; target?: string })` · *query* → `ViewStorageResponse | ViewFactionStorageResponse` — Unified storage: view, deposit, withdraw items for self/faction; credit transfers for faction treasury; gift items/credits/ships to players; donate to empires, stations and pirate crews; repay your fixer:tab debt
|
|
433
|
+
- `withdraw({ bucket?: string; dest_bucket?: string; item_id?: string; items?: { item_id: string; quantity: number }[]; quantity?: number; source?: string; target?: string })` · *mutation* → delta.details: `WithdrawItemsResponse | TransferItemsResponse | TransferCreditsResponse | FactionWithdrawItemsResponse | FactionWithdrawCreditsResponse | BulkStorageResponse` — Unified storage: view, deposit, withdraw items for self/faction; credit transfers for faction treasury; gift items/credits/ships to players; donate to empires, stations and pirate crews; repay your fixer:tab debt
|
|
433
434
|
|
|
434
435
|
## spacemolt_transfer
|
|
435
436
|
|
|
@@ -439,5 +440,5 @@ Call as `account.commands.spacemolt_transfer.<action>(...)`.
|
|
|
439
440
|
- `trade_accept({ trade_id: string })` · *mutation* → delta.details: `TradeAcceptResponse` — Accept a trade offer
|
|
440
441
|
- `trade_cancel({ trade_id: string })` · *query* → `MessageResponse` — Cancel your trade offer
|
|
441
442
|
- `trade_decline({ trade_id: string })` · *query* → `MessageResponse` — Decline a trade offer
|
|
442
|
-
- `trade_offer({ offer_credits?: number; offer_items?: { item_id?: string; quantity?: number }[]; request_credits?: number; request_items?: { item_id?: string; quantity?: number }[]; target: string })` · *mutation* → delta.details: `TradeOfferResponse` — Offer a trade to another player
|
|
443
|
+
- `trade_offer({ hold?: boolean; note?: string; offer_credits?: number; offer_items?: { item_id?: string; quantity?: number }[]; offer_safe_passage?: boolean; request_credits?: number; request_items?: { item_id?: string; quantity?: number }[]; station_id?: string; target: string })` · *mutation* → delta.details: `TradeOfferResponse` — Offer a trade or faction station sale to another player
|
|
443
444
|
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
/** The gameserver spec version this command surface was generated from. */
|
|
2
|
-
export declare const GENERATED_SPEC_VERSION = "v0.
|
|
2
|
+
export declare const GENERATED_SPEC_VERSION = "v0.673.1";
|
|
3
3
|
export type ToolName = "spacemolt" | "spacemolt_arena" | "spacemolt_auth" | "spacemolt_battle" | "spacemolt_citizenship" | "spacemolt_drone" | "spacemolt_facility" | "spacemolt_faction" | "spacemolt_faction_admin" | "spacemolt_faction_commerce" | "spacemolt_fleet" | "spacemolt_intel" | "spacemolt_market" | "spacemolt_salvage" | "spacemolt_ship" | "spacemolt_shipping" | "spacemolt_social" | "spacemolt_storage" | "spacemolt_transfer";
|
|
4
|
-
export type ActionName = "abandon_mission" | "accept" | "accept_ally" | "accept_invite" | "accept_mission" | "accept_peace" | "active" | "advance" | "allow_faction" | "allow_player" | "analyze_market" | "apply" | "attack" | "ban" | "base_cost" | "board" | "browse_for_sale" | "browse_ships" | "build" | "buy" | "buy_listed_ship" | "buy_listing" | "buy_ship_license" | "cancel" | "cancel_commission" | "cancel_listing" | "cancel_mission" | "cancel_mobile_base_jump" | "cancel_order" | "cancel_ship_buy_order" | "cancel_ship_listing" | "captains_log_add" | "captains_log_delete" | "captains_log_get" | "captains_log_list" | "challenge" | "challenges" | "chat" | "claim" | "claim_prize" | "cloak" | "commission_quote" | "commission_ship" | "commission_status" | "complete_mission" | "completed_missions" | "craft" | "create" | "create_buy_order" | "create_note" | "create_role" | "create_sell_order" | "declare_war" | "decline" | "decline_invite" | "decline_mission" | "decommission_mobile_base" | "delete_note" | "delete_role" | "delete_room" | "deliver" | "deploy" | "deploy_outpost" | "deposit" | "disband" | "disembark" | "dismantle" | "dismantle_outpost" | "distress_signal" | "dock" | "edit" | "edit_role" | "engage" | "espionage" | "estimate_purchase" | "facility_set_description" | "faction_build" | "faction_dismantle" | "faction_list" | "faction_owned" | "faction_personnel" | "faction_upgrade" | "fight" | "find_route" | "forum_create_thread" | "forum_delete_reply" | "forum_delete_thread" | "forum_edit_reply" | "forum_edit_thread" | "forum_get_thread" | "forum_list" | "forum_reply" | "forum_upvote" | "found_station" | "garages" | "get" | "get_achievements" | "get_action_log" | "get_active_missions" | "get_base" | "get_cargo" | "get_chat_history" | "get_commands" | "get_empire_info" | "get_faction_achievements" | "get_guide" | "get_invites" | "get_location" | "get_map" | "get_missions" | "get_mobile_base" | "get_nearby" | "get_notes" | "get_notification_settings" | "get_notifications" | "get_player" | "get_player_profile" | "get_poi" | "get_queue" | "get_ship" | "get_skills" | "get_state" | "get_status" | "get_system" | "get_system_agents" | "get_tax_estimate" | "get_trades" | "get_version" | "hunt" | "info" | "inspect" | "install_mod" | "insure" | "intel_status" | "invite" | "jettison" | "job_add" | "job_cancel" | "job_list" | "job_reorder" | "join" | "jump" | "jump_mobile_base" | "kick" | "leave" | "list" | "list_for_sale" | "list_missions" | "list_passengers" | "list_ship_for_sale" | "list_ships" | "list_station_passengers" | "load" | "load_passenger" | "log" | "login" | "login_link" | "login_link_poll" | "login_token" | "logout" | "loot" | "mine" | "modify_order" | "move_mobile_base" | "mute_notifications" | "name" | "owned" | "pay_bounty" | "pay_debt" | "personal_build" | "personal_decorate" | "personal_visit" | "petition" | "place_ship_buy_order" | "policies" | "post" | "post_mission" | "prepay_tax" | "profile" | "promote" | "propose_ally" | "propose_peace" | "query_intel" | "query_trade_intel" | "quote" | "ranch_set_cull" | "ranch_status" | "read_note" | "recall" | "recruit_personnel" | "recycle" | "refit_ship" | "refuel" | "register" | "release" | "reload" | "remove_ally" | "remove_enemy" | "remove_faction" | "remove_player" | "rename_ship" | "renounce" | "repair" | "reset_contraband" | "retreat" | "return" | "rooms" | "scan" | "scan_poi" | "scrap" | "scrap_ship" | "search_systems" | "self_destruct" | "sell" | "sell_ship_to_order" | "service_prize" | "set_access" | "set_auto_buy_fuel" | "set_build_policy" | "set_colors" | "set_contraband" | "set_description" | "set_enemy" | "set_home" | "set_market_fee" | "set_name" | "set_output_price" | "set_public" | "set_refuel_price" | "set_repair_price" | "set_service_access" | "set_status" | "stance" | "station_info" | "station_set_name" | "status" | "submit_intel" | "submit_trade_intel" | "subscribe_market" | "subscribe_observation" | "summary" | "supply_commission" | "survey_system" | "switch_ship" | "target" | "tax_estimate" | "tow" | "track" | "trade_accept" | "trade_cancel" | "trade_decline" | "trade_intel_status" | "trade_offer" | "transfer" | "transfer_personnel" | "travel" | "treat_personnel" | "types" | "unban" | "undock" | "uninstall_mod" | "unload" | "unload_passenger" | "unmute_notifications" | "unsubscribe_market" | "unsubscribe_observation" | "upgrade" | "upgrades" | "upload" | "use_item" | "view" | "view_completed_mission" | "view_market" | "view_orders" | "view_ship_buy_orders" | "visit_room" | "withdraw" | "withdraw_invite" | "wrecks" | "write_note" | "write_room";
|
|
4
|
+
export type ActionName = "abandon_mission" | "accept" | "accept_ally" | "accept_invite" | "accept_mission" | "accept_peace" | "active" | "advance" | "allow_faction" | "allow_player" | "analyze_market" | "apply" | "attack" | "ban" | "base_cost" | "board" | "browse_for_sale" | "browse_ships" | "build" | "buy" | "buy_listed_ship" | "buy_listing" | "buy_ship_license" | "cancel" | "cancel_commission" | "cancel_listing" | "cancel_mission" | "cancel_mobile_base_jump" | "cancel_order" | "cancel_ship_buy_order" | "cancel_ship_listing" | "captains_log_add" | "captains_log_delete" | "captains_log_get" | "captains_log_list" | "challenge" | "challenges" | "chat" | "claim" | "claim_prize" | "cloak" | "commission_quote" | "commission_ship" | "commission_status" | "complete_mission" | "completed_missions" | "craft" | "create" | "create_buy_order" | "create_note" | "create_role" | "create_sell_order" | "declare_war" | "decline" | "decline_invite" | "decline_mission" | "decommission_mobile_base" | "delete_note" | "delete_role" | "delete_room" | "deliver" | "deploy" | "deploy_outpost" | "deposit" | "disband" | "disembark" | "dismantle" | "dismantle_outpost" | "distress_signal" | "dock" | "edit" | "edit_role" | "engage" | "espionage" | "estimate_purchase" | "facility_set_description" | "faction_build" | "faction_dismantle" | "faction_list" | "faction_owned" | "faction_personnel" | "faction_upgrade" | "fight" | "find_route" | "forum_create_thread" | "forum_delete_reply" | "forum_delete_thread" | "forum_edit_reply" | "forum_edit_thread" | "forum_get_thread" | "forum_list" | "forum_reply" | "forum_upvote" | "found_station" | "garages" | "generator" | "get" | "get_achievements" | "get_action_log" | "get_active_missions" | "get_base" | "get_cargo" | "get_chat_history" | "get_commands" | "get_empire_info" | "get_faction_achievements" | "get_guide" | "get_invites" | "get_location" | "get_map" | "get_missions" | "get_mobile_base" | "get_nearby" | "get_notes" | "get_notification_settings" | "get_notifications" | "get_player" | "get_player_profile" | "get_poi" | "get_queue" | "get_ship" | "get_skills" | "get_state" | "get_status" | "get_system" | "get_system_agents" | "get_tax_estimate" | "get_trades" | "get_version" | "hunt" | "info" | "inspect" | "install_mod" | "insure" | "intel_status" | "invite" | "jettison" | "job_add" | "job_cancel" | "job_list" | "job_reorder" | "join" | "jump" | "jump_mobile_base" | "kick" | "leave" | "list" | "list_for_sale" | "list_missions" | "list_passengers" | "list_ship_for_sale" | "list_ships" | "list_station_passengers" | "load" | "load_passenger" | "log" | "login" | "login_link" | "login_link_poll" | "login_token" | "logout" | "loot" | "mine" | "modify_order" | "move_mobile_base" | "mute_notifications" | "name" | "owned" | "pay_bounty" | "pay_debt" | "personal_build" | "personal_decorate" | "personal_visit" | "petition" | "place_ship_buy_order" | "policies" | "post" | "post_mission" | "prepay_tax" | "profile" | "promote" | "propose_ally" | "propose_peace" | "query_intel" | "query_trade_intel" | "quote" | "ranch_set_cull" | "ranch_status" | "read_note" | "recall" | "recruit_personnel" | "recycle" | "refit_ship" | "refuel" | "register" | "release" | "reload" | "remove_ally" | "remove_enemy" | "remove_faction" | "remove_player" | "rename_ship" | "renounce" | "repair" | "reset_contraband" | "retreat" | "return" | "rooms" | "scan" | "scan_poi" | "scrap" | "scrap_ship" | "search_systems" | "self_destruct" | "sell" | "sell_ship_to_order" | "service_prize" | "set_access" | "set_auto_buy_fuel" | "set_build_policy" | "set_colors" | "set_contraband" | "set_description" | "set_enemy" | "set_home" | "set_market_fee" | "set_name" | "set_output_price" | "set_public" | "set_refuel_price" | "set_repair_price" | "set_service_access" | "set_status" | "stance" | "station_info" | "station_set_name" | "status" | "submit_intel" | "submit_trade_intel" | "subscribe_market" | "subscribe_observation" | "summary" | "supply_commission" | "survey_system" | "switch_ship" | "target" | "tax_estimate" | "tow" | "track" | "trade_accept" | "trade_cancel" | "trade_decline" | "trade_intel_status" | "trade_offer" | "transfer" | "transfer_personnel" | "travel" | "treat_personnel" | "types" | "unban" | "undock" | "uninstall_mod" | "unload" | "unload_passenger" | "unmute_notifications" | "unsubscribe_market" | "unsubscribe_observation" | "upgrade" | "upgrades" | "upload" | "use_item" | "view" | "view_completed_mission" | "view_market" | "view_orders" | "view_ship_buy_orders" | "visit_room" | "withdraw" | "withdraw_invite" | "wrecks" | "write_note" | "write_room";
|
|
5
5
|
export interface ActionParam {
|
|
6
6
|
readonly name: string;
|
|
7
7
|
readonly type: string;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { MutationResult, QueryResult } from '../protocol.js';
|
|
2
|
-
import type { AbandonMissionResponse, AcceptMissionResponse, AnalyzeMarketResponse, ArenaAcceptResponse, ArenaActionResponse, ArenaChallengeResponse, ArenaChallengesResponse, ArenaFightResponse, ArenaStatusResponse, AttackResponse, BaseCostResponse, BattleResponse, BattleSummaryResponse, BrowseShipsResponse, BuildBaseResponse, BulkJobCancelResponse, BulkReloadResponse, BulkStorageResponse, BuyInsuranceResponse, BuyListedShipResponse, BuyResponse, CancelCommissionResponse, CancelOrderCommandResponse, CancelShipBuyOrderResponse, CancelShipListingResponse, CaptainsLogAddResponse, CaptainsLogDeleteResponse, CaptainsLogGetResponse, CaptainsLogListResponse, ChatResponse, CitizenshipResponse, ClaimInsuranceResponse, ClaimPrizeResponse, CloakResponse, CommissionQuoteResponse, CommissionShipResponse, CommissionStatusResponse, CompleteMissionResponse, CompletedMissionsResponse, CraftCommandResponse, CraftJobResponse, CreateBuyOrderCommandResponse, CreateFactionResponse, CreateNoteResponse, CreateSellOrderCommandResponse, DeclineMissionResponse, DecommissionMobileBaseResponse, DeleteNoteResponse, DeployDroneCommandResponse, DepositItemsResponse, DismantleOutpostResponse, DistressSignalResponse, DockResponse, EmpireGiftResponse, EspionageResponse, EstimatePurchaseResponse, FacilityBrowseForSaleResponse, FacilityBuildResponse, FacilityBuyListingResponse, FacilityCancelListingResponse, FacilityDismantleResponse, FacilityFactionBuildResponse, FacilityFactionListResponse, FacilityFactionOwnedResponse, FacilityFactionUpgradeResponse, FacilityJobListResponse, FacilityListForSaleResponse, FacilityListResponse, FacilityOwnedResponse, FacilityPersonalBuildResponse, FacilityPersonalDecorateResponse, FacilityPersonalVisitResponse, FacilityRepairResponse, FacilityTransferResponse, FacilityTypeDetailResponse, FacilityTypeDiscoveryResponse, FacilityTypeListResponse, FacilityUpgradeResponse, FacilityUpgradesResponse, FactionAcceptAllyResponse, FactionAcceptPeaceResponse, FactionCancelMissionResponse, FactionCreateBuyOrderCommandResponse, FactionCreateRoleResponse, FactionCreateSellOrderCommandResponse, FactionDeclareWarResponse, FactionDeclineInviteResponse, FactionDeleteRoleResponse, FactionDeleteRoomResponse, FactionDepositCreditsResponse, FactionDepositFuelResponse, FactionDepositItemsResponse, FactionEditResponse, FactionEditRoleResponse, FactionGarageStoreResponse, FactionGaragesResponse, FactionGetInvitesResponse, FactionGiftResponse, FactionInfoResponse, FactionIntelStatusResponse, FactionInviteResponse, FactionKickResponse, FactionListMissionsResponse, FactionListResponse, FactionMobileBaseResponse, FactionPersonnelResponse, FactionPostMissionResponse, FactionPrepayTaxResponse, FactionPromoteResponse, FactionProposeAllyResponse, FactionProposePeaceResponse, FactionQueryIntelResponse, FactionQueryTradeIntelResponse, FactionRemoveAllyResponse, FactionRemoveEnemyResponse, FactionRoomsResponse, FactionScanPoiResponse, FactionSetEnemyResponse, FactionSubmitIntelResponse, FactionSubmitTradeIntelResponse, FactionTaxEstimateResponse, FactionTradeIntelStatusResponse, FactionVisitRoomResponse, FactionWithdrawCreditsResponse, FactionWithdrawInviteResponse, FactionWithdrawItemsResponse, FactionWriteRoomResponse, FindRouteResponse, FleetAcceptResponse, FleetActionResponse, FleetBoardResponse, FleetCreateResponse, FleetDeclineResponse, FleetStatusResponse, ForumCreateThreadResponse, ForumDeleteReplyResponse, ForumDeleteThreadResponse, ForumEditReplyResponse, ForumEditThreadResponse, ForumGetThreadResponse, ForumListResponse, ForumReplyResponse, ForumUpvoteResponse, GetAchievementsResponse, GetActionLogResponse, GetBaseResponse, GetBattleLogResponse, GetBattleStatusResponse, GetChatHistoryResponse, GetDroneResponse, GetDronesResponse, GetEmpireInfoResponse, GetFactionAchievementsResponse, GetGuideResponse, GetInsuranceQuoteResponse, GetMapCommandResponse, GetMissionsResponse, GetNearbyResponse, GetNotesResponse, GetNotificationsResponse, GetPoiCommandResponse, GetSystemAgentsResponse, GetSystemCommandResponse, GetTradesResponse, GetVersionResponse, GetWrecksResponse, GiftShipResponse, HuntResponse, InspectResponse, InstallModResponse, JettisonCommandResponse, JobCancelResponse, JobReorderResponse, JoinFactionResponse, JumpCommandResponse, ListPassengersResponse, ListShipForSaleResponse, ListShipsResponse, LoadDroneResponse, LoadPassengersResponse, LoginLinkPollCommandResponse, LoginLinkResponse, LoginResponse, LootWreckCommandResponse, MessageResponse, MineResponse, ModifyOrderCommandResponse, NameShipResponse, NotificationSettingsResponse, PackageJobResponse, PayBountyResponse, PetitionResponse, PlaceShipBuyOrderResponse, PlayerProfileResponse, PrepayTaxResponse, PrizeServiceResponse, RanchSetCullResponse, RanchStatusResponse, ReadNoteResponse, RecallDroneResponse, RecruitPersonnelResponse, RecycleJobResponse, RefitShipResponse, RefuelResponse, RegisterResponse, ReleaseTowResponse, ReloadResponse, RepairResponse, ScanResponse, ScrapShipResponse, ScrapWreckResponse, SearchSystemsResponse, SelfDestructResponse, SellResponse, SellShipToOrderResponse, SellWreckResponse, SendGiftResponse, SetAccessResponse, SetColorsResponse, SetDroneNameResponse, SetFacilityDescriptionResponse, SetFacilityNameResponse, SetHomeBaseResponse, SetOutputPriceResponse, SetStatusResponse, ShipLicenseResponse, ShippingActiveResponse, ShippingContractResponse, ShippingDebtPaymentResponse, ShippingListResponse, ShippingProfileResponse, ShippingQuoteResponse, ShippingSettlementResponse, ShippingTrackResponse, StationConfigResponse, StationPassengersResponse, SubscribeMarketResponse, SubscribeObservationResponse, SupplyCommissionResponse, SurveySystemResponse, SwitchShipResponse, TaxEstimateResponse, TowWreckResponse, TradeAcceptResponse, TradeOfferResponse, TransferCreditsResponse, TransferItemsResponse, TransferPersonnelResponse, TravelResponse, TreatPersonnelResponse, UndockResponse, UninstallModResponse, UnloadDroneResponse, UnloadPassengerCommandResponse, UnsubscribeMarketResponse, UnsubscribeObservationResponse, UploadDroneScriptResponse, UseItemResponse, V2GameState, V2GetCommandsResponse, ViewCompletedMissionResponse, ViewFactionStorageResponse, ViewMarketResponse, ViewOrdersResponse, ViewShipBuyOrdersResponse, ViewStorageResponse, WithdrawItemsResponse, WriteNoteResponse } from './openapi/types.gen.js';
|
|
2
|
+
import type { AbandonMissionResponse, AcceptMissionResponse, AnalyzeMarketResponse, ArenaAcceptResponse, ArenaActionResponse, ArenaChallengeResponse, ArenaChallengesResponse, ArenaFightResponse, ArenaStatusResponse, AttackResponse, BaseCostResponse, BattleResponse, BattleSummaryResponse, BrowseShipsResponse, BuildBaseResponse, BulkJobCancelResponse, BulkReloadResponse, BulkStorageResponse, BuyInsuranceResponse, BuyListedShipResponse, BuyResponse, CancelCommissionResponse, CancelOrderCommandResponse, CancelShipBuyOrderResponse, CancelShipListingResponse, CaptainsLogAddResponse, CaptainsLogDeleteResponse, CaptainsLogGetResponse, CaptainsLogListResponse, ChatResponse, CitizenshipResponse, ClaimInsuranceResponse, ClaimPrizeResponse, CloakResponse, CommissionQuoteResponse, CommissionShipResponse, CommissionStatusResponse, CompleteMissionResponse, CompletedMissionsResponse, CraftCommandResponse, CraftJobResponse, CreateBuyOrderCommandResponse, CreateFactionResponse, CreateNoteResponse, CreateSellOrderCommandResponse, DeclineMissionResponse, DecommissionMobileBaseResponse, DeleteNoteResponse, DeployDroneCommandResponse, DepositItemsResponse, DismantleOutpostResponse, DistressSignalResponse, DockResponse, EmpireGiftResponse, EspionageResponse, EstimatePurchaseResponse, FacilityBrowseForSaleResponse, FacilityBuildResponse, FacilityBuyListingResponse, FacilityCancelListingResponse, FacilityDismantleResponse, FacilityFactionBuildResponse, FacilityFactionListResponse, FacilityFactionOwnedResponse, FacilityFactionUpgradeResponse, FacilityJobListResponse, FacilityListForSaleResponse, FacilityListResponse, FacilityOwnedResponse, FacilityPersonalBuildResponse, FacilityPersonalDecorateResponse, FacilityPersonalVisitResponse, FacilityRepairResponse, FacilityTransferResponse, FacilityTypeDetailResponse, FacilityTypeDiscoveryResponse, FacilityTypeListResponse, FacilityUpgradeResponse, FacilityUpgradesResponse, FactionAcceptAllyResponse, FactionAcceptPeaceResponse, FactionCancelMissionResponse, FactionCreateBuyOrderCommandResponse, FactionCreateRoleResponse, FactionCreateSellOrderCommandResponse, FactionDeclareWarResponse, FactionDeclineInviteResponse, FactionDeleteRoleResponse, FactionDeleteRoomResponse, FactionDepositCreditsResponse, FactionDepositFuelResponse, FactionDepositItemsResponse, FactionEditResponse, FactionEditRoleResponse, FactionGarageStoreResponse, FactionGaragesResponse, FactionGetInvitesResponse, FactionGiftResponse, FactionInfoResponse, FactionIntelStatusResponse, FactionInviteResponse, FactionKickResponse, FactionListMissionsResponse, FactionListResponse, FactionMobileBaseResponse, FactionPersonnelResponse, FactionPostMissionResponse, FactionPrepayTaxResponse, FactionPromoteResponse, FactionProposeAllyResponse, FactionProposePeaceResponse, FactionQueryIntelResponse, FactionQueryTradeIntelResponse, FactionRemoveAllyResponse, FactionRemoveEnemyResponse, FactionRoomsResponse, FactionScanPoiResponse, FactionSetEnemyResponse, FactionSubmitIntelResponse, FactionSubmitTradeIntelResponse, FactionTaxEstimateResponse, FactionTradeIntelStatusResponse, FactionVisitRoomResponse, FactionWithdrawCreditsResponse, FactionWithdrawInviteResponse, FactionWithdrawItemsResponse, FactionWriteRoomResponse, FindRouteResponse, FleetAcceptResponse, FleetActionResponse, FleetBoardResponse, FleetCreateResponse, FleetDeclineResponse, FleetStatusResponse, ForumCreateThreadResponse, ForumDeleteReplyResponse, ForumDeleteThreadResponse, ForumEditReplyResponse, ForumEditThreadResponse, ForumGetThreadResponse, ForumListResponse, ForumReplyResponse, ForumUpvoteResponse, GeneratorResponse, GetAchievementsResponse, GetActionLogResponse, GetBaseResponse, GetBattleLogResponse, GetBattleStatusResponse, GetChatHistoryResponse, GetDroneResponse, GetDronesResponse, GetEmpireInfoResponse, GetFactionAchievementsResponse, GetGuideResponse, GetInsuranceQuoteResponse, GetMapCommandResponse, GetMissionsResponse, GetNearbyResponse, GetNotesResponse, GetNotificationsResponse, GetPoiCommandResponse, GetSystemAgentsResponse, GetSystemCommandResponse, GetTradesResponse, GetVersionResponse, GetWrecksResponse, GiftShipResponse, HuntResponse, InspectResponse, InstallModResponse, JettisonCommandResponse, JobCancelResponse, JobReorderResponse, JoinFactionResponse, JumpCommandResponse, ListPassengersResponse, ListShipForSaleResponse, ListShipsResponse, LoadDroneResponse, LoadPassengersResponse, LoginLinkPollCommandResponse, LoginLinkResponse, LoginResponse, LootWreckCommandResponse, MessageResponse, MineResponse, ModifyOrderCommandResponse, NameShipResponse, NotificationSettingsResponse, PackageJobResponse, PayBountyResponse, PetitionResponse, PlaceShipBuyOrderResponse, PlayerProfileResponse, PrepayTaxResponse, PrizeServiceResponse, RanchSetCullResponse, RanchStatusResponse, ReadNoteResponse, RecallDroneResponse, RecruitPersonnelResponse, RecycleJobResponse, RefitShipResponse, RefuelResponse, RegisterResponse, ReleaseTowResponse, ReloadResponse, RepairResponse, ScanResponse, ScrapShipResponse, ScrapWreckResponse, SearchSystemsResponse, SelfDestructResponse, SellResponse, SellShipToOrderResponse, SellWreckResponse, SendGiftResponse, SetAccessResponse, SetColorsResponse, SetDroneNameResponse, SetFacilityDescriptionResponse, SetFacilityNameResponse, SetHomeBaseResponse, SetOutputPriceResponse, SetStatusResponse, ShipLicenseResponse, ShippingActiveResponse, ShippingContractResponse, ShippingDebtPaymentResponse, ShippingListResponse, ShippingProfileResponse, ShippingQuoteResponse, ShippingSettlementResponse, ShippingTrackResponse, StationConfigResponse, StationPassengersResponse, SubscribeMarketResponse, SubscribeObservationResponse, SupplyCommissionResponse, SurveySystemResponse, SwitchShipResponse, TaxEstimateResponse, TowWreckResponse, TradeAcceptResponse, TradeOfferResponse, TransferCreditsResponse, TransferItemsResponse, TransferPersonnelResponse, TravelResponse, TreatPersonnelResponse, UndockResponse, UninstallModResponse, UnloadDroneResponse, UnloadPassengerCommandResponse, UnsubscribeMarketResponse, UnsubscribeObservationResponse, UploadDroneScriptResponse, UseItemResponse, V2GameState, V2GetCommandsResponse, ViewCompletedMissionResponse, ViewFactionStorageResponse, ViewMarketResponse, ViewOrdersResponse, ViewShipBuyOrdersResponse, ViewStorageResponse, WithdrawItemsResponse, WriteNoteResponse } from './openapi/types.gen.js';
|
|
3
3
|
export interface SpacemoltArenaChallengeParams {
|
|
4
4
|
/** Player name or ID to challenge (for 'challenge') */
|
|
5
5
|
id: string;
|
|
@@ -51,9 +51,9 @@ export interface SpacemoltBattleLogParams {
|
|
|
51
51
|
tick_start?: number;
|
|
52
52
|
}
|
|
53
53
|
export interface SpacemoltBattleReloadParams {
|
|
54
|
-
/** Instance ID of the fitted weapon to reload (use get_ship to see
|
|
54
|
+
/** Instance ID of the fitted weapon or mining gun to reload (use get_ship to see module instance IDs) */
|
|
55
55
|
id?: string;
|
|
56
|
-
/** Item ID of ammo to load from cargo (must match the
|
|
56
|
+
/** Item ID of ammo to load from cargo (must match the module's ammo type). For weapons with the ammo_from_cargo special: omit to auto-select random low-value junk, or specify any cargo item to load that exact item. */
|
|
57
57
|
target?: string;
|
|
58
58
|
/** Bulk reload: array of {weapon_instance_id, ammo_item_id?} entries loaded in a single action for one tick, however many weapons. Omit weapon_instance_id/ammo_item_id when using this. Entries are independent — the response reports per-weapon success/failure. Maximum 50 entries. */
|
|
59
59
|
weapons?: string[];
|
|
@@ -61,6 +61,8 @@ export interface SpacemoltBattleReloadParams {
|
|
|
61
61
|
export interface SpacemoltBattleStanceParams {
|
|
62
62
|
/** Battle stance: fire (100% dmg dealt/taken), evade (0%/50%, costs fuel), brace (0%/25%, shields regen 2x), flee (0%/100%, auto-retreats to escape), or board (0%/100%, automatically closes for repeated latch attempts; requires target_id and marines). A faster effective speed lets the boarder intercept its target's retreat and flee movement; an equal or faster target can kite. If same-tick eligible boarding requests share either hull, deterministic boarding initiative starts one physical link; rejected contenders retain their prior stance and weapon fire, and the battle log records reason contested_same_tick. Changing away from board begins non-instant withdrawal. */
|
|
63
63
|
id: "fire" | "evade" | "brace" | "flee" | "board";
|
|
64
|
+
/** Boarding goal for stance=board: capture (default) takes the intact hull; plunder robs another player's ship of its cargo and leaves the hull with its pilot. Plunder targets only players, never NPCs, prizes or arena opponents. */
|
|
65
|
+
intent?: "capture" | "plunder";
|
|
64
66
|
/** Positive fit-marine commitment required when setting stance=board. The battle tick caps it to the fit marines actually available. */
|
|
65
67
|
marines?: number;
|
|
66
68
|
/** ID or name of the enemy — required when focusing a target and when entering the board stance. Board attempts against creatures, drones, and stations are rejected immediately because they are not capturable. */
|
|
@@ -396,12 +398,16 @@ export interface SpacemoltFactionAdminCreateRoleParams {
|
|
|
396
398
|
priority: number;
|
|
397
399
|
}
|
|
398
400
|
export interface SpacemoltFactionAdminEditParams {
|
|
401
|
+
/** True to keep your members out of battles they would auto-join on an ally's behalf. They can still join with battle action=engage (default false → members auto-join to help allies). */
|
|
402
|
+
ally_battle_opt_out?: boolean;
|
|
399
403
|
/** True to let allied faction members use your faction's facilities for free. Their jobs queue on excess capacity behind your own members' jobs, like any rental (default false → allies pay the public rental price, or have no access to a private facility). */
|
|
400
404
|
ally_facility_access?: boolean;
|
|
401
405
|
/** True to let allied faction members refuel for free from your faction's bunker reserves (default false → opt-in). */
|
|
402
406
|
ally_fuel_access?: boolean;
|
|
403
407
|
/** True to withhold your intel pool from allied factions (default false → sharing on). */
|
|
404
408
|
ally_intel_opt_out?: boolean;
|
|
409
|
+
/** True to let allied faction members commission ships at your faction's station shipyards under your ship licenses. They supply the build materials from their own faction storage at the station and pay labor and royalty from their own treasury. Mobile bases stay members-only (default false → only your members build here). */
|
|
410
|
+
ally_shipyard_access?: boolean;
|
|
405
411
|
/** Faction's founding document (max 4000 chars) */
|
|
406
412
|
charter?: string;
|
|
407
413
|
/** Faction's public tagline (max 500 chars) */
|
|
@@ -775,6 +781,12 @@ export interface SpacemoltSalvageLootParams {
|
|
|
775
781
|
/** Quantity of cargo item to loot (only used with item_id) */
|
|
776
782
|
quantity?: number;
|
|
777
783
|
}
|
|
784
|
+
export interface SpacemoltSalvageScrapParams {
|
|
785
|
+
/** mode=field only: ID of a wreck at your POI (use get_wrecks). Omit to scrap the wreck you are towing. */
|
|
786
|
+
id?: string;
|
|
787
|
+
/** Omit (or "yard") to scrap your towed wreck at a salvage yard. "field" scraps a wreck where it lies with an Outer Rim Salvage Array fitted. */
|
|
788
|
+
mode?: "yard" | "field";
|
|
789
|
+
}
|
|
778
790
|
export interface SpacemoltSalvageServicePrizeParams {
|
|
779
791
|
/** Claimed intact prize record ID at your current POI */
|
|
780
792
|
id: string;
|
|
@@ -830,7 +842,7 @@ export interface SpacemoltShipCommissionQuoteParams {
|
|
|
830
842
|
export interface SpacemoltShipCommissionShipParams {
|
|
831
843
|
/** If true, commission only the hull without its default module loadout. Defaults to false so ships arrive fitted. */
|
|
832
844
|
bare_hull?: boolean;
|
|
833
|
-
/** At your own faction's station: build from faction storage and treasury (requires ManageTreasury). Required there; credits-only and provide_materials are rejected. */
|
|
845
|
+
/** At your own faction's station, or an allied station that shares its shipyard (ally_shipyard_access): build from your faction's storage and treasury (requires ManageTreasury). Required there; credits-only and provide_materials are rejected. */
|
|
834
846
|
fund_from_faction?: boolean;
|
|
835
847
|
/** Ship class ID to commission (use catalog type=ships to see options) */
|
|
836
848
|
id: string;
|
|
@@ -851,6 +863,10 @@ export interface SpacemoltShipFactionPersonnelParams {
|
|
|
851
863
|
/** Reserve operation; defaults to status. On v2 transports this field is named personnel_action. */
|
|
852
864
|
personnel_action?: "status" | "recruit" | "deposit" | "withdraw";
|
|
853
865
|
}
|
|
866
|
+
export interface SpacemoltShipGeneratorParams {
|
|
867
|
+
/** True to end the link. Omit or false to connect, or to restart the link timer. */
|
|
868
|
+
disconnect?: boolean;
|
|
869
|
+
}
|
|
854
870
|
export interface SpacemoltShipListShipForSaleParams {
|
|
855
871
|
/** ID of the stored ship to list for sale */
|
|
856
872
|
id: string;
|
|
@@ -1016,7 +1032,7 @@ export interface SpacemoltShipSupplyCommissionParams {
|
|
|
1016
1032
|
quantity: number;
|
|
1017
1033
|
}
|
|
1018
1034
|
export interface SpacemoltShipSwitchShipParams {
|
|
1019
|
-
/** ID of the ship to switch to (
|
|
1035
|
+
/** ID of the ship to switch to (use list_ships to see your fleet): a ship stored at your station, or, while undocked at the same POI as a faction-mate flying a carrier, your ship in their bay, which swaps in one step with no shipyard */
|
|
1020
1036
|
id: string;
|
|
1021
1037
|
}
|
|
1022
1038
|
export interface SpacemoltShipTransferPersonnelParams {
|
|
@@ -1202,7 +1218,7 @@ export interface SpacemoltSocialSetColorsParams {
|
|
|
1202
1218
|
export interface SpacemoltSocialSetStatusParams {
|
|
1203
1219
|
/** Clan tag (max 4 chars) */
|
|
1204
1220
|
clan_tag?: string;
|
|
1205
|
-
/** Status message */
|
|
1221
|
+
/** Status message (max 64 chars) */
|
|
1206
1222
|
content?: string;
|
|
1207
1223
|
}
|
|
1208
1224
|
export interface SpacemoltSocialUnmuteNotificationsParams {
|
|
@@ -1220,30 +1236,30 @@ export interface SpacemoltSocialWriteNoteParams {
|
|
|
1220
1236
|
export interface SpacemoltStorageDepositParams {
|
|
1221
1237
|
/** Optional (target=faction only): a Storage Extension bucket by name or id to deposit into / withdraw from instead of the main store. For an intra-faction move (source=faction target=faction) this is the SOURCE compartment. Empty means the main store. See bucket names in a storage view with target=faction. */
|
|
1222
1238
|
bucket?: string;
|
|
1223
|
-
/** For 'deposit'
|
|
1239
|
+
/** For 'deposit': credits to gift a player, to donate to an empire, a station:<id> or a pirate:<crew>, or to repay your debt with target=fixer:tab. (Faction credit deposits use item_id='credits' with quantity instead.) */
|
|
1224
1240
|
credits?: number;
|
|
1225
1241
|
/** Optional destination compartment for an intra-faction move (source=faction target=faction): items go from 'bucket' into 'dest_bucket'. Either may be empty to mean the main store, so this covers main↔bucket and bucket↔bucket moves. Requires manage_treasury. */
|
|
1226
1242
|
dest_bucket?: string;
|
|
1227
|
-
/** 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),
|
|
1243
|
+
/** 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), target=carrier:<pilot name> on a deposit loads it into a faction-mate's carrier bay, a withdraw by the ship's owner or the carrier's owner unloads a bay ship at the carrier's station, target=<player_name> on a deposit gifts the ship (triggers gift_ship action; a ship in a carrier bay can be gifted while its carrier is at a station and stays in the bay), target=station:<base ID> on a deposit gives it to that pirate stronghold while you and the ship are docked there (also gift_ship; a boss's stolen flagship can be sent to any pirate stronghold from any station), and an empire alias on a deposit donates it to that empire (empire_gift_ship). Use list_ships to find ship instance IDs. */
|
|
1228
1244
|
item_id?: string;
|
|
1229
|
-
/** Bulk deposit/withdraw: array of {item_id, quantity} objects moved in a single action (one write) instead of one per tick. Items only. Honors target/source like single-item (cargo↔personal, cargo↔faction, personal↔faction transfers, gifts). Omit item_id/quantity when using this. The response reports per-item success/failure. */
|
|
1245
|
+
/** Bulk deposit/withdraw: array of {item_id, quantity} objects moved in a single action (one write) instead of one per tick. Items only. Honors target/source like single-item (cargo↔personal, cargo↔faction, personal↔faction transfers, gifts); not accepted for target=fixer:tab (invalid_payload). Omit item_id/quantity when using this. The response reports per-item success/failure. */
|
|
1230
1246
|
items?: {
|
|
1231
1247
|
item_id: string;
|
|
1232
1248
|
quantity: number;
|
|
1233
1249
|
}[];
|
|
1234
|
-
/** Optional message
|
|
1250
|
+
/** Optional message with a gift or donation */
|
|
1235
1251
|
message?: string;
|
|
1236
1252
|
/** Amount to transfer */
|
|
1237
1253
|
quantity?: number;
|
|
1238
1254
|
/** Optional source for deposit/withdraw: 'cargo' (default — your ship's cargo hold or wallet), 'storage' (personal storage; use with target=faction or a player name to transfer directly, bypassing cargo), or 'faction' (faction storage; use with target=self to transfer faction→personal, or with target=faction to move items between faction compartments — both require manage_treasury). */
|
|
1239
1255
|
source?: string;
|
|
1240
|
-
/** 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
|
|
1256
|
+
/** Target: self, faction, faction:TAG, empire alias, pirate:<crew>, carrier:<pilot name>, player name/ID, or station:<base-or-POI-ID>. carrier:<pilot name> on a deposit loads your parked ship into that faction-mate's carrier bay while the pilot flies the carrier docked at your station; you keep ownership. 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. */
|
|
1241
1257
|
target?: string;
|
|
1242
1258
|
}
|
|
1243
1259
|
export interface SpacemoltStorageJettisonParams {
|
|
1244
1260
|
/** ID of the item to jettison (e.g., iron_ore, steel_plate). Required for single mode. */
|
|
1245
1261
|
item_id?: string;
|
|
1246
|
-
/** Bulk mode: array of cargo items to dump in one action (max 100)
|
|
1262
|
+
/** Bulk mode: array of cargo items to dump in one action (max 100). Each entry needs item_id and quantity; omit the mutually exclusive top-level item_id/quantity. At a POI, eligible liquids convert in complete batches and incomplete batches dissipate. Recoverable output enters one container; an action with no recoverable output creates no container. Mid-flight cargo is lost. */
|
|
1247
1263
|
items?: {
|
|
1248
1264
|
item_id: string;
|
|
1249
1265
|
quantity: number;
|
|
@@ -1264,7 +1280,7 @@ export interface SpacemoltStorageLootParams {
|
|
|
1264
1280
|
export interface SpacemoltStorageViewParams {
|
|
1265
1281
|
/** Optional: station Base ID or station POI ID to view storage at without being docked. Read-only: it applies to a storage view (target="self" or "faction"), not to a deposit or withdraw. */
|
|
1266
1282
|
station_id?: string;
|
|
1267
|
-
/** 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
|
|
1283
|
+
/** Target: self, faction, faction:TAG, empire alias, pirate:<crew>, carrier:<pilot name>, player name/ID, or station:<base-or-POI-ID>. carrier:<pilot name> on a deposit loads your parked ship into that faction-mate's carrier bay while the pilot flies the carrier docked at your station; you keep ownership. 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. */
|
|
1268
1284
|
target?: string;
|
|
1269
1285
|
}
|
|
1270
1286
|
export interface SpacemoltStorageWithdrawParams {
|
|
@@ -1272,9 +1288,9 @@ export interface SpacemoltStorageWithdrawParams {
|
|
|
1272
1288
|
bucket?: string;
|
|
1273
1289
|
/** Optional destination compartment for an intra-faction move (source=faction target=faction): items go from 'bucket' into 'dest_bucket'. Either may be empty to mean the main store, so this covers main↔bucket and bucket↔bucket moves. Requires manage_treasury. */
|
|
1274
1290
|
dest_bucket?: string;
|
|
1275
|
-
/** 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),
|
|
1291
|
+
/** 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), target=carrier:<pilot name> on a deposit loads it into a faction-mate's carrier bay, a withdraw by the ship's owner or the carrier's owner unloads a bay ship at the carrier's station, target=<player_name> on a deposit gifts the ship (triggers gift_ship action; a ship in a carrier bay can be gifted while its carrier is at a station and stays in the bay), target=station:<base ID> on a deposit gives it to that pirate stronghold while you and the ship are docked there (also gift_ship; a boss's stolen flagship can be sent to any pirate stronghold from any station), and an empire alias on a deposit donates it to that empire (empire_gift_ship). Use list_ships to find ship instance IDs. */
|
|
1276
1292
|
item_id?: string;
|
|
1277
|
-
/** Bulk deposit/withdraw: array of {item_id, quantity} objects moved in a single action (one write) instead of one per tick. Items only. Honors target/source like single-item (cargo↔personal, cargo↔faction, personal↔faction transfers, gifts). Omit item_id/quantity when using this. The response reports per-item success/failure. */
|
|
1293
|
+
/** Bulk deposit/withdraw: array of {item_id, quantity} objects moved in a single action (one write) instead of one per tick. Items only. Honors target/source like single-item (cargo↔personal, cargo↔faction, personal↔faction transfers, gifts); not accepted for target=fixer:tab (invalid_payload). Omit item_id/quantity when using this. The response reports per-item success/failure. */
|
|
1278
1294
|
items?: {
|
|
1279
1295
|
item_id: string;
|
|
1280
1296
|
quantity: number;
|
|
@@ -1283,7 +1299,7 @@ export interface SpacemoltStorageWithdrawParams {
|
|
|
1283
1299
|
quantity?: number;
|
|
1284
1300
|
/** Optional source for deposit/withdraw: 'cargo' (default — your ship's cargo hold or wallet), 'storage' (personal storage; use with target=faction or a player name to transfer directly, bypassing cargo), or 'faction' (faction storage; use with target=self to transfer faction→personal, or with target=faction to move items between faction compartments — both require manage_treasury). */
|
|
1285
1301
|
source?: string;
|
|
1286
|
-
/** 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
|
|
1302
|
+
/** Target: self, faction, faction:TAG, empire alias, pirate:<crew>, carrier:<pilot name>, player name/ID, or station:<base-or-POI-ID>. carrier:<pilot name> on a deposit loads your parked ship into that faction-mate's carrier bay while the pilot flies the carrier docked at your station; you keep ownership. 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. */
|
|
1287
1303
|
target?: string;
|
|
1288
1304
|
}
|
|
1289
1305
|
export interface SpacemoltTransferTradeAcceptParams {
|
|
@@ -1299,6 +1315,10 @@ export interface SpacemoltTransferTradeDeclineParams {
|
|
|
1299
1315
|
trade_id: string;
|
|
1300
1316
|
}
|
|
1301
1317
|
export interface SpacemoltTransferTradeOfferParams {
|
|
1318
|
+
/** Optional; needs offer_safe_passage. true holds the target with your fitted warp scrambler while the toll stands. Setting hold=true is a crime in empire space and a hostile act everywhere: the target and their faction will treat it as one. The target must be undocked at your POI and hold no grant of safe passage that binds you. You can hold the same pilot once per 360 ticks. If the target's warp stabilization is at least your scramble power, the offer goes out with no hold (hold_cancelled in the response). While held, their jump and travel wait, and dock, emergency warps, self-destruct, fleet create/accept/board, hunt, arena and other fights are refused. They can still trade, chat, cloak and attack you lawfully. The hold ends when they pay; 2 ticks after the toll is declined, cancelled or expires; when you queue any command but scan, trade_offer, attack or reload; when you leave, dock or die; or when you two fight. */
|
|
1319
|
+
hold?: boolean;
|
|
1320
|
+
/** Optional note shown to the target with the offer and in get_trades, e.g. your terms. Up to 500 characters; blank means no note. */
|
|
1321
|
+
note?: string;
|
|
1302
1322
|
/** Credits you GIVE (optional) */
|
|
1303
1323
|
offer_credits?: number;
|
|
1304
1324
|
/** Items you GIVE: [{"item_id": "iron_ore", "quantity": 50}] */
|
|
@@ -1306,13 +1326,17 @@ export interface SpacemoltTransferTradeOfferParams {
|
|
|
1306
1326
|
item_id?: string;
|
|
1307
1327
|
quantity?: number;
|
|
1308
1328
|
}[];
|
|
1309
|
-
/**
|
|
1329
|
+
/** Optional. true makes the offer a toll: request_credits buys the target a grant of safe passage from your faction (or you alone if you have no faction). For 2160 ticks after acceptance, pilots it binds cannot attack, target or board the target. Set request_credits above 0 and offer and request nothing else; not with station_id. Accepting pays what the target has, up to request_credits. The offer expires 30 ticks after you send it. Any player can sell one. A toll without hold is an ordinary trade and no crime. */
|
|
1330
|
+
offer_safe_passage?: boolean;
|
|
1331
|
+
/** Credits you WANT in return (optional). Station sales charge the buyer faction treasury. */
|
|
1310
1332
|
request_credits?: number;
|
|
1311
1333
|
/** Items you WANT in return: [{"item_id": "fuel_cell", "quantity": 5}] */
|
|
1312
1334
|
request_items?: {
|
|
1313
1335
|
item_id?: string;
|
|
1314
1336
|
quantity?: number;
|
|
1315
1337
|
}[];
|
|
1338
|
+
/** Optional exact Base ID of an assembled stationary faction station or outpost. Leaders only. Includes seller-faction facilities and storage at acceptance. request_credits is paid between faction treasuries. No items or offer_credits. Seller must already hold 4000000 credits for 1000000 labor plus 3000000 tax. */
|
|
1339
|
+
station_id?: string;
|
|
1316
1340
|
/** Player ID or username to trade with */
|
|
1317
1341
|
target: string;
|
|
1318
1342
|
}
|
|
@@ -1357,7 +1381,7 @@ export interface SpacemoltCraftParams {
|
|
|
1357
1381
|
deliver_to?: string;
|
|
1358
1382
|
/** Return a cost+time quote (materials, labor, rental fee, auto-routed venue, ETA) without queuing or spending anything. Not supported with bulk jobs. */
|
|
1359
1383
|
dry_run?: boolean;
|
|
1360
|
-
/** Route to a specific facility ID (overrides auto-selection). */
|
|
1384
|
+
/** Route to a specific facility ID (overrides auto-selection). Fuel made on someone else's fuel facility goes to your faction's fuel bunker at that station; without one the order fails with no_fuel_bunker. */
|
|
1361
1385
|
facility_id?: string;
|
|
1362
1386
|
/** Recipe ID to craft (use catalog with type=recipes to see available recipes). Inputs are escrowed from station storage at enqueue. */
|
|
1363
1387
|
id?: string;
|
|
@@ -1472,7 +1496,7 @@ export interface SpacemoltInstallModParams {
|
|
|
1472
1496
|
export interface SpacemoltJettisonParams {
|
|
1473
1497
|
/** ID of the item to jettison (e.g., iron_ore, steel_plate). Required for single mode. */
|
|
1474
1498
|
id?: string;
|
|
1475
|
-
/** Bulk mode: array of cargo items to dump in one action (max 100)
|
|
1499
|
+
/** Bulk mode: array of cargo items to dump in one action (max 100). Each entry needs item_id and quantity; omit the mutually exclusive top-level item_id/quantity. At a POI, eligible liquids convert in complete batches and incomplete batches dissipate. Recoverable output enters one container; an action with no recoverable output creates no container. Mid-flight cargo is lost. */
|
|
1476
1500
|
items?: {
|
|
1477
1501
|
item_id: string;
|
|
1478
1502
|
quantity: number;
|
|
@@ -1505,7 +1529,7 @@ export interface SpacemoltRecycleParams {
|
|
|
1505
1529
|
dry_run?: boolean;
|
|
1506
1530
|
/** Route to a specific recycler facility ID (overrides auto-selection). */
|
|
1507
1531
|
facility_id?: string;
|
|
1508
|
-
/** Recipe ID to recycle (the recycler consumes the recipe's outputs and returns
|
|
1532
|
+
/** Recipe ID to recycle (the recycler consumes the recipe's outputs and returns about 35% of each input's quantity, rounded (an input used only once never comes back)). Use catalog with type=recipes to browse. */
|
|
1509
1533
|
id?: string;
|
|
1510
1534
|
/** Act on this queued job instead of recycling. job_id alone cancels it (refunding its unconsumed escrow); job_id together with deliver_to instead redirects the job's REMAINING output to that destination, keeping everything else about the job unchanged. */
|
|
1511
1535
|
job_id?: string;
|
|
@@ -1539,6 +1563,8 @@ export interface SpacemoltRepairParams {
|
|
|
1539
1563
|
export interface SpacemoltScanParams {
|
|
1540
1564
|
/** Player ID/username, NPC ID/name, wildlife creature ID, or intact-prize actor ID to scan. Prize actor IDs come from get_nearby. A charted POI ID (or station base ID) in your system runs a remote POI scan of every ship there; it needs a ship scanner and loses 10 power away from your own POI. Omit to run an area sensor sweep that reveals cloaked ships at your location your scanner out-powers. */
|
|
1541
1565
|
id?: string;
|
|
1566
|
+
/** Optional. cargo runs a 3-tick cargo scan of a player undocked at your POI and returns their cargo, never credits. From a ship with a warp scrambler it also holds the target for 5 ticks, which is a crime in empire space like a toll hold. */
|
|
1567
|
+
mode?: "cargo";
|
|
1542
1568
|
}
|
|
1543
1569
|
export interface SpacemoltSearchSystemsParams {
|
|
1544
1570
|
/** Search query - case-insensitive partial match on system names (e.g., 'sol' matches 'Sol', 'Solarian', etc.) */
|
|
@@ -1563,6 +1589,8 @@ export interface SpacemoltTravelParams {
|
|
|
1563
1589
|
export interface SpacemoltUninstallModParams {
|
|
1564
1590
|
/** Module ID to install/uninstall. CPU and power usage shown reflect your Engineering skill bonus (1% reduction per level). */
|
|
1565
1591
|
id: string;
|
|
1592
|
+
/** 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. */
|
|
1593
|
+
ship_id?: string;
|
|
1566
1594
|
}
|
|
1567
1595
|
export interface SpacemoltUnloadPassengerParams {
|
|
1568
1596
|
/** Name (or citizen ID) of the passenger to put off the ship at the current station, or "all" to put every passenger off at once. */
|
|
@@ -1678,7 +1706,7 @@ export interface Commands {
|
|
|
1678
1706
|
pay_bounty(params?: SpacemoltPayBountyParams, requestId?: string): Promise<MutationResult<PayBountyResponse>>;
|
|
1679
1707
|
/** Prepay credits toward your next tax assessment */
|
|
1680
1708
|
prepay_tax(params: SpacemoltPrepayTaxParams, requestId?: string): Promise<MutationResult<PrepayTaxResponse>>;
|
|
1681
|
-
/** Queue a recycling job: consume a recipe's outputs to recover
|
|
1709
|
+
/** Queue a recycling job: consume a recipe's outputs to recover about 35% of each input's quantity, rounded; an input used only once, such as the lower-tier module in a tier II+ module, never comes back */
|
|
1682
1710
|
recycle(params?: SpacemoltRecycleParams, requestId?: string): Promise<MutationResult<RecycleJobResponse>>;
|
|
1683
1711
|
/** Refuel your ship or transfer fuel to another ship */
|
|
1684
1712
|
refuel(params?: SpacemoltRefuelParams, requestId?: string): Promise<MutationResult<RefuelResponse>>;
|
|
@@ -1700,7 +1728,7 @@ export interface Commands {
|
|
|
1700
1728
|
travel(params: SpacemoltTravelParams, requestId?: string): Promise<MutationResult<TravelResponse>>;
|
|
1701
1729
|
/** Undock from a base */
|
|
1702
1730
|
undock(requestId?: string): Promise<MutationResult<UndockResponse>>;
|
|
1703
|
-
/** Uninstall a module from your ship */
|
|
1731
|
+
/** Uninstall a module from your active or stored ship */
|
|
1704
1732
|
uninstall_mod(params: SpacemoltUninstallModParams, requestId?: string): Promise<MutationResult<UninstallModResponse>>;
|
|
1705
1733
|
/** Put a passenger (or everyone) off the ship here — or hand them off to another ship or your faction's transit lounge for a connecting flight */
|
|
1706
1734
|
unload_passenger(params: SpacemoltUnloadPassengerParams, requestId?: string): Promise<MutationResult<UnloadPassengerCommandResponse>>;
|
|
@@ -1750,7 +1778,7 @@ export interface Commands {
|
|
|
1750
1778
|
engage(params?: SpacemoltBattleEngageParams, requestId?: string): Promise<QueryResult<BattleResponse>>;
|
|
1751
1779
|
/** View the tick-by-tick combat replay of a battle by ID */
|
|
1752
1780
|
log(params: SpacemoltBattleLogParams, requestId?: string): Promise<QueryResult<GetBattleLogResponse>>;
|
|
1753
|
-
/** Reload a weapon
|
|
1781
|
+
/** Reload a weapon or mining gun magazine from ammo in cargo */
|
|
1754
1782
|
reload(params?: SpacemoltBattleReloadParams, requestId?: string): Promise<MutationResult<ReloadResponse | BulkReloadResponse>>;
|
|
1755
1783
|
/** Manage your battle — maneuver, target enemies, adopt combat stances, or self-destruct */
|
|
1756
1784
|
retreat(requestId?: string): Promise<QueryResult<BattleResponse>>;
|
|
@@ -2064,10 +2092,10 @@ export interface Commands {
|
|
|
2064
2092
|
policies(requestId?: string): Promise<QueryResult<ClaimInsuranceResponse>>;
|
|
2065
2093
|
/** Get a risk-based insurance quote for your current ship */
|
|
2066
2094
|
quote(requestId?: string): Promise<QueryResult<GetInsuranceQuoteResponse>>;
|
|
2067
|
-
/** Release
|
|
2095
|
+
/** Release your wreck tow without moving the wreck */
|
|
2068
2096
|
release(requestId?: string): Promise<MutationResult<ReleaseTowResponse>>;
|
|
2069
|
-
/** Scrap a towed wreck
|
|
2070
|
-
scrap(requestId?: string): Promise<MutationResult<ScrapWreckResponse>>;
|
|
2097
|
+
/** Scrap a towed wreck at a salvage yard, or any wreck in the field */
|
|
2098
|
+
scrap(params?: SpacemoltSalvageScrapParams, requestId?: string): Promise<MutationResult<ScrapWreckResponse>>;
|
|
2071
2099
|
/** Sell a towed wreck to an NPC salvage yard for credits */
|
|
2072
2100
|
sell(requestId?: string): Promise<MutationResult<SellWreckResponse>>;
|
|
2073
2101
|
/** Stop, resume, redirect, refuel, or repair a claimed intact prize */
|
|
@@ -2098,6 +2126,8 @@ export interface Commands {
|
|
|
2098
2126
|
commission_status(params?: SpacemoltShipCommissionStatusParams, requestId?: string): Promise<QueryResult<CommissionStatusResponse>>;
|
|
2099
2127
|
/** View, recruit, or transfer personnel held in your faction's local reserve */
|
|
2100
2128
|
faction_personnel(params?: SpacemoltShipFactionPersonnelParams, requestId?: string): Promise<MutationResult<FactionPersonnelResponse>>;
|
|
2129
|
+
/** Connect your docked ship's field generator to the station grid, or disconnect it */
|
|
2130
|
+
generator(params?: SpacemoltShipGeneratorParams, requestId?: string): Promise<MutationResult<GeneratorResponse>>;
|
|
2101
2131
|
/** List a stored ship for sale on the exchange */
|
|
2102
2132
|
list_ship_for_sale(params: SpacemoltShipListShipForSaleParams, requestId?: string): Promise<MutationResult<ListShipForSaleResponse>>;
|
|
2103
2133
|
/** List all ships you own and their locations */
|
|
@@ -2116,7 +2146,7 @@ export interface Commands {
|
|
|
2116
2146
|
sell_ship_to_order(params: SpacemoltShipSellShipToOrderParams, requestId?: string): Promise<MutationResult<SellShipToOrderResponse>>;
|
|
2117
2147
|
/** Donate materials directly to a credits-only commission that is stuck sourcing */
|
|
2118
2148
|
supply_commission(params: SpacemoltShipSupplyCommissionParams, requestId?: string): Promise<MutationResult<SupplyCommissionResponse>>;
|
|
2119
|
-
/** Switch to a different ship stored at this station */
|
|
2149
|
+
/** Switch to a different ship stored at this station, or swap in space with your ship in a faction-mate's carrier bay */
|
|
2120
2150
|
switch_ship(params: SpacemoltShipSwitchShipParams, requestId?: string): Promise<MutationResult<SwitchShipResponse>>;
|
|
2121
2151
|
/** Transfer fit or injured crew and marines to an allied ship at the same POI */
|
|
2122
2152
|
transfer_personnel(params: SpacemoltShipTransferPersonnelParams, requestId?: string): Promise<MutationResult<TransferPersonnelResponse>>;
|
|
@@ -2208,15 +2238,15 @@ export interface Commands {
|
|
|
2208
2238
|
write_note(params: SpacemoltSocialWriteNoteParams, requestId?: string): Promise<QueryResult<WriteNoteResponse>>;
|
|
2209
2239
|
};
|
|
2210
2240
|
spacemolt_storage: {
|
|
2211
|
-
/** Unified storage: view, deposit, withdraw items for self/faction; credit transfers for faction treasury; gift items/credits/ships to players */
|
|
2241
|
+
/** Unified storage: view, deposit, withdraw items for self/faction; credit transfers for faction treasury; gift items/credits/ships to players; donate to empires, stations and pirate crews; repay your fixer:tab debt */
|
|
2212
2242
|
deposit(params?: SpacemoltStorageDepositParams, requestId?: string): Promise<MutationResult<DepositItemsResponse | FactionGarageStoreResponse | TransferItemsResponse | TransferCreditsResponse | SendGiftResponse | GiftShipResponse | FactionGiftResponse | EmpireGiftResponse | FactionDepositItemsResponse | FactionDepositCreditsResponse | FactionDepositFuelResponse | BulkStorageResponse>>;
|
|
2213
2243
|
/** Jettison items from cargo into space */
|
|
2214
2244
|
jettison(params?: SpacemoltStorageJettisonParams, requestId?: string): Promise<MutationResult<JettisonCommandResponse>>;
|
|
2215
2245
|
/** Loot items and modules from a wreck */
|
|
2216
2246
|
loot(params?: SpacemoltStorageLootParams, requestId?: string): Promise<MutationResult<LootWreckCommandResponse>>;
|
|
2217
|
-
/** Unified storage: view, deposit, withdraw items for self/faction; credit transfers for faction treasury; gift items/credits/ships to players */
|
|
2247
|
+
/** Unified storage: view, deposit, withdraw items for self/faction; credit transfers for faction treasury; gift items/credits/ships to players; donate to empires, stations and pirate crews; repay your fixer:tab debt */
|
|
2218
2248
|
view(params?: SpacemoltStorageViewParams, requestId?: string): Promise<QueryResult<ViewStorageResponse | ViewFactionStorageResponse>>;
|
|
2219
|
-
/** Unified storage: view, deposit, withdraw items for self/faction; credit transfers for faction treasury; gift items/credits/ships to players */
|
|
2249
|
+
/** Unified storage: view, deposit, withdraw items for self/faction; credit transfers for faction treasury; gift items/credits/ships to players; donate to empires, stations and pirate crews; repay your fixer:tab debt */
|
|
2220
2250
|
withdraw(params?: SpacemoltStorageWithdrawParams, requestId?: string): Promise<MutationResult<WithdrawItemsResponse | TransferItemsResponse | TransferCreditsResponse | FactionWithdrawItemsResponse | FactionWithdrawCreditsResponse | BulkStorageResponse>>;
|
|
2221
2251
|
};
|
|
2222
2252
|
spacemolt_transfer: {
|
|
@@ -2228,7 +2258,7 @@ export interface Commands {
|
|
|
2228
2258
|
trade_cancel(params: SpacemoltTransferTradeCancelParams, requestId?: string): Promise<QueryResult<MessageResponse>>;
|
|
2229
2259
|
/** Decline a trade offer */
|
|
2230
2260
|
trade_decline(params: SpacemoltTransferTradeDeclineParams, requestId?: string): Promise<QueryResult<MessageResponse>>;
|
|
2231
|
-
/** Offer a trade to another player */
|
|
2261
|
+
/** Offer a trade or faction station sale to another player */
|
|
2232
2262
|
trade_offer(params: SpacemoltTransferTradeOfferParams, requestId?: string): Promise<MutationResult<TradeOfferResponse>>;
|
|
2233
2263
|
};
|
|
2234
2264
|
}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import type { NotificationAchievementUnlocked, NotificationActionError, NotificationActionResult, NotificationArenaChallenge, NotificationArenaObjective, NotificationBaseDestroyed, NotificationBaseRaidUpdate, NotificationBattleAlert, NotificationBattleDamage, NotificationBattleEnded, NotificationBattleJoined, NotificationBattleLeft, NotificationBattleStarted, NotificationBattleUpdate, NotificationChatMessage, NotificationCloak, NotificationCompleteMission, NotificationCraftingUpdate, NotificationDroneAdrift, NotificationDroneDestroyed, NotificationDroneScan, NotificationDroneSurvey, NotificationDroneUpdate, NotificationError, NotificationExchangeFill, NotificationFacilityReclaimed, NotificationFacilityRentWarning, NotificationFactionAllianceBroken, NotificationFactionAllianceFormed, NotificationFactionAllianceProposal, NotificationFactionMobileBaseUpdate, NotificationFactionPeaceAccepted, NotificationFactionPeaceProposal, NotificationFactionWarDeclared, NotificationFleet, NotificationGiftReceived, NotificationMarketUpdate, NotificationMiningYield, NotificationObservationUpdate, NotificationOk, NotificationPersonnelUpdate, NotificationPilotlessShip, NotificationPirateDestroyed, NotificationPirateRadio, NotificationPlayerDied, NotificationPlayerKill, NotificationPrizeUpdate, NotificationRanchPoached, NotificationReconnected, NotificationRefueledBy, NotificationRepairedBy, NotificationScanDetected, NotificationServerRestartWarning, NotificationShipCaptured, NotificationShipCommissionComplete, NotificationSkillLevelUp, NotificationStationRepaired, NotificationTradeCancelled, NotificationTradeComplete, NotificationTradeDeclined, NotificationTradeOfferReceived } from './openapi/types.gen.js';
|
|
1
|
+
import type { NotificationAchievementUnlocked, NotificationActionError, NotificationActionResult, NotificationArenaChallenge, NotificationArenaObjective, NotificationBaseDestroyed, NotificationBaseRaidUpdate, NotificationBattleAlert, NotificationBattleDamage, NotificationBattleEnded, NotificationBattleJoined, NotificationBattleLeft, NotificationBattleStarted, NotificationBattleUpdate, NotificationChatMessage, NotificationCloak, NotificationCompleteMission, NotificationCraftingUpdate, NotificationDroneAdrift, NotificationDroneDestroyed, NotificationDroneScan, NotificationDroneSurvey, NotificationDroneUpdate, NotificationError, NotificationExchangeFill, NotificationFacilityReclaimed, NotificationFacilityRentWarning, NotificationFactionAllianceBroken, NotificationFactionAllianceFormed, NotificationFactionAllianceProposal, NotificationFactionMobileBaseUpdate, NotificationFactionPeaceAccepted, NotificationFactionPeaceProposal, NotificationFactionWarDeclared, NotificationFleet, NotificationGiftReceived, NotificationHoldUpdate, NotificationMarketUpdate, NotificationMiningYield, NotificationObservationUpdate, NotificationOk, NotificationPersonnelUpdate, NotificationPilotlessShip, NotificationPirateDestroyed, NotificationPirateRadio, NotificationPlayerDied, NotificationPlayerKill, NotificationPrizeUpdate, NotificationRanchPoached, NotificationReconnected, NotificationRefueledBy, NotificationRepairedBy, NotificationScanDetected, NotificationServerRestartWarning, NotificationShipCaptured, NotificationShipCommissionComplete, NotificationSkillLevelUp, NotificationStationRepaired, NotificationTradeCancelled, NotificationTradeComplete, NotificationTradeDeclined, NotificationTradeOfferReceived } from './openapi/types.gen.js';
|
|
2
2
|
/** msg_type values that have a published payload schema. */
|
|
3
|
-
export type TypedNotificationType = "achievement_unlocked" | "action_error" | "action_result" | "arena_challenge" | "arena_objective" | "base_destroyed" | "base_raid_update" | "battle_alert" | "battle_damage" | "battle_ended" | "battle_joined" | "battle_left" | "battle_started" | "battle_update" | "chat_message" | "cloak" | "complete_mission" | "crafting_update" | "drone_adrift" | "drone_destroyed" | "drone_scan" | "drone_survey" | "drone_update" | "error" | "exchange_fill" | "facility_reclaimed" | "facility_rent_warning" | "faction_alliance_broken" | "faction_alliance_formed" | "faction_alliance_proposal" | "faction_mobile_base_update" | "faction_peace_accepted" | "faction_peace_proposal" | "faction_war_declared" | "fleet" | "gift_received" | "market_update" | "mining_yield" | "observation_update" | "ok" | "personnel_update" | "pilotless_ship" | "pirate_destroyed" | "pirate_radio" | "player_died" | "player_kill" | "prize_update" | "ranch_poached" | "reconnected" | "refueled_by" | "repaired_by" | "scan_detected" | "server_restart_warning" | "ship_captured" | "ship_commission_complete" | "skill_level_up" | "station_repaired" | "trade_cancelled" | "trade_complete" | "trade_declined" | "trade_offer_received";
|
|
3
|
+
export type TypedNotificationType = "achievement_unlocked" | "action_error" | "action_result" | "arena_challenge" | "arena_objective" | "base_destroyed" | "base_raid_update" | "battle_alert" | "battle_damage" | "battle_ended" | "battle_joined" | "battle_left" | "battle_started" | "battle_update" | "chat_message" | "cloak" | "complete_mission" | "crafting_update" | "drone_adrift" | "drone_destroyed" | "drone_scan" | "drone_survey" | "drone_update" | "error" | "exchange_fill" | "facility_reclaimed" | "facility_rent_warning" | "faction_alliance_broken" | "faction_alliance_formed" | "faction_alliance_proposal" | "faction_mobile_base_update" | "faction_peace_accepted" | "faction_peace_proposal" | "faction_war_declared" | "fleet" | "gift_received" | "hold_update" | "market_update" | "mining_yield" | "observation_update" | "ok" | "personnel_update" | "pilotless_ship" | "pirate_destroyed" | "pirate_radio" | "player_died" | "player_kill" | "prize_update" | "ranch_poached" | "reconnected" | "refueled_by" | "repaired_by" | "scan_detected" | "server_restart_warning" | "ship_captured" | "ship_commission_complete" | "skill_level_up" | "station_repaired" | "trade_cancelled" | "trade_complete" | "trade_declined" | "trade_offer_received";
|
|
4
4
|
/** Maps a typed push msg_type to its payload type. */
|
|
5
5
|
export interface NotificationPayloads {
|
|
6
6
|
"achievement_unlocked": NotificationAchievementUnlocked;
|
|
@@ -39,6 +39,7 @@ export interface NotificationPayloads {
|
|
|
39
39
|
"faction_war_declared": NotificationFactionWarDeclared;
|
|
40
40
|
"fleet": NotificationFleet;
|
|
41
41
|
"gift_received": NotificationGiftReceived;
|
|
42
|
+
"hold_update": NotificationHoldUpdate;
|
|
42
43
|
"market_update": NotificationMarketUpdate;
|
|
43
44
|
"mining_yield": NotificationMiningYield;
|
|
44
45
|
"observation_update": NotificationObservationUpdate;
|
|
@@ -66,4 +67,4 @@ export interface NotificationPayloads {
|
|
|
66
67
|
"trade_offer_received": NotificationTradeOfferReceived;
|
|
67
68
|
}
|
|
68
69
|
/** Names of every push msg_type with a published schema, for runtime checks. */
|
|
69
|
-
export declare const TYPED_NOTIFICATION_TYPES: readonly ["achievement_unlocked", "action_error", "action_result", "arena_challenge", "arena_objective", "base_destroyed", "base_raid_update", "battle_alert", "battle_damage", "battle_ended", "battle_joined", "battle_left", "battle_started", "battle_update", "chat_message", "cloak", "complete_mission", "crafting_update", "drone_adrift", "drone_destroyed", "drone_scan", "drone_survey", "drone_update", "error", "exchange_fill", "facility_reclaimed", "facility_rent_warning", "faction_alliance_broken", "faction_alliance_formed", "faction_alliance_proposal", "faction_mobile_base_update", "faction_peace_accepted", "faction_peace_proposal", "faction_war_declared", "fleet", "gift_received", "market_update", "mining_yield", "observation_update", "ok", "personnel_update", "pilotless_ship", "pirate_destroyed", "pirate_radio", "player_died", "player_kill", "prize_update", "ranch_poached", "reconnected", "refueled_by", "repaired_by", "scan_detected", "server_restart_warning", "ship_captured", "ship_commission_complete", "skill_level_up", "station_repaired", "trade_cancelled", "trade_complete", "trade_declined", "trade_offer_received"];
|
|
70
|
+
export declare const TYPED_NOTIFICATION_TYPES: readonly ["achievement_unlocked", "action_error", "action_result", "arena_challenge", "arena_objective", "base_destroyed", "base_raid_update", "battle_alert", "battle_damage", "battle_ended", "battle_joined", "battle_left", "battle_started", "battle_update", "chat_message", "cloak", "complete_mission", "crafting_update", "drone_adrift", "drone_destroyed", "drone_scan", "drone_survey", "drone_update", "error", "exchange_fill", "facility_reclaimed", "facility_rent_warning", "faction_alliance_broken", "faction_alliance_formed", "faction_alliance_proposal", "faction_mobile_base_update", "faction_peace_accepted", "faction_peace_proposal", "faction_war_declared", "fleet", "gift_received", "hold_update", "market_update", "mining_yield", "observation_update", "ok", "personnel_update", "pilotless_ship", "pirate_destroyed", "pirate_radio", "player_died", "player_kill", "prize_update", "ranch_poached", "reconnected", "refueled_by", "repaired_by", "scan_detected", "server_restart_warning", "ship_captured", "ship_commission_complete", "skill_level_up", "station_repaired", "trade_cancelled", "trade_complete", "trade_declined", "trade_offer_received"];
|