How To Enable A Script Break Warning

How to enable an in-game warning for script breaks.

Introduction

The context viewer, usually intended for modders, can give you a warning when you have a script break in your game. A script break occurs when a Lua script throws an error while running. This in turn crashes the whole in-game Lua interpreter, so other script mods stop working as well, as well as some vanilla game features powered by scripts. You should never play the game with broken scripts.

Enable in game options

In the options menu click the gear icon and under the "Modding" header check the "Enable context viewer" checkbox.

In-game warning

if you have a script break you will see a red cross in the top right of your screen:


Reload the last save and do not play the game with broken scripts. It's possible you'll have to find and disable the mod that caused the script break.

Caveat

Once a script warning shows it'll always persist from then on if you save the game with it showing. So in cases where a reload somehow causes the script to not break (possible with some scripts) or in cases where you remove a script mod that was the cause, you'd expect the warning to disappear, but it'll always stay there when you load the game where the warning was already showing. You must reload a save from before the warning appeared.

Error in the script log

If you enable the script log using an option in the WH3 Mod Manager (inside Other Options) or using the Script debug activator mod you will have script logs saved into the directory where your Warhammer3.exe is located. Script logs have a file name like script_log_010524_1229.txt. If you get a script error it will get logged in that file and reporting it could help a modder fix the error. Post your log in https://discord.gg/moddingden, in the mod_user_troubleshooting channel.

[blackiswhite1]

seem to have run into an issue i can no longer solve after two months of trying, and blaming it all on mods, but it turns out this isnt the case. the problem is that I was playing as the dwarfs and couldnt play a manual battle, an autoresolve, or occupy, or really do anything without the game freezing then crashing. tried everything with my mods but couldnt narrow down the problem. eventually i just uninstalled the game, clean reinstall, deactivated all mods, then boot up the game, i still get a script break warning in campaign UI benchmark, but not in actual campaign, so i cant even see what the problem is, and i have nowhere else to turn to because google is very unhelpful when you ask it precise questions and it gives you irrelevant answers. help?

[dotanuki]

I deleted all the log txt files in the main wh3 directory after the 31st patch and the button is back.

[prop joe]

it shows for "script breaks" meaning your scripts won't work at all

[=[NK]= Col. Jack O'Neil]

Would script breaks display the x for minor script issues, like a value being wrong, or only the major breaks that flag errors on the logged script file?

[Lampros]

I see. Thanks!

[prop joe]

usually an error has the name of the script that caused it, so you can kind of guess by the prefix and the name of the script, or post in the modding den and someone will know

[Lampros]

But how do you find which mod has script breaks?

[Guvenoren]

Got it, all I need to know!

[prop joe]

you don't have to be concerned based on my experience and the experience of other modders who always have this enabled

[Guvenoren]

It has a noticable stability warning. Should I be concerned?