Merge branch 'startingcell' into 'master'

Lua startingCell to return the original cell

Closes #9010

See merge request OpenMW/openmw!4973

Author: Capostrophic

CMakeLists.txt

@@ -82,7 +82,7 @@ message(STATUS "Configuring OpenMW...")
 set(OPENMW_VERSION_MAJOR 0)
 set(OPENMW_VERSION_MINOR 51)
 set(OPENMW_VERSION_RELEASE 0)
-set(OPENMW_LUA_API_REVISION 116)
+set(OPENMW_LUA_API_REVISION 117)
 set(OPENMW_POSTPROCESSING_API_REVISION 5)
 
 set(OPENMW_VERSION_COMMITHASH "")

apps/openmw/mwlua/objectbindings.cpp

@@ -319,6 +319,13 @@ namespace MWLua
             objectT["rotation"] = sol::readonly_property([](const ObjectT& o) -> LuaUtil::TransformQ {
                 return { toQuat(o.ptr().getRefData().getPosition(), o.ptr().getClass().isActor()) };
             });
+            objectT["startingCell"] = sol::readonly_property([](const ObjectT& o) -> sol::optional<Cell<ObjectT>> {
+                const MWWorld::Ptr& ptr = o.ptr();
+                MWWorld::WorldModel* wm = MWBase::Environment::get().getWorldModel();
+                if (ptr.isInCell() && ptr.getCell() != &wm->getDraftCell())
+                    return Cell<ObjectT>{ ptr.getCell()->getOriginCell(ptr) };
+                return sol::nullopt;
+            });
             objectT["startingPosition"] = sol::readonly_property(
                 [](const ObjectT& o) -> osg::Vec3f { return o.ptr().getCellRef().getPosition().asVec3(); });
             objectT["startingRotation"] = sol::readonly_property([](const ObjectT& o) -> LuaUtil::TransformQ {

files/lua_api/openmw/core.lua

@@ -166,6 +166,7 @@
 -- @field openmw.util#Vector3 position Object position.
 -- @field #number scale Object scale.
 -- @field openmw.util#Transform rotation Object rotation.
+-- @field #Cell startingCell The object's original cell. Returns nil if `cell` of the object is nil.
 -- @field openmw.util#Vector3 startingPosition The object original position
 -- @field openmw.util#Transform startingRotation The object original rotation
 -- @field #ObjectOwner owner Ownership information