Triggers

=====================================================================================================================

WELCOME TO JOHNYSONE'S ROBO-TEXTER SYSTEM !! (You can call it Letter-Quest-Message progressively-displayer, it's kinda a long name).

READ THE TRIGGERS BELOW FOR MORE KEWL INFO.

Visit http://www.hiveworkshop.com for freakingly more info, systems, spells, models, skins, maps, tutorials, packs, tools, and MUCH MORE !

Author : Jonhysone.

Date of creation : 8/11/2015 (08 November 2015)

Date of the last update : 11/11/2015 (10 November 2015)

Version of Release : 1.0.3c

Credits :
- Dr. SuperGood and Bribe for explaining some algorithms of chat-dividing...
- Tank-Commander for the considerable insipration.


=====================================================================================================================

I may include these features in the future :
- Fade in-and-out (Transparency-controler) method to game messages and floating messages and also quest messages.
- Rainbow theme to messages for different occasions (Fun-feature) soon.
- Colour library with gradient colours to support gradiently-coloured messages.
- Adding more binding buttons (Including letters, numbers, symbols)
- Other things suggested by people.

Good luck using this.

=================================================== CHANGE LOG =====================================================

The version number syntax is built like this : X.Y.Zt (X= A brand new system build, Y=New feature, Z=Major bug fix, t= minor bug fix).

1.0.0a [Date : 08 November 2015) :
- Initial Release

1.0.1a [Date : 09 November 2015) :
- Fixed a bug where player messages were not being shown in both floating text mode and game-message text mode (Shown as blank messages)

1.0.3b [Date : 10 November 2015) :
- Fixed a bug that prevented Colour-checking algorithm from checking colourtags that are put in the very beginning.
- Changed the method of indexing units which used UnitData (Custom Value) to a simpler hashtable indexing.
- Improved the comment documentation a little bit.

1.0.3c [Date : 11 November 2015)
- Explained (in Trigger comments and comment lines) what the core of the system is. (A moderator notice)

Found a bug? Report it on the hiveworkshop to Jonhysone's profile or comment on the resource's post.

=====================================================================================================================

=========== The use of this system is really simple, what it does : ==========================================================

