Snippet Debug Block

[Jesus4Lyf]

Debug Block​

A very simple snippet for having blocks of code in debug mode only, or not in debug mode only.

//! textmacro StartDebug
    static if false then
    debug endif
//! endtextmacro
//! textmacro EndDebug
    debug static if false then
    endif
//! endtextmacro
//! textmacro StartNoDebug
    debug static if false then
//! endtextmacro
//! textmacro EndNoDebug
    debug endif
//! endtextmacro

Test script (and example use):

scope TestDebugMode initializer OnInit
    private function OnInit takes nothing returns nothing
        //! runtextmacro StartDebug()
            call BJDebugMsg("Debug Mode")
        //! runtextmacro EndDebug()
        //! runtextmacro StartNoDebug()
            call BJDebugMsg("No Debug Mode")
        //! runtextmacro EndNoDebug()
    endfunction
endscope

This abuses static ifs. You can remove functions from your map using this (but defining a function for debug mode and for non-debug mode will count as a multiple declaration still). Does not work for global variable declarations.

 

[Renendaru]

Cool trick there. I half-expected you to come out with this.

 

[Gtam]

how is this diffrent that puting debug infront of the lines you want in debug mode

 

[Jesus4Lyf]

It is shorter.

The premise is you may have 20 lines, or a few entire functions, that you want for debug mode.

 

[Gtam]

oh but is debug mode like singleplayer only or only when the test map is used?

 

[Lyerae]

When debug mode is enabled...
Read the JassHelper manual dude. It's awesome.

So this'll let us create blocks of debug-only code? Well that saves a lot of time typing.

 

[Deaod]

only inside functions, since static ifs also only work inside functions.

 

[Artificial]

static if DEBUG_MODE then
    // Debug mode is on.
else
    // Debug mode is off.
endif

Works, does it not?

You may also use the constant boolean DEBUG_MODE which is set to true or false depending on whether the debug mode is enabled.

0.9.Z.4:
[...]
* You may now use the identifier DEBUG_MODE as a constant boolean that is true if and only if debug mode is on.

 

[Troll-Brain]

Seriously textmacros are ugly, i mean in general using, i would prefer use a static if directly like Artificial showed.

 

[Romek]

Artificial speaks the truth.

Not only does that look clearer, but it's also shorter to type than a textmacro.

 

[Jesus4Lyf]

Was wondering if it existed. Good call.

>only inside functions, since static ifs also only work inside functions.
Nope. XD