Issue #351: Refactoring Action class

apps/openmw/mwclass/door.cpp

@@ -40,7 +40,7 @@ namespace MWClass
             physics.insertObjectPhysics(ptr, model);
         }
     }
-    
+
     std::string Door::getModel(const MWWorld::Ptr &ptr) const
     {
         MWWorld::LiveCellRef<ESM::Door> *ref =
@@ -97,18 +97,18 @@ namespace MWClass
         if (ref->ref.teleport)
         {
             // teleport door
+            /// \todo remove this if clause once ActionTeleport can also support other actors
             if (MWBase::Environment::get().getWorld()->getPlayer().getPlayer()==actor)
             {
                 // the player is using the door
                 // The reason this is not 3D is that it would get interrupted when you teleport
                 MWBase::Environment::get().getSoundManager()->playSound(openSound, 1.0, 1.0);
                 return boost::shared_ptr<MWWorld::Action> (
-                    new MWWorld::ActionTeleportPlayer (ref->ref.destCell, ref->ref.doorDest));
+                    new MWWorld::ActionTeleport (ref->ref.destCell, ref->ref.doorDest));
             }
             else
             {
                 // another NPC or a creature is using the door
-                // TODO return action for teleporting other NPC/creature
                 return boost::shared_ptr<MWWorld::Action> (new MWWorld::NullAction);
             }
         }

apps/openmw/mwclass/potion.cpp

@@ -40,7 +40,7 @@ namespace MWClass
             physics.insertObjectPhysics(ptr, model);
         }
     }
-    
+
     std::string Potion::getModel(const MWWorld::Ptr &ptr) const
     {
         MWWorld::LiveCellRef<ESM::Potion> *ref =
@@ -158,7 +158,7 @@ namespace MWClass
         MWWorld::Ptr actor = MWBase::Environment::get().getWorld()->getPlayer().getPlayer();
 
         return boost::shared_ptr<MWWorld::Action> (
-            new MWWorld::ActionApply (actor, ref->base->mId, actor));
+            new MWWorld::ActionApply (actor, ref->base->mId));
     }
 
     MWWorld::Ptr
@@ -170,4 +170,3 @@ namespace MWClass
         return MWWorld::Ptr(&cell.potions.insert(*ref), &cell);
     }
 }
-

apps/openmw/mwgui/bookwindow.cpp

@@ -3,9 +3,11 @@
 #include <boost/lexical_cast.hpp>
 
 #include "../mwbase/environment.hpp"
+#include "../mwbase/world.hpp"
 #include "../mwinput/inputmanager.hpp"
 #include "../mwsound/soundmanager.hpp"
 #include "../mwworld/actiontake.hpp"
+#include "../mwworld/player.hpp"
 
 #include "formatting.hpp"
 #include "window_manager.hpp"
@@ -99,7 +101,7 @@ void BookWindow::onTakeButtonClicked (MyGUI::Widget* _sender)
     MWBase::Environment::get().getSoundManager()->playSound ("Item Book Up", 1.0, 1.0, MWSound::Play_NoTrack);
 
     MWWorld::ActionTake take(mBook);
-    take.execute();
+    take.execute (MWBase::Environment::get().getWorld()->getPlayer().getPlayer());
 
     mWindowManager.removeGuiMode(GM_Book);
 }

apps/openmw/mwgui/inventorywindow.cpp

@@ -175,7 +175,7 @@ namespace MWGui
 
             boost::shared_ptr<MWWorld::Action> action = MWWorld::Class::get(ptr).use(ptr);
 
-            action->execute();
+            action->execute (MWBase::Environment::get().getWorld()->getPlayer().getPlayer());
 
             // this is necessary for books/scrolls: if they are already in the player's inventory,
             // the "Take" button should not be visible.

apps/openmw/mwgui/scrollwindow.cpp

@@ -1,8 +1,10 @@
 #include "scrollwindow.hpp"
 
 #include "../mwbase/environment.hpp"
+#include "../mwbase/world.hpp"
 #include "../mwinput/inputmanager.hpp"
 #include "../mwworld/actiontake.hpp"
+#include "../mwworld/player.hpp"
 #include "../mwsound/soundmanager.hpp"
 
 #include "formatting.hpp"
@@ -63,7 +65,7 @@ void ScrollWindow::onTakeButtonClicked (MyGUI::Widget* _sender)
     MWBase::Environment::get().getSoundManager()->playSound ("Item Book Up", 1.0, 1.0, MWSound::Play_NoTrack);
 
     MWWorld::ActionTake take(mScroll);
-    take.execute();
+    take.execute (MWBase::Environment::get().getWorld()->getPlayer().getPlayer());
 
     mWindowManager.removeGuiMode(GM_Scroll);
 }

apps/openmw/mwscript/interpretercontext.cpp

@@ -10,6 +10,7 @@
 #include "../mwbase/world.hpp"
 
 #include "../mwworld/class.hpp"
+#include "../mwworld/player.hpp"
 
 #include "../mwgui/window_manager.hpp"
 
