[DONE] more debug logging for mission scripts processing?

[psavola]

I've had several campaigns where mission scripts have had really strange RNG, like a mission with 0.33 probability not occurring for 12 months in a row even though the requirements are met (the mathematical probability for something like this being less than 1 %).

Would it be possible to include a debug log, for example before this check in GeoscapeState::determineAlienMissions()? If the debug log showed which potential missions proceeded to the RNG check, at least you might be able to rule out any bugs before that? (Looking at the RNG code it would be far more intrusive and spammy to add debugging there.)

                                // level three condition check: does random chance favour this command's execution?
                                if (triggerHappy && RNG::percent(eventScript->getExecutionOdds()))
                                {
                                        relevantEventScripts.push_back(eventScript);
                                }

[Meridian]

it's possible

I didn't add it because it would make the log 10x longer (and it's already too long)

[psavola]

it's possible

I didn't add it because it would make the log 10x longer (and it's already too long)

Doesn't this run only once a month? If so, is this such a bad thing? And it wouldn't need to be printed except when debug is true.

[Meridian]

yes, it runs once a month
with mods like XCF having most odds around 3%, it would be more like 30x more than just 10x more

I don't need this if it runs only when debug mode is turned on (nobody plays a campaign in debug mode)
(if you meant debug: true in options.cfg, then I also don't need that because practically everyone has it turned on)

[psavola]

I'm thinking of a use case where you have a suspicion that something is could be wrong, so you save just before the end of month. Then enable extra logging and wait for the end of the month, then look at the logs if you can figure out anything. After that you could continue the campaign until the next end-of-month as normal.

[Yankes]

probably `verboseLogging` user config is what you search for, its already spam heavy logs with different details.

[Meridian]

Added: https://github.com/MeridianOXC/OpenXcom/commit/f1777b086338195a498ce41127b33c2fdf0a66a2
Requires "verboseLogging: true" in options.cfg

"rng: 0" means false
"rng: 1" means true

Sample output:

Code: [Select]

geoscapeDebugLog:
  - "month: 3 script: shipTerror odds: 60 rng: 0"
  - "month: 3 script: recurringTerror odds: 100 rng: 1"
  - "month: 3 script: recurringTerror id: 9 type: STR_ALIEN_SURFACE_ATTACK race: STR_GILLMAN region: STR_INDIAN_OCEAN targetZone: 3 targetArea: 4"
  - "month: 3 script: recon odds: 100 rng: 1"
  - "month: 3 script: recon id: 10 type: STR_ALIEN_INTERDICTION race: STR_GILLMAN region: STR_NORTH_SEA targetZone: -1 targetArea: -1"
  - "month: 3 script: researchRetaliation odds: 100 rng: 1"
  - "month: 3 script: researchRetaliation id: 11 type: STR_ALIEN_RETALIATION race: STR_LOBSTERMAN region: STR_SOUTH_ATLANTIC targetZone: -1 targetArea: -1"


[psavola]

Very nice, this was more than I had hoped for. 

The update was very timely. My very strange run with the cumulative probability <1% continued for another month. But at least I now I can blame the RNG with clear conscience.

  - "month: 25 script: frontierPsychiatrist odds: 33 rng: 0"