search

adventuregamestudio / ags-manual

AGS documentation.
https://adventuregamestudio.github.io/ags-manual/
MIT License
26 stars 9 forks source link

Document specific engine log messages #243

Open ivan-mogilko opened 5 months ago

ivan-mogilko commented 5 months ago

There are script log messages in a following format: (room:%d) [%s %d] where ags will print error location in square brackets, using a single letter and a number. https://github.com/adventuregamestudio/ags/blob/12b7f62fce17bb5fdbf4aa5464268b3dcbcebd67/Engine/debug/debug.cpp#L369

May be worth documenting their meaning somewhere. But also have to note that these may be engine-specific and change in future (just in case).

ericoporto commented 5 months ago

There was the idea of GameFeatures that we didn't fleshed out, perhaps there with a link to/from the Log Panel page.

Other possibility is consider logging something in Engine, and then add a topic on Engine logging and place it there.

ivan-mogilko commented 5 months ago

Yes, I think "engine logging" topic in Engine section would look better, because this is not really a game feature, it's just engine reporting about something.

ericoporto commented 4 months ago

Hey, I don't understand what the ? means in this case. It's not the game script (module ?), Room Script, or the Dialog Script. Which script is it than that would cause the ? character?

Edit: I think G means global script and ? means is any other script module.

ivan-mogilko commented 3 months ago

Edit: I think G means global script and ? means is any other script module.

Right, and that's kind of weird. I think it's possible that this code was written at the time when custom modules ~did not exist~ were not supported, so the ? means "undefined behavior". Perhaps we should change it to something, like M or a module's index.