contract2.gm

The actions for this contract with their input parameters and potential response data.

• addmodule

  addmodule

  Install a module into a slot

  Request Parameters
  entity_id	uint64
  module_index	uint8
  module_ref	cargo_ref
  target_ref	cargo_ref?
• addnexus

  addnexus

  Add a nexus location

  Request Parameters
  nexus_name	string
  x	int64
  y	int64
• addoracle

  Request Parameters
  oracle_id	name
• blend

  blend

  Blend cargo stacks

  Request Parameters
  id	uint64
  inputs	cargo_item[]
• buildplot

  Request Parameters
  builder_id	uint64
  plot_id	uint64

  Response Array
  entities	entity_task_info[]

• cancel

  cancel

  Cancel scheduled tasks

  Request Parameters
  id	uint64
  count	uint64

  Response Object
  entity_id	uint64
  entity_type	name
  cancelled_count	uint8
  schedule_started	time_point?
  entitygroup	uint64?
  group_members	B_vector_entity_ref_E?

• claimplot

  Request Parameters
  builder_id	uint64
  target_item_id	uint16
  coords	coordinates

  Response Array
  entities	entity_task_info[]

• cleanrsvp

  cleanrsvp

  Clean up past epoch reserves

  Request Parameters
  epoch	uint64
  max_rows	uint64
• cleartable

  cleartable

  DEBUG: cleartable action

  Request Parameters
  table_name	name
  scope	name?
  max_rows	uint64?
• commit

  commit

  Set commit value

  Request Parameters
  oracle_id	name
  epoch	uint64
  commit	checksum256
• configlog

  configlog

  Log game configuration

  Request Parameters
  config	game_config
• craft

  craft

  Craft items from a recipe

  Request Parameters
  id	uint64
  recipe_id	uint16
  quantity	uint32
  inputs	cargo_item[]

  Response Array
  entities	entity_task_info[]

• demolish

  demolish

  Demolish a stationary entity

  Request Parameters
  entity_id	uint64

  Response Array
  entities	entity_task_info[]

• deploy

  deploy

  Deploy a packed entity

  Request Parameters
  id	uint64
  ref	cargo_ref

  Response Array
  entities	entity_task_info[]

• descentity

  descentity

  Describe a packed entity

  Request Parameters
  item_id	uint16
  hull_stats	uint64
  module_items	uint16[]
  module_stats	uint64[]

  Response Object
  descentity	string

• enable

  enable

  Set enabled state

  Request Parameters
  enabled	bool
• fixcargomass

  fixcargomass

  DEBUG: recompute entity cargo mass

  Request Parameters
  entity_id	uint64
• forcereveal

  forcereveal

  DEBUG: force-finalize an epoch from existing reveals

  Request Parameters
  epoch	uint64
• gather

  gather

  Gather resources

  Request Parameters
  source_id	uint64
  destination_id	uint64
  stratum	uint16
  quantity	uint32

  Response Array
  entities	entity_task_info[]

• getconfig

  getconfig

  Get game configuration

  Request Parameters
  No action parameters.

  Response Object
  version	uint32
  defaults	entity_defaults
  items	item_def[]

• getdeposit

  Request Parameters
  owner	name
  asset_id	uint64

  Response Object
  getdeposit	extended_asset

• geteligible

  geteligible

  Get eligible resource item IDs at a location and stratum

  Request Parameters
  coords	coordinates
  stratum	uint16

  Response Array
  geteligible	uint16[]

• getentcls

  getentcls

  Get entity class enum values

  Request Parameters
  No action parameters.

  Response Array
  members	enum_member[]

• getentities

  getentities

  Get all entities for a player

  Request Parameters
  owner	name
  entity_type	name?

  Response Array
  ...	entity_info[]

• getentity

  getentity

  Get entity state

  Request Parameters
  entity_id	uint64

  Response Object
  type	name
  id	uint64
  owner	name
  entity_name	string
  coordinates	coordinates
  item_id	uint16
  cargomass	uint32
  cargo	cargo_view[]
  modules	module_entry[]
  energy	uint16?
  hullmass	uint32?
  capacity	uint32?
  engines	movement_stats?
  warp	warp_stats?
  generator	energy_stats?
  gatherer	gatherer_stats?
  loaders	loader_stats?
  hauler	hauler_stats?
  crafter	crafter_stats?
  is_idle	bool
  current_task	task?
  current_task_elapsed	uint32
  current_task_remaining	uint32
  pending_tasks	task[]
  idle_at	time_point?
  schedule	schedule?

