Merge branch 'bodily' into 'master'

Add types.BodyPart

See merge request OpenMW/openmw!5208

Author: Capostrophic

apps/openmw/CMakeLists.txt

@@ -64,7 +64,7 @@ add_openmw_dir (mwlua
     mwscriptbindings camerabindings vfsbindings uibindings soundbindings inputbindings nearbybindings dialoguebindings
     postprocessingbindings stats recordstore debugbindings corebindings worldbindings worker landbindings magicbindings factionbindings
     classbindings itemdata inputprocessor animationbindings birthsignbindings racebindings markupbindings weatherbindings regionbindings
-    types/types types/door types/item types/actor types/container types/lockable types/weapon types/npc
+    types/types types/door types/item types/actor types/container types/lockable types/weapon types/npc types/bodypart
     types/creature types/player types/activator types/book types/lockpick types/probe types/apparatus
     types/potion types/ingredient types/misc types/repair types/armor types/light types/static
     types/clothing types/levelledlist types/terminal magictypebindings

apps/openmw/mwlua/types/bodypart.cpp

@@ -0,0 +1,45 @@
+#include "types.hpp"
+
+#include "modelproperty.hpp"
+
+#include <components/esm3/loadbody.hpp>
+#include <components/lua/luastate.hpp>
+
+namespace sol
+{
+    template <>
+    struct is_automagical<ESM::BodyPart> : std::false_type
+    {
+    };
+}
+
+namespace MWLua
+{
+    void addBodyPartBindings(sol::table bodypart, const Context& context)
+    {
+        addRecordFunctionBinding<ESM::BodyPart>(bodypart, context);
+
+        sol::state_view lua = context.sol();
+        sol::usertype<ESM::BodyPart> record = lua.new_usertype<ESM::BodyPart>("ESM3_BodyPart");
+        record[sol::meta_function::to_string]
+            = [](const ESM::BodyPart& rec) { return "ESM3_BodyPart[" + rec.mId.toDebugString() + "]"; };
+        record["id"] = sol::readonly_property([](const ESM::BodyPart& rec) -> ESM::RefId { return rec.mId; });
+        record["race"] = sol::readonly_property([](const ESM::BodyPart& rec) -> ESM::RefId { return rec.mRace; });
+        addModelProperty(record);
+        record["isFemale"] = sol::readonly_property(
+            [](const ESM::BodyPart& rec) -> bool { return rec.mData.mFlags & ESM::BodyPart::BPF_Female; });
+        record["isPlayable"] = sol::readonly_property(
+            [](const ESM::BodyPart& rec) -> bool { return !(rec.mData.mFlags & ESM::BodyPart::BPF_NotPlayable); });
+        record["isVampire"]
+            = sol::readonly_property([](const ESM::BodyPart& rec) -> bool { return rec.mData.mVampire; });
+        record["type"] = sol::readonly_property([](const ESM::BodyPart& rec) -> std::optional<std::string_view> {
+            if (rec.mData.mType == ESM::BodyPart::MT_Skin)
+                return "skin";
+            else if (rec.mData.mType == ESM::BodyPart::MT_Clothing)
+                return "clothing";
+            else if (rec.mData.mType == ESM::BodyPart::MT_Armor)
+                return "armor";
+            return {};
+        });
+    }
+}

apps/openmw/mwlua/types/types.cpp

@@ -15,6 +15,7 @@ namespace MWLua
 
         constexpr std::string_view Activator = "Activator";
         constexpr std::string_view Armor = "Armor";
+        constexpr std::string_view BodyPart = "BodyPart";
         constexpr std::string_view Book = "Book";
         constexpr std::string_view Clothing = "Clothing";
         constexpr std::string_view Container = "Container";
@@ -64,6 +65,7 @@ namespace MWLua
             { ESM::REC_INTERNAL_MARKER, ObjectTypeName::Marker },
             { ESM::REC_ACTI, ObjectTypeName::Activator },
             { ESM::REC_ARMO, ObjectTypeName::Armor },
+            { ESM::REC_BODY, ObjectTypeName::BodyPart },
             { ESM::REC_BOOK, ObjectTypeName::Book },
             { ESM::REC_CLOT, ObjectTypeName::Clothing },
             { ESM::REC_CONT, ObjectTypeName::Container },
@@ -205,6 +207,7 @@ namespace MWLua
         addLockableBindings(
             addType(ObjectTypeName::Lockable, { ESM::REC_CONT, ESM::REC_DOOR, ESM::REC_CONT4, ESM::REC_DOOR4 }));
 
+        addBodyPartBindings(addType(ObjectTypeName::BodyPart, { ESM::REC_BODY }), context);
         addCreatureBindings(addType(ObjectTypeName::Creature, { ESM::REC_CREA }, ObjectTypeName::Actor), context);
         addNpcBindings(
             addType(ObjectTypeName::NPC, { ESM::REC_INTERNAL_PLAYER, ESM::REC_NPC_ }, ObjectTypeName::Actor), context);

apps/openmw/mwlua/types/types.hpp

@@ -31,6 +31,7 @@ namespace MWLua
     void addActivatorBindings(sol::table activator, const Context& context);
     ESM::Activator tableToActivator(const sol::table& rec);
     void addMutableActivatorType(sol::state_view& lua);
+    void addBodyPartBindings(sol::table list, const Context& context);
     void addBookBindings(sol::table book, const Context& context);
     ESM::Book tableToBook(const sol::table& rec);
     void addMutableBookType(sol::state_view& lua);

files/lua_api/openmw/types.lua

@@ -1513,6 +1513,36 @@
 -- world.createObject(newRecord.id):moveInto(playerActor)--Create an instance of this object, and move it into the player's inventory
 
 
+--- @{#BodyPart} functions
+-- @field [parent=#types] #BodyPart BodyPart
+
+---
+-- @type BodyPart
+
+---
+-- A read-only list of all @{#BodyPartRecord}s in the world database.
+-- Implements [iterables#List](iterables.html#List) of #BodyPartRecord.
+-- @field [parent=#BodyPart] #list<#BodyPartRecord> records
+-- @usage local record = types.BodyPart.records['example_recordid']
+-- @usage local record = types.BodyPart.records[1]
+
+---
+-- Whether the object is a BodyPart.
+-- @function [parent=#BodyPart] objectIsInstance
+-- @param openmw.core#GameObject object
+-- @return #boolean
+
+---
+-- @type BodyPartRecord
+-- @field #string id The record ID of the body part
+-- @field #string race The id of the race of the body part
+-- @field #string model VFS path to the model
+-- @field #boolean isFemale Whether the body part only applies to female characters
+-- @field #boolean isPlayable Whether the player can choose this part
+-- @field #boolean isVampire Whether this body part is meant for vampires
+-- @field #string type `armor`, `clothing`, or `skin`
+
+
 --- @{#Book} functions
 -- @field [parent=#types] #Book Book