Add Debug to properties.yml

[tayjay]

Notice to Plugin Developers

Not a breaking change, but developers that have not explicitly set canBePrinted to true in their Logger.Debug calls will not see [DEBUG] message in the Console until debug is set true in configs/{PORT}/{Plugin}/properties.yml. Existing custom Debug configs will still work if prefered.

Changes

• Adds bool debug to plugins' properties.yml to control default Debug log behaviour.
  • Logger.Debug(object) will check for this Debug value before printing.
  • Logger.Debug(object,bool) will override the Debug check.
  • debug value is updated when Properties are loaded on initial LabAPI load.
• Adds LabAPIConfig bool debug_override, if set true will force all Debugs to display, unless overrode by Logger.Debug(object,bool)

Notes

Purpose is to prevent console spam of unhandled Debug calls when a plugin is published.

Same names from EXILED were only used to improve experience of developers adopting LabAPI. Implementation is custom but used most optimal patterns if it matched theirs.

Updating the Debug property could be handled on Per-Plugin reload but wanted to reduce changes first time around.

[davidsebesta1]

Nice 👍

[davidsebesta1]

Same

[tayjay]

See line 27, was following the same way LoadUnsupportedPlugins was commented.

[davidsebesta1]

Forcing a parameter on devs is in fact, breaking change.

[tayjay]

The overloaded Debug method on line 36 will be used if only 1 parameter is provided. So it is not forced, just explicitly defined. Plugins that are already built will have the default "true" parameter included automatically and the IL will point them to Logger::Debug(object,bool) which is present.

[tayjay]

Overall on my code comments I was just wanting to be thorough on my reasoning on why I did each one. I'll do a bulk trim of them.

[tayjay]

Thank you for the feedback. I have made the suggested revisions. :)

This change should be inert for plugins compiled for existing LabAPI versions. If the developer did not specify a second parameter the compiler will have included the default true (ldc.i4.1) before it calls

call void [LabApi]LabApi.Features.Console.Logger::Debug(object, bool)

With this change the 1 parameter overload would be used on new builds

call void [LabApi]LabApi.Features.Console.Logger::Debug(object)

The [opt] tag on the parameter in the current Debug method is not seen by the calling plugin. It will not be aware of its removal.

---

This does change the default behaviour of the Debug method, essentially replacing canBePrinted=true with canBePrinted=false and a config option to change it. I can see the rationale for this being a breaking change, but I feel that Debug off by default is better to get to eventually.