Settlement

Some responses contain a settlement object:

Attributes

  • int id, the canonical settlement ID. Each settlement created has a unique ID. This value is incremented every time a new settlement is created on the server, and is maintained through server resets.
    > 0

Fields

  • string coordinate: The coordinate of the monolith.
  • string name: The settlements name. Generated on creation of settlement
  • int life: How many seconds has it been since the settlement was created, up to when the request was made.
  • users: contains >= 1 User Objects. members of the settlement. Always one or more user objects.
  • tokens: contains >= 1 Token Objects. At minimum, the monolith is returned, thusly one or more tokens can be expected.

Example

...
<settlement id="309">
  <coordinate>127:127:I</coordinate>
  <name>Settlement Name</name>
  <lifetime>7200</lifetime>
  <users>
    <user>
      <name>Fieldeon</name>
      <friendname>FieldeonsFriend</friendname>
      <players>
        <player server="3" status="online">Rastabon</player>
        <player server="1" status="offline">Phadon</player>
      </players>
    </user>
  </users>
  <tokens>
    <token id="1" coordinate="127:127:I" />
    <token id="4" coordinate="127:124:I">
      <param name="frequency" value="99.7mhz" />
      <param name="target" value="120:103:I" />
      <param name="locked" value="false" />
    </token>
    <token id="13" coordinate="120:103:I">
      <param name="output" value="4" />
      <param name="frequency" value="99.2mhz" />
      <param name="target" value="124:106:I" />
    </token>
  </tokens>
</settlement>
...