https://vgaplanets.org/api.php?action=feedcontributions&user=HandsomeCam&feedformat=atomVGA Planets Wiki - User contributions [en]2024-03-29T00:48:00ZUser contributionsMediaWiki 1.39.5https://vgaplanets.org/index.php?title=Taurus_Class_Scout&diff=3094Taurus Class Scout2012-12-01T20:30:09Z<p>HandsomeCam: </p>
<hr />
<div>{{Ship<br />
|ShipName=Taurus Class Scout |Races=[[The_Rebel_Confederation|The Rebel Confederation]], [[The_Missing_Colonies_of_Man|The Missing Colonies of Man]] |Comments= |Notes= }}<br />
<br />
[[Category:Ships]]</div>HandsomeCamhttps://vgaplanets.org/index.php?title=Pbp&diff=3093Pbp2012-12-01T19:55:04Z<p>HandsomeCam: Redirected page to Priority Build Points</p>
<hr />
<div>#REDIRECT:[[Priority_Build_Points]]</div>HandsomeCamhttps://vgaplanets.org/index.php?title=Neutronic_Refinery_Ship&diff=3092Neutronic Refinery Ship2012-11-30T17:04:48Z<p>HandsomeCam: </p>
<hr />
<div>{{Ship<br />
|ShipName=Neutronic Refinery Ship |Races= All Races |Comments=The Neutronic Refinery Ship is along with the Rush and Golem Class Carriers one of the most expensive ship hulls. It produces 1kt of neutronium fuel for the cost of 1kt supplies + 1kt of any mineral. Like the Merlin Class Alchemy Ship it can be the economic backbone of already exploited planetary clusters and usually is found close to important star-bases and bovinoid planets. In combat it is fairly tough to destroy, although it can only be equipped with 6 beam weapons, and its fairly large cargo hold can be used for the evacuation from important planets.<br />
|Notes= <br />
<br />
* Can produce up to 525kt of Neutronium per turn<br />
<br />
* 1 supply + 1 mineral = 1 neutronium<br />
<br />
* Range:<br />
<br />
Empty: 700ly<br />
<br />
Full: 355ly <br />
<br />
* Fuel consumption per lightyear:<br />
<br />
Empty: 1,14kt<br />
<br />
Full: 2,25kt<br />
<br />
* Combat<br />
<br />
- write here -<br />
<br />
* Can tow<br />
<br />
=== Notes ===<br />
<br />
Ranges and fuel consumption were taken from a Neutronic Refinery ship equipped with Heavy Blasters and Transwarp Drives in non-stop-flight.<br />
<br />
The 'full' range can be extended by loading minerals and supplies that will produce fuel during flight.<br />
}}<br />
<br />
[[Category:Ships]]<br />
[[Category:Alchemy Ships]]</div>HandsomeCamhttps://vgaplanets.org/index.php?title=Tow_Capture&diff=3091Tow Capture2012-11-30T17:02:56Z<p>HandsomeCam: /* Overview */ fixed a link typo</p>
<hr />
<div>= Overview =<br />
The [[Privateers]] and [[The Crystal Confederation|Crystal People]] can [[capture]] [[starships]] in space that are out of [[fuel]]. To [[capture]] the helpless enemy [[starships]] they need to lock a [[tow]] beam onto the enemy [[starship]]. When they do this the capturing vessel Transorts over armed [[crew]] members to take over the enemy [[starship]]. When the [[starship]] is secured (all the enemy [[crew]] jettisoned into space) half of the capturing starship's [[crew]] or a full compliment for the captured [[starship]] (which ever is less) will transport over and man the captured [[starship]]. (i.e., Say starship A has 500 [[crew]] and [[capture]]s [[starship]] B which normally has a [[crew]] of 1000. 250 crew member from starship A will man [[starship]] B. If B had only required 100 [[crew]] members to be full only 100 [[crew]] members would have transported over to run the starship).<br />
<br />
== Disabling the Tow Capture ==<br />
*The tow capture can be disabled by using the [[Friendly Codes|Friendly Code]] "'''nbr'''"<br />
<br />
== The Tow and Movement Phases ==<br />
Tow capture takes place during the [[tow]] phase of the movement stage of [[host]]. The 3 movement phases of host are:<br />
<br />
*Move Tow<br />
*Move Most (Not Towing, Not being towed and Not intercepting)<br />
*Move Intercepting ships<br />
<br />
== Crew Defections ==<br />
As stated above the [[crew]] of the captured [[starship]] is ejected into space except for [[The Solar Federation|Fed]], [[The Privateer Bands|Privateer]], [[The Evil Empire|Empire]], and [[The Missing Colonies of Man|Colonial]] starships. With these [[race]]s some of the [[crew]] members will rather go traitor than be ejected into space. the following shows the percentage of original [[crew]] members that grovel well enough to be kept on as lesser [[crew]] members.<br />
<br />
{| border="1" cellpadding="5" cellspacing="0" style="border-collapse:collapse;"<br />
|- style="background:#333333; color:#FFFFFF;"<br />
| align="Center" | Race<br />
! align="Center" | %traitor <br />
|- align="Center"<br />
|-<br />
| Feds<br />
| 90 %<br />
|-<br />
| Privateer <br />
| 100 %<br />
|-<br />
| Empire <br />
| 40 %<br />
|-<br />
| Colonial <br />
| 70 %<br />
|-<br />
|}<br />
<br />
<br />
<br />
<br />
<br />
<br />
[[Category:Tactics]]</div>HandsomeCamhttps://vgaplanets.org/index.php?title=Fascist&diff=3090Fascist2012-11-30T03:04:39Z<p>HandsomeCam: Redirected page to The Fascist Empire</p>
<hr />
<div>#REDIRECT:[[The_Fascist_Empire]]</div>HandsomeCamhttps://vgaplanets.org/index.php?title=B222_Destroyer&diff=3089B222 Destroyer2012-11-30T03:01:55Z<p>HandsomeCam: </p>
<hr />
<div>{{Ship<br />
|ShipName=B222 Destroyer |Races=[[The_Cyborg|The Cyborg]] |Comments= |Notes= }}<br />
<br />
[[Category:Ships]]</div>HandsomeCamhttps://vgaplanets.org/index.php?title=Rush_Class_Heavy_Carrier&diff=3088Rush Class Heavy Carrier2012-11-29T20:42:20Z<p>HandsomeCam: </p>
<hr />
<div>{{Ship<br />
|ShipName=Rush Class Heavy Carrier |Races= [[The_Rebel_Confederation|The Rebel Confederation]] |Comments= |Notes= }}<br />
<br />
[[Category:Ships]]</div>HandsomeCamhttps://vgaplanets.org/index.php?title=The_borg&diff=3087The borg2012-11-29T20:30:16Z<p>HandsomeCam: Redirected page to The Cyborg</p>
<hr />
<div>#REDIRECT: [[The_Cyborg]]</div>HandsomeCamhttps://vgaplanets.org/index.php?title=Borg&diff=3086Borg2012-11-29T20:29:06Z<p>HandsomeCam: Redirected page to The Cyborg</p>
<hr />
<div>#REDIRECT: [[The_Cyborg]]</div>HandsomeCamhttps://vgaplanets.org/index.php?title=Annihilation_Class_Battleship&diff=3085Annihilation Class Battleship2012-11-29T20:28:40Z<p>HandsomeCam: Added built by data</p>
<hr />
<div>{{Ship<br />
|ShipName=Annihilation Class Battleship |Races= [[The_Cyborg|Cyborg]] |Comments= |Notes= }}<br />
<br />
[[Category:Ships]]</div>HandsomeCamhttps://vgaplanets.org/index.php?title=Gemini_Class_Transport&diff=3084Gemini Class Transport2012-11-29T20:27:40Z<p>HandsomeCam: Added built by data</p>
<hr />
<div>{{Ship<br />
|ShipName=Gemini Class Transport |Races= [[The_Rebel_Confederation|The Rebel Confederation]],[[The_Missing_Colonies_of_Man|The Missing Colonies of Man]] |Comments= |Notes= }}<br />
<br />
[[Category:Ships]]</div>HandsomeCamhttps://vgaplanets.org/index.php?title=Meteor_Class_Blockade_Runner&diff=3083Meteor Class Blockade Runner2012-11-29T18:49:05Z<p>HandsomeCam: </p>
<hr />
<div>{{Ship<br />
|ShipName=Meteor Class Blockade Runner<br />
|Races=[[The Privateer Bands]]<br />
|Comments=<br />
|Notes=Commonly referred to as an MBR or MCBR. Due to the [[Gravitonic_Accelerator|gravitonic accelerator]], low cost, cloaking device and large (for it's size) fuel tanks the Meteor Class Blockade Runner is the mainstay of most [[privateer]] fleets. It is not uncommon for MBRs to travel in [[Wolfpack|packs]] of 4 or more.<br />
|Addons=<br />
=== [[Stellar Cartography]] ===<br />
* {{RadiationCloaking|Meteor Blockade Runner}}<br />
}}<br />
<br />
[[Category:Ships]]</div>HandsomeCamhttps://vgaplanets.org/index.php?title=Meteor_Class_Blockade_Runner&diff=3082Meteor Class Blockade Runner2012-11-29T18:48:30Z<p>HandsomeCam: </p>
<hr />
<div>{{Ship<br />
|ShipName=Meteor Class Blockade Runner<br />
|Races=[[The Privateer Bands]]<br />
|Comments=<br />
|Notes=Commonly referred to as an MBR or MCBR. Due to the [[Gravitonic_Accelerator|gravitonic accelerator]], low cost, cloaking device and large (for it's size) fuel tanks the Meteor Class Blockade Runner is the mainstay of most [[privateer]] fleets. It is not uncommon for MBRs to travel in packs of 4 or more.<br />
|Addons=<br />
=== [[Stellar Cartography]] ===<br />
* {{RadiationCloaking|Meteor Blockade Runner}}<br />
}}<br />
<br />
[[Category:Ships]]</div>HandsomeCamhttps://vgaplanets.org/index.php?title=Scorpius_Class_Light_Carrier&diff=3081Scorpius Class Light Carrier2012-11-29T18:47:27Z<p>HandsomeCam: </p>
<hr />
<div>{{Ship<br />
|ShipName=Scorpius Class Light Carrier |Races= [[The_Missing_Colonies_of_Man|The Missing Colonies]] |Comments= |Notes= }}<br />
<br />
[[Category:Ships]]</div>HandsomeCamhttps://vgaplanets.org/index.php?title=Avians&diff=3080Avians2012-11-29T18:46:39Z<p>HandsomeCam: </p>
<hr />
<div>Avians are a [[native]] race found on [[planet|planets]] scattered throughout the galaxy. <br />
<br />
Avians in particular have the capacity to boost your [[Megacredits]] upon the planet.<br />
<br />
==Taxing Boost==<br />
Avians are quick to forgive you for overtaxing them. They will allow you to slightly overtax them without growing unhappy. (They are somewhat dumb) Avians gain 10% bonus on happiness loss from taxes. Where other natives would lose 10% happiness, Avians remain stable.<br />
<br />
=== Related Articles ===<br />
*[[Taxes]]<br />
*[[Happiness]]<br />
[[Category:Native Races]]</div>HandsomeCamhttps://vgaplanets.org/index.php?title=Distance&diff=3079Distance2012-11-29T18:46:05Z<p>HandsomeCam: </p>
<hr />
<div>[[VGA Planets]] uses Light Years to measure distance. sometimes the term [[Turn]]s can be used for the measure of distance. <br />
<br />
<br><br />
'''Example1:''' im 3 turns away!.<br />
<br><br />
'''Example2:''' im 220 lyrs away!<br />
<br />
*'''note''' LY or Lyrs are both abbreviations for the Term "Light Years"</div>HandsomeCamhttps://vgaplanets.org/index.php?title=Native&diff=3078Native2012-11-29T18:45:34Z<p>HandsomeCam: </p>
<hr />
<div> #REDIRECT [[:Category:Native Races]]</div>HandsomeCamhttps://vgaplanets.org/index.php?title=Native&diff=3077Native2012-11-29T18:44:32Z<p>HandsomeCam: Redirected page to Category:Native Races</p>
<hr />
<div>#REDIRECT:[[Category:Native_Races]]</div>HandsomeCamhttps://vgaplanets.org/index.php?title=Humanoids&diff=3076Humanoids2012-11-29T18:44:01Z<p>HandsomeCam: </p>
<hr />
<div>Humanoids are a [[native]] race found on [[planet|planets]] scattered throughout the galaxy. <br />
<br />
Humanoids in particular have the capacity to give you free level 10 [[Hull Tech]] when you build a [[starbase]] on their [[planet]].<br />
<br />
[[Category:Native Races]]</div>HandsomeCamhttps://vgaplanets.org/index.php?title=Wolfpack&diff=3075Wolfpack2012-11-29T18:41:08Z<p>HandsomeCam: Fixed up some grammar and spelling</p>
<hr />
<div>= Overview =<br />
a [[VGA Planets]] combat Tactic For cloaking [[Races]]!<br />
== The Problem ==<br />
as birdmen or fascists you want to [[attack]] a particular [[Ship]] within an enemy fleet without being forced to engage the rest of the fleet, or as a privateer you wish to capture a particular ship within an enemy fleet without being forced to engage the rest of the fleet.<br />
<br />
== The Wolfpack Solution ==<br />
=== Fascists and Birds solution ===<br />
<br />
a small force of cloaked vessels '''WolfPack''' lies waiting within 81 lyrs of the target. another cloaker the '''Lamb''' is at the exact location of the enemy fleet under cloak and tows away 1 of the ships to the '''wolfpack''' which is set to destroy the towed target. the '''lamb''' and the '''wolfpack''' fight together to destroy the single target.<br />
<br />
=== The Privateers solution for capture ===<br />
A small force of [[MBR]]s lie in wait cloaked as the '''wolfpack''' within 160 lyrs of the planet to be booby trapped. The booby trapped planet will have two MBRs present the '''Lamb''' and the '''duck'''. the duck is empty of fuel and not cloaked above the planet. while the lamb is full of fuel and cloaked above the planet. the booby trapped planet should have no fuel on its surface. if there is room in the lambs tank have him bring it up before the operation begins.<br />
<br />
When the enemy vessel enters the booby trapped planet, they will notice the MBR that is empty of fuel, but wont be able to do anything about it as you cannot attack a ship with no fuel. The '''lamb''' transfers 1kt of fuel to the '''duck'''. the '''duck''' sets his mission to rob ship and moves away from the planet to a safe location. the '''lamb''' tows the ship to the '''wolfpack''' hoping a tow capture will occur. if the enemy ship was robbed completely of fuel the ship will now belong to the privateers, if not, combat may occur with the '''lamb'''. if the privateer '''lamb''' fails to capture the ship thru combat vcr it or the target will be destroyed. if the target survives the combat vcr and is still not captured the wolfpack will then be able to rob the ship completely dry of fuel and tow capture the target the following turn.<br />
<br />
=== Variations ===<br />
There are a few variations to this tactic and as long as the end result is the target captured, the '''wolfpack''' has done its job. for largers vessels such as heavy carriers or battleships with big fuel tanks the '''duck''' can be replaced with a merlin or a neutronic fuel tanker. or even have multiple ducks to rob more fuel. the point is the '''ducks''' need to rob all or as much fuel as possible so the lamb can tow capture, the wolfpack is a backup measure in most cases. and is used when the '''lamb''' fails to tow capture. in some cases the loss of a single MBR is worth the cost of capturing heavy carriers and dreadnaughts. in this case a single '''lamb''' and '''duck''' can be used . the '''lamb''' will die at the hands of the heavy cruiser or battleship, but the '''wolfpack''' will rob it dry the following turn. another version is to not use a '''duck''' at all. but instead sacrifice the lamb each time in order to bring its target to the '''wolfpack''', and allow the '''wolfpack''' to do the robbing of fuel instead of the '''duck'''<br />
<br />
<br />
{{stub}}<br />
<br />
== Common Usage ==<br />
Most cloaking [[Races]] use this [[Tactics|tactic]].<br />
[[category:Tactics]]</div>HandsomeCamhttps://vgaplanets.org/index.php?title=MBR&diff=3074MBR2012-11-29T18:38:31Z<p>HandsomeCam: Redirected page to Meteor Class Blockade Runner</p>
<hr />
<div>#REDIRECT:[[Meteor_Class_Blockade_Runner]]</div>HandsomeCamhttps://vgaplanets.org/index.php?title=Beam_Tech_Level&diff=3073Beam Tech Level2012-11-29T18:33:45Z<p>HandsomeCam: Removed double title</p>
<hr />
<div>Beam [[Tech levels]] are required for building the Beam Weapons That Will Be Placed upon your newly constructed or [[The Solar Federation|Super Refited]] [[Ships]]. Each Beam Weapon has its own specific Beam Weapon Tech requirement for it to be built. a [[starbase]] must first achieve this [[Tech level]] in order to build that specific Beam Weapon.<br />
<br />
=Beam Tech Table=<br />
<pre><br />
Tech Name Mass Damage Crew Kill Sweep MC Dur Trit Moly<br />
1 Laser 1 3 10 1 1 0 1 0<br />
1 X-Ray Laser 1 1 15 4 2 0 1 0<br />
2 Plasma Bolt 2 10 3 9 5 2 1 0<br />
3 Blaster 4 25 10 16 10 12 1 1<br />
4 Positron Beam 3 29 9 25 12 12 1 5<br />
5 Disruptor 4 20 30 36 13 12 1 1<br />
6 Heavy Blaster 7 40 20 49 31 12 1 14<br />
7 Phaser 5 35 30 64 35 12 1 30<br />
8 Heavy Disruptor 7 35 50 81 36 17 1 37<br />
10 Heavy Phaser 6 45 35 100 54 12 1 55 <br />
</pre><br />
<br />
[[category:Tech Levels]]</div>HandsomeCamhttps://vgaplanets.org/index.php?title=Nebula_Class_Cruiser&diff=3072Nebula Class Cruiser2012-11-29T18:33:22Z<p>HandsomeCam: </p>
<hr />
<div>{{Ship<br />
|ShipName=Nebula Class Cruiser |Races= [[The_Solar_Federation|The Solar Federation]]|Comments= |Notes= }}<br />
<br />
[[Category:Ships]]</div>HandsomeCamhttps://vgaplanets.org/index.php?title=Meteor_Class_Blockade_Runner&diff=3071Meteor Class Blockade Runner2012-11-29T18:32:20Z<p>HandsomeCam: MBR commentary</p>
<hr />
<div>{{Ship<br />
|ShipName=Meteor Class Blockade Runner<br />
|Races=[[The Privateer Bands]]<br />
|Comments=<br />
|Notes=Commonly referred to as an MBR. Due to the [[Gravitonic_Accelerator|gravitonic accelerator]], low cost, cloaking device and large (for it's size) fuel tanks the Meteor Class Blockade Runner is the mainstay of most [[privateer]] fleets. It is not uncommon for MBRs to travel in packs of 4 or more.<br />
|Addons=<br />
=== [[Stellar Cartography]] ===<br />
* {{RadiationCloaking|Meteor Blockade Runner}}<br />
}}<br />
<br />
[[Category:Ships]]</div>HandsomeCamhttps://vgaplanets.org/index.php?title=Privateer&diff=3070Privateer2012-11-29T18:31:45Z<p>HandsomeCam: Redirected page to The Privateer Bands</p>
<hr />
<div>#REDIRECT:[[The_Privateer_Bands]]</div>HandsomeCamhttps://vgaplanets.org/index.php?title=Super_Star_Cruiser&diff=3069Super Star Cruiser2012-11-29T18:27:35Z<p>HandsomeCam: </p>
<hr />
<div>{{Ship<br />
|ShipName=Super Star Cruiser |Races= [[Empire|The Evil Empire]] |Comments= |Notes= }}<br />
<br />
[[Category:Ships]]</div>HandsomeCamhttps://vgaplanets.org/index.php?title=Priority_Intercept&diff=3068Priority Intercept2012-11-29T18:26:55Z<p>HandsomeCam: </p>
<hr />
<div>A ship equipped with a cloaking device and on the intercept mission will ignore the regular combat order and attack its intercept target first. During its intercept mission the ship is not cloaked and will not cloak after combat, although the name of this operation may suggest this.<br />
<br />
After the ship has successfully intercepted its target (and either has set its primary enemy to the target's race or is being attacked by the target), it will first engage its target and then (if it survives) fight in the regular battle order.<br />
<br />
The most common use of this mechanism is to remove ships from enemy fleets, sacrificing your ship to destroy the enemy's ship. For instance, destroying a Cobol or Fuel Refinery in an enemy fleet can cripple an entire offensive, buying you critical time to mount a counterattack, or by forcing the enemy to send fewer ships.<br />
<br />
=See Also=<br />
[[Cloaking]]<br><br />
[[Combat Order]]<br />
[[Category:Tactics]]</div>HandsomeCamhttps://vgaplanets.org/index.php?title=Planets.Nu_API&diff=3067Planets.Nu API2012-11-29T18:22:39Z<p>HandsomeCam: /* Send Message */</p>
<hr />
<div>On December 21, 2011, [[VGA_Planets_Nu|Planets.Nu]] opened up an API for developers.<br />
<br />
=Public API=<br />
<br />
The public API calls consist of:<br />
<br />
* [[#Login|Login]] - Use this to acquire the apikey of a given player. <br />
* [[#List Games|List Games]] - List the games on the Planets Nu platform in various ways<br />
* [[#Load Game Info|Load Game Info]] - Load the publicly available data about a single game<br />
* [[#Load Turn Data|Load Turn Data]] - Load a single players complete turn package<br />
<br />
==Errors==<br />
<br />
API calls return a JSON dictionary. In the event of an API call failure, the following dictionary will be returned:<br />
<br />
{"success":false,"error":"This is the error message."}<br />
<br />
on occasion, instead of a JSON dictionary the following text is returned:<br />
<br />
Error: <i>Error Description Here</i><br />
<br />
==Login==<br />
<br />
The login API returns an API key which can be used along with a username for subsequent API calls.<br />
<br />
The login command is an HTTP GET to http://api.planets.nu/login with the following values passed on the connection string:<br />
<br />
{| cellspacing="0" cellpadding="5" style="white-space:nowrap;" border="1"<br />
|-bgcolor=lightblue<br />
! align="left" | variable<br />
! align="left" | description<br />
! align="left" | Required<br />
! align="center" | Default Value<br />
|-<br />
| username || account username || YES || n/a<br />
|-<br />
| password || account password || YES || n/a<br />
|}<br />
<br />
Example:<br />
<br />
<code>http:/<nowiki />/api.planets.nu/login?username=user12345&password=straightouttagalibor</code><br />
<br />
The response is a JSON dictionary with the following keys:<br />
<br />
{| cellspacing="0" cellpadding="5" style="white-space:nowrap;" border="1"<br />
|-bgcolor=lightblue<br />
! align="left" | key<br />
! align="left" | value<br />
|-<br />
| success || Indicates if the call was successful (true or false)<br />
|-<br />
| apikey || The API key used in other requests. An API key is formatted as: <code>xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx</code> where any <code>x</code> is a hexadecimal value.<br />
|-<br />
| settings || The current [[#Player Settings Object|player's settings object]] <br />
|}<br />
<br />
The API key is used for subsequent API calls for the given account. This is the API Key of the account and will only change if the user changes their account password.<br />
<br />
==List Games==<br />
<br />
The list games API returns detailed information about all games on the Planets Nu website or for an individual player. This API is a public API and does not require authentication. <br />
<br />
The list games command is a GET call to http://api.planets.nu/games/list<br />
<br />
The following variables are all optional:<br />
<br />
{| cellspacing="0" cellpadding="5" style="white-space:nowrap;" border="1"<br />
|-bgcolor=lightblue<br />
! align="left" | variable<br />
! align="left" | description<br />
! align="left" | Required<br />
! align="center" | Default Value<br />
|-<br />
| status || Current status of games to return, with multiple values joined by commas.<br />Possible values are:<br/>1 : Joining<br />2 : Running<br/>3 : Finished<br/>4 : Hold || NO || 1,2<br />
|-<br />
| type || The type of games to return, with multiple values joined by commas.<br />Possible values are:<br/>1 : Training<br />2 : Standard<br />3 : Team<br />4 : Melee<br />5 : Blitz || NO || 2,3,4<br />
|-<br />
| scope || Current scope of games to return, with multiple values joined by commas.<br />Possible values are:<br/>0 : Public<br />1 : Custom (private games) || NO || 0<br />
|-<br />
| ids || IDs of games to return, comma separated || NO || n/a<br />
|-<br />
| username || Username of the account to list games. Will list all games for this user regardless of other settings || NO || n/a<br />
|-<br />
| limit || The maximum number of records to return. A value of 0 (zero) will return all records. || NO || 0<br />
|}<br />
<br />
Each game record will be returned in a JSON array of [[#Game Object|game objects]]:<br />
<br />
<code>[{game 1},{game 2},{game 3}]</code><br />
<br />
==Load Game Info==<br />
<br />
The Load Game Info API returns all the publicly available information about a game including its historical game records.<br />
<br />
The load game info command is a GET call to http://api.planets.nu/game/loadinfo with the following values passed on the connection string:<br />
<br />
{| cellspacing="0" cellpadding="5" style="white-space:nowrap;" border="1"<br />
|-bgcolor=lightblue<br />
! align="left" | variable<br />
! align="left" | description<br />
! align="left" | Required<br />
! align="center" | Default Value<br />
|-<br />
| gameid || The of the game being loaded || YES || n/a<br />
|}<br />
<br />
On success, the following JSON dictionary is returned:<br />
<br />
{| cellspacing="0" cellpadding="5" style="white-space:nowrap;" border="1"<br />
|-bgcolor=lightblue<br />
! align="left" | key<br />
! align="left" | value<br />
|-<br />
| game || A [[#Game Object|game object]] dictionary<br />
|-<br />
| players || An array of [[#Player Object|player object]] dictionaries<br />
|-<br />
| relations || An array of [[#Relation Object|relation object]] dictionaries<br />
|-<br />
| schedule || A text description of the host schedule<br />
|-<br />
| settings || A [[#Game Settings Object|game settings object]] dictionary<br />
|-<br />
| timetohost || A text description of the time until the next scheduled host<br />
|-<br />
| wincondition || A text description of the condition required to win the game<br />
|-<br />
| yearfrom || The Planets.NU year that the game began<br />
|-<br />
| yearto || The Planets.NU year the game ended<br />
|}<br />
<br />
==Load Turn Data==<br />
<br />
The load turn API returns all the data for a single complete turn given a game id and player id. <br />
This API requires the api key from [[#Login|Login]] as authentication when loading a turn for a game in progress. <br />
<br />
The load turn command is a GET call to http://api.planets.nu/game/loadturn<br />
<br />
The following variables may be passed as arguments in the connection string:<br />
<br />
{| cellspacing="0" cellpadding="5" style="white-space:nowrap;" border="1"<br />
|-bgcolor=lightblue<br />
! align="left" | variable<br />
! align="left" | description<br />
! align="left" | Required<br />
! align="center" | Default Value<br />
|-<br />
| apikey || The api key from the [[#Login|login]] API call. Only required for turns in active games || NO || n/a<br />
|-<br />
| forsave || Indicates if the client intends to make a call to the save data APIs || NO || false<br />
|-<br />
| gameid || The game ID for which to request the turn || YES || n/a<br />
|-<br />
| playerid || The player to request a turn for. <br/>In an active game this value must match the player for the supplied api key, otherwise an error will be returned || NO || n/a<br />
|-<br />
| turn || The turn to request || NO || The latest turn<br />
|}<br />
<br />
The response is a JSON dictionary with the following keys:<br />
<br />
{| cellspacing="0" cellpadding="5" style="white-space:nowrap;" border="1"<br />
|-bgcolor=lightblue<br />
! align="left" | key<br />
! align="left" | value<br />
|-<br />
| success || Indicates if the call was successful (true or false)<br />
|-<br />
| accountsettings || A [[#Player Settings Object|player settings object]] for the player whose turn was fetched<br />
|-<br />
| ispremium || Indicates if the player is/was a registered subscriber when the turn was generated<br />
|-<br />
| rst || A [[#Turn Result Object|result object]] which contains the bulk of the turn information<br />
|-<br />
| savekey || A unique, dynamically generated key for saving data back to the API. If <i>forsave</i> was false, this value is empty<br />
|}<br />
<br />
<br />
===Turn Result Object===<br />
<br />
The turn result object returned by Load Turn is a dictionary with the following keys:<br />
<br />
{| cellspacing="0" cellpadding="5" style="white-space:nowrap;" border="1"<br />
|-bgcolor=lightblue<br />
! align="left" | key<br />
! align="left" | value<br />
|-<br />
| settings || A [[#Game Settings Object|game settings object]] for the current game<br />
|-<br />
| game || A [[#Game Object|game object]] for the current game<br />
|-<br />
| player || A [[#Player Object|player object]] for the player the turn data belongs to<br />
|-<br />
| players || An array of [[#Player Object|player objects]] for all players in the current turn<br />
|-<br />
| scores || An array of [[#Score Object|score objects]] for all players in the current turn<br />
|-<br />
| maps || A url to a pre-rendered image of the game map for the given player for the current turn<br />
|-<br />
| planets || An array of [[#Planet Object|planet objects]] for the game<br />
|- <br />
| ships || An array of [[#Ship Object|ship objects]] representing the ships controlled by the given player for the current turn<br />
|-<br />
| ionstorms || An array of [[#Ion Storm Object|ion storm objects]] for the storms currently active in the cluster<br />
|-<br />
| nebulas || An array of [[#Nebula Object|nebula objects]]<br />
|-<br />
| stars || An array of [[#Star Object|star objects]]<br />
|-<br />
| starbases || An array of [[#Starbase Object|starbase objects]] for the starbases under the control of the given player<br />
|-<br />
| stock || An array of [[#Stock Item Object|stock item objects]] of the loose parts the player has at their starbases<br />
|-<br />
| minefields || An array of [[#Minefield Object|minefield objects]] for all minefields known to the player<br />
|- <br />
| relations || An array of [[#Relation Object|relation objects]] for all diplomatic relations as of the current turn<br />
|-<br />
| messages || An array of [[#Message Object|message objects]] representing the system messages (reports) for the current turn<br />
|-<br />
| mymessages || An array of [[#Message Object|message objects]] representing the diplomatic messages sent and received for the player of the current game<br />
|-<br />
| notes || An array of [[#Note Object|note objects]] for notes attached to planets, starbases and ships<br />
|-<br />
| vcrs || An array of [[#VCR Object|visual combat recording objects]] for any combat known to the player for the current turn<br />
|-<br />
| races || An array of [[#Race Object|race objects]] representing all races participating in the current game<br />
|-<br />
| hulls || An array of [[#Hull Object|hull objects]] for the attributes of every hull possible for the current game<br />
|-<br />
| racehulls || An array of the [[#Hull Object|hull IDs]] available to the current player's race<br />
|-<br />
| beams || An array of [[#Beam Object|beam objects]] for the attributes of every beam weapon possible for the current game<br />
|-<br />
| engines || An array of [[#Engine Object|engine objects]] for the attributes of every engine possible for the current game<br />
|-<br />
| torpedos || An array of [[#Torpedo Object|torpedo objects]] for the attributes of every torpedo possible for the current game<br />
|}<br />
<br />
=Non-Public API=<br />
<br />
In addition to the publicly documented API, there are several calls available from reading the actual game code. The maintainers of Planets.Nu have stated that any API endpoint is safe to use. <br />
<br />
==Encoding==<br />
<br />
Any data sent over the non-public API is expected to be encoded to prevent & and = characters from getting mangled by the connection string. <br />
<br />
* <code>&</code> (ampersand) characters are to be replaced with <code>|||</code> (3 pipe characters)<br />
* <code>=</code> (equals) characters are to be replaced with <code>:::</code> (3 colon characters)<br />
<br />
==Send Message==<br />
<br />
The Send Message API allows users to send in-game messages to other players in the current game.<br />
<br />
The send message command is a GET call to http://api.planets.nu/game/sendmessage with the following values passed on the connection string:<br />
<br />
{| cellspacing="0" cellpadding="5" style="white-space:nowrap;" border="1"<br />
|-bgcolor=lightblue<br />
! align="left" | variable<br />
! align="left" | description<br />
! align="left" | Required<br />
! align="center" | Default Value<br />
|-<br />
| gameid || The of the game in which to send the message || YES || n/a<br />
|-<br />
| playerid || The player who is sending the message || YES || n/a<br />
|-<br />
| apikey || The api key of the player sending the message || YES || n/a<br />
|-<br />
| to || A comma separated list of all recipients of the message || YES || n/a<br />
|-<br />
| body || The body of the message to be sent || YES || n/a<br />
|}<br />
<br />
===Send Message Response===<br />
<br />
The response for a send message API call is a dictionary with the following keys:<br />
<br />
{| cellspacing="0" cellpadding="5" style="white-space:nowrap;" border="1"<br />
|-bgcolor=lightblue<br />
! align="left" | key<br />
! align="left" | value<br />
|-<br />
| success || A boolean value indicating the success or failure of the API call<br />
|-<br />
| mymessages || An array of [[#Message Object|message objects]] for all the game's player messages (for the given player)<br />
|-<br />
| html || The html response containing any resulting messages (ie. "Message sent via ambassador immediately") sent to the client<br />
|}<br />
<br />
=Common Data Objects=<br />
<br />
The following objects are used or returned by the API calls:<br />
<br />
==Beam Object==<br />
<br />
The beam object returned by Load Turn Info is a dictionary with the following keys:<br />
<br />
{| cellspacing="0" cellpadding="5" style="white-space:nowrap;" border="1"<br />
|-bgcolor=lightblue<br />
! align="left" | key<br />
! align="left" | value<br />
|-<br />
| cost || The amount of megacredits required to build the beam weapon<br />
|-<br />
| crewkill || The number of crew the beam will kill if the shields of the target ship are down<br />
|-<br />
| damage || The damage that the particular beam will do to the hull or shield of a ship<br />
|-<br />
| duranium || The amount of duranium required to build the beam weapon<br />
|-<br />
| id || The beam ID referenced by other objects, such as the [[#Ship Object|Ship Object]]<br />
|-<br />
| mass || The mass of the beam weapon when constructed<br />
|-<br />
| molybdenum || The amount of molybdenum required to build the beam weapon<br />
|-<br />
| name || The name of the beam weapon<br />
|-<br />
| techlevel || The tech level required at the starbase to build the beam weapon<br />
|-<br />
| tritanium || The amount of tritanium required to build the beam weapon<br />
|}<br />
<br />
==Engine Object==<br />
<br />
The engine object returned by Load Turn Info is a dictionary with the following keys:<br />
<br />
{| cellspacing="0" cellpadding="5" style="white-space:nowrap;" border="1"<br />
|-bgcolor=lightblue<br />
! align="left" | key<br />
! align="left" | value<br />
|-<br />
| cost || The amount of megacredits required to build the engine<br />
|-<br />
| duranium || The amount of duranium required to build the engine<br />
|-<br />
| id || The engine ID referenced by other objects, such as the [[#Ship Object|Ship Object]]<br />
|-<br />
| molybdenum || The amount of molybdenum required to build the engine<br />
|-<br />
| name || The name of the engine<br />
|-<br />
| techlevel || The tech level required at the starbase to build the engine<br />
|-<br />
| tritanium || The amount of tritanium required to build the engine<br />
|-<br />
| warp1 ||<br />
|-<br />
| warp2 ||<br />
|-<br />
| warp3 ||<br />
|-<br />
| warp4 ||<br />
|-<br />
| warp5 ||<br />
|-<br />
| warp6 ||<br />
|-<br />
| warp7 ||<br />
|-<br />
| warp8 ||<br />
|-<br />
| warp9 ||<br />
|}<br />
<br />
==Game Object==<br />
<br />
The game object returned by List Games or Load Game Info is a dictionary with the following keys:<br />
<br />
{| cellspacing="0" cellpadding="5" style="white-space:nowrap;" border="1"<br />
|-bgcolor=lightblue<br />
! align="left" | key<br />
! align="left" | value<br />
|-<br />
| allturnsin || Indicates if all turns have been submitted<br />
|-<br />
| createdby ||<br />
|-<br />
| datecreated || The date the game was created<br />
|-<br />
| dateended || The date the game ended<br />
|-<br />
| deletedate || The date the game was deleted<br />
|-<br />
| description || The text description of the game<br />
|-<br />
| difficulty||<br />
|-<br />
| faststart||<br />
|-<br />
| gametype||<br />
|-<br />
| hostdays || The days of the week the host will run in the format SMTWTFS. An underscore will replace days the host will not run.<br />eg. _M___F_ indicates the host will run on mondays and fridays<br />
|-<br />
| hosttime || The scheduled time of day for the host to run on scheduled host days<br />
|-<br />
| id || The ID of the game<br />
|-<br />
| ishosting||<br />
|-<br />
| isprivate||<br />
|-<br />
| lastbackuppath||<br />
|-<br />
| lastloadeddate||<br />
|-<br />
| lastnotified||<br />
|-<br />
| maptype||<br />
|-<br />
| masterplanetid||<br />
|-<br />
| maxlevelid || The maximum level for captains to participate in the game<br />
|-<br />
| name || The name of the game / system<br />
|-<br />
| nexthost || The datetime of the next scheduled host run<br />
|-<br />
| quadrant ||<br />
|-<br />
| requiredlevelid || The required level for captains to participate in the game<br />
|-<br />
| scenarioid||<br />
|-<br />
| shortdescription||<br />
|-<br />
| slots || The number of player slots available in the game<br />
|-<br />
| slowhostdays||<br />
|-<br />
| status||<br />
|-<br />
| turn || The current game turn<br />
|- <br />
| turnsperweek || The number of scheduled turns per week<br />
|-<br />
| turnstatus || A set of characters indicating which players have submitted their turns. An underscore indicates the turn is not yet viewed.<br />
|-<br />
| tutorialid||<br />
|-<br />
| wincondition||<br />
|-<br />
| yearstarted||<br />
|}<br />
<br />
==Game Settings Object==<br />
<br />
The game settings object returned by Load Game Info is a dictionary with the following keys:<br />
<br />
{| cellspacing="0" cellpadding="5" style="white-space:nowrap;" border="1"<br />
|-bgcolor=lightblue<br />
! align="left" | key<br />
! align="left" | value<br />
|-<br />
| allowchunneltowdropbug ||<br />
|-<br />
| averagedensitypercent ||<br />
|-<br />
| buildqueueplanetid ||<br />
|-<br />
| campaignmode ||<br />
|-<br />
| cloakfail ||<br />
|-<br />
| closeplanets ||<br />
|-<br />
| deadradius ||<br />
|-<br />
| debrisdiskpercent ||<br />
|-<br />
| developmentfactor ||<br />
|- <br />
| discussionid ||<br />
|-<br />
| duraniumlevel ||<br />
|-<br />
| fixedstartpositions ||<br />
|-<br />
| hideraceselection ||<br />
|-<br />
| hostcompleted ||<br />
|-<br />
| hoststart ||<br />
|-<br />
| hwdistribution ||<br />
|-<br />
| id ||<br />
|-<br />
| killrace ||<br />
|-<br />
| mapheight || The height of the map in pixels / lightyears. The upper limit is 4000<br />
|-<br />
| mapshape ||<br />
|-<br />
| mapwidth || The width of the map in pixels / lightyears. The upper limit is 4000<br />
|-<br />
| maxallies || The maximum number of allies a player can have in the current game<br />
|-<br />
| maxioncloudsperstorm ||<br />
|-<br />
| maxions ||<br />
|-<br />
| militaryscorepercent ||<br />
|-<br />
| molybdenumlevel ||<br />
|-<br />
| name || The name of the current game<br />
|-<br />
| nativeprobability ||<br />
|-<br />
| ncircles ||<br />
|-<br />
| ndebrisdiscs ||<br />
|-<br />
| nebulas ||<br />
|-<br />
| neutroniumlevel ||<br />
|-<br />
| nexthost ||<br />
|-<br />
| nuionstorms ||<br />
|-<br />
| numplanets || The number of planets in the game<br />
|-<br />
| planetscanrange ||<br />
|-<br />
| playerselectrace ||<br />
|-<br />
| roundmap ||<br />
|-<br />
| runningstart ||<br />
|-<br />
| shipscanrange ||<br />
|-<br />
| showallexplosions ||<br />
|-<br />
| stars ||<br />
|-<br />
| structuredecayrate ||<br />
|-<br />
| teamsize ||<br />
|-<br />
| tritaniumlevel ||<br />
|-<br />
| turn || The current game turn<br />
|-<br />
| uniqueraces ||<br />
|-<br />
| verycloseplanets ||<br />
|-<br />
| victorycountdown ||<br />
|}<br />
<br />
==Hull Object==<br />
<br />
The hull object returned by Load Turn Info is a dictionary with the following keys:<br />
<br />
{| cellspacing="0" cellpadding="5" style="white-space:nowrap;" border="1"<br />
|-bgcolor=lightblue<br />
! align="left" | key<br />
! align="left" | value<br />
|-<br />
| advantage ||<br />
|-<br />
| beams || The maximum number of beams that can be added to the hull<br />
|-<br />
| cancloak || A boolean value indicating if the hull includes a cloaking device<br />
|-<br />
| cargo || The amount of cargo space available in the constructed hull<br />
|-<br />
| cost || The amount of megacredits required to build the hull<br />
|-<br />
| crew || The maximum crew capacity in the constructed hull<br />
|-<br />
| description ||<br />
|-<br />
| dur ||<br />
|-<br />
| duranium || The amount of duranium required to build the hull<br />
|-<br />
| engines || The amount of engines required by the hull when building a ship<br />
|-<br />
| fighterbays || The number of fighter bays in the constructed hull<br />
|-<br />
| fueltank || The maximum fuel capacity in the constructed hull<br />
|-<br />
| id || The hull ID referenced by other objects, such as the [[#Ship Object|Ship Object]]<br />
|-<br />
| isbase ||<br />
|-<br />
| launchers || The maximum number of torpedo launchers that can be added to the hull<br />
|-<br />
| mass || The mass of the constructed hull<br />
|-<br />
| mc ||<br />
|-<br />
| mol ||<br />
|-<br />
| molybdenum || The amount of molybdenum required to build the hull<br />
|-<br />
| name || The name of the hull<br />
|-<br />
| parentid ||<br />
|-<br />
| special || The text description of the special abilities available to the constructed hull<br />
|-<br />
| techlevel || The tech level required at the starbase to build the hull<br />
|-<br />
| tri ||<br />
|-<br />
| tritanium || The amount of tritanium required to build the hull<br />
|}<br />
<br />
==Ion Storm Object==<br />
<br />
The ion storm object returned by Load Turn Info is a dictionary with the following keys:<br />
<br />
{| cellspacing="0" cellpadding="5" style="white-space:nowrap;" border="1"<br />
|-bgcolor=lightblue<br />
! align="left" | key<br />
! align="left" | value<br />
|-<br />
| heading ||<br />
|-<br />
| id || The ID of the [[Ion_storm|Ion Storm]]<br />
|-<br />
| isgrowing || A boolean value indicating if the ion storm is growing (strengthening)<br />
|-<br />
| radius || The radius of the ion storm in light years<br />
|-<br />
| voltage || The current voltage (strength) of the ion storm<br />
|-<br />
| warp || The speed at which the ion storm is travelling<br />
|-<br />
| x || The x coordinate of the ion storm's current position<br />
|-<br />
| y || The y coordinate of the ion storm's current position<br />
|}<br />
<br />
==Message Object==<br />
<br />
The message object returned by Load Turn Info is a dictionary with the following keys:<br />
<br />
{| cellspacing="0" cellpadding="5" style="white-space:nowrap;" border="1"<br />
|-bgcolor=lightblue<br />
! align="left" | key<br />
! align="left" | value<br />
|-<br />
| body || The body of the message. May contain HTML line breaks<br />
|-<br />
| headline || The title of the message<br />
|-<br />
| id || The ID of the message<br />
|-<br />
| messagetype || The [[#Message Types|type]] of message.<br />
|-<br />
| ownerid || The recipient of the message<br />
|-<br />
| target || The ID of the subject of the message based on the context (Ship, Planet, etc) or the sender in the case of a diplomatic message<br />
|-<br />
| turn || The game turn in which the message was received<br />
|-<br />
| x || The x coordinate of the event described, may only be useful in certain contexts<br />
|-<br />
| y || The y coordinate of the event described, may only be useful in certain contexts<br />
|}<br />
<br />
===Message Types===<br />
<br />
The message types indicated by the <i>messagetype</i> field in the message object are as follows:<br />
<br />
* 0: Outbound <br />
* 1 : System <br />
* 2 : Terraforming <br />
* 3 : Minelaying <br />
* 4 : Mine Sweep <br />
* 5 : Colony <br />
* 6 : Combat <br />
* 7 : Fleet <br />
* 8 : Ship <br />
* 9 : Enemy Distress Call<br />
* 10 : Explosion <br />
* 11 : Starbase <br />
* 12 : Web Mines <br />
* 13 : Meteors <br />
* 14 : Sensor Sweep<br />
* 15 : Bio Scan <br />
* 16 : DistressCall <br />
* 17 : Player <br />
* 18 : Diplomacy <br />
* 19 : MineScan<br />
* 20 : Dark Sense <br />
* 21 : Hiss<br />
<br />
==Minefield Object==<br />
<br />
The minefield object returned by Load Turn Info is a dictionary with the following keys:<br />
<br />
{| cellspacing="0" cellpadding="5" style="white-space:nowrap;" border="1"<br />
|-bgcolor=lightblue<br />
! align="left" | key<br />
! align="left" | value<br />
|-<br />
| friendlycode || The friendly code to safely pass through the minefield, if known<br />
|-<br />
| id || The ID of the minefield<br />
|-<br />
| infoturn || The turn the minefield information was last updated<br />
|-<br />
| isweb || A boolean value indicating if the minefield is a web mine<br />
|-<br />
| ownerid || The player ID that owns the minefield<br />
|-<br />
| radius || The last known radius of the minefield<br />
|-<br />
| units ||<br />
|-<br />
| x || The x coordinate of the center of the minefield<br />
|-<br />
| y || The y coordinate of the center of the minefield<br />
|}<br />
<br />
==Nebula Object==<br />
<br />
The nebula object returned by Load Turn Info is a dictionary with the following keys:<br />
<br />
{| cellspacing="0" cellpadding="5" style="white-space:nowrap;" border="1"<br />
|-bgcolor=lightblue<br />
! align="left" | key<br />
! align="left" | value<br />
|-<br />
| <i>n/a</i> || <i>This is a stub, please fill this out</i><br />
|}<br />
<br />
==Note Object==<br />
<br />
The note object returned by Load Turn Info is a dictionary with the following keys:<br />
<br />
{| cellspacing="0" cellpadding="5" style="white-space:nowrap;" border="1"<br />
|-bgcolor=lightblue<br />
! align="left" | key<br />
! align="left" | value<br />
|-<br />
| body || The text body of the note<br />
|-<br />
| color || The hexadecimal color of the noted entity on the map<br />
|-<br />
| id || The ID of the note<br />
|-<br />
| ownerid || The player ID that created the note<br />
|-<br />
| targetid || The ID of the entity the note belongs to<br />
|-<br />
| targettype || The type of entity the note belongs to<br />
|}<br />
<br />
<i>If anyone has a clear list of what targettype IDs are possible, please add it here</i><br />
<br />
==Planet Object==<br />
<br />
The planet object returned by Load Turn Info is a dictionary with the following keys:<br />
<br />
{| cellspacing="0" cellpadding="5" style="white-space:nowrap;" border="1"<br />
|-bgcolor=lightblue<br />
! align="left" | key<br />
! align="left" | value<br />
|-<br />
| buildingstarbase || A boolean value indicating if the planet is currently building a starbase<br />
|-<br />
| builtdefense || The number of defense posts being built this turn<br />
|-<br />
| builtfactories || The number of factories being built this turn<br />
|-<br />
| builtmines || The number of mines being build this turn<br />
|-<br />
| checkduranium ||<br />
|-<br />
| checkmegacredits ||<br />
|-<br />
| checkmolybdenum ||<br />
|-<br />
| checkneutronium ||<br />
|-<br />
| checksupplies ||<br />
|-<br />
| checktritanium ||<br />
|-<br />
| clans || The number of clans populating the planet<br />
|-<br />
| colchange ||<br />
|-<br />
| colhappychange || The increase or decrease of happiness points on the planet this turn<br />
|-<br />
| colonisthappypoints || The current happiness level of the colonists on the planet<br />
|-<br />
| colonisttaxrate || The current tax rate (from 1 to 100)<br />
|-<br />
| debrisdisk ||<br />
|-<br />
| defense || The total number of defense posts on the planet<br />
|-<br />
| densityduranium ||<br />
|-<br />
| densitymolybdenum ||<br />
|-<br />
| densityneutronium ||<br />
|-<br />
| densitytritanium ||<br />
|-<br />
| duranium || The amount of duranium sitting on the surface of the planet<br />
|-<br />
| factories || The total number of factories on the planet<br />
|-<br />
| flag ||<br />
|-<br />
| friendlycode || The planet's friendly code<br />
|-<br />
| groundduranium ||<br />
|-<br />
| groundmolybdenum ||<br />
|-<br />
| groundneutronium ||<br />
|-<br />
| groundtritanium ||<br />
|-<br />
| id || The ID of the planet<br />
|-<br />
| img || A url to the image of the planet<br />
|-<br />
| infoturn || The turn in which the information of this planet was last updated<br />
|-<br />
| megacredits || The megacredits available on the planet<br />
|-<br />
| mines || The total number of mines on the planet<br />
|-<br />
| molybdenum || The amount of molybdenum sitting on the surface of the planet<br />
|-<br />
| name || The name of the planet<br />
|-<br />
| nativechange ||<br />
|-<br />
| nativeclans || The number of clans of natives populating the planet<br />
|-<br />
| nativegovernment || The ID representing the government type of the native life on the planet<br />
|-<br />
| nativegovernmentname || The text name of the government type of the native life on the planet<br />
|-<br />
| nativehappychange || The increase or decrease in happy points for the native life on the planet this turn<br />
|-<br />
| nativehappypoints || The overall happiness points for the native life on the planet this turn<br />
|-<br />
| nativeracename || The text name of the native race populating the planet<br />
|-<br />
| nativetaxrate || The current tax rate (from 1 to 100) for the native race on the planet<br />
|-<br />
| nativetaxvalue ||<br />
|-<br />
| nativetype || The ID representing the race of native life on the planet<br />
|-<br />
| neutronium || The amount of neutronium sitting on the surface of the planet<br />
|-<br />
| ownerid || The player ID currently in control of the planet<br />
|-<br />
| readystatus ||<br />
|-<br />
| supplies || The amount of supplies sitting on the surface of the planet <br />
|-<br />
| suppliessold || The number of supplies converted to megacredits on the planet this turn<br />
|-<br />
| targetdefense || The target value for defense posts in the auto-build queue<br />
|-<br />
| targetfactories || The target value for factories in the auto-build queue<br />
|-<br />
| targetmines || The target value for mines in the auto-build queue<br />
|-<br />
| temp || The temperature on the planet (from 0-100) or -1 if unknown<br />
|-<br />
| totalduranium ||<br />
|-<br />
| totalmolybdenum ||<br />
|-<br />
| totalneutronium ||<br />
|-<br />
| totaltritanium ||<br />
|-<br />
| tritanium || The amount of tritanium sitting on the surface of the planet<br />
|-<br />
| x || The x coordinate of the planet in space<br />
|-<br />
| y || The y coordinate of the planet in space<br />
|}<br />
<br />
==Player Object==<br />
<br />
The player object returned by Load Game Info is a dictionary with the following keys:<br />
<br />
{| cellspacing="0" cellpadding="5" style="white-space:nowrap;" border="1"<br />
|-bgcolor=lightblue<br />
! align="left" | key<br />
! align="left" | value<br />
|-<br />
| activeadvantages ||<br />
|-<br />
| activehulls || The hulls (by ID) allowed for use by the player<br />
|-<br />
| email ||<br />
|-<br />
| finishrank ||<br />
|-<br />
| id || The ID of the player for the current game<br />
|-<br />
| isregistered || Indicates if the player is registered (paid subscription)<br />
|-<br />
| levelhullid ||<br />
|-<br />
| levelid ||<br />
|-<br />
| planets || The number of planets the player controls in the current game<br />
|-<br />
| prioritypoints || The number of [[Priority_Build_Points|priority points]] the player has at their disposal<br />
|-<br />
| raceid || The race ID of the player in the current game<br />
|-<br />
| savekey ||<br />
|-<br />
| score || The [[#Score Object|score object]] for the player in the current game<br />
|-<br />
| ships || The number of ships (war ships and freighters) the player currently controls<br />
|-<br />
| starbases || The number of starbases the player controls in the current game<br />
|-<br />
| status ||<br />
|-<br />
| statusturn ||<br />
|-<br />
| teamid ||<br />
|-<br />
| turnjoined || The turn at which the player joined the current game<br />
|-<br />
| turnready || Indicates if the players turn is ready (finished)<br />
|-<br />
| turnsmissed ||<br />
|-<br />
| turnstatus ||<br />
|-<br />
| username || The Planets.NU username of the player<br />
|}<br />
<br />
<br />
<br />
==Player Settings Object==<br />
<br />
The player settings object returned by Login and Load Turn is a dictionary with the following keys:<br />
<br />
{| cellspacing="0" cellpadding="5" style="white-space:nowrap;" border="1"<br />
|-bgcolor=lightblue<br />
! align="left" | key<br />
! align="left" | value<br />
|-<br />
| allymines || A hex RGB color code for allied minefields<br />
|-<br />
| allyplanetfrom ||<br />
|-<br />
| allyplanetto ||<br />
|-<br />
| allyshipfrom ||<br />
|-<br />
| allyshipto ||<br />
|-<br />
| assistanton ||<br />
|-<br />
| battletaskid ||<br />
|-<br />
| battletutorialid ||<br />
|-<br />
| enemymines || A hex RGB color code for enemy minefields<br />
|-<br />
| enemyplanetfrom ||<br />
|-<br />
| enemyplanetto ||<br />
|-<br />
| enemyshipfrom ||<br />
|-<br />
| enemyshipto ||<br />
|-<br />
| id ||<br />
|-<br />
| infoplanetfrom ||<br />
|-<br />
| infoplanetto ||<br />
|-<br />
| ionstorms || A hex RGB color code for ion storms<br />
|-<br />
| musicon ||<br />
|-<br />
| mymines || A hex RGB color code for the current player's minefields<br />
|-<br />
| myplanetfrom ||<br />
|-<br />
| myplanetto ||<br />
|-<br />
| myshipfrom ||<br />
|-<br />
| myshipto ||<br />
|-<br />
| soundon ||<br />
|-<br />
| unknownplanetfrom ||<br />
|-<br />
| unknownplanetto ||<br />
|-<br />
| webmines || A hex RGB color code for webmines<br />
|}<br />
<br />
<br />
==Race Object==<br />
<br />
The race object returned by Load Turn Info is a dictionary with the following keys:<br />
<br />
{| cellspacing="0" cellpadding="5" style="white-space:nowrap;" border="1"<br />
|-bgcolor=lightblue<br />
! align="left" | key<br />
! align="left" | value<br />
|-<br />
| adjective || The adjective used to describe the race's ships and planets<br />
|-<br />
| advantages ||<br />
|-<br />
| baseadvantages ||<br />
|-<br />
| basehulls || The base set of hulls (by Hull ID) available to the race<br />
|-<br />
| hulls ||<br />
|-<br />
| id || The race ID<br />
|-<br />
| name || The full name of the race<br />
|-<br />
| shortname || The shorter version of the race name<br />
|}<br />
<br />
==Relation Object==<br />
<br />
The relation object returned by Load Game Info is a dictionary with the following keys:<br />
<br />
{| cellspacing="0" cellpadding="5" style="white-space:nowrap;" border="1"<br />
|-bgcolor=lightblue<br />
! align="left" | key<br />
! align="left" | value<br />
|-<br />
| color ||<br />
|-<br />
| conflictlevel ||<br />
|-<br />
| id ||<br />
|-<br />
| playerid ||<br />
|-<br />
| playertoid ||<br />
|-<br />
| relationfrom ||<br />
|-<br />
| relationto ||<br />
|}<br />
<br />
<br />
==Score Object==<br />
<br />
The score object is a dictionary with the following keys:<br />
<br />
{| cellspacing="0" cellpadding="5" style="white-space:nowrap;" border="1"<br />
|-bgcolor=lightblue<br />
! align="left" | key<br />
! align="left" | value<br />
|-<br />
| capitalships ||<br />
|-<br />
| dateadded ||<br />
|-<br />
| freighters ||<br />
|-<br />
| id ||<br />
|-<br />
| inventoryscore ||<br />
|-<br />
|militaryscore ||<br />
|-<br />
|ownerid ||<br />
|-<br />
|percent ||<br />
|-<br />
|planets ||<br />
|-<br />
|prioritypoints ||<br />
|-<br />
| starbases ||<br />
|-<br />
| turn ||<br />
|}<br />
<br />
<br />
==Ship Object==<br />
<br />
The ship object returned by Load Turn Info is a dictionary with the following keys:<br />
<br />
{| cellspacing="0" cellpadding="5" style="white-space:nowrap;" border="1"<br />
|-bgcolor=lightblue<br />
! align="left" | key<br />
! align="left" | value<br />
|-<br />
| ammo || The number of Torpedos or Fighters present on the ship<br />
|-<br />
| bays || The number of fighter bays on the ship<br />
|-<br />
| beamid || The type of beam weapons installed on the ship. This corresponds to an entry in the [[#Beam Object|beam object]] array<br />
|-<br />
| beams || The number of installed beam weapons on the ship<br />
|-<br />
| clans || The number of clans in the ship's cargo hold<br />
|-<br />
| crew || The number of active crew members aboard the ship <br />
|-<br />
| damage || The amount of damage sustained on the ship<br />
|-<br />
| duranium || The amount of duranium in the ship's cargo hold<br />
|-<br />
| enemy || The primary enemy assigned to the ship<br />
|-<br />
| engineid || The type of engine installed on the ship<br />
|-<br />
| experience || The experience of the crew on the ship<br />
|-<br />
| friendlycode || The friendly code assigned to the ship<br />
|-<br />
| heading || <br />
|-<br />
| history || An array of (x,y) coordinates (as a dictionary) indicating the previous positions of the ship<br />
|-<br />
| hullid || The [[#Hull Object|hull]] used in the ship<br />
|-<br />
| id || The ID of the ship<br />
|-<br />
| infoturn || The last turn the information about the ship was updated<br />
|-<br />
| iscloaked || A boolean value indicating if the ship is cloaked or not<br />
|-<br />
| mass || The total mass of the ship including all cargo<br />
|-<br />
| megacredits || The amount of megacredits on board the ship<br />
|-<br />
| mission || The current mission being performed on the ship<br />
|-<br />
| mission1target ||<br />
|-<br />
| mission2target ||<br />
|-<br />
| molybdenum || The amount of molybdenum in the ship's cargo hold<br />
|-<br />
| name || The name of the ship<br />
|-<br />
| neutronium || The amount of neutronium (fuel) in the ship's fuel tank<br />
|-<br />
| ownerid || The player ID of the owner of the ship<br />
|-<br />
| readystatus ||<br />
|-<br />
| supplies || The amount of supplies in the ship's cargo hold<br />
|-<br />
| targetx || The x coordinate of the flight path target for the ship<br />
|-<br />
| targety || The y coordinate of the flight path target for the ship<br />
|-<br />
| torpedoid || The ID of the [[#Torpedo Object|torpedo launchers]] installed in the ship<br />
|-<br />
| torps || The number of torpedo launchers installed in the ship<br />
|-<br />
| transferammo ||<br />
|-<br />
| transferclans ||<br />
|-<br />
| transferduranium ||<br />
|-<br />
| transfermegacredits ||<br />
|-<br />
| transfermolybdenum ||<br />
|-<br />
| transferneutronium ||<br />
|-<br />
| transfersupplies ||<br />
|-<br />
| transfertargetid ||<br />
|-<br />
| transfertargettype ||<br />
|-<br />
| transfertritanium ||<br />
|-<br />
| tritanium || The amount of tritanium in the ship's cargo hold<br />
|-<br />
| turn ||<br />
|-<br />
| turnkilled ||<br />
|-<br />
| warp || The current warp speed of the ship<br />
|-<br />
| waypoints ||<br />
|-<br />
| x || The x coordinate of the ship's current position in space<br />
|-<br />
| y || The y coordinate of the ship's current position in space<br />
|}<br />
<br />
==Star Object==<br />
<br />
The star object returned by Load Turn Info is a dictionary with the following keys:<br />
<br />
{| cellspacing="0" cellpadding="5" style="white-space:nowrap;" border="1"<br />
|-bgcolor=lightblue<br />
! align="left" | key<br />
! align="left" | value<br />
|-<br />
| <i>n/a</i> || <i>This is a stub, please fill this out</i><br />
|}<br />
<br />
==Starbase Object==<br />
<br />
The starbase object returned by Load Turn Info is a dictionary with the following keys:<br />
<br />
{| cellspacing="0" cellpadding="5" style="white-space:nowrap;" border="1"<br />
|-bgcolor=lightblue<br />
! align="left" | key<br />
! align="left" | value<br />
|-<br />
| beamtechlevel || The tech level for beam weapons on the starbase<br />
|-<br />
| beamtechup || The level raised of the beam tech in the current turn<br />
|-<br />
| buildbeamcount ||<br />
|-<br />
| buildbeamid ||<br />
|-<br />
| buildengineid ||<br />
|-<br />
| buildhullid ||<br />
|-<br />
| buildtorpcount ||<br />
|-<br />
| buildtorpedoid ||<br />
|-<br />
| builtdefense || The number of starbase defense points added this turn<br />
|-<br />
| builtfighters || The number of fighters built this turn<br />
|-<br />
| damage || The current damage level of the starbase<br />
|-<br />
| defense || The total defense points on the starbase<br />
|-<br />
| enginetechlevel || The tech level for engines on the starbase<br />
|-<br />
| enginetechup || The level raised of the engine tech in the current turn<br />
|-<br />
| fighters || The number of fighters currently on the starbase<br />
|-<br />
| hulltechlevel || The tech level for hulls on the starbase<br />
|-<br />
| hulltechup || The level raised of the hull tech in the current turn<br />
|-<br />
| id || The ID of the starbase<br />
|-<br />
| infoturn || The last turn the information on this starbase was updated<br />
|-<br />
| isbuilding || <br />
|-<br />
| mission ||<br />
|-<br />
| planetid || The planet this starbase belongs to<br />
|-<br />
| raceid || <br />
|-<br />
| readystatus ||<br />
|-<br />
| shipmission ||<br />
|-<br />
| starbasetype ||<br />
|-<br />
| targetshipid || The ship targeted by the current mission (if applicable)<br />
|-<br />
| torptechlevel || The tech level for torpedos on the starbase<br />
|-<br />
| torptechup || The level raised of the torpedo tech in the current turn<br />
|}<br />
<br />
<br />
==Stock Item Object==<br />
<br />
The stock item object returned by Load Turn Info is a dictionary with the following keys:<br />
<br />
{| cellspacing="0" cellpadding="5" style="white-space:nowrap;" border="1"<br />
|-bgcolor=lightblue<br />
! align="left" | key<br />
! align="left" | value<br />
|-<br />
| amount || The quantity of the stock item on the starbase<br />
|-<br />
| builtamount ||<br />
|-<br />
| id || The ID of the stock item<br />
|-<br />
| starbaseid || The ID of the starbase that the stock item belongs to<br />
|-<br />
| stockid || The ID of the type of item in stock (looked up in the table corresponding to stocktype)<br />
|-<br />
| stocktype || The type of item in stock<br />
|}<br />
<br />
<br />
==Torpedo Object==<br />
<br />
The torpedo object returned by Load Turn Info is a dictionary with the following keys:<br />
<br />
{| cellspacing="0" cellpadding="5" style="white-space:nowrap;" border="1"<br />
|-bgcolor=lightblue<br />
! align="left" | key<br />
! align="left" | value<br />
|-<br />
| crewkill || The number of crew the torpedo will kill if the shields of the target ship are down<br />
|-<br />
| damage || The damage that the particular torpedo will do to the hull or shield of a ship<br />
|-<br />
| duranium || The amount of duranium required to build the torpedo<br />
|-<br />
| id || The torpedo ID referenced by other objects, such as the [[#Ship Object|Ship Object]]<br />
|-<br />
| launchercost || The amount of megacredits required to build the torpedo launcher<br />
|-<br />
| mass || The mass of the torpedo when constructed<br />
|-<br />
| molybdenum || The amount of molybdenum required to build the torpedo<br />
|-<br />
| name || The name of the torpedo<br />
|-<br />
| techlevel || The tech level required at the starbase to build the torpedo laucher and ammo<br />
|-<br />
| torpedocost || The amount of megacredits required to build the torpedo ammo<br />
|-<br />
| tritanium || The amount of tritanium required to build the torpedo<br />
|}<br />
<br />
<br />
==VCR Object==<br />
<br />
The vcr (visual combat recording) object returned by Load Turn Info is a dictionary with the following keys:<br />
<br />
{| cellspacing="0" cellpadding="5" style="white-space:nowrap;" border="1"<br />
|-bgcolor=lightblue<br />
! align="left" | key<br />
! align="left" | value<br />
|-<br />
| <i>n/a</i> || <i>This is a stub, please fill this out</i><br />
|}<br />
<br />
=References=<br />
<br />
[http://planets.nu/api-documentation Official API Documentation]</div>HandsomeCamhttps://vgaplanets.org/index.php?title=Glory_Device&diff=3066Glory Device2012-11-29T17:57:03Z<p>HandsomeCam: </p>
<hr />
<div>== Overview ==<br />
<br />
The Glory Device is a hull specific self-destruct feature of the [[D19b Nefarious Class Destroyer]] and the [[Saber Class Frigate]]. Although both of these hull models belong exclusively to the Fascist fleets, the device can be triggered by any race in possession of a ship equipped with the device.<br />
<br />
== Conditions ==<br />
There are two principle activation triggers for the Glory Device:<br />
* Manual Trigger<br />
** By setting the friendly code of the ship to "pop" the glory device will be activated. The ship does not need fuel, however it will fail to trigger if it is destroyed by a [[mine hit]] or an [[ion storm]].<br />
* Cloak Detection Trigger<br />
** By setting the friendly code of the ship to "trg" the glory device will activate if certain criteria are met:<br />
*** The Glory Device ship and a cloaked enemy ship are present, the Glory Device ship has it's mission set to KILL and has at least 1kt of fuel.<br />
*** The Glory Device ship and a cloaked enemy ship are present and the Glory Device ship has the primary enemy set to that of the cloaked ship (no fuel requirements). <br />
<br />
== Actions ==<br />
When triggered, the devices detonates the ship and causes 1 mine hit worth of damage to all ships at the location AFTER the movement phase. Fascist ships, along with ships belonging to the player who owns the Glory Device ship take only 20% (or 10% if a Saber detonates) of a mine hit worth of damage.<br />
<br />
When a glory device is triggered over an enemy planet the following additional damage will be done:<br />
* 40% of all colonists will be killed. [[The Lizard Alliance|Lizard]] and [[The Crystal Confederation|Crystalline]] colonists are immune.<br />
* 40% of all natives will also be killed. Siliconoid, Reptilian, and Bovinoid natives are immune.<br />
* 25% of all planetary structures will be destroyed<br />
<br />
Lastly, the glory device can be used to rid a planet of Amorphous natives, converting them into supplies.<br />
<br />
== Addons ==<br />
=== [[Stellar Cartography]] ===<br />
Any non-[[The Robotic Imperium|Robotic]] ships that get hit by a glory device while in radiation will immediately take a loss in crew and colonists equal to the radiation due to the sudden hull breach.<br />
<br />
== References ==<br />
[http://www.donovansvgap.com/help/glory.htm Glory Device from Donovan's Super Site]<br />
<br />
[[Category:Hull Functions]]</div>HandsomeCamhttps://vgaplanets.org/index.php?title=Siliconoids&diff=3065Siliconoids2012-11-29T17:55:37Z<p>HandsomeCam: </p>
<hr />
<div>Siliconoids are a [[native]] race found on [[planet|planets]] scattered throughout the galaxy.<br />
<br />
Siliconoids in particular have the capacity to give you free level 10 [[Torpedo]] tech level when you build a [[starbase]] on their [[planet]].<br />
<br />
[[Category:Native Races]]</div>HandsomeCamhttps://vgaplanets.org/index.php?title=White_Falcon_Class_Cruiser&diff=3064White Falcon Class Cruiser2012-11-29T17:55:21Z<p>HandsomeCam: </p>
<hr />
<div>{{Ship<br />
|ShipName=White Falcon Class Cruiser |Races= [[The_Empire_of_Birds|The Empire of Birds]] |Comments= |Notes= }}<br />
<br />
[[Category:Ships]]</div>HandsomeCamhttps://vgaplanets.org/index.php?title=Supplies&diff=3063Supplies2012-11-29T17:53:16Z<p>HandsomeCam: </p>
<hr />
<div>= Overview =<br />
The supplies produced by your [[factories]] can be carried by [[starship]] to new [[planets]] to be used to build new [[Planetary Structures]].You can also sell supply units for one [[megacredit]] each.<br />
<br />
[[Alchemy|Alchemy ships]] can use supplies to make [[minerals]] and [[fuel]].<br />
<br />
Supplies are also used to [[repair]] [[damage]]d [[ships]]. Five [[mass|KT]] units of supplies will [[repair]] 1% of damage to a [[starship]] (''automatically''). <br />
[[Category:Resources]]</div>HandsomeCamhttps://vgaplanets.org/index.php?title=Supllies&diff=3062Supllies2012-11-29T17:52:16Z<p>HandsomeCam: Redirected page to Supplies</p>
<hr />
<div>#REDIRECT:[[Supplies]]</div>HandsomeCamhttps://vgaplanets.org/index.php?title=Starbase_Missions&diff=3061Starbase Missions2012-11-29T17:50:12Z<p>HandsomeCam: Removed double title</p>
<hr />
<div>A.K.A. Primary Mission or Primary Orders<br />
<br />
*'''None''' - just as it says....none!<br />
*'''Refuel'''- - the [[starbase]] will load [[neutronium]] onto any [[ship]] at the bases location that is of your [[race]] or have the same [[friendly code]] as the [[planet]].<br />
*'''Max Defense!''' - The [[starbase]] will automatically build up [[defense]] strength to max.<br />
*'''Load torps onto ships''' - [[starbase]] will automatically load [[torpedo]]es of the proper type onto all [[ships]] that have [[torpedo]] [[launch tubes]]. The [[ship]]s must be yours or have the same [[friendly code]] as the [[starbase]].<br />
*'''Unload all freighters''' - The [[starbase]] will automatically unload all [[cargo]] and [[megacredits]] from [[ships]] at the [[starbase]] location that are of your [[race]] or have the same [[friendly code]] as the [[starbase]].<br />
*'''Repair Base''' - The [[starbase]] will [[repair]] [[damage]] done to the [[starbase]] by enemy [[ships]].<br />
*'''Force a surrender''' - The [[starbase]] will force all "enemy" [[ships]] with the same [[friendly code]] as the [[starbase]] to [[surrender]] to the [[starbase]]. [[Ships]] without [[fuel]] will [[surrender]] no matter what the [[friendly codes]] are.</div>HandsomeCamhttps://vgaplanets.org/index.php?title=Golem_Class_Baseship&diff=3060Golem Class Baseship2012-11-29T17:47:41Z<p>HandsomeCam: </p>
<hr />
<div>{{Ship<br />
|ShipName=Golem Class Baseship |Races=[[The_Robotic_Imperium|The Robotic Imperium]] |Comments= |Notes= }}<br />
<br />
[[Category:Ships]]</div>HandsomeCamhttps://vgaplanets.org/index.php?title=Golem_Class_Baseship&diff=3059Golem Class Baseship2012-11-29T17:47:21Z<p>HandsomeCam: </p>
<hr />
<div>{{Ship<br />
|ShipName=Golem Class Baseship |Races=[[The_Robotic_Imperium]] |Comments= |Notes= }}<br />
<br />
[[Category:Ships]]</div>HandsomeCamhttps://vgaplanets.org/index.php?title=Ammunition&diff=3058Ammunition2012-11-29T17:46:19Z<p>HandsomeCam: </p>
<hr />
<div>the only known ammunition is this game, is [[torpedo]]es.</div>HandsomeCamhttps://vgaplanets.org/index.php?title=Bloodfang_Class_Carrier&diff=3057Bloodfang Class Carrier2012-11-29T17:46:01Z<p>HandsomeCam: Added link to privateers</p>
<hr />
<div>{{Ship<br />
|ShipName=Bloodfang Class Carrier |Races=[[The Privateer Bands]] |Comments= |Notes= }}<br />
<br />
[[Category:Ships]]</div>HandsomeCamhttps://vgaplanets.org/index.php?title=Lady_Royale_Class_Cruiser&diff=3056Lady Royale Class Cruiser2012-11-29T17:43:11Z<p>HandsomeCam: </p>
<hr />
<div>{{Ship<br />
|ShipName=Lady Royale Class Cruiser<br />
|Races=Privateers, Colonies<br />
|Comments=The LRCC, a pleasure/gambling/cruise ship, can 'create' megacredits at the rate of 1 MC per clan on board.<br />
|Notes=Probably most useful to the Privateers, who do not require much money to produce MBRs, and for the large fuel tanks during [[Rob]] missions<br />
}}<br />
<br />
[[Category:Ships]]</div>HandsomeCamhttps://vgaplanets.org/index.php?title=Tac&diff=3055Tac2012-11-29T05:21:39Z<p>HandsomeCam: Redirected page to Tachyon Device</p>
<hr />
<div>#REDIRECT:[[Tachyon_Device]]</div>HandsomeCamhttps://vgaplanets.org/index.php?title=Killicams&diff=3054Killicams2012-11-29T03:12:26Z<p>HandsomeCam: </p>
<hr />
<div>The measure of distance within the [[VCR]] beggining at 60,000 killicams when [[fighter]]s launch and [[beams]] can fire at [[fighter]]s, to 30,000 killicams when [[torpedo]]es fire, to 20000 killicams when [[beams]] fire at enemy ships.</div>HandsomeCamhttps://vgaplanets.org/index.php?title=Warp_Wells&diff=3053Warp Wells2012-11-29T03:09:58Z<p>HandsomeCam: Fixed link to gravitonic page</p>
<hr />
<div>[[File:warpwell-1.jpg|300px|thumb|right|Warp well surrounds each planet]]<br />
Planets are surrounded by a '''warp well''', a region of space approximately 3 light-years in radius in which ships exiting warp speed travel will be sucked into planetary orbit.<br />
<br />
The warp well consists of 28 points: the 8 points immediately next to the planet (+/- 1 ly); the 16 points surrounding those (+/- 2 ly from the planet), and then 4 points directly above, below, left and right of the planet, exactly 3 ly away.<br />
<br />
Any ship that ends ''movement'' at warp 2 or greater in one of these points will be sucked into the planet's orbit. This gravity-assisted movement requires no [[neutronium|fuel]], and cannot be avoided. Ships can move within the warpwell at warp 1 and not be sucked into the planet. [[Gravitonic_Accelerator|Gravitonic]] ships may also move at warp 1 within the warpwell, they will travel 2 ly and not be sucked into the planet's orbit. Ships sitting in the warp well but not moving will not be sucked to the planet no matter their warp setting. Ships being towed to a planet's warp well will continue to be towed to the planet (even if the towing ship is out of fuel by the time it arrives). [[hyperjump|Hyperjumping]] ships are also subject to the warpwell, but only for 16 of the 20 points -- the 4 points 3.0 ly away (top, bottom, left, right) are not considered part of the warpwell for hyperjumping ships.<br />
<br />
Strategy points with warpwells include:<br />
* setting ship waypoint to the edge of the warpwell to shorten the journey by 2-3 ly, thereby saving fuel<br />
* moving within warpwell at warp-1, thereby preventing intercept by ships traveling faster than warp-1</div>HandsomeCamhttps://vgaplanets.org/index.php?title=Mass&diff=3052Mass2012-11-29T03:04:21Z<p>HandsomeCam: Removed double title</p>
<hr />
<div>Mass specifically is a measure of weight and volume in space and represents a measure of inertia. <br />
more mass generally constitutes larger or more densely packed items. Any ship or cargo within the game has mass. <br />
Megacredits have a negligible mass. <br />
<br />
The larger a ship's mass, the more [[Fuel]] is required to move the ship (increasing the cost of acceleration and deceleration).<br />
<br />
===Kilotons===<br />
Kilotons are the units of measure for mass. More kilotons is more mass. Anything with a weight in kilotons is Mass. Kiloton is often abbreviated with '''KT''' or '''kt'''</div>HandsomeCamhttps://vgaplanets.org/index.php?title=Hull_Tech_Level&diff=3051Hull Tech Level2012-11-29T03:03:43Z<p>HandsomeCam: minor formatting</p>
<hr />
<div>Hull tech levels are required for building the hulls of your race specific Ships.<br />
Each Player Race has its own specific hull list and tech level requirement for it to be built.<br />
*see [[ship List]] for more details on tech level requirements<br />
<BR><br />
<br />
[[category:Tech Levels]]</div>HandsomeCamhttps://vgaplanets.org/index.php?title=GD&diff=3050GD2012-11-29T03:02:36Z<p>HandsomeCam: Redirected page to Glory Device</p>
<hr />
<div>#REDIRECT:[[Glory_Device]]</div>HandsomeCamhttps://vgaplanets.org/index.php?title=Grav&diff=3049Grav2012-11-29T03:01:04Z<p>HandsomeCam: Redirected page to Gravitonic Accelerator</p>
<hr />
<div>#REDIRECT:[[Gravitonic_Accelerator]]</div>HandsomeCamhttps://vgaplanets.org/index.php?title=Chunnel&diff=3048Chunnel2012-11-29T02:57:17Z<p>HandsomeCam: Chunnel redirect to Warp Chunnel</p>
<hr />
<div>#REDIRECT:[[Warp_Chunnel]]</div>HandsomeCamhttps://vgaplanets.org/index.php?title=Alc&diff=3047Alc2012-11-29T02:56:00Z<p>HandsomeCam: Add redirect from Alc to Alchemy</p>
<hr />
<div>#REDIRECT [[Alchemy]]</div>HandsomeCamhttps://vgaplanets.org/index.php?title=Planets.Nu_API&diff=3044Planets.Nu API2012-11-27T22:27:06Z<p>HandsomeCam: /* Load Turn Data */ fixed a link typo</p>
<hr />
<div>On December 21, 2011, [[VGA_Planets_Nu|Planets.Nu]] opened up an API for developers.<br />
<br />
=Public API=<br />
<br />
The public API calls consist of:<br />
<br />
* [[#Login|Login]] - Use this to acquire the apikey of a given player. <br />
* [[#List Games|List Games]] - List the games on the Planets Nu platform in various ways<br />
* [[#Load Game Info|Load Game Info]] - Load the publicly available data about a single game<br />
* [[#Load Turn Data|Load Turn Data]] - Load a single players complete turn package<br />
<br />
==Errors==<br />
<br />
API calls return a JSON dictionary. In the event of an API call failure, the following dictionary will be returned:<br />
<br />
{"success":false,"error":"This is the error message."}<br />
<br />
on occasion, instead of a JSON dictionary the following text is returned:<br />
<br />
Error: <i>Error Description Here</i><br />
<br />
==Login==<br />
<br />
The login API returns an API key which can be used along with a username for subsequent API calls.<br />
<br />
The login command is an HTTP GET to http://api.planets.nu/login with the following values passed on the connection string:<br />
<br />
{| cellspacing="0" cellpadding="5" style="white-space:nowrap;" border="1"<br />
|-bgcolor=lightblue<br />
! align="left" | variable<br />
! align="left" | description<br />
! align="left" | Required<br />
! align="center" | Default Value<br />
|-<br />
| username || account username || YES || n/a<br />
|-<br />
| password || account password || YES || n/a<br />
|}<br />
<br />
Example:<br />
<br />
<code>http:/<nowiki />/api.planets.nu/login?username=user12345&password=straightouttagalibor</code><br />
<br />
The response is a JSON dictionary with the following keys:<br />
<br />
{| cellspacing="0" cellpadding="5" style="white-space:nowrap;" border="1"<br />
|-bgcolor=lightblue<br />
! align="left" | key<br />
! align="left" | value<br />
|-<br />
| success || Indicates if the call was successful (true or false)<br />
|-<br />
| apikey || The API key used in other requests. An API key is formatted as: <code>xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx</code> where any <code>x</code> is a hexadecimal value.<br />
|-<br />
| settings || The current [[#Player Settings Object|player's settings object]] <br />
|}<br />
<br />
The API key is used for subsequent API calls for the given account. This is the API Key of the account and will only change if the user changes their account password.<br />
<br />
==List Games==<br />
<br />
The list games API returns detailed information about all games on the Planets Nu website or for an individual player. This API is a public API and does not require authentication. <br />
<br />
The list games command is a GET call to http://api.planets.nu/games/list<br />
<br />
The following variables are all optional:<br />
<br />
{| cellspacing="0" cellpadding="5" style="white-space:nowrap;" border="1"<br />
|-bgcolor=lightblue<br />
! align="left" | variable<br />
! align="left" | description<br />
! align="left" | Required<br />
! align="center" | Default Value<br />
|-<br />
| status || Current status of games to return, with multiple values joined by commas.<br />Possible values are:<br/>1 : Joining<br />2 : Running<br/>3 : Finished<br/>4 : Hold || NO || 1,2<br />
|-<br />
| type || The type of games to return, with multiple values joined by commas.<br />Possible values are:<br/>1 : Training<br />2 : Standard<br />3 : Team<br />4 : Melee<br />5 : Blitz || NO || 2,3,4<br />
|-<br />
| scope || Current scope of games to return, with multiple values joined by commas.<br />Possible values are:<br/>0 : Public<br />1 : Custom (private games) || NO || 0<br />
|-<br />
| ids || IDs of games to return, comma separated || NO || n/a<br />
|-<br />
| username || Username of the account to list games. Will list all games for this user regardless of other settings || NO || n/a<br />
|-<br />
| limit || The maximum number of records to return. A value of 0 (zero) will return all records. || NO || 0<br />
|}<br />
<br />
Each game record will be returned in a JSON array of [[#Game Object|game objects]]:<br />
<br />
<code>[{game 1},{game 2},{game 3}]</code><br />
<br />
==Load Game Info==<br />
<br />
The Load Game Info API returns all the publicly available information about a game including its historical game records.<br />
<br />
The load game info command is a GET call to http://api.planets.nu/game/loadinfo with the following values passed on the connection string:<br />
<br />
{| cellspacing="0" cellpadding="5" style="white-space:nowrap;" border="1"<br />
|-bgcolor=lightblue<br />
! align="left" | variable<br />
! align="left" | description<br />
! align="left" | Required<br />
! align="center" | Default Value<br />
|-<br />
| gameid || The of the game being loaded || YES || n/a<br />
|}<br />
<br />
On success, the following JSON dictionary is returned:<br />
<br />
{| cellspacing="0" cellpadding="5" style="white-space:nowrap;" border="1"<br />
|-bgcolor=lightblue<br />
! align="left" | key<br />
! align="left" | value<br />
|-<br />
| game || A [[#Game Object|game object]] dictionary<br />
|-<br />
| players || An array of [[#Player Object|player object]] dictionaries<br />
|-<br />
| relations || An array of [[#Relation Object|relation object]] dictionaries<br />
|-<br />
| schedule || A text description of the host schedule<br />
|-<br />
| settings || A [[#Game Settings Object|game settings object]] dictionary<br />
|-<br />
| timetohost || A text description of the time until the next scheduled host<br />
|-<br />
| wincondition || A text description of the condition required to win the game<br />
|-<br />
| yearfrom || The Planets.NU year that the game began<br />
|-<br />
| yearto || The Planets.NU year the game ended<br />
|}<br />
<br />
==Load Turn Data==<br />
<br />
The load turn API returns all the data for a single complete turn given a game id and player id. <br />
This API requires the api key from [[#Login|Login]] as authentication when loading a turn for a game in progress. <br />
<br />
The load turn command is a GET call to http://api.planets.nu/game/loadturn<br />
<br />
The following variables may be passed as arguments in the connection string:<br />
<br />
{| cellspacing="0" cellpadding="5" style="white-space:nowrap;" border="1"<br />
|-bgcolor=lightblue<br />
! align="left" | variable<br />
! align="left" | description<br />
! align="left" | Required<br />
! align="center" | Default Value<br />
|-<br />
| apikey || The api key from the [[#Login|login]] API call. Only required for turns in active games || NO || n/a<br />
|-<br />
| forsave || Indicates if the client intends to make a call to the save data APIs || NO || false<br />
|-<br />
| gameid || The game ID for which to request the turn || YES || n/a<br />
|-<br />
| playerid || The player to request a turn for. <br/>In an active game this value must match the player for the supplied api key, otherwise an error will be returned || NO || n/a<br />
|-<br />
| turn || The turn to request || NO || The latest turn<br />
|}<br />
<br />
The response is a JSON dictionary with the following keys:<br />
<br />
{| cellspacing="0" cellpadding="5" style="white-space:nowrap;" border="1"<br />
|-bgcolor=lightblue<br />
! align="left" | key<br />
! align="left" | value<br />
|-<br />
| success || Indicates if the call was successful (true or false)<br />
|-<br />
| accountsettings || A [[#Player Settings Object|player settings object]] for the player whose turn was fetched<br />
|-<br />
| ispremium || Indicates if the player is/was a registered subscriber when the turn was generated<br />
|-<br />
| rst || A [[#Turn Result Object|result object]] which contains the bulk of the turn information<br />
|-<br />
| savekey || A unique, dynamically generated key for saving data back to the API. If <i>forsave</i> was false, this value is empty<br />
|}<br />
<br />
<br />
===Turn Result Object===<br />
<br />
The turn result object returned by Load Turn is a dictionary with the following keys:<br />
<br />
{| cellspacing="0" cellpadding="5" style="white-space:nowrap;" border="1"<br />
|-bgcolor=lightblue<br />
! align="left" | key<br />
! align="left" | value<br />
|-<br />
| settings || A [[#Game Settings Object|game settings object]] for the current game<br />
|-<br />
| game || A [[#Game Object|game object]] for the current game<br />
|-<br />
| player || A [[#Player Object|player object]] for the player the turn data belongs to<br />
|-<br />
| players || An array of [[#Player Object|player objects]] for all players in the current turn<br />
|-<br />
| scores || An array of [[#Score Object|score objects]] for all players in the current turn<br />
|-<br />
| maps || A url to a pre-rendered image of the game map for the given player for the current turn<br />
|-<br />
| planets || An array of [[#Planet Object|planet objects]] for the game<br />
|- <br />
| ships || An array of [[#Ship Object|ship objects]] representing the ships controlled by the given player for the current turn<br />
|-<br />
| ionstorms || An array of [[#Ion Storm Object|ion storm objects]] for the storms currently active in the cluster<br />
|-<br />
| nebulas || An array of [[#Nebula Object|nebula objects]]<br />
|-<br />
| stars || An array of [[#Star Object|star objects]]<br />
|-<br />
| starbases || An array of [[#Starbase Object|starbase objects]] for the starbases under the control of the given player<br />
|-<br />
| stock || An array of [[#Stock Item Object|stock item objects]] of the loose parts the player has at their starbases<br />
|-<br />
| minefields || An array of [[#Minefield Object|minefield objects]] for all minefields known to the player<br />
|- <br />
| relations || An array of [[#Relation Object|relation objects]] for all diplomatic relations as of the current turn<br />
|-<br />
| messages || An array of [[#Message Object|message objects]] representing the system messages (reports) for the current turn<br />
|-<br />
| mymessages || An array of [[#Message Object|message objects]] representing the diplomatic messages sent and received for the player of the current game<br />
|-<br />
| notes || An array of [[#Note Object|note objects]] for notes attached to planets, starbases and ships<br />
|-<br />
| vcrs || An array of [[#VCR Object|visual combat recording objects]] for any combat known to the player for the current turn<br />
|-<br />
| races || An array of [[#Race Object|race objects]] representing all races participating in the current game<br />
|-<br />
| hulls || An array of [[#Hull Object|hull objects]] for the attributes of every hull possible for the current game<br />
|-<br />
| racehulls || An array of the [[#Hull Object|hull IDs]] available to the current player's race<br />
|-<br />
| beams || An array of [[#Beam Object|beam objects]] for the attributes of every beam weapon possible for the current game<br />
|-<br />
| engines || An array of [[#Engine Object|engine objects]] for the attributes of every engine possible for the current game<br />
|-<br />
| torpedos || An array of [[#Torpedo Object|torpedo objects]] for the attributes of every torpedo possible for the current game<br />
|}<br />
<br />
=Non-Public API=<br />
<br />
In addition to the publicly documented API, there are several calls available from reading the actual game code. The maintainers of Planets.Nu have stated that any API endpoint is safe to use. <br />
<br />
==Encoding==<br />
<br />
Any data sent over the non-public API is expected to be encoded to prevent & and = characters from getting mangled by the connection string. <br />
<br />
* <code>&</code> (ampersand) characters are to be replaced with <code>|||</code> (3 pipe characters)<br />
* <code>=</code> (equals) characters are to be replaced with <code>:::</code> (3 colon characters)<br />
<br />
==Send Message==<br />
<br />
The Send Message API allows users to send in-game messages to other players in the current game.<br />
<br />
The send message command is a GET call to http://api.planets.nu/game/sendmessage with the following values passed on the connection string:<br />
<br />
{| cellspacing="0" cellpadding="5" style="white-space:nowrap;" border="1"<br />
|-bgcolor=lightblue<br />
! align="left" | variable<br />
! align="left" | description<br />
! align="left" | Required<br />
! align="center" | Default Value<br />
|-<br />
| gameid || The of the game in which to send the message || YES || n/a<br />
|-<br />
| playerid || The player who is sending the message || YES || n/a<br />
|-<br />
| apikey || The api key of the player sending the message || YES || n/a<br />
|-<br />
| to || A comma separated list of all recipients of the message || YES || n/a<br />
|-<br />
| body || The body of the message to be sent || YES || n/a<br />
|}<br />
<br />
=Common Data Objects=<br />
<br />
The following objects are used or returned by the API calls:<br />
<br />
==Beam Object==<br />
<br />
The beam object returned by Load Turn Info is a dictionary with the following keys:<br />
<br />
{| cellspacing="0" cellpadding="5" style="white-space:nowrap;" border="1"<br />
|-bgcolor=lightblue<br />
! align="left" | key<br />
! align="left" | value<br />
|-<br />
| cost || The amount of megacredits required to build the beam weapon<br />
|-<br />
| crewkill || The number of crew the beam will kill if the shields of the target ship are down<br />
|-<br />
| damage || The damage that the particular beam will do to the hull or shield of a ship<br />
|-<br />
| duranium || The amount of duranium required to build the beam weapon<br />
|-<br />
| id || The beam ID referenced by other objects, such as the [[#Ship Object|Ship Object]]<br />
|-<br />
| mass || The mass of the beam weapon when constructed<br />
|-<br />
| molybdenum || The amount of molybdenum required to build the beam weapon<br />
|-<br />
| name || The name of the beam weapon<br />
|-<br />
| techlevel || The tech level required at the starbase to build the beam weapon<br />
|-<br />
| tritanium || The amount of tritanium required to build the beam weapon<br />
|}<br />
<br />
==Engine Object==<br />
<br />
The engine object returned by Load Turn Info is a dictionary with the following keys:<br />
<br />
{| cellspacing="0" cellpadding="5" style="white-space:nowrap;" border="1"<br />
|-bgcolor=lightblue<br />
! align="left" | key<br />
! align="left" | value<br />
|-<br />
| cost || The amount of megacredits required to build the engine<br />
|-<br />
| duranium || The amount of duranium required to build the engine<br />
|-<br />
| id || The engine ID referenced by other objects, such as the [[#Ship Object|Ship Object]]<br />
|-<br />
| molybdenum || The amount of molybdenum required to build the engine<br />
|-<br />
| name || The name of the engine<br />
|-<br />
| techlevel || The tech level required at the starbase to build the engine<br />
|-<br />
| tritanium || The amount of tritanium required to build the engine<br />
|-<br />
| warp1 ||<br />
|-<br />
| warp2 ||<br />
|-<br />
| warp3 ||<br />
|-<br />
| warp4 ||<br />
|-<br />
| warp5 ||<br />
|-<br />
| warp6 ||<br />
|-<br />
| warp7 ||<br />
|-<br />
| warp8 ||<br />
|-<br />
| warp9 ||<br />
|}<br />
<br />
==Game Object==<br />
<br />
The game object returned by List Games or Load Game Info is a dictionary with the following keys:<br />
<br />
{| cellspacing="0" cellpadding="5" style="white-space:nowrap;" border="1"<br />
|-bgcolor=lightblue<br />
! align="left" | key<br />
! align="left" | value<br />
|-<br />
| allturnsin || Indicates if all turns have been submitted<br />
|-<br />
| createdby ||<br />
|-<br />
| datecreated || The date the game was created<br />
|-<br />
| dateended || The date the game ended<br />
|-<br />
| deletedate || The date the game was deleted<br />
|-<br />
| description || The text description of the game<br />
|-<br />
| difficulty||<br />
|-<br />
| faststart||<br />
|-<br />
| gametype||<br />
|-<br />
| hostdays || The days of the week the host will run in the format SMTWTFS. An underscore will replace days the host will not run.<br />eg. _M___F_ indicates the host will run on mondays and fridays<br />
|-<br />
| hosttime || The scheduled time of day for the host to run on scheduled host days<br />
|-<br />
| id || The ID of the game<br />
|-<br />
| ishosting||<br />
|-<br />
| isprivate||<br />
|-<br />
| lastbackuppath||<br />
|-<br />
| lastloadeddate||<br />
|-<br />
| lastnotified||<br />
|-<br />
| maptype||<br />
|-<br />
| masterplanetid||<br />
|-<br />
| maxlevelid || The maximum level for captains to participate in the game<br />
|-<br />
| name || The name of the game / system<br />
|-<br />
| nexthost || The datetime of the next scheduled host run<br />
|-<br />
| quadrant ||<br />
|-<br />
| requiredlevelid || The required level for captains to participate in the game<br />
|-<br />
| scenarioid||<br />
|-<br />
| shortdescription||<br />
|-<br />
| slots || The number of player slots available in the game<br />
|-<br />
| slowhostdays||<br />
|-<br />
| status||<br />
|-<br />
| turn || The current game turn<br />
|- <br />
| turnsperweek || The number of scheduled turns per week<br />
|-<br />
| turnstatus || A set of characters indicating which players have submitted their turns. An underscore indicates the turn is not yet viewed.<br />
|-<br />
| tutorialid||<br />
|-<br />
| wincondition||<br />
|-<br />
| yearstarted||<br />
|}<br />
<br />
==Game Settings Object==<br />
<br />
The game settings object returned by Load Game Info is a dictionary with the following keys:<br />
<br />
{| cellspacing="0" cellpadding="5" style="white-space:nowrap;" border="1"<br />
|-bgcolor=lightblue<br />
! align="left" | key<br />
! align="left" | value<br />
|-<br />
| allowchunneltowdropbug ||<br />
|-<br />
| averagedensitypercent ||<br />
|-<br />
| buildqueueplanetid ||<br />
|-<br />
| campaignmode ||<br />
|-<br />
| cloakfail ||<br />
|-<br />
| closeplanets ||<br />
|-<br />
| deadradius ||<br />
|-<br />
| debrisdiskpercent ||<br />
|-<br />
| developmentfactor ||<br />
|- <br />
| discussionid ||<br />
|-<br />
| duraniumlevel ||<br />
|-<br />
| fixedstartpositions ||<br />
|-<br />
| hideraceselection ||<br />
|-<br />
| hostcompleted ||<br />
|-<br />
| hoststart ||<br />
|-<br />
| hwdistribution ||<br />
|-<br />
| id ||<br />
|-<br />
| killrace ||<br />
|-<br />
| mapheight || The height of the map in pixels / lightyears. The upper limit is 4000<br />
|-<br />
| mapshape ||<br />
|-<br />
| mapwidth || The width of the map in pixels / lightyears. The upper limit is 4000<br />
|-<br />
| maxallies || The maximum number of allies a player can have in the current game<br />
|-<br />
| maxioncloudsperstorm ||<br />
|-<br />
| maxions ||<br />
|-<br />
| militaryscorepercent ||<br />
|-<br />
| molybdenumlevel ||<br />
|-<br />
| name || The name of the current game<br />
|-<br />
| nativeprobability ||<br />
|-<br />
| ncircles ||<br />
|-<br />
| ndebrisdiscs ||<br />
|-<br />
| nebulas ||<br />
|-<br />
| neutroniumlevel ||<br />
|-<br />
| nexthost ||<br />
|-<br />
| nuionstorms ||<br />
|-<br />
| numplanets || The number of planets in the game<br />
|-<br />
| planetscanrange ||<br />
|-<br />
| playerselectrace ||<br />
|-<br />
| roundmap ||<br />
|-<br />
| runningstart ||<br />
|-<br />
| shipscanrange ||<br />
|-<br />
| showallexplosions ||<br />
|-<br />
| stars ||<br />
|-<br />
| structuredecayrate ||<br />
|-<br />
| teamsize ||<br />
|-<br />
| tritaniumlevel ||<br />
|-<br />
| turn || The current game turn<br />
|-<br />
| uniqueraces ||<br />
|-<br />
| verycloseplanets ||<br />
|-<br />
| victorycountdown ||<br />
|}<br />
<br />
==Hull Object==<br />
<br />
The hull object returned by Load Turn Info is a dictionary with the following keys:<br />
<br />
{| cellspacing="0" cellpadding="5" style="white-space:nowrap;" border="1"<br />
|-bgcolor=lightblue<br />
! align="left" | key<br />
! align="left" | value<br />
|-<br />
| advantage ||<br />
|-<br />
| beams || The maximum number of beams that can be added to the hull<br />
|-<br />
| cancloak || A boolean value indicating if the hull includes a cloaking device<br />
|-<br />
| cargo || The amount of cargo space available in the constructed hull<br />
|-<br />
| cost || The amount of megacredits required to build the hull<br />
|-<br />
| crew || The maximum crew capacity in the constructed hull<br />
|-<br />
| description ||<br />
|-<br />
| dur ||<br />
|-<br />
| duranium || The amount of duranium required to build the hull<br />
|-<br />
| engines || The amount of engines required by the hull when building a ship<br />
|-<br />
| fighterbays || The number of fighter bays in the constructed hull<br />
|-<br />
| fueltank || The maximum fuel capacity in the constructed hull<br />
|-<br />
| id || The hull ID referenced by other objects, such as the [[#Ship Object|Ship Object]]<br />
|-<br />
| isbase ||<br />
|-<br />
| launchers || The maximum number of torpedo launchers that can be added to the hull<br />
|-<br />
| mass || The mass of the constructed hull<br />
|-<br />
| mc ||<br />
|-<br />
| mol ||<br />
|-<br />
| molybdenum || The amount of molybdenum required to build the hull<br />
|-<br />
| name || The name of the hull<br />
|-<br />
| parentid ||<br />
|-<br />
| special || The text description of the special abilities available to the constructed hull<br />
|-<br />
| techlevel || The tech level required at the starbase to build the hull<br />
|-<br />
| tri ||<br />
|-<br />
| tritanium || The amount of tritanium required to build the hull<br />
|}<br />
<br />
==Ion Storm Object==<br />
<br />
The ion storm object returned by Load Turn Info is a dictionary with the following keys:<br />
<br />
{| cellspacing="0" cellpadding="5" style="white-space:nowrap;" border="1"<br />
|-bgcolor=lightblue<br />
! align="left" | key<br />
! align="left" | value<br />
|-<br />
| heading ||<br />
|-<br />
| id || The ID of the [[Ion_storm|Ion Storm]]<br />
|-<br />
| isgrowing || A boolean value indicating if the ion storm is growing (strengthening)<br />
|-<br />
| radius || The radius of the ion storm in light years<br />
|-<br />
| voltage || The current voltage (strength) of the ion storm<br />
|-<br />
| warp || The speed at which the ion storm is travelling<br />
|-<br />
| x || The x coordinate of the ion storm's current position<br />
|-<br />
| y || The y coordinate of the ion storm's current position<br />
|}<br />
<br />
==Message Object==<br />
<br />
The message object returned by Load Turn Info is a dictionary with the following keys:<br />
<br />
{| cellspacing="0" cellpadding="5" style="white-space:nowrap;" border="1"<br />
|-bgcolor=lightblue<br />
! align="left" | key<br />
! align="left" | value<br />
|-<br />
| body || The body of the message. May contain HTML line breaks<br />
|-<br />
| headline || The title of the message<br />
|-<br />
| id || The ID of the message<br />
|-<br />
| messagetype || The [[#Message Types|type]] of message.<br />
|-<br />
| ownerid || The recipient of the message<br />
|-<br />
| target || The ID of the subject of the message based on the context (Ship, Planet, etc) or the sender in the case of a diplomatic message<br />
|-<br />
| turn || The game turn in which the message was received<br />
|-<br />
| x || The x coordinate of the event described, may only be useful in certain contexts<br />
|-<br />
| y || The y coordinate of the event described, may only be useful in certain contexts<br />
|}<br />
<br />
===Message Types===<br />
<br />
The message types indicated by the <i>messagetype</i> field in the message object are as follows:<br />
<br />
* 0: Outbound <br />
* 1 : System <br />
* 2 : Terraforming <br />
* 3 : Minelaying <br />
* 4 : Mine Sweep <br />
* 5 : Colony <br />
* 6 : Combat <br />
* 7 : Fleet <br />
* 8 : Ship <br />
* 9 : Enemy Distress Call<br />
* 10 : Explosion <br />
* 11 : Starbase <br />
* 12 : Web Mines <br />
* 13 : Meteors <br />
* 14 : Sensor Sweep<br />
* 15 : Bio Scan <br />
* 16 : DistressCall <br />
* 17 : Player <br />
* 18 : Diplomacy <br />
* 19 : MineScan<br />
* 20 : Dark Sense <br />
* 21 : Hiss<br />
<br />
==Minefield Object==<br />
<br />
The minefield object returned by Load Turn Info is a dictionary with the following keys:<br />
<br />
{| cellspacing="0" cellpadding="5" style="white-space:nowrap;" border="1"<br />
|-bgcolor=lightblue<br />
! align="left" | key<br />
! align="left" | value<br />
|-<br />
| friendlycode || The friendly code to safely pass through the minefield, if known<br />
|-<br />
| id || The ID of the minefield<br />
|-<br />
| infoturn || The turn the minefield information was last updated<br />
|-<br />
| isweb || A boolean value indicating if the minefield is a web mine<br />
|-<br />
| ownerid || The player ID that owns the minefield<br />
|-<br />
| radius || The last known radius of the minefield<br />
|-<br />
| units ||<br />
|-<br />
| x || The x coordinate of the center of the minefield<br />
|-<br />
| y || The y coordinate of the center of the minefield<br />
|}<br />
<br />
==Nebula Object==<br />
<br />
The nebula object returned by Load Turn Info is a dictionary with the following keys:<br />
<br />
{| cellspacing="0" cellpadding="5" style="white-space:nowrap;" border="1"<br />
|-bgcolor=lightblue<br />
! align="left" | key<br />
! align="left" | value<br />
|-<br />
| <i>n/a</i> || <i>This is a stub, please fill this out</i><br />
|}<br />
<br />
==Note Object==<br />
<br />
The note object returned by Load Turn Info is a dictionary with the following keys:<br />
<br />
{| cellspacing="0" cellpadding="5" style="white-space:nowrap;" border="1"<br />
|-bgcolor=lightblue<br />
! align="left" | key<br />
! align="left" | value<br />
|-<br />
| body || The text body of the note<br />
|-<br />
| color || The hexadecimal color of the noted entity on the map<br />
|-<br />
| id || The ID of the note<br />
|-<br />
| ownerid || The player ID that created the note<br />
|-<br />
| targetid || The ID of the entity the note belongs to<br />
|-<br />
| targettype || The type of entity the note belongs to<br />
|}<br />
<br />
<i>If anyone has a clear list of what targettype IDs are possible, please add it here</i><br />
<br />
==Planet Object==<br />
<br />
The planet object returned by Load Turn Info is a dictionary with the following keys:<br />
<br />
{| cellspacing="0" cellpadding="5" style="white-space:nowrap;" border="1"<br />
|-bgcolor=lightblue<br />
! align="left" | key<br />
! align="left" | value<br />
|-<br />
| buildingstarbase || A boolean value indicating if the planet is currently building a starbase<br />
|-<br />
| builtdefense || The number of defense posts being built this turn<br />
|-<br />
| builtfactories || The number of factories being built this turn<br />
|-<br />
| builtmines || The number of mines being build this turn<br />
|-<br />
| checkduranium ||<br />
|-<br />
| checkmegacredits ||<br />
|-<br />
| checkmolybdenum ||<br />
|-<br />
| checkneutronium ||<br />
|-<br />
| checksupplies ||<br />
|-<br />
| checktritanium ||<br />
|-<br />
| clans || The number of clans populating the planet<br />
|-<br />
| colchange ||<br />
|-<br />
| colhappychange || The increase or decrease of happiness points on the planet this turn<br />
|-<br />
| colonisthappypoints || The current happiness level of the colonists on the planet<br />
|-<br />
| colonisttaxrate || The current tax rate (from 1 to 100)<br />
|-<br />
| debrisdisk ||<br />
|-<br />
| defense || The total number of defense posts on the planet<br />
|-<br />
| densityduranium ||<br />
|-<br />
| densitymolybdenum ||<br />
|-<br />
| densityneutronium ||<br />
|-<br />
| densitytritanium ||<br />
|-<br />
| duranium || The amount of duranium sitting on the surface of the planet<br />
|-<br />
| factories || The total number of factories on the planet<br />
|-<br />
| flag ||<br />
|-<br />
| friendlycode || The planet's friendly code<br />
|-<br />
| groundduranium ||<br />
|-<br />
| groundmolybdenum ||<br />
|-<br />
| groundneutronium ||<br />
|-<br />
| groundtritanium ||<br />
|-<br />
| id || The ID of the planet<br />
|-<br />
| img || A url to the image of the planet<br />
|-<br />
| infoturn || The turn in which the information of this planet was last updated<br />
|-<br />
| megacredits || The megacredits available on the planet<br />
|-<br />
| mines || The total number of mines on the planet<br />
|-<br />
| molybdenum || The amount of molybdenum sitting on the surface of the planet<br />
|-<br />
| name || The name of the planet<br />
|-<br />
| nativechange ||<br />
|-<br />
| nativeclans || The number of clans of natives populating the planet<br />
|-<br />
| nativegovernment || The ID representing the government type of the native life on the planet<br />
|-<br />
| nativegovernmentname || The text name of the government type of the native life on the planet<br />
|-<br />
| nativehappychange || The increase or decrease in happy points for the native life on the planet this turn<br />
|-<br />
| nativehappypoints || The overall happiness points for the native life on the planet this turn<br />
|-<br />
| nativeracename || The text name of the native race populating the planet<br />
|-<br />
| nativetaxrate || The current tax rate (from 1 to 100) for the native race on the planet<br />
|-<br />
| nativetaxvalue ||<br />
|-<br />
| nativetype || The ID representing the race of native life on the planet<br />
|-<br />
| neutronium || The amount of neutronium sitting on the surface of the planet<br />
|-<br />
| ownerid || The player ID currently in control of the planet<br />
|-<br />
| readystatus ||<br />
|-<br />
| supplies || The amount of supplies sitting on the surface of the planet <br />
|-<br />
| suppliessold || The number of supplies converted to megacredits on the planet this turn<br />
|-<br />
| targetdefense || The target value for defense posts in the auto-build queue<br />
|-<br />
| targetfactories || The target value for factories in the auto-build queue<br />
|-<br />
| targetmines || The target value for mines in the auto-build queue<br />
|-<br />
| temp || The temperature on the planet (from 0-100) or -1 if unknown<br />
|-<br />
| totalduranium ||<br />
|-<br />
| totalmolybdenum ||<br />
|-<br />
| totalneutronium ||<br />
|-<br />
| totaltritanium ||<br />
|-<br />
| tritanium || The amount of tritanium sitting on the surface of the planet<br />
|-<br />
| x || The x coordinate of the planet in space<br />
|-<br />
| y || The y coordinate of the planet in space<br />
|}<br />
<br />
==Player Object==<br />
<br />
The player object returned by Load Game Info is a dictionary with the following keys:<br />
<br />
{| cellspacing="0" cellpadding="5" style="white-space:nowrap;" border="1"<br />
|-bgcolor=lightblue<br />
! align="left" | key<br />
! align="left" | value<br />
|-<br />
| activeadvantages ||<br />
|-<br />
| activehulls || The hulls (by ID) allowed for use by the player<br />
|-<br />
| email ||<br />
|-<br />
| finishrank ||<br />
|-<br />
| id || The ID of the player for the current game<br />
|-<br />
| isregistered || Indicates if the player is registered (paid subscription)<br />
|-<br />
| levelhullid ||<br />
|-<br />
| levelid ||<br />
|-<br />
| planets || The number of planets the player controls in the current game<br />
|-<br />
| prioritypoints || The number of [[Priority_Build_Points|priority points]] the player has at their disposal<br />
|-<br />
| raceid || The race ID of the player in the current game<br />
|-<br />
| savekey ||<br />
|-<br />
| score || The [[#Score Object|score object]] for the player in the current game<br />
|-<br />
| ships || The number of ships (war ships and freighters) the player currently controls<br />
|-<br />
| starbases || The number of starbases the player controls in the current game<br />
|-<br />
| status ||<br />
|-<br />
| statusturn ||<br />
|-<br />
| teamid ||<br />
|-<br />
| turnjoined || The turn at which the player joined the current game<br />
|-<br />
| turnready || Indicates if the players turn is ready (finished)<br />
|-<br />
| turnsmissed ||<br />
|-<br />
| turnstatus ||<br />
|-<br />
| username || The Planets.NU username of the player<br />
|}<br />
<br />
<br />
<br />
==Player Settings Object==<br />
<br />
The player settings object returned by Login and Load Turn is a dictionary with the following keys:<br />
<br />
{| cellspacing="0" cellpadding="5" style="white-space:nowrap;" border="1"<br />
|-bgcolor=lightblue<br />
! align="left" | key<br />
! align="left" | value<br />
|-<br />
| allymines || A hex RGB color code for allied minefields<br />
|-<br />
| allyplanetfrom ||<br />
|-<br />
| allyplanetto ||<br />
|-<br />
| allyshipfrom ||<br />
|-<br />
| allyshipto ||<br />
|-<br />
| assistanton ||<br />
|-<br />
| battletaskid ||<br />
|-<br />
| battletutorialid ||<br />
|-<br />
| enemymines || A hex RGB color code for enemy minefields<br />
|-<br />
| enemyplanetfrom ||<br />
|-<br />
| enemyplanetto ||<br />
|-<br />
| enemyshipfrom ||<br />
|-<br />
| enemyshipto ||<br />
|-<br />
| id ||<br />
|-<br />
| infoplanetfrom ||<br />
|-<br />
| infoplanetto ||<br />
|-<br />
| ionstorms || A hex RGB color code for ion storms<br />
|-<br />
| musicon ||<br />
|-<br />
| mymines || A hex RGB color code for the current player's minefields<br />
|-<br />
| myplanetfrom ||<br />
|-<br />
| myplanetto ||<br />
|-<br />
| myshipfrom ||<br />
|-<br />
| myshipto ||<br />
|-<br />
| soundon ||<br />
|-<br />
| unknownplanetfrom ||<br />
|-<br />
| unknownplanetto ||<br />
|-<br />
| webmines || A hex RGB color code for webmines<br />
|}<br />
<br />
<br />
==Race Object==<br />
<br />
The race object returned by Load Turn Info is a dictionary with the following keys:<br />
<br />
{| cellspacing="0" cellpadding="5" style="white-space:nowrap;" border="1"<br />
|-bgcolor=lightblue<br />
! align="left" | key<br />
! align="left" | value<br />
|-<br />
| adjective || The adjective used to describe the race's ships and planets<br />
|-<br />
| advantages ||<br />
|-<br />
| baseadvantages ||<br />
|-<br />
| basehulls || The base set of hulls (by Hull ID) available to the race<br />
|-<br />
| hulls ||<br />
|-<br />
| id || The race ID<br />
|-<br />
| name || The full name of the race<br />
|-<br />
| shortname || The shorter version of the race name<br />
|}<br />
<br />
==Relation Object==<br />
<br />
The relation object returned by Load Game Info is a dictionary with the following keys:<br />
<br />
{| cellspacing="0" cellpadding="5" style="white-space:nowrap;" border="1"<br />
|-bgcolor=lightblue<br />
! align="left" | key<br />
! align="left" | value<br />
|-<br />
| color ||<br />
|-<br />
| conflictlevel ||<br />
|-<br />
| id ||<br />
|-<br />
| playerid ||<br />
|-<br />
| playertoid ||<br />
|-<br />
| relationfrom ||<br />
|-<br />
| relationto ||<br />
|}<br />
<br />
<br />
==Score Object==<br />
<br />
The score object is a dictionary with the following keys:<br />
<br />
{| cellspacing="0" cellpadding="5" style="white-space:nowrap;" border="1"<br />
|-bgcolor=lightblue<br />
! align="left" | key<br />
! align="left" | value<br />
|-<br />
| capitalships ||<br />
|-<br />
| dateadded ||<br />
|-<br />
| freighters ||<br />
|-<br />
| id ||<br />
|-<br />
| inventoryscore ||<br />
|-<br />
|militaryscore ||<br />
|-<br />
|ownerid ||<br />
|-<br />
|percent ||<br />
|-<br />
|planets ||<br />
|-<br />
|prioritypoints ||<br />
|-<br />
| starbases ||<br />
|-<br />
| turn ||<br />
|}<br />
<br />
<br />
==Ship Object==<br />
<br />
The ship object returned by Load Turn Info is a dictionary with the following keys:<br />
<br />
{| cellspacing="0" cellpadding="5" style="white-space:nowrap;" border="1"<br />
|-bgcolor=lightblue<br />
! align="left" | key<br />
! align="left" | value<br />
|-<br />
| ammo || The number of Torpedos or Fighters present on the ship<br />
|-<br />
| bays || The number of fighter bays on the ship<br />
|-<br />
| beamid || The type of beam weapons installed on the ship. This corresponds to an entry in the [[#Beam Object|beam object]] array<br />
|-<br />
| beams || The number of installed beam weapons on the ship<br />
|-<br />
| clans || The number of clans in the ship's cargo hold<br />
|-<br />
| crew || The number of active crew members aboard the ship <br />
|-<br />
| damage || The amount of damage sustained on the ship<br />
|-<br />
| duranium || The amount of duranium in the ship's cargo hold<br />
|-<br />
| enemy || The primary enemy assigned to the ship<br />
|-<br />
| engineid || The type of engine installed on the ship<br />
|-<br />
| experience || The experience of the crew on the ship<br />
|-<br />
| friendlycode || The friendly code assigned to the ship<br />
|-<br />
| heading || <br />
|-<br />
| history || An array of (x,y) coordinates (as a dictionary) indicating the previous positions of the ship<br />
|-<br />
| hullid || The [[#Hull Object|hull]] used in the ship<br />
|-<br />
| id || The ID of the ship<br />
|-<br />
| infoturn || The last turn the information about the ship was updated<br />
|-<br />
| iscloaked || A boolean value indicating if the ship is cloaked or not<br />
|-<br />
| mass || The total mass of the ship including all cargo<br />
|-<br />
| megacredits || The amount of megacredits on board the ship<br />
|-<br />
| mission || The current mission being performed on the ship<br />
|-<br />
| mission1target ||<br />
|-<br />
| mission2target ||<br />
|-<br />
| molybdenum || The amount of molybdenum in the ship's cargo hold<br />
|-<br />
| name || The name of the ship<br />
|-<br />
| neutronium || The amount of neutronium (fuel) in the ship's fuel tank<br />
|-<br />
| ownerid || The player ID of the owner of the ship<br />
|-<br />
| readystatus ||<br />
|-<br />
| supplies || The amount of supplies in the ship's cargo hold<br />
|-<br />
| targetx || The x coordinate of the flight path target for the ship<br />
|-<br />
| targety || The y coordinate of the flight path target for the ship<br />
|-<br />
| torpedoid || The ID of the [[#Torpedo Object|torpedo launchers]] installed in the ship<br />
|-<br />
| torps || The number of torpedo launchers installed in the ship<br />
|-<br />
| transferammo ||<br />
|-<br />
| transferclans ||<br />
|-<br />
| transferduranium ||<br />
|-<br />
| transfermegacredits ||<br />
|-<br />
| transfermolybdenum ||<br />
|-<br />
| transferneutronium ||<br />
|-<br />
| transfersupplies ||<br />
|-<br />
| transfertargetid ||<br />
|-<br />
| transfertargettype ||<br />
|-<br />
| transfertritanium ||<br />
|-<br />
| tritanium || The amount of tritanium in the ship's cargo hold<br />
|-<br />
| turn ||<br />
|-<br />
| turnkilled ||<br />
|-<br />
| warp || The current warp speed of the ship<br />
|-<br />
| waypoints ||<br />
|-<br />
| x || The x coordinate of the ship's current position in space<br />
|-<br />
| y || The y coordinate of the ship's current position in space<br />
|}<br />
<br />
==Star Object==<br />
<br />
The star object returned by Load Turn Info is a dictionary with the following keys:<br />
<br />
{| cellspacing="0" cellpadding="5" style="white-space:nowrap;" border="1"<br />
|-bgcolor=lightblue<br />
! align="left" | key<br />
! align="left" | value<br />
|-<br />
| <i>n/a</i> || <i>This is a stub, please fill this out</i><br />
|}<br />
<br />
==Starbase Object==<br />
<br />
The starbase object returned by Load Turn Info is a dictionary with the following keys:<br />
<br />
{| cellspacing="0" cellpadding="5" style="white-space:nowrap;" border="1"<br />
|-bgcolor=lightblue<br />
! align="left" | key<br />
! align="left" | value<br />
|-<br />
| beamtechlevel || The tech level for beam weapons on the starbase<br />
|-<br />
| beamtechup || The level raised of the beam tech in the current turn<br />
|-<br />
| buildbeamcount ||<br />
|-<br />
| buildbeamid ||<br />
|-<br />
| buildengineid ||<br />
|-<br />
| buildhullid ||<br />
|-<br />
| buildtorpcount ||<br />
|-<br />
| buildtorpedoid ||<br />
|-<br />
| builtdefense || The number of starbase defense points added this turn<br />
|-<br />
| builtfighters || The number of fighters built this turn<br />
|-<br />
| damage || The current damage level of the starbase<br />
|-<br />
| defense || The total defense points on the starbase<br />
|-<br />
| enginetechlevel || The tech level for engines on the starbase<br />
|-<br />
| enginetechup || The level raised of the engine tech in the current turn<br />
|-<br />
| fighters || The number of fighters currently on the starbase<br />
|-<br />
| hulltechlevel || The tech level for hulls on the starbase<br />
|-<br />
| hulltechup || The level raised of the hull tech in the current turn<br />
|-<br />
| id || The ID of the starbase<br />
|-<br />
| infoturn || The last turn the information on this starbase was updated<br />
|-<br />
| isbuilding || <br />
|-<br />
| mission ||<br />
|-<br />
| planetid || The planet this starbase belongs to<br />
|-<br />
| raceid || <br />
|-<br />
| readystatus ||<br />
|-<br />
| shipmission ||<br />
|-<br />
| starbasetype ||<br />
|-<br />
| targetshipid || The ship targeted by the current mission (if applicable)<br />
|-<br />
| torptechlevel || The tech level for torpedos on the starbase<br />
|-<br />
| torptechup || The level raised of the torpedo tech in the current turn<br />
|}<br />
<br />
<br />
==Stock Item Object==<br />
<br />
The stock item object returned by Load Turn Info is a dictionary with the following keys:<br />
<br />
{| cellspacing="0" cellpadding="5" style="white-space:nowrap;" border="1"<br />
|-bgcolor=lightblue<br />
! align="left" | key<br />
! align="left" | value<br />
|-<br />
| amount || The quantity of the stock item on the starbase<br />
|-<br />
| builtamount ||<br />
|-<br />
| id || The ID of the stock item<br />
|-<br />
| starbaseid || The ID of the starbase that the stock item belongs to<br />
|-<br />
| stockid || The ID of the type of item in stock (looked up in the table corresponding to stocktype)<br />
|-<br />
| stocktype || The type of item in stock<br />
|}<br />
<br />
<br />
==Torpedo Object==<br />
<br />
The torpedo object returned by Load Turn Info is a dictionary with the following keys:<br />
<br />
{| cellspacing="0" cellpadding="5" style="white-space:nowrap;" border="1"<br />
|-bgcolor=lightblue<br />
! align="left" | key<br />
! align="left" | value<br />
|-<br />
| crewkill || The number of crew the torpedo will kill if the shields of the target ship are down<br />
|-<br />
| damage || The damage that the particular torpedo will do to the hull or shield of a ship<br />
|-<br />
| duranium || The amount of duranium required to build the torpedo<br />
|-<br />
| id || The torpedo ID referenced by other objects, such as the [[#Ship Object|Ship Object]]<br />
|-<br />
| launchercost || The amount of megacredits required to build the torpedo launcher<br />
|-<br />
| mass || The mass of the torpedo when constructed<br />
|-<br />
| molybdenum || The amount of molybdenum required to build the torpedo<br />
|-<br />
| name || The name of the torpedo<br />
|-<br />
| techlevel || The tech level required at the starbase to build the torpedo laucher and ammo<br />
|-<br />
| torpedocost || The amount of megacredits required to build the torpedo ammo<br />
|-<br />
| tritanium || The amount of tritanium required to build the torpedo<br />
|}<br />
<br />
<br />
==VCR Object==<br />
<br />
The vcr (visual combat recording) object returned by Load Turn Info is a dictionary with the following keys:<br />
<br />
{| cellspacing="0" cellpadding="5" style="white-space:nowrap;" border="1"<br />
|-bgcolor=lightblue<br />
! align="left" | key<br />
! align="left" | value<br />
|-<br />
| <i>n/a</i> || <i>This is a stub, please fill this out</i><br />
|}<br />
<br />
=References=<br />
<br />
[http://planets.nu/api-documentation Official API Documentation]</div>HandsomeCamhttps://vgaplanets.org/index.php?title=Insectoids&diff=3019Insectoids2012-11-23T16:22:02Z<p>HandsomeCam: Removed double title</p>
<hr />
<div>Insectoids are a [[native]] race found on [[planet|planets]] scattered throughout the galaxy.<br />
<br />
Insectoids are very giving to their Masters and thus provide extra [[Megacredits]] to the planet.<br />
<br />
== Increased Taxing ==<br />
Insectoids produce twice the normal amount of [[Megacredits]] per turn per percentage as other native races, to a maximum of 5000MC. More than 2500 colonist clans on the planet are therefore unnecessary.<br />
<br />
[[Category:Native Races]]</div>HandsomeCam