@@ -236,7 +237,7 @@ namespace MWScript
         if (!mAction.get())
             throw std::runtime_error ("activation failed, because no action to perform");
 
-        mAction->execute();
+        mAction->execute (MWBase::Environment::get().getWorld()->getPlayer().getPlayer());
         mActivationHandled = true;
     }
 

apps/openmw/mwworld/action.cpp

@@ -0,0 +1,11 @@
+
+#include "action.hpp"
+
+MWWorld::Action::Action() {}
+
+MWWorld::Action::~Action() {}
+
+void MWWorld::Action::execute (const Ptr& actor)
+{
+    executeImp (actor);
+}

apps/openmw/mwworld/action.hpp

@@ -3,6 +3,8 @@
 
 namespace MWWorld
 {
+    class Ptr;
+
     /// \brief Abstract base for actions
     class Action
     {
@@ -10,13 +12,15 @@ namespace MWWorld
             Action (const Action& action);
             Action& operator= (const Action& action);
 
+            virtual void executeImp (const Ptr& actor) = 0;
+
         public:
 
-            Action() {}
+            Action();
 
-            virtual ~Action() {}
+            virtual ~Action();
 
-            virtual void execute() = 0;
+            void execute (const Ptr& actor);
     };
 }
 

apps/openmw/mwworld/actionalchemy.cpp

@@ -5,7 +5,7 @@
 
 namespace MWWorld
 {
-    void ActionAlchemy::execute()
+    void ActionAlchemy::executeImp (const Ptr& actor)
     {
         MWBase::Environment::get().getWindowManager()->pushGuiMode(MWGui::GM_Alchemy);
     }

apps/openmw/mwworld/actionalchemy.hpp

@@ -7,8 +7,7 @@ namespace MWWorld
 {
     class ActionAlchemy : public Action
     {
-        public:
+            virtual void executeImp (const Ptr& actor);
-            virtual void execute ();
     };
 }
 

apps/openmw/mwworld/actionapply.cpp

@@ -5,24 +5,24 @@
 
 namespace MWWorld
 {
-    ActionApply::ActionApply (const Ptr& target, const std::string& id, const Ptr& actor)
+    ActionApply::ActionApply (const Ptr& target, const std::string& id)
-    : mTarget (target), mId (id), mActor (actor)
+    : mTarget (target), mId (id)
     {}
 
-    void ActionApply::execute()
+    void ActionApply::executeImp (const Ptr& actor)
     {
-        MWWorld::Class::get (mTarget).apply (mTarget, mId, mActor);
+        MWWorld::Class::get (mTarget).apply (mTarget, mId, actor);
     }
 
 
     ActionApplyWithSkill::ActionApplyWithSkill (const Ptr& target, const std::string& id,
-        const Ptr& actor, int skillIndex, int usageType)
+        int skillIndex, int usageType)
-    : mTarget (target), mId (id), mActor (actor), mSkillIndex (skillIndex), mUsageType (usageType)
+    : mTarget (target), mId (id), mSkillIndex (skillIndex), mUsageType (usageType)
     {}
 
-    void ActionApplyWithSkill::execute()
+    void ActionApplyWithSkill::executeImp (const Ptr& actor)
     {
-        if (MWWorld::Class::get (mTarget).apply (mTarget, mId, mActor) && mUsageType!=-1)
+        if (MWWorld::Class::get (mTarget).apply (mTarget, mId, actor) && mUsageType!=-1)
-            MWWorld::Class::get (mTarget).skillUsageSucceeded (mActor, mSkillIndex, mUsageType);
+            MWWorld::Class::get (mTarget).skillUsageSucceeded (actor, mSkillIndex, mUsageType);
     }
 }

apps/openmw/mwworld/actionapply.hpp

@@ -13,29 +13,27 @@ namespace MWWorld
     {
             Ptr mTarget;
             std::string mId;
-            Ptr mActor;
+
+            virtual void executeImp (const Ptr& actor);
 
         public:
 
-            ActionApply (const Ptr& target, const std::string& id, const Ptr& actor);
+            ActionApply (const Ptr& target, const std::string& id);
-
-            virtual void execute();
     };
 
     class ActionApplyWithSkill : public Action
     {
             Ptr mTarget;
             std::string mId;
-            Ptr mActor;
             int mSkillIndex;
             int mUsageType;
 
+            virtual void executeImp (const Ptr& actor);
+
         public:
 
-            ActionApplyWithSkill (const Ptr& target, const std::string& id, const Ptr& actor,
+            ActionApplyWithSkill (const Ptr& target, const std::string& id,
                 int skillIndex, int usageType);
-
-            virtual void execute();
     };
 }
 

apps/openmw/mwworld/actionequip.cpp

@@ -13,7 +13,7 @@ namespace MWWorld
     {
     }
 
