Fatelist

Fatelist

• The Fatelist can be accessed through the MapObject
• It holds a list with all Fates and all Fate-related data and information.

---

Accessing the FateList

• Example:

local fl = MapObject:FateList()
if ( fl ) then
   local i,fate = next(fl)
   while (i~=nil and fate ~=nil) do
      -- the 'd' command is a global command for printing out information into the console
      d("FateID: ".. tostring(fate.ID).. " FateName: "..tostring(fate.name))  
      local i,fate = next(fl,i)  
   end  
end

---
### Fate Object Attributes 
<dl>
  <dt>id</dt>
  <dd>Returns an ID of the fate (number).</dd>

  <dt>name</dt>
  <dd>Returns fate name (string).</dd>

  <dt>description</dt>
  <dd>Returns fate description (string).</dd>

  <dt>status</dt>
  <dd>Returns the <a href="Enumerations#fatestatus">FATESTATUS</a> of the fate (number).</dd>

  <dt>completion</dt>
  <dd>Returns how far the fate is completed already (number).</dd>

  <dt>level</dt>
  <dd>Returns the fate level (number).</dd>

  <dt>maxlevel</dt>
  <dd>Returns the fate maxlevel (number).</dd>

  <dt>x</dt>
  <dd>Returns fate x position (number).</dd>

  <dt>y</dt>
  <dd>Returns fate y position (number).</dd>

  <dt>z</dt>
  <dd>Returns fate z position (number).</dd>

  <dt>radius</dt>
  <dd>Returns the fate radius (number).</dd>

  <dt>duration</dt>
  <dd>Returns the remaining fate duration (number).</dd>
</dl>