What is this?
This aura facilitates easy debug messages for WeakAura developers. Ever since I've recently started learning how to use custom code in WeakAuras, I've found that one common thing over all my projects is the need to have robust debug code during development. It started as a simple "print" function that I included in all my projects and has grown to be very versatile and robust over time. I figured I'd package it up for public use and share it for other WA devs.
Features
>"Detached"
You only need to include minimal code to in your own auras as pretty much everything is handled "remotely" via WeakAuras.ScanEvent().
>Message "Groups"
Define different types of messages each with different formatting. Reuse these message groups over multiple projects. Easily Enable/Disable all messages in a group.
"templates" would've been a more descriptive name but I can't be arsed to change it at this point
>Automatic Key/Value Pair Printing
Most of the time a debug message is made to print out variable values at different points of execution. This helps simplify that process (and helps make table output readable as well).
>All output is ran through tostring() first to prevent any issues with nil values or different data types
I don't know about you but there were many times where I was trying to find a bug and it turned out to be the debug message itself
>Reroute output to another chatframe
The only way to route output to a chatwindow other than the default is via https://wowwiki.fandom.com/wiki/API_MessageFrame_AddMessage , (thanks to asakawa for pointing this function out to me) which has a lot more limitations than print(). This makes it easy to switch between chat frames and is also pretty much seamless.
>It looks nice!
and it's also easy to customize via the User Options interface
Usage
> Just have this aura installed and loaded; It responds to "DPRINT" events sent by any other aura.
> Fire an event with:
WeakAuras.ScanEvents("DPRINT", groupName, prefix, message, ...)
- groupName is the message template you want to use for the debug message
- prefix will prefix the message sent (I personally send 'aura_env.id' as the prefix so I know which aura each message is coming from) You can disable prefixes in User Options
- All additional args after "message" will print in a key/value format automatically. (ie, odd args will print as keys, even args will print as values, pairs print on separate lines)
- You can enable/disable this behavior in User Options
- Additionally, you can specify "keywords" to print out all arguments after that keyword as values. (ie, printing out a list of args)
> This is the function I personally put at the top of all my projects:
aura_env.debug_print = function(group,msg,...)
return WeakAuras.ScanEvents("DPRINT",group,aura_env.id,msg,...)
end
Obviously you can make it a local function or name it whatever you want for less typing.
>Some examples:
A debug message with some key/value pairs:
aura_env.debug_print("fail", "Something bad happened!", "Variable 1", var1, "Variable 2", var2)
A debug message using a "keyword" to stop printing as pairs:
aura_env.debug_print("warning", "Something iffy happened!", "Variable 1", var1, "Variable 2", var2, "args", arg1,arg2,arg3)
Everything else should be pretty self explanatory.
I also included a demo aura that shows off how it works. It triggers demo debug messages from: player movement, player target change, modifier key pressed, player spell cast start and spell cast success |
1、在门户里发表的文章仅代表作者本人的观点,与本网站立场无关。
2、门户的所有内容都不保证其准确性,有效性,时间性。阅读本站内容因误导等因素而造成的损失本站不承担连带责任。
3、当政府机关依照法定程序要求披露信息时,论坛均得免责。
4、若因线路及非本站所能控制范围的故障导致暂停服务期间造成的一切不便与损失,论坛不负任何责任。
5、注册会员通过任何手段和方法针对论坛进行破坏,我们有权对其行为作出处理。并保留进步追究其责任的权利。
|
楼主
提升卡
千斤顶