• getitemdata

  getitemdata

  Get full item catalog

  Request Parameters
  No action parameters.

  Response Array
  items	item_def[]
  recipes	recipes_result

• getitemids

  getitemids

  Get item id to name mappings

  Request Parameters
  No action parameters.

  Response Array
  items	item_id_pair[]

• getitems

  getitems

  Get all available items

  Request Parameters
  No action parameters.

  Response Array
  items	item_def[]

• getitemtype

  Request Parameters
  item_id	uint16

  Response Object
  getitemtype	uint8

• getitemtypes

  getitemtypes

  Get item type enum values

  Request Parameters
  No action parameters.

  Response Array
  members	enum_member[]

• getkindmeta

  getkindmeta

  Get entity kind metadata

  Request Parameters
  No action parameters.

  Response Array
  kinds	kind_meta_row[]
  templates	template_meta_row[]

• getlocation

  getlocation

  Get location information

  Request Parameters
  x	int64
  y	int64

  Response Object
  coords	coordinates
  is_system	bool

• getlocdata

  getlocdata

  Get derived location data

  Request Parameters
  x	int64
  y	int64

  Response Object
  static_props	location_static
  size	uint16

• getmodtypes

  getmodtypes

  Get module type enum values

  Request Parameters
  No action parameters.

  Response Array
  members	enum_member[]

• getmodules

  getmodules

  Get all module items

  Request Parameters
  No action parameters.

  Response Array
  modules	module_info[]

• getnearby

  getnearby

  Get nearby reachable systems

  Request Parameters
  entity_id	uint64
  recharge	bool

  Response Object
  can_travel	bool
  current	entity_current_state
  projected	entity_current_state
  max_energy	uint16
  systems	nearby_system[]

• getnftbase

  Request Parameters
  No action parameters.

  Response Array
  getnftbase	string[]

• getnftinfo

  getnftinfo

  Get NFT schema and template configuration

  Request Parameters
  No action parameters.

  Response Array
  schemas	nft_schema_def[]
  templates	nft_template_def[]

• getplayer

  getplayer

  Get player information

  Request Parameters
  account	name

  Response Object
  owner	name
  is_player	bool
  company_name	string

• getprojstate

  getprojstate

  Get projected entity state

  Request Parameters
  entity_id	uint64
  task_count	uint8?

  Response Object
  owner	name
  coordinates	coordinates
  energy	uint16?
  cargomass	uint32
  cargo	cargo_view[]
  hullmass	uint32?
  capacity	uint32?
  engines	movement_stats?
  warp	warp_stats?
  generator	energy_stats?
  gatherer	gatherer_stats?
  loaders	loader_stats?
  hauler	hauler_stats?
  crafter	crafter_stats?

• getrecipe

  getrecipe

  Get a single crafting recipe

  Request Parameters
  output_item_id	uint16

  Response Array
  recipes	recipe_response[]

• getrecipes

  getrecipes

  List crafting recipes

  Request Parameters
  lower_bound	uint16
  limit	uint8

  Response Array
  recipes	recipe_response[]

• getrescats

  getrescats

  Get resource category enum values

  Request Parameters
  No action parameters.

  Response Array
  members	enum_member[]

• getreserves

  getreserves

  Get current reserve modifications at a location

  Request Parameters
  x	int64
  y	int64

  Response Array
  ...	stratum_remaining[]

• getresources

  getresources

  Get all resource items

  Request Parameters
  No action parameters.

  Response Array
  resources	resource_info[]

• getslots

  getslots

  Get entity slot layouts

  Request Parameters
  No action parameters.

  Response Array
  entities	entity_layout[]

• getstratum

  getstratum

  Get resource stratum data

  Request Parameters
  x	int64
  y	int64
  stratum	uint16

  Response Object
  stratum	stratum_info
  stats	resource_stats

• getsummaries

  getsummaries

  Get entity summaries for a player

  Request Parameters
  owner	name
  entity_type	name?

  Response Array
  ...	entity_summary[]

