Merge pull request #82272 from PatrikLundell/personal_mission

Author: Maleclypse

data/raw/keybindings.json

@@ -1284,6 +1284,13 @@
     "id": "MISSIONS",
     "bindings": [ { "input_method": "keyboard_char", "key": "M" }, { "input_method": "keyboard_code", "key": "m", "mod": [ "shift" ] } ]
   },
+  {
+    "type": "keybinding",
+    "name": "Define Point of Interest",
+    "category": "OVERMAP",
+    "id": "CREATE_POINT_OF_INTEREST",
+    "bindings": [ { "input_method": "keyboard_char", "key": "P" }, { "input_method": "keyboard_code", "key": "p", "mod": [ "shift" ] } ]
+  },
   {
     "type": "keybinding",
     "id": "ROTATE",

src/avatar.cpp

@@ -300,11 +300,21 @@ std::vector<mission *> avatar::get_failed_missions() const
     return failed_missions;
 }
 
+std::vector<point_of_interest> avatar::get_points_of_interest() const
+{
+    return points_of_interest;
+}
+
 mission *avatar::get_active_mission() const
 {
     return active_mission;
 }
 
+point_of_interest avatar::get_active_point_of_interest() const
+{
+    return active_point_of_interest;
+}
+
 void avatar::reset_all_missions()
 {
     active_mission = nullptr;
@@ -315,10 +325,12 @@ void avatar::reset_all_missions()
 
 tripoint_abs_omt avatar::get_active_mission_target() const
 {
-    if( active_mission == nullptr ) {
-        return tripoint_abs_omt::invalid;
+    if( active_mission != nullptr ) {
+        return active_mission->get_target();
+    } else {
+        // It's tripoint_abs_invalid if not active.
+        return active_point_of_interest.pos;
     }
-    return active_mission->get_target();
 }
 
 void avatar::set_active_mission( mission &cur_mission )
@@ -329,7 +341,25 @@ void avatar::set_active_mission( mission &cur_mission )
                   cur_mission.mission_id().c_str() );
     } else {
         active_mission = &cur_mission;
+        active_point_of_interest.pos = tripoint_abs_omt::invalid;
+    }
+}
+
+void avatar::set_active_point_of_interest( const point_of_interest &active_point_of_interest )
+{
+    for( const point_of_interest &iter : points_of_interest ) {
+        // It's really sufficient to only check the position as used...
+        if( iter.pos == active_point_of_interest.pos &&
+            iter.text == active_point_of_interest.text ) {
+            this->active_point_of_interest = active_point_of_interest;
+            active_mission = nullptr;
+            return;
+        }
+
     }
+
+    debugmsg( "active point of interest %s is not in the points_of_interest list",
+              active_point_of_interest.text.c_str() );
 }
 
 void avatar::update_active_mission()
@@ -399,6 +429,44 @@ void avatar::remove_active_mission( mission &cur_mission )
     }
 }
 
+void avatar::add_point_of_interest( const point_of_interest &new_point_of_interest )
+{
+    for( point_of_interest &existing_point_of_interest : points_of_interest ) {
+        if( new_point_of_interest.pos == existing_point_of_interest.pos ) {
+            existing_point_of_interest.text = new_point_of_interest.text;
+            active_mission = nullptr;
+            active_point_of_interest = new_point_of_interest;
+            return;
+        }
+    }
+
+    points_of_interest.push_back( new_point_of_interest );
+    active_mission = nullptr;
+    active_point_of_interest = new_point_of_interest;
+}
+
+void avatar::delete_point_of_interest( tripoint_abs_omt pos )
+{
+    for( auto iter = points_of_interest.begin(); iter != points_of_interest.end(); iter++ ) {
+        if( iter->pos == pos ) {
+            points_of_interest.erase( iter );
+
+            if( active_point_of_interest.pos == pos ) {
+                active_point_of_interest.pos = tripoint_abs_omt::invalid;
+
+                if( !active_missions.empty() ) {
+                    active_mission = active_missions.front();
+                }
+            }
+
+            return;
+        }
+    }
+
+    debugmsg( "removed point of interest at %s was not in the points_of_interest list",
+              pos.to_string().c_str() );
+}
+
 diary *avatar::get_avatar_diary()
 {
     if( a_diary == nullptr ) {

src/avatar.h

@@ -25,6 +25,7 @@
 #include "magic_teleporter_list.h"
 #include "mdarray.h"
 #include "memory_fast.h"
+#include "point.h"
 #include "type_id.h"
 #include "units.h"
 
@@ -74,6 +75,11 @@ struct monster_visible_info {
     void remove_npc( npc *n );
 };
 
+struct point_of_interest {
+    tripoint_abs_omt pos = tripoint_abs_omt::invalid;
+    std::string text;
+};
+
 class avatar : public Character
 {
     public:
@@ -159,19 +165,28 @@ class avatar : public Character
         std::vector<mission *> get_active_missions() const;
         std::vector<mission *> get_completed_missions() const;
         std::vector<mission *> get_failed_missions() const;
+        std::vector<point_of_interest> get_points_of_interest() const;
         /**
-         * Returns the mission that is currently active. Returns null if mission is active.
+         * Returns the mission that is currently active. Returns null if no mission is active.
          */
         mission *get_active_mission() const;
         /**
-         * Returns the target of the active mission or @ref tripoint_abs_omt::invalid if there is
-         * no active mission.
+         * Returns the point of interest that is currently active. Returns null if no mission is active.
+         */
+        point_of_interest get_active_point_of_interest() const;
+        /**
+         * Returns the target of the active mission/point of interest or @ref tripoint_abs_omt::invalid if there is
+         * no active mission or point of interest.
          */
         tripoint_abs_omt get_active_mission_target() const;
         /**
          * Set which mission is active. The mission must be listed in @ref active_missions.
          */
         void set_active_mission( mission &cur_mission );
+        /**
+         * Set which point of interest is active. The point of interest must be listed in @ref points_of_interest.
+         */
+        void set_active_point_of_interest( const point_of_interest &active_point_of_interest );
         /**
          * Called when a mission has been assigned to the player.
          */
@@ -188,6 +203,12 @@ class avatar : public Character
 
         void remove_active_mission( mission &cur_mission );
 
+        /**
+        * Despite the name, this operation also makes an existing point of interest active.
+        */
+        void add_point_of_interest( const point_of_interest &new_point_of_interest );
+        void delete_point_of_interest( tripoint_abs_omt pos );
+
         //return avatar diary
         diary *get_avatar_diary();
 
@@ -404,10 +425,18 @@ class avatar : public Character
         /**
          * The currently active mission, or null if no mission is currently in progress.
          */
+        /**
+        * Points of interest added by the player.
+        */
+        std::vector<point_of_interest> points_of_interest;
+
         mission *active_mission;
+
+        point_of_interest active_point_of_interest;
+
         void update_active_mission();
         /**
-        * diary to track player progression and to write the players stroy
+        * diary to track player progression and to write the players story
         */
         std::unique_ptr <diary> a_diary;
         /**