[Snippet] Debug

[LuizBills]

library DebugToolkit 
    /*! by LuizBills | v1.1.0 */ 

    globals
        private constant real MSG_DURATION = 60 // seconds
        
        private constant string COLOR_LOG = "FFFFFF"
        private constant string COLOR_WARN = "FF851B"
        private constant string COLOR_ERROR = "FF4136"
        
        private constant string PREFIX_LOG = ""
        private constant string PREFIX_WARN = "[WARNING] "
        private constant string PREFIX_ERROR = "[ERROR] "
    endglobals

    struct Debug extends array

        // Displays a normal message
        static method log takes string msg returns nothing
            call DisplayTimedTextToPlayer(GetLocalPlayer(), 0, 0, MSG_DURATION, "|cFF" + COLOR_LOG + PREFIX_LOG + msg + "|r")
        endmethod

        // Displays an warning message
        static method warn takes string msg returns nothing
            debug call DisplayTimedTextToPlayer(GetLocalPlayer(), 0, 0, MSG_DURATION, "|cFF" + COLOR_WARN + PREFIX_WARN + msg + "|r")
        endmethod

        // Displays an error message
        static method error takes string msg returns nothing
            debug call DisplayTimedTextToPlayer(GetLocalPlayer(), 0, 0, MSG_DURATION, "|cFF" + COLOR_ERROR + PREFIX_ERROR + msg + "|r")
        endmethod

        /* Displays an error message if the condition is false
         *
         * @param {boolean} A boolean, which references whether your test passed or failed
         * @param {string} A short description of your test
         *
         * @example
         *    ```
         *    call Debug.assert(1 == 1, "it will never be shown")
         *    call Debug.assert(1 == 0, "it will be shown")
         *    ```
         */
        static method assert takes boolean condition, string msg returns nothing
            if (not condition) then
                call thistype.error(msg)
            endif
        endmethod
        
        /*
        static if DEBUG_MODE then
        static method onInit takes nothing returns nothing
            // test
            call thistype.log("foo")
            call thistype.warn("bar")
            call thistype.error("taz")
        endmethod
        endif
        */
    endstruct

endlibrary

CHANGELOG

v1.0.0
- first release

v1.1.0
- Now "[WARNING] " and "[ERROR] " prefixes are configurables

 

[PurgeandFire]

Library name should be a little more specific, e.g. "DebugMessage". (I'll update the thread title accordingly)

And according to JPAG, function names should be capitalized.

Apart from that, there is nothing wrong with it. Assert is particularly useful.

 

[LuizBills]

Library name should be a little more specific, e.g. "DebugMessage". (I'll update the thread title accordingly)

And according to JPAG, function names should be capitalized.

Apart from that, there is nothing wrong with it. Assert is particularly useful.

Thanks for your suggestions. Updated.

 

[TriggerHappy]

Maybe"[WARNING] "and"[ERROR] "should be configurable?

 

[LuizBills]

why?

 

[TriggerHappy]

why?

Because I don't like it lol

 

[Troll-Brain]

why?

Because he is an active jass moderator and you're a simple peon

 

[TriggerHappy]

Because he is an active jass moderator and you're a simple peon

 

[Troll-Brain]

Hey, i was just kidding trolling.
Nothing serious.

Yes, configurable part would be better.

 

[Krogoth]

Displays an warning message

Displays a warning message

 

[TriggerHappy]

Approved.

I still think [WARNING] and [ERROR] should be configurable.

 

[LuizBills]

Updated.

 

[edo494]

after year but it looks good

 

[BPower]

A valid alternative to ErrorMessage. I like it.

 

[LuizBills]

Thank you guys