Skip to content

Latest commit

 

History

History
51 lines (38 loc) · 1.1 KB

Mission.md

File metadata and controls

51 lines (38 loc) · 1.1 KB
Raw

Mission

  • This URL retrieves data from the current mission

HTTP Request

Query parameters

  • None

HTTP Response ✅

  • Example:
{
   "objectives" : [
      {
         "primary" : true,
         "status" : "in_progress",
         "text" : "Decole"
      }
   ],
   "status" : "running"
}

Fields

  • name: objectives

    • type: JSON array containing all mission objectives
    • description:

    • name: primary

      • type: boolean
      • description: flag to determine if this is a primary mission

    • name: status

      • type: string
      • description: contains the status of current primary objective
      • possible values: "in_progress", "completed" or "failed"

    • name: text

      • type: string
      • description: contains instruction of what the player needs to do for complete the mission

  • name: status

    • type: string
    • descruption: contains status of the current mission can be "running" or "fail"