Enemy Highlighter
Package Info
By: ThePhoenix
For(MUD): Achaea
Size: 4kb
Website: http://dl.dropbox.com/u/22569276/EnemyHighlighter.zip
Version: 2.6
Contents: EnemyHighlighter.xml
Summary/Description: This package is an extremely quick enemy-highlighter. It is precise, only ever highlighting the full name, and highlighting all of the full name on that line. Using obscene amounts of names on a line, you can introduce minor lag... Obscene being something such as doing 'city enemies' in Mhaldor (2000 enemies to highlight, anyone?). However, even so, it is fast to do them. Check out the benchmarks at the bottom. This package uses substring triggers for fastest results.
Feedback is desired. If you have any questions, send me an email.
Related Packages: None.
Other Packages made by this Package Author:
API
Aliases
enhi
Syntax: enhi <command>
- This is currently the only alias in the system. It's a very simply alias - simply use 'enhi' before the normal command, to highlight them. After enhi you use the normal Achaean syntax for checking the enemies. For instance:
enhi city enemies - this would highlight city enemies.
enhi clan example enemies - this would highlight all the enemies of that clan.
Functions
colorAll()
colorAll(word[, fg[, bg[, italic[, underline[, bold[, noCase]]]]]])
This function will color all of 'word' in the line. It will not find it inside another word, only highlighting full words. All arguments aside from word are optional
- Parameters
- fg, bg
- These arguments take either a color name from showColors(), or r,g,b format (in string).
- italic
- Boolean value. If it is true, the word will be made italic.
- underline
- Boolean value. If it is true, the word will be underlined.
- bold
- Boolean value. If it is true, the word will be made bold.
- noCase
- Boolean value. If it is true, all of <word> will be matched on the line, regardless of case.
- Example
<lua> colorAll(word,"blue","134,234,12", true, false, false, true) --In this example, all of 'word' will be colored blue on a yellowy-greenish background. --They will be made italic, and the case will not matter. </lua>
isEnemy()
isEnemy(person[, place[, orAll]])
This function will check to see if 'person' is an enemy to 'place', or if 'person' is a known enemy period. This function is made to be extremely quick.
- Parameters:
- person
- String value. This is the name of the person to check.
- place
- string value. This is an optional argument for place to check. If this place does not exist, it will default to 'false'.
- orAll
- Boolean value. If 'place' does not exist, will check everywhere if this is true.
- Example
<lua> isEnemy("Rakon","the City of Hashan", true) -- In this example, if "Rakon" is an enemy of "the City of Hashan", it will return true. -- If we do not know the enemies of his place, it will check -all- places. </lua>
Changing Enemy Colors
Benchmarks
These benchmarks are done while running this highlighter in conjunction svo. In other words... alone, it'd probably be faster still.
- highlighter
0 enemies to search for, 814 words on the line, 0 highlights - 0.032 seconds to parse the line.
814 enemies to search for, 814 words on the line, 814 unique highlights - 0.352 seconds to parse the line.
814 enemies to search for, 1628 enemies on the line, 814 enemies (Doubled the names up, so it did two highlights per name) - 0.6 seconds
814 enemies to search for, 106 words on the line, 53 enemies, each name twice per line - (106 total highlights)- 0.008 seconds
814 enemies to search for, 5000 words on the line, 20 enemies on the line - 0.1 second
814 enemies to search for, 5000 words on the line, 1 enemies name, - 0.010 seconds
814 enemies to search for, 84 words on the line, 1 enemies name, - 0.003 seconds.
- isEnemy
10,000 iterations of isEnemy takes 0.01 seconds.
Bugs
Ok. There are a few. Lets note them here. Feature requests too, why not.
Submitter: ThePhoenix
Bug/Feature: Checking multiple lists only formats the last list.
Status: Confirmed
Submitter: Jarrod
Bug/Feature: Personal enemy lists.
Status: Wishlist
Change Log
-v2.6-
Added isEnemy, a function to check if someone is an enemy. 07.27.2011 6:50PM
-v2.5-
--Added functionality to colorAll - takes a lot more types of formatting now, as well as rgb color. --Updated enemy triggers and tables and such to match the updates.
-v2.3-
--Added enhi alias, so that it doesn't re-highlight any time you check city enemies.
--Added a stopwatch trigger set, to take benchmarks of 'city enemies' and such.
-v2.1-
--Minor bug in deletion of triggers, now fixed.
-v2.0-
--Got rid of the highlight bug, and switched back to substrings. colorAll is now a -lot- better.
--Speed improvements are amazing in this release.
-v1.0-
--First 'final' release, all bugs are out of the system, except for a single highlight bug...
--Turned off the no-case pattern for enemy names, sped it up considerably.
-v0.7-
--Switched to regex trigger, allows me to specify only coloring on a word.
--Fixed triggers deleting themselves, they weren't always.
-v0.6-
--Bit of debugging, made triggers delete themselves before creating new.
--Added colorization for multiple people on a line, major issues with coloring within words
-v0.5-
--Initial script, only highglights first instance of name. City must be changed to match in trigger. Single filter trigger makes it run.
--Improvement from using colourizer triggers made manually.