From 6096598c10d667ee0671a79f73140103619dce28 Mon Sep 17 00:00:00 2001 From: Iain C Docherty Date: Sat, 23 Feb 2013 18:10:26 -0500 Subject: [PATCH] Updated documentation for Shipyard, subsidize_ship --- docs/Shipyard.pod | 21 ++++++++++++++++----- 1 file changed, 16 insertions(+), 5 deletions(-) diff --git a/docs/Shipyard.pod b/docs/Shipyard.pod index 34c8136b..8de7f489 100644 --- a/docs/Shipyard.pod +++ b/docs/Shipyard.pod @@ -61,24 +61,35 @@ A session id. The unique id of the Shipyard. -=head2 subsidize_ship ( session_id, building_id, ship_id ) +=head2 subsidize_ship ( parameter_hash ) -Will spend 1 essentia to complete the build of the specified ship immediately. Returns C. +Will spend 1 essentia to complete the build of the specified ship. + +This accepts a hash of named arguments. + + { + "session_id" : 1234-123-123, + "building_id" : 4567, + "ship_id" : 88478, + } Throws 1011. -=head3 session_id +=head3 session_id (required) A session id. -=head3 building_id +=head3 building_id (required) The unique id of the Shipyard. -=head3 ship_id +=head3 ship_id (required) The unique id of the Ship, as returned in C +=head3 RESPONSE + +Returns the same as C =head2 get_buildable ( session_id, building_id, [ tag ] ) -- 2.51.2