Scripting: Bindings for the player

Added the built-in class `App.Player`. This allows scripts to access player information such as health, armor, and powerup status.

IssueID #1539

doomsday/apps/client/src/clientapp.cpp

@@ -125,6 +125,11 @@ static void continueInitWithEventLoopRunning()
 #endif
 }
 
+static Value *Function_App_ConsolePlayer(Context &, const Function::ArgumentValues &)
+{
+    return new RecordValue(DoomsdayApp::players().at(consolePlayer).objectNamespace());
+}
+
 static Value *Function_App_GamePlugin(Context &, Function::ArgumentValues const &)
 {
     if (App_CurrentGame().isNull())
@@ -547,9 +552,13 @@ ClientApp::ClientApp(int &argc, char **argv)
     // We must presently set the current game manually (the collection is global).
     setGame(games().nullGame());
 
-    d->binder.init(scriptSystem()["App"])
-            << DENG2_FUNC_NOARG (App_GamePlugin, "gamePlugin")
-            << DENG2_FUNC_NOARG (App_Quit,       "quit");
+    // Script bindings.
+    {
+        d->binder.init(scriptSystem()["App"])
+                << DENG2_FUNC_NOARG (App_ConsolePlayer, "consolePlayer")
+                << DENG2_FUNC_NOARG (App_GamePlugin,    "gamePlugin")
+                << DENG2_FUNC_NOARG (App_Quit,          "quit");
+    }
 
 #if !defined (DENG_MOBILE)
     /// @todo Remove the splash screen when file system indexing can be done as

doomsday/apps/client/src/world/base/bindings_world.cpp

@@ -32,10 +32,7 @@ using namespace de;
 
 namespace world {
 
-static Value *Function_World_ConsolePlayer(Context &, const Function::ArgumentValues &)
-{
-    return new NumberValue(consolePlayer);
-}
+//-------------------------------------------------------------------------------------------------
 
 static Value *Function_Thing_Id(Context &ctx, const Function::ArgumentValues &)
 {
@@ -77,14 +74,10 @@ static Value *Function_Thing_Recoil(Context &ctx, const Function::ArgumentValues
     return nullptr;
 }
 
+//-------------------------------------------------------------------------------------------------
+
 void initBindings(Binder &binder, Record &worldModule)
 {
-    // Global functions.
-    {
-        binder.init(worldModule)
-            << DENG2_FUNC_NOARG(World_ConsolePlayer, "consolePlayer");
-    }
-
     // Thing
     {
         Record &thing = worldModule.addSubrecord("Thing");

doomsday/apps/libdoomsday/include/doomsday/player.h

@@ -96,6 +96,7 @@ typedef struct ddplayer_s {
 
 #ifdef __cplusplus
 
+#include <de/IObject>
 #include <de/Record>
 
 class World;
@@ -109,7 +110,7 @@ class World;
  * public. Some members could be moved into an internal, engine-only private class,
  * if necessary. -jk
  */
-class LIBDOOMSDAY_PUBLIC Player
+class LIBDOOMSDAY_PUBLIC Player : public de::IObject
 {
 public:
     // ID number. Each client has a unique ID number.
@@ -130,6 +131,8 @@ class LIBDOOMSDAY_PUBLIC Player
 
     virtual ~Player();
 
+    void initBindings();
+
     virtual void setWorld(World *world);
 
     ddplayer_t &publicData();
@@ -164,6 +167,10 @@ class LIBDOOMSDAY_PUBLIC Player
 
     DENG2_CAST_METHODS()
 
+    // Implements IObject.
+    de::Record &objectNamespace();
+    const de::Record &objectNamespace() const;
+
 private:
     DENG2_PRIVATE(d)
 };

doomsday/apps/libdoomsday/include/doomsday/players.h

@@ -72,6 +72,8 @@ class LIBDOOMSDAY_PUBLIC Players
      */
     int indexOf(ddplayer_s const *publicData) const;
 
+    void initBindings();
+
 private:
     DENG2_PRIVATE(d)
 };

doomsday/apps/libdoomsday/src/doomsdayapp.cpp

@@ -133,6 +133,7 @@ DENG2_PIMPL(DoomsdayApp)
         audienceForGameChange += scriptAudienceForGameChange;
 
         initBindings(binder);
+        players.initBindings();
 
         gameProfiles.setGames(games);
         saveGames   .setGames(games);

doomsday/apps/libdoomsday/src/doomsdayapp_bindings.cpp

@@ -17,7 +17,10 @@
  */
 
 #include "doomsday/DoomsdayApp"
+#include "doomsday/world/mobj.h"
+#include "doomsday/world/thinkerdata.h"
 
+#include <de/Context>
 #include <de/Folder>
 #include <de/ScriptSystem>
 
@@ -37,6 +40,30 @@ static Value *Function_App_Download(Context &, Function::ArgumentValues const &a
     return nullptr;
 }
 
+//-------------------------------------------------------------------------------------------------
+
+static int playerIndex(const Context &ctx)
+{
+    return ctx.selfInstance().geti("__id__", 0);
+}
+
+static Value *Function_Player_Id(Context &ctx, const Function::ArgumentValues &)
+{
+    return new NumberValue(playerIndex(ctx));
+}
+
+static Value *Function_Player_Thing(Context &ctx, const Function::ArgumentValues &)
+{
+    const int plrNum = playerIndex(ctx);
+    if (const mobj_t *mo = DoomsdayApp::players().at(plrNum).publicData().mo)
+    {
+        return new RecordValue(THINKER_DATA(mo->thinker, ThinkerData).objectNamespace());
+    }
+    return nullptr;
+}
+
+//-------------------------------------------------------------------------------------------------
+
 static Value *Function_FS_RefreshPackageFolders(Context &, const Function::ArgumentValues &)
 {
     LOG_SCR_MSG("Initializing package folders...");
@@ -49,9 +76,20 @@ static Value *Function_FS_RefreshPackageFolders(Context &, const Function::Argum
 
 void DoomsdayApp::initBindings(Binder &binder)
 {
-    binder.init(ScriptSystem::get()["App"])
+    auto &scr       = ScriptSystem::get();
+    auto &appModule = scr["App"];
+
+    binder.init(appModule)
             << DENG2_FUNC(App_Download, "download", "packageId");
 
-    binder.init(ScriptSystem::get()["FS"])
-            << DENG2_FUNC_NOARG(FS_RefreshPackageFolders, "refreshPackageFolders");
+    // Player
+    {
+        Record &player = appModule.addSubrecord("Player");
+        binder.init(player)
+            << DENG2_FUNC_NOARG(Player_Id, "id")
+            << DENG2_FUNC_NOARG(Player_Thing, "thing");
+    }
+
+    binder.init(scr["FS"])
+        << DENG2_FUNC_NOARG(FS_RefreshPackageFolders, "refreshPackageFolders");
 }

doomsday/apps/libdoomsday/src/player.cpp

@@ -19,6 +19,8 @@
 #include "doomsday/player.h"
 #include "doomsday/world/world.h"
 
+#include <de/ScriptSystem>
+
 using namespace de;
 
 DENG2_PIMPL_NOREF(Player)
@@ -55,6 +57,11 @@ Player::Player()
 Player::~Player()
 {}
 
+void Player::initBindings()
+{
+    objectNamespace().addSuperRecord(ScriptSystem::builtInClass("App", "Player"));
+}
+
 void Player::setWorld(World *world)
 {
     if (world)
@@ -106,6 +113,16 @@ Pinger const &Player::pinger() const
 void Player::tick(timespan_t /*elapsed*/)
 {}
 
+Record &Player::objectNamespace()
+{
+    return d->info;
+}
+
+const Record &Player::objectNamespace() const
+{
+    return d->info;
+}
+
 short P_LookDirToShort(float lookDir)
 {
     int dir = int( lookDir/110.f * DDMAXSHORT );

doomsday/apps/libdoomsday/src/players.cpp

@@ -96,3 +96,11 @@ int Players::indexOf(ddplayer_s const *publicData) const
     }
     return -1;
 }
+
+void Players::initBindings()
+{
+    for (auto *plr : d->players)
+    {
+        plr->initBindings();
+    }
+}

doomsday/apps/libdoomsday/src/world/actions.cpp

@@ -38,11 +38,13 @@ static String s_currentAction;
 static void C_DECL A_DoomsdayScript(void *actor)
 {
     struct mobj_s *mobj = reinterpret_cast<struct mobj_s *>(actor);
+    int plrNum = -1;
+
+    auto &plrs = DoomsdayApp::players();
 
     // The actor can also be a player in the case of psprites.
     // Look up the corresponding player.
     {
-        auto &plrs = DoomsdayApp::players();
         for (int i = 0; i < DDMAXPLAYERS; ++i)
         {
             // Note: It is assumed that the player data structure begins with a pointer to
@@ -53,6 +55,7 @@ static void C_DECL A_DoomsdayScript(void *actor)
             {
                 // Refer to the player mobj instead.
                 mobj = plrs.at(i).publicData().mo;
+                plrNum = i;
             }
         }
     }
@@ -62,6 +65,11 @@ static void C_DECL A_DoomsdayScript(void *actor)
     {
         const ThinkerData &data = THINKER_DATA(mobj->thinker, ThinkerData);
         Record ns;
+        if (plrNum >= 0)
+        {
+            ns.add(new Variable(QStringLiteral("player"),
+                                new RecordValue(plrs.at(plrNum).objectNamespace())));
+        }
         ns.add(new Variable(QStringLiteral("self"), new RecordValue(data.objectNamespace())));
         Process proc(&ns);
         const Script script(s_currentAction);
@@ -76,7 +84,7 @@ static void C_DECL A_DoomsdayScript(void *actor)
 
 static bool isScriptAction(const String &name)
 {
-    return name.contains('(') && name.contains(")");
+    return !name.beginsWith("A_");
 }
 
 void P_GetGameActions()