Skip to content

Commit

Permalink
Clarify player attribute TODO
Browse files Browse the repository at this point in the history
Explain what the player attribute block is in packhand.js's handle_player_attribute_chunk().
  • Loading branch information
kvilhaugsvik committed Apr 1, 2015
1 parent 86a3f6a commit 61fb0d0
Showing 1 changed file with 17 additions and 1 deletion.
18 changes: 17 additions & 1 deletion freeciv-web/src/main/webapp/javascript/packhand.js
Original file line number Diff line number Diff line change
Expand Up @@ -378,7 +378,23 @@ function handle_city_sabotage_list(packet)

function handle_player_attribute_chunk(packet)
{
/* TODO: implement*/
/* The attribute block of the player structure is an area of Freeciv
* server memory that the client controls. The server will store it to
* savegames, send it when the client requests a copy and change it on
* the client's request. The server has no idea about its content. This
* is a chunk of it.
*
* The C clients can use the attribute block to store key-value pair
* attributes for the object types city, player, tile and unit. The
* format the they use to encode this data can be found in Freeciv's
* client/attribute.c.
*
* The C clients uses it to store parameters of cities for the (client
* side) CMA agent. */

/* TODO: Find out if putting something inside savegames is needed. If it
* is: decide if compatibility with the format of the Freeciv C clients
* is needed and implement the result of the decision. */
}

/**************************************************************************
Expand Down

0 comments on commit 61fb0d0

Please sign in to comment.