• grouptravel

  grouptravel

  Move multiple entities together

  Request Parameters
  entities	entity_ref[]
  x	int64
  y	int64
  recharge	bool

  Response Array
  entities	entity_task_info[]

• hash

  hash

  Calculate sha256 hash

  Request Parameters
  value	string

  Response Object
  hash	checksum256

• hash512

  hash512

  Calculate sha512 hash

  Request Parameters
  value	string

  Response Object
  hash512	checksum512

• importcargo

  Request Parameters
  row	cargo_row
• importentity

  Request Parameters
  row	entity_row
• importgroup

  Request Parameters
  row	entitygroup_row
• importplayer

  Request Parameters
  owner	name
• importreserve

  Request Parameters
  epoch_scope	uint32
  row	reserve_row
• importstate

  Request Parameters
  row	state_row
• join

  join

  Join a game

  Request Parameters
  account	name
• nftimgurl

  nftimgurl

  Get NFT image URL for a cargo item

  Request Parameters
  item	cargo_item
  location	coordinates?

  Response Object
  nftimgurl	string

• notify

  notify

  Task lifecycle notification

  Request Parameters
  event	task_event
• placecargo

  placecargo

  Restore NFT cargo onto a host entity

  Request Parameters
  owner	name
  host_id	uint64
  asset_id	uint64

  Response Array
  entities	entity_task_info[]

• placeentity

  placeentity

  Materialize a packed-entity NFT as a live entity

  Request Parameters
  owner	name
  asset_id	uint64
  target_nexus_id	uint64

  Response Array
  entities	entity_task_info[]

• recharge

  recharge

  Recharge ship energy

  Request Parameters
  id	uint64

  Response Array
  entities	entity_task_info[]

• refrshentity

  refrshentity

  Refresh derived entity state

  Request Parameters
  entity_id	uint64
• removeoracle

  Request Parameters
  oracle_id	name
• resolve

  resolve

  Complete scheduled tasks

  Request Parameters
  id	uint64
  count	uint64?

  Response Object
  entity_id	uint64
  entity_type	name
  resolved_count	uint8
  new_schedule_started	time_point?
  entitygroup	uint64?
  group_members	B_vector_entity_ref_E?

• reveal

  Request Parameters
  oracle_id	name
  epoch	uint64
  reveal	checksum256
• rmmodule

  rmmodule

  Remove a module from a slot

  Request Parameters
  entity_id	uint64
  module_index	uint8
  target_ref	cargo_ref?
• rmnftcfg

  rmnftcfg

  Remove NFT template mapping for an item

  Request Parameters
  item_id	uint16
• setnftcfg

  setnftcfg

  Set NFT template mapping for an item

  Request Parameters
  item_id	uint16
  template_id	int32
  schema_name	name
• setthreshold

  Request Parameters
  threshold	uint8
• setwrapcost

  Request Parameters
  item_type	uint8
  tier	uint8
  amount	uint64
• setwrapfee

  Request Parameters
  fee_pct	uint16
  fee_account	name
• stowcargo

  stowcargo

  Reserve a cargo stack for wrapping into an NFT

  Request Parameters
  owner	name
  entity_id	uint64
  nexus_id	uint64
  cargo_id	uint64
  quantity	uint64

  Response Array
  entities	entity_task_info[]

• stowentity

  stowentity

  Reserve an entity for wrapping into an NFT

  Request Parameters
  owner	name
  entity_id	uint64
  nexus_id	uint64

  Response Array
  entities	entity_task_info[]

• transfer

  transfer

  Transfer cargo between entities

  Request Parameters
  source_id	uint64
  dest_id	uint64
  items	cargo_item[]

  Response Array
  entities	entity_task_info[]

• travel

  travel

  Move a ship

  Request Parameters
  id	uint64
  x	int64
  y	int64
  recharge	bool

  Response Array
  entities	entity_task_info[]

• undeploy

  undeploy

  Pack a deployed entity into a host

  Request Parameters
  host_id	uint64
  target_id	uint64

  Response Array
  entities	entity_task_info[]

• warp

  warp

  Warp to a destination

  Request Parameters
  id	uint64
  x	int64
  y	int64

  Response Array
  entities	entity_task_info[]

• wipe

  wipe

  DEBUG: wipe action

  Request Parameters
  No action parameters.