This wiki is archived from 2021-09-05

Planetary Annihilation net API: Difference between revisions

From Planetary Annihilation: TITANS and Classic PA Wiki
Jump to navigation Jump to search
(Created page with "Category:Modding = 50px Planetary Annihilation net API = == api.net.startGame( region, mode ) == create a new local or Uber game: * region: loca...")
 
No edit summary
Line 15: Line 15:
* Expires (string)
* Expires (string)


== api.net.joinGame( params) ==
== api.net.joinGame( params ) ==
 
joins an Uber game based on a lobbyId:
* lobbyId (string)
* all other params are ignored
 
returns object with:
* ServerHostName
* ServerPort
and if lobbyId resolved:
* LobbyId
* Ticket
* Expires
and if delayed:
* PollWaitTimeMS
 
 
== api.net.connect( params ) ==


joins an Uber game based on a lobbyId:
joins an Uber game based on a lobbyId:

Revision as of 07:33, 6 April 2016

File:Titans-icon.png Planetary Annihilation net API

api.net.startGame( region, mode )

create a new local or Uber game:

  • region: local or valid Uber region string
  • mode: Config or gw optionally prefixed with content eg PAExpansion1:Config for Titans

returns object with:

  • LobbyId (string)
  • ServerHostname (string)
  • ServerPort (string)
  • Ticket (string)
  • Expires (string)

api.net.joinGame( params )

joins an Uber game based on a lobbyId:

  • lobbyId (string)
  • all other params are ignored

returns object with:

  • ServerHostName
  • ServerPort

and if lobbyId resolved:

  • LobbyId
  • Ticket
  • Expires

and if delayed:

  • PollWaitTimeMS


api.net.connect( params )

joins an Uber game based on a lobbyId:

  • lobbyId (string)
  • all other params are ignored

returns object with:

  • ServerHostName
  • ServerPort