Merge branch 'data-mw' into 'master'

Move Morrowind mechanics to data-mw

See merge request OpenMW/openmw!4937

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 102)
+set(OPENMW_LUA_API_REVISION 103)
 set(OPENMW_POSTPROCESSING_API_REVISION 3)
 
 set(OPENMW_VERSION_COMMITHASH "")

docs/source/luadoc_data_paths.sh

@@ -2,7 +2,7 @@ paths=(
   openmw_aux/*lua
   scripts/omw/activationhandlers.lua
   scripts/omw/ai.lua
-  scripts/omw/combat/local.lua
+  scripts/omw/combat/interface.lua
   scripts/omw/input/playercontrols.lua
   scripts/omw/mechanics/animationcontroller.lua
   scripts/omw/input/gamepadcontrols.lua

docs/source/reference/lua-scripting/interface_combat.rst

@@ -4,5 +4,5 @@ Interface Combat
 .. include:: version.rst
 
 .. raw:: html
-   :file: generated_html/scripts_omw_combat_local.html
+   :file: generated_html/scripts_omw_combat_interface.html
 

files/data-mw/CMakeLists.txt

@@ -20,8 +20,29 @@ set(BUILTIN_DATA_MW_FILES
 
     # Game-specific settings for calendar.lua
     openmw_aux/calendarconfig.lua
+
+    scripts/omw/cellhandlers.lua
+    scripts/omw/combat/common.lua
+    scripts/omw/combat/global.lua
+    scripts/omw/combat/local.lua
+    scripts/omw/combat/menu.lua
+    scripts/omw/music/helpers.lua
+    scripts/omw/music/music.lua
+    scripts/omw/music/settings.lua
+    scripts/omw/playerskillhandlers.lua
 )
 
 foreach (f ${BUILTIN_DATA_MW_FILES})
     copy_resource_file("${CMAKE_CURRENT_SOURCE_DIR}/${f}" "${OPENMW_RESOURCES_ROOT}" "resources/vfs-mw/${f}")
 endforeach (f)
+
+# Concat data/builtin.omwscripts and data-mw/builtin.omwscripts.in to create vfs-mw/builtin.omwscripts
+set(builtinBase "${CMAKE_CURRENT_SOURCE_DIR}/../data/builtin.omwscripts")
+
+# https://gitlab.kitware.com/cmake/cmake/-/issues/20181
+if (NOT CMAKE_GENERATOR MATCHES "Ninja")
+    set_property(DIRECTORY APPEND PROPERTY CMAKE_CONFIGURE_DEPENDS "${builtinBase}")
+endif()
+
+file(READ "${builtinBase}" BUILTIN_SCRIPTS)
+configure_resource_file("${CMAKE_CURRENT_SOURCE_DIR}/builtin.omwscripts.in" "${OPENMW_RESOURCES_ROOT}" "resources/vfs-mw/builtin.omwscripts")

files/data-mw/builtin.omwscripts.in

@@ -0,0 +1,10 @@
+@BUILTIN_SCRIPTS@
+
+# Game specific scripts to append to builtin.omwscripts
+GLOBAL: scripts/omw/cellhandlers.lua
+GLOBAL: scripts/omw/combat/global.lua
+MENU: scripts/omw/combat/menu.lua
+NPC,CREATURE,PLAYER: scripts/omw/combat/local.lua
+PLAYER: scripts/omw/music/music.lua
+MENU: scripts/omw/music/settings.lua
+PLAYER: scripts/omw/playerskillhandlers.lua

files/data/scripts/omw/cellhandlers.lua …les/data-mw/scripts/omw/cellhandlers.luafiles/data/scripts/omw/cellhandlers.lua renamed to files/data-mw/scripts/omw/cellhandlers.lua files/data/scripts/omw/cellhandlers.lua renamed to files/data-mw/scripts/omw/cellhandlers.lua

@@ -1,17 +1,13 @@
-local animation = require('openmw.animation')
-local async = require('openmw.async')
 local core = require('openmw.core')
 local I = require('openmw.interfaces')
 local self = require('openmw.self')
 local storage = require('openmw.storage')
 local types = require('openmw.types')
-local util = require('openmw.util')
-local auxUtil = require('openmw_aux.util')
 local Actor = types.Actor
-local Weapon = types.Weapon
 local Player = types.Player
 local Creature = types.Creature
 local Armor = types.Armor
+local auxUtil = require('openmw_aux.util')
 local isPlayer = Player.objectIsInstance(self)
 
 local godMode = function() return false end
@@ -20,8 +16,6 @@ if isPlayer then
     godMode = function() return require('openmw.debug').isGodMode() end
 end
 
-local onHitHandlers = {}
-
 local settings = storage.globalSection('SettingsOMWCombat')
 
 local function getSkill(actor, skillId)
@@ -271,16 +265,13 @@ local function spawnBloodEffect(position)
 end
 
 local function onHit(data)
-    if auxUtil.callEventHandlers(onHitHandlers, data) then
-        return
-    end
     if data.successful and not godMode() then
         I.Combat.applyArmor(data)
         I.Combat.adjustDamageForDifficulty(data)
         if getDamage(data, 'health') > 0 then
             core.sound.playSound3d('Health Damage', self)
             if data.hitPos then
-                spawnBloodEffect(data.hitPos)
+                I.Combat.spawnBloodEffect(data.hitPos)
             end
         end
     elseif data.attacker and Player.objectIsInstance(data.attacker) then
@@ -289,142 +280,20 @@ local function onHit(data)
     Actor._onHit(self, data)
 end
 
----
--- Table of possible attack source types
--- @type AttackSourceType
--- @field #string Magic
--- @field #string Melee
--- @field #string Ranged
--- @field #string Unspecified
-
----
--- @type AttackInfo
--- @field [parent=#AttackInfo] #table damage A table mapping a stat name (health, fatigue, or magicka) to a number. For example, {health = 50, fatigue = 10} will cause 50 damage to health and 10 to fatigue (before adjusting for armor and difficulty). This field is ignored for failed attacks.
--- @field [parent=#AttackInfo] #number strength A number between 0 and 1 representing the attack strength. This field is ignored for failed attacks.
--- @field [parent=#AttackInfo] #boolean successful Whether the attack was successful or not.
--- @field [parent=#AttackInfo] #AttackSourceType sourceType What class of attack this is.
--- @field [parent=#AttackInfo] openmw.self#ATTACK_TYPE type (Optional) Attack variant if applicable. For melee attacks this represents chop vs thrust vs slash. For unarmed creatures this implies which of its 3 possible attacks were used. For other attacks this field can be ignored.
--- @field [parent=#AttackInfo] openmw.types#Actor attacker (Optional) Attacking actor
--- @field [parent=#AttackInfo] openmw.types#Weapon weapon (Optional) Attacking weapon
--- @field [parent=#AttackInfo] #string ammo (Optional) Ammo record ID
--- @field [parent=#AttackInfo] openmw.util#Vector3 hitPos (Optional) Where on the victim the attack is landing. Used to spawn blood effects. Blood effects are skipped if nil.
-return {
-    --- Basic combat interface
-    -- @module Combat
-    -- @usage require('openmw.interfaces').Combat
-    --
-    --I.Combat.addOnHitHandler(function(attack)
-    --    -- Adds fatigue loss when hit by draining fatigue when taking health damage
-    --    if attack.damage.health and not attack.damage.fatigue then
-    --        local strengthFactor = Actor.stats.attributes.strength(self).modified / 100 * 0.66
-    --        local enduranceFactor = Actor.stats.attributes.endurance(self).modified / 100 * 0.34
-    --        local factor = 1 - math.min(strengthFactor + enduranceFactor, 1)
-    --        if factor > 0 then
-    --            attack.damage.fatigue = attack.damage.health * factor
-    --        end
-    --    end
-    --end)
+I.Combat.addOnHitHandler(onHit)
 
-    interfaceName = 'Combat',
-    interface = {
-        --- Interface version
-        -- @field [parent=#Combat] #number version
-        version = 1,
-
-        --- Add new onHit handler for this actor
-        -- If `handler(attack)` returns false, other handlers for
-        -- the call will be skipped. Where attack is the same @{#AttackInfo} passed to #Combat.onHit
-        -- @function [parent=#Combat] addOnHitHandler
-        -- @param #function handler The handler.
-        addOnHitHandler = function(handler)
-            onHitHandlers[#onHitHandlers + 1] = handler
-        end,
-
-        --- Calculates the character's armor rating and adjusts damage accordingly.
-        -- Note that this function only adjusts the number, use #Combat.applyArmor
-        -- to include other side effects.
-        -- @function [parent=#Combat] adjustDamageForArmor
-        -- @param #number Damage The numeric damage to adjust
-        -- @param openmw.core#GameObject actor (Optional) The actor to calculate the armor rating for. Defaults to self.
-        -- @return #number Damage adjusted for armor
-        adjustDamageForArmor = function(damage, actor) return adjustDamageForArmor(damage, actor or self) end,
-
-        --- Calculates a difficulty multiplier based on the current difficulty settings
-        -- and adjusts damage accordingly. Has no effect if both this actor and the
-        -- attacker are NPCs, or if both are Players.
-        -- @function [parent=#Combat] adjustDamageForDifficulty
-        -- @param #Attack attack The attack to adjust
-        -- @param openmw.core#GameObject defendant (Optional) The defendant to make the difficulty adjustment for. Defaults to self.
-        adjustDamageForDifficulty = function(attack, defendant) return adjustDamageForDifficulty(attack, defendant or self) end,
-
-        --- Applies this character's armor to the attack. Adjusts damage, reduces item
-        -- condition accordingly, progresses armor skill, and plays the armor appropriate
-        -- hit sound.
-        -- @function [parent=#Combat] applyArmor
-        -- @param #Attack attack
-        applyArmor = applyArmor,
-
-        --- Computes this character's armor rating.
-        -- Note that this interface function is read by the engine to update the UI.
-        -- This function can still be overridden same as any other interface, but must not call any functions or interfaces that modify anything.
-        -- @function [parent=#Combat] getArmorRating
-        -- @param openmw.core#GameObject actor (Optional) The actor to calculate the armor rating for. Defaults to self.
-        -- @return #number
-        getArmorRating = function(actor) return getArmorRating(actor or self) end,
-
-        --- Computes this character's armor rating.
-        -- You can override this to return any skill you wish (including non-armor skills, if you so wish).
-        -- Note that this interface function is read by the engine to update the UI.
-        -- This function can still be overridden same as any other interface, but must not call any functions or interfaces that modify anything.
-        -- @function [parent=#Combat] getArmorSkill
-        -- @param openmw.core#GameObject item The item
-        -- @return #string The armor skill identifier, or unarmored if the item was nil or not an instace of @{openmw.types#Armor}
-        getArmorSkill = getArmorSkill,
-
-        --- Computes the armor rating of a single piece of @{openmw.types#Armor}, adjusted for skill
-        -- Note that this interface function is read by the engine to update the UI.
-        -- This function can still be overridden same as any other interface, but must not call any functions or interfaces that modify anything.
-        -- @function [parent=#Combat] getSkillAdjustedArmorRating
-        -- @param openmw.core#GameObject item The item
-        -- @param openmw.core#GameObject actor (Optional) The actor, defaults to self
-        -- @return #number
-        getSkillAdjustedArmorRating = function(item, actor) return getSkillAdjustedArmorRating(item, actor or self) end,
-
-        --- Computes the effective armor rating of a single piece of @{openmw.types#Armor}, adjusted for skill and item condition
-        -- @function [parent=#Combat] getEffectiveArmorRating
-        -- @param openmw.core#GameObject item The item
-        -- @param openmw.core#GameObject actor (Optional) The actor, defaults to self
-        -- @return #number
-        getEffectiveArmorRating = function(item, actor) return getEffectiveArmorRating(item, actor or self) end,
-
-        --- Spawns a random blood effect at the given position
-        -- @function [parent=#Combat] spawnBloodEffect
-        -- @param openmw.util#Vector3 position
-        spawnBloodEffect = spawnBloodEffect,
-
-        --- Hit this actor. Normally called as Hit event from the attacking actor, with the same parameters.
-        -- @function [parent=#Combat] onHit
-        -- @param #AttackInfo attackInfo
-        onHit = onHit,
-
-        --- Picks a random armor slot and returns the item equipped in that slot.
-        -- Used to pick which armor to damage / skill to increase when hit during combat.
-        -- @function [parent=#Combat] pickRandomArmor
-        -- @param openmw.core#GameObject actor (Optional) The actor to pick armor from, defaults to self
-        -- @return openmw.core#GameObject The armor equipped in the chosen slot. nil if nothing was equipped in that slot.
-        pickRandomArmor = function(actor) return pickRandomArmor(actor or self) end,
-
-        --- @{#AttackSourceType}
-        -- @field [parent=#Combat] #AttackSourceType ATTACK_SOURCE_TYPES Available attack source types
-        ATTACK_SOURCE_TYPES = {
-            Magic = 'magic',
-            Melee = 'melee',
-            Ranged = 'ranged',
-            Unspecified = 'unspecified',
-        },
-    },
+local interface = auxUtil.shallowCopy(I.Combat)
+interface.adjustDamageForArmor = function(damage, actor) return adjustDamageForArmor(damage, actor or self) end
+interface.adjustDamageForDifficulty = function(attack, defendant) return adjustDamageForDifficulty(attack, defendant or self) end
+interface.applyArmor = applyArmor
+interface.getArmorRating = function(actor) return getArmorRating(actor or self) end
+interface.getArmorSkill = getArmorSkill
+interface.getSkillAdjustedArmorRating = function(item, actor) return getSkillAdjustedArmorRating(item, actor or self) end
+interface.getEffectiveArmorRating = function(item, actor) return getEffectiveArmorRating(item, actor or self) end
+interface.spawnBloodEffect = spawnBloodEffect
+interface.pickRandomArmor = function(actor) return pickRandomArmor(actor or self) end
 
-    eventHandlers = {
-        Hit = function(data) I.Combat.onHit(data) end,
-    },
+return {
+    interfaceName = 'Combat',
+    interface = interface
 }