- You can show Quests as "Robo-texting" mode. When the quest is finally shown , there will be an auto-timer to hide it.
- Players can shout to take attention.
- Players can bind their own sentences, so it can be used later via one-click. They can also unbind keys on and on.
- Players can shout not only as a game-text , but as a floating-text too;..
- The ability to turn ON and OFF the SFXs ( Sound Effects).
- Players can COLOR their messages using different simple color tags.
- Player can make their message unrobo-able. They can add -unrobo at the end of the message. (This doesn't work in Quest messages, because it can be configured by a boolean before any quest detecting operation).
- Helps mapmakers to save some time because they can add simple colour tags presented in JSL_Setup trigger, without the need to search for the hex-complicated code in other programs.

===============================================================================================================

============================== Pros ==============================================================================
- It is fully configurable.
- Can be merged with that system that prevents players from chatting except by filtering it. Now those filtered messages can be robo-texted.
- Quests' messages will be even neater.
- Doesn't require any delay, also, it's so simple.
- Players can't spam shouting-messages.
- Key-stroke sound effects attached, too.
- Doesn't need any Object-Editor data.
- Players can't override Quest messages, so quest messages will be shown normally. They can use floating texts instead because they'll still be shown (Floating texts move with the unit group selected)
- Different color tags, yet not too many.
- It is fully documented and is fully GUI-friendly, and it is very-widely configurable, and is -of course- MUI/MPI.

============================== Cons : ============================================================================
- Shout-mode's game-texts affect normal game-messages.
WHAT-TO-DO with this : Just show your game-messages the same way Quests messages are shown (not necessarily robo-texted), use a periodic displayer.

- Currently HTTP hexx color tags aren't really supported in any quest message.
WHY : Since color tag codes are "letters" and "numbers" and are "long", the system will just show the code letter-by-letter, so for example :
We want to show "|cFFF00000 Hello there|r" totally black... well it won't be shown black, until the system reaches that "|r" symbol.
WHAT-TO-DO with this : Use my own simple colour tags (Like this : #BLACK# Hello!) , you'll save your time.

===================================================== HOW TO IMPORT ====================================================

1- Import the whole "JS letter system" trigger category (folder) into your map. (Remember to check "create unknown variables" in editor's preferences).
2- Import both sound effects. and "Use them as Sound" in Sound Editor. (In case you want the SFX on).
3- Remove all trigger comments, including those 'HELP' triggers. Keep only the normal triggers.
4- Read "How to use/merge with your map

=========================================================================================================================

========================================= How to use it and merge it with your map ===========================================

NOTE 1 : First of all, if you want to show your quest, all you have to do is follow the example in "Quester 1" trigger under the "Just for this map" category/folder.
There is a string variable which stores the content of the quest, and there is a real variable that makes the system detects the quest,
all you have to do is set this real non-array variable "JSL_QuestDetector" to 1 every time you add a new quest. When the quest finishes displaying, re-set it to 0.

NOTE 2 : If you want to merge your system with the Chat-message-hider system (There is one on the hive), just import JSL system (of course, this system) and in the other system ,
disable the trigger that shows players messages, and use this one's instead.

NOTE 3 : Everything , is totally configurable. This is fully GUI-friendly, it doesn't use any Custom script , except in one case, leak removal. So if you don't understand something, just feel free to contact me in the hive.

NOTE 4 : Floating texts are shown above as much units as you want. So if you want to add an unit to the unit group whose floating texts are shown above, all you have to do is increase
the JSL_FT_Indexer integer variable by 1, then save the wanted unit's handle as JSL_FT_Indexer in JSL_Hashtable3.
Floating text's handles will be saved by the same integer under the same parent key but in JSL_Hashtable2 , so there will be a syncronization that links units to their floating texts.
SEE "This Map" test trigger for an observable indexing operation.

NOTE 5: This system shows quests as "Game messages", so quests' log won't be updated, use 'Quest - Update Quest or Quest message' with a blank text if you want to add the quest to quests' log in F9 menu.

=====================================================================================================================

======================================= HOW THE SYSTEM WORKS ===================================================

===================== How it generally works ====================================

The system isn't actually complicated, furthermore it follows everything you configure in "JSL Configuration" trigger. The robo-texting displayer will show each letter periodically.
So since there isn't a constant periodic trigger (such as : every 0.07 seconds, show the next letter), it's much advanced than that, it uses a random variable between two constant reals,
that's just to make the system look real. so there is a trigger to randomize the period (JSL Shouting Refresher), and there is a trigger to display the text simulatineously (JSL Shouting Show).
The same method is used for the Quest system, no changes, except that the JSL Shouting system is MUI and MPI, while the Quest system doesn't need that, there is only one quest, thus one instance...

===================== How color-tags checker works ==================================

This is a little bit more complicated algorithm. (Yet simple :D) Since there are colours with 3 letters, 4 letters, 5 letters or 6 letters in their names, it'll be a little ryhtmy-repeat-dat method.

===================== How binding trigger works ======================================

The bound text will be saved in a children key of the "bound-to key" and the parent key of the binding player in JSL_Hashtable, once the key is pressed, that value will be called from the hashtable. That button will no longer be "Unbound" (of Course). But everytime it is unbound by the command "-unbind -button-" then it'll be unbound. Every key has its own integer indexer. (It's just like having names, in this case, buttons have numbers). So every boolean for every button has an array with the number of the button. (For example the boolean JSL_IsKeyUnbound).

=====================================================================================================================

======================================= IMPORTANT NOTES ===================================================

1\- So this system is just to show messages of players COLOURED and ROBO-ED.
The first option is on by default, (If you don't want it to work, remove the corresponding colour-checking algorithm triggers in JSL Shouting Refresher). The second option will work
only if the player wants to. The -unrobo command will be verified once a message is submitted.
Quests are a different thing, just show them normally by "GAME - SHOW GAME MESSAGE AUTO-TIMED" trigger in case you don't want them to be roboed. In this case you won't have
to increase QuestDetector real variable.

2\- You can add colours on your own in JSL Setup , make sure you add ColourEnglish with an english syntax, then another variable ColourHex with the hex code of the colour.
The array value will be one of your own, make sure it doesn't overwrite any of my existing colours already. (Which means you give it an array that's higher than 13.)
[[ Make sure also the array of ColourHex and the array of ColourEnglish are similiar. ]]
[[ Make sure you change the "13" number to the highest array used by you, in every ForEachInteger trigger under the colour-checking algorithm ...]]
[[ It'll be something like For Each Integer from 0 to 20 for example , in case you add 7 colours for example ...]]

=====================================================================================================================

============================== F . A . Q ==================================
- Why does this have so many triggers ?!

£££= This is not a simple system (nor is it complicated), but yet it does"many" things, such as binding (One trigger) , Unbinding (One trigger) , Configuration and Setup (Could have been compiled but they are seperated for the sake of clearness), Responding to 5 keys (5 Triggers), responding to any message (One trigger), Refreshing the message (quest mode and shout mode 2 triggers), showing the messages (Quest and Shout : 2 triggers), Indexing (1 Trigger), Detecting a quest (1 trigger), Hiding a quest (1 Trigger). See bruh ?!

- Why does this use two hashtables ?!

£££= One hashtable isn't enough. The first hashtable (JSL_Hashtable) stores bound (saved) text according to buttons (Child keys) under a parent key of the binding player. But the second hashtable stores floating texts, if the number of the units that have floating texts above, some child keys would get overwritten, a brand-new hashtable (JSL_Hashtable2) would be enough to make everything bug-free.

- Where and how would I this ? What do I use it for ?!
£££= This is made to save time for RPG-maps makers to show quests in a neater way, and even saves every map maker's time by helping them use colour tags very easily by copying colour-checking algorithm. This is also good in realistic-chat system that hides warcraft's chat messages and replaces them with either floating texts (Maniac with a saw for example) or with game messages (The Thing map for example) , and the ability to even use colour tags in there too. This is also good for LOAP maps and RPG maps, players can store their messages (long messages I.) for later use...
It also shows an example of simple indexing system and linking something to an unit without using custom values. (In this case I am linking every unit to its floating text in two different hashtables.


=========================================================================

======================================================== Explaining the core of the system ===========================================================

First of all, this is a system that's split to different features, thus, every feature has its own core.
And It's cleared up using comment trigger lines.
Before copying any single feature, copy the configuration and setup triggers, they are no core and no optional addon of course, but they are horribly important.

- If you want to copy Quest mode :
# After copying the initialization triggers, copy everything that's under JSL's Questing Mode. That's the whole core, a trigger removed , the whole system won't work.

- If you want the binding and shouting mode :
# Copy everything under JSL's shouting mode and JSL's Binding Mode. That's all the core...

- Question : Seriously, everything is the core?!
# Yes , or not really, the core triggers are listed by trigger comments. Everything else is a core-helper (Not an add-on) except two things, the colour-cheking algorithm system,
you can remove it (It's obviously there surrounded highlighted by Comment lines), and also that small line of sound-playing (obvious too).
Which means, you SHOULD not adjust anything in the core and core-helpers. You can just tweak the configuration (For safe use).

=============================================================================================================================================

This is the general configuration, if there is something else that should be configured, post a comment in Hiveworkshop (Of this system, the link is shown in "JSL System help" comment-trigger).

This trigger saves Players colors, Binding buttons as "Integers" (Just like naming some people with different names, in this case, we name a button as "Integer").
We also set default should-not-be-changed booleans and integers.

The player, of course, will use the -bind command followed by the button bound to, and the sentence bound.
This won't run if you disable BindMode feature in "JSL Configuration" trigger.
The text is saved in a hashtable as:

Hashtable - Save "Entered Text" as "The Integer of the button bound to" (Children Key) of "Chat-Submitting Player Number" (Parent Key) in Hashtable1.

The player, of course, will use the -unbind command followed by the button desired to unbind, thus the button's data is cleared.
This won't run if you disable BindMode feature in "JSL Configuration" trigger.
The text of the button in the Hashtable will be cleared like this :

Hashtable - Save "EMPTY STRING" as "The Integer of the button ubound" (Children Key) of "Unbinding Player Number" (Parent Key) in Hashtable1.
Then the button state's boolean (Which is ButtonISunbound) will be set to true. Everytime a player tries to press that button, it'll not submit an empty string.

This trigger is to respond to "ESC" pressing event.

This trigger is a little bit different. It responds to any entered message that's not a command to bind , or to unbind.
The message will be stored in a 0 (Child key) under the parent key (Player Number of Chat-submitter) in the JSL_Hashtable.
The reason why it is always stored in 0 Child key (Unlike the other responding triggers of buttons), it's because no key is pressed this time; so I liked to use 0 to juse make it unique.
In fact, this won't run except the length of the message is more than 1, to prevent blank message. And also if the player doesn't have a message that's being shown currently.
Every message that disappears will set "JSL_IsShouting[Player Number of Message Owner]" to False, which means the player will be able to post messages again.
Hello world -unrobo

This trigger refreshes the messages thatare shown by the trigger "JSL ShoutingShow". Thus this trigger stores variables, the other triggers shows variables.
I recommend not to touch the event period value. Let it as it is (0.01 seconds).

This trigger is no different than"JSL Quest Shower", but just making it MUI/MPI, and at the same time it shows Floating Texts and Game-texts, instead of game-texts.
It's not complicated, it uses the same routine and boring rythme, which is explained in comments action lines.
NOTE : This won't run if ShoutMode is off (False).