-    void ActionEquip::execute ()
+    void ActionEquip::executeImp (const Ptr& actor)
     {
         MWWorld::Ptr player = MWBase::Environment::get().getWorld()->getPlayer().getPlayer();
         MWWorld::InventoryStore& invStore = MWWorld::Class::get(player).getInventoryStore(player);

apps/openmw/mwworld/actionequip.hpp

@@ -10,11 +10,11 @@ namespace MWWorld
     {
             Ptr mObject;
 
+            virtual void executeImp (const Ptr& actor);
+
         public:
             /// @param item to equip
             ActionEquip (const Ptr& object);
-
-            virtual void execute ();
     };
 }
 

apps/openmw/mwworld/actionopen.cpp

@@ -15,7 +15,7 @@ namespace MWWorld
         mContainer = container;
     }
 
-    void ActionOpen::execute ()
+    void ActionOpen::executeImp (const MWWorld::Ptr& actor)
     {
         if (!MWBase::Environment::get().getWindowManager()->isAllowed(MWGui::GW_Inventory))
             return;

apps/openmw/mwworld/actionopen.hpp

@@ -12,10 +12,11 @@ namespace MWWorld
     {
             Ptr mContainer;
 
+            virtual void executeImp (const MWWorld::Ptr& actor);
+
         public:
             ActionOpen (const Ptr& container);
             ///< \param The Container the Player has activated.
-            virtual void execute ();
     };
 }
 

apps/openmw/mwworld/actionread.cpp

@@ -11,7 +11,7 @@ namespace MWWorld
     {
     }
 
-    void ActionRead::execute ()
+    void ActionRead::executeImp (const MWWorld::Ptr& actor)
     {
         LiveCellRef<ESM::Book> *ref = mObject.get<ESM::Book>();
 

apps/openmw/mwworld/actionread.hpp

@@ -10,11 +10,11 @@ namespace MWWorld
     {
             Ptr mObject; // book or scroll to read
 
+            virtual void executeImp (const MWWorld::Ptr& actor);
+
         public:
             /// @param book or scroll to read
             ActionRead (const Ptr& object);
-
-            virtual void execute ();
     };
 }
 

apps/openmw/mwworld/actiontake.cpp

@@ -13,7 +13,7 @@ namespace MWWorld
 {
     ActionTake::ActionTake (const MWWorld::Ptr& object) : mObject (object) {}
 
-    void ActionTake::execute()
+    void ActionTake::executeImp (const Ptr& actor)
     {
         if (!MWBase::Environment::get().getWindowManager()->isAllowed(MWGui::GW_Inventory))
             return;

apps/openmw/mwworld/actiontake.hpp

@@ -10,11 +10,11 @@ namespace MWWorld
     {
             MWWorld::Ptr mObject;
 
+            virtual void executeImp (const Ptr& actor);
+
         public:
 
             ActionTake (const MWWorld::Ptr& object);
-
-            virtual void execute();
     };
 }
 

apps/openmw/mwworld/actiontalk.cpp

@@ -9,7 +9,7 @@ namespace MWWorld
 {
     ActionTalk::ActionTalk (const Ptr& actor) : mActor (actor) {}
 
-    void ActionTalk::execute()
+    void ActionTalk::executeImp (const Ptr& actor)
     {
         MWBase::Environment::get().getDialogueManager()->startDialogue (mActor);
     }

apps/openmw/mwworld/actiontalk.hpp

@@ -10,12 +10,12 @@ namespace MWWorld
     {
             Ptr mActor;
 
+            virtual void executeImp (const Ptr& actor);
+
         public:
 
             ActionTalk (const Ptr& actor);
             ///< \param actor The actor the player is talking to
-
-            virtual void execute();
     };
 }
 

apps/openmw/mwworld/actionteleport.cpp

@@ -6,12 +6,12 @@
 
 namespace MWWorld
 {
-    ActionTeleportPlayer::ActionTeleportPlayer (const std::string& cellName,
+    ActionTeleport::ActionTeleport (const std::string& cellName,
         const ESM::Position& position)
     : mCellName (cellName), mPosition (position)
     {}
 
-    void ActionTeleportPlayer::execute()
+    void ActionTeleport::executeImp (const Ptr& actor)
     {
         if (mCellName.empty())
             MWBase::Environment::get().getWorld()->changeToExteriorCell (mPosition);

apps/openmw/mwworld/actionteleport.hpp

@@ -9,17 +9,17 @@
 
 namespace MWWorld
 {
-    class ActionTeleportPlayer : public Action
+    class ActionTeleport : public Action
     {
             std::string mCellName;
             ESM::Position mPosition;
 
+            virtual void executeImp (const Ptr& actor);
+
         public:
 
-            ActionTeleportPlayer (const std::string& cellName, const ESM::Position& position);
+            ActionTeleport (const std::string& cellName, const ESM::Position& position);
             ///< If cellName is empty, an exterior cell is asumed.
-
-            virtual void execute();
     };
 }
 

apps/openmw/mwworld/nullaction.hpp

@@ -8,9 +8,7 @@ namespace MWWorld
     /// \brief Action: do nothing
     class NullAction : public Action
     {
-        public:
+            virtual void executeImp (const Ptr& actor) {}
-
-            virtual void execute() {}
     };
 }