With [Game] real time combat and the new [Game] hit reactions setting on (default), melee hits cause short reactions: - A connecting hit queues a flinch of 0.2 to 0.7 s, growing with damage up to a quarter of max health and halved at zero attack strength. It starts when the hit's stagger is applied, so Lua's ignoreStagger and god mode prevent it. - A blocked hit or parry makes the blocker recoil for 0.1 to 0.25 s, and a blocked blow at 0.75 strength or more staggers the attacker for 0.25 to 0.6 s. - During any reaction, an attack wind-up is interrupted and no new attack starts. Hit animations still play where the content has them; the timer works without them, as on the Game Template. The rules are in mwmechanics/hitreaction.cpp. The shield block and parry resolution moves into resolveMeleeBlock, shared by NPCs and creatures. The combat scenario now counts reactions. Also moves a stray line of the ai active blocking docs back under that setting. Closes #22 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Building OpenMW documentation
Building in Docker (the recommended way)
Preparing Docker image
Run the following commands from OpenMW source directory to build a new Docker image openmw_doc:
cd docs
docker build -t openmw_doc .
cd ..
(or run script docs/prepare_docker_image.sh)
This step needs to be repeated only if any dependencies were changed.
The image is based on Ubuntu 22.04 and installs the system tools and Python packages required to build the documentation. The bundled installation script builds Lua 5.1 and LuaRocks and installs a pinned version of openmwluadocumentor.
Generating HTML
Run the following command from OpenMW source directory to generate the documentation:
docker run --user "$(id -u)":"$(id -g)" --volume "$PWD":/openmw openmw_doc \
sphinx-build /openmw/docs/source /openmw/docs/build
(or run script docs/build_docs.sh)
To view the generated documentation just open docs/build/index.html in a browser.
Building without Docker (an alternative way)
Building documentation without Docker is more complicated as it requires multiple dependencies.
Installation of required python packages
From OpenMW source directory
pip3 install -r docs/requirements.txt
Installation of openmwluadocumentor:
Debian/Ubuntu
sudo apt install luarocks
git clone https://gitlab.com/ptmikheev/openmw-luadocumentor.git
cd openmw-luadocumentor/luarocks
luarocks --local pack openmwluadocumentor-0.2.0-1.rockspec
luarocks --local install openmwluadocumentor-0.2.0-1.src.rock
Windows
- install LuaRocks (heavily recommended to use the standalone package) https://github.com/luarocks/luarocks/wiki/Installation-instructions-for-Windows
git clone https://gitlab.com/ptmikheev/openmw-luadocumentor.gitcd openmw-luadocumentor/luarocks- open "Developer Command Prompt for VS <2017/2019>" in this directory and run:
luarocks --local pack openmwluadocumentor-0.2.0-1.rockspec
luarocks --local install openmwluadocumentor-0.2.0-1.src.rock
Generating HTML
Run the following command from OpenMW source directory to generate the documentation:
sphinx-build docs/source docs/build