Project-GC Lua Sandbox API
Loading...
Searching...
No Matches
GetFurthestFound

Member Function Documentation

◆ GetFurthestFound()

GetFurthestFound ( $profileId,
$params = [] )

Get the furthest found from home.

If the user doesn't have home coordinates a value of false will be returned.

Parameters
int$profileId(required) An integer with the users profile id.
array$params(optional) An optional associative array of options for filtering/sorting/limit.
  • types (array): An array of valid cache types (defaults to all).
  • excludeTypes (array): An array of invalid cache types (defaults to [Locationless (Reverse) Cache], set to [] to include all).
  • excludeTraveling (bool): Defaults to true. Ignore geocaches listed in http://www.geocaching.com/bookmarks/view.aspx?code=BMAFMJR .
  • ftfOnly (bool): Defaults to false. If true, considers logs that are FTF tagged.
  • leapdayOnly (bool): Defaults to false. If true, considers logs on leapday only.
Returns
array|false An associative array with the following fields:
  • (string) gccode
  • (int) distance (km)
  • (string) visitdate