Use functions from other triggers

[Almia]

Use functions from other triggers [Standard JASS]

---

I. Introduction
This tutorial allows you to use the functions from other triggers.
There are problems we experience when we want to use other functions from other triggers.Examples is that we get syntax error when we try to use functions from other triggers with or without arguements. You will probably need a JNGP to use the functions without conflicts/problems that you will experience.

---

II. What are the problems?

function Message takes string s returns nothing
    call BJDebugMsg(s)
endfunction

//===========================================================================
function InitTrig_Untitled_Trigger_001 takes nothing returns nothing
    set gg_trg_Untitled_Trigger_001 = CreateTrigger(  )
endfunction

This example of snippet will explain it.

We want to use the function MessageX to display messages, but the thing is that if we try to use this like this from other triggers : call Message("Hello"), this will give us a syntax error " Expected a function name ".But if you use it inside the trigger it is located, it will work perfectly.

---

III. The Solution

I discovered the solution when I tried to code a system using scripts. The solution to this problem is to use a simple snippet of function inside the Map Header(the top-of-the-script Script, located in the upper-most of the Trigger Editor with the map icon). We shall add a dummy function there so that we can use the functions properly. Example : Let's add this simple snippet of code :

function EnableScriptUsage takes nothing returns nothing
endfunction

So what does this do?
Nothing. But when a map header has a function inside it, it will allow any functions from the triggers to be used by external triggers.
Simple huh?

---

IV. Known bugs

You can experience some bugs when using this trick. Try removing any function in the map header while other triggers uses the functions from the external triggers.Enable/Disable the trigger that uses external functions (to check syntax), this won't show any syntax error.But when you tried to save the map, a syntax error message will show.

There is a bug also when attempting to move the scripts. The trigger you are going to move in must be the first trigger to be created on your map,or else you are doomed.

The solution to the problem is replacing your first trigger,then move all of the actions to a replica.Then move the scripts you want to the trigger replaced.

Note: All of the triggers in your map will be moved in the header,and then will be arranged based on how old they are in the Trigger Editor,starting from the oldest,which will be on top,and the newest,will be on the bottom.

---

 

[Maker]

I'm not sure if this warrants a tutorial.

Additionally I don't encourage people to rely on bunch of map header code, as it can get very cluttered. Just stick to gui or use vjass.

 

[Almia]

They will just use the map header code for a 2-lined function.

 

[Chaosy]

so if I put a empty function inside the map header I wont get expected function name?

 

[Almia]

Correct.
This is good to prevent the map header with so much API inside it.

 

[Chaosy]

that is really useful, rep +

 

[looking_for_help]

They will just use the map header code for a 2-lined function.

You don't even have to keep the function.

Once you saved your map with a function inside the map header external scripts get unlocked even if you remove the function again (you get a message like "own script code is used...").

So you can keep your map header completly clean.
-> Very useful.

 

[Almia]

Thanks for the feedback

 

[Almia]

Updated.
I found some bugs.

 

[PurgeandFire]

Sorry about the super late response. I had to test this myself.

It seems to work for the most part. There are some issues (e.g. if you have A call B, then B call C or something like that), but I seemed to work around them by deleting and recreating the triggers as you said.

I remember hearing someone say that WE compiles it in a random order, it would be cool if you could figure out the exact order WE compiles it in (or confirm that it is random). Would be interesting to know.

As for the tutorial, it is well-explained. The only issues are the signature and the font + color. However, those are somewhat minor. I will detach the signature, and then it is approved.

 

[Almia]

Actually,the scripts are ordered based on how old the trigger is(just like what i have said)
It goes like this:
Oldest Trigger A
Older Trigger B
Old Trigger C
Young Trigger D
Younger Trigger E
Youngest Trigger F

 

[Daffa]

This doesn't apply if ExecuteFunc is used (which is ugly with their slow response though), and the TriggerExecute thingy as well. Sadly, they're not so similar with executing the function with their returns and such.

 

[Wietlol]

@Daffa the Mage
I did make a system so ExecuteFunc() can have return values, parameters, etc.
I made a String2JASS system

It is supposed to convert chat messages to JASS so you can get variable values, set variable values, execute functions, etc during gameplay to test the map.
However... it is hard to implement and is not yet finished.
But someone said it was bull shit to have... so I stopped working on it.

 

[Chaosy]

This no longer works fully for me btw. Even with a function in the header the editor still saves the oldest trigger first. So I get undeclared function name in quite a lot of my projects these days. I have to keep copy pasting stuff :-/

 

[Wietlol]

A function in the header is always saved at the top (with the exception of libraries).
I guess you are missing something.

 

[Almia]

Maybe you didn't read my instruction

I rather suggest pasting first the systems where other codes rely, codes that rely to systems that will be relied, and codes that rely to other codes

 

[Chaosy]

Easier said than done

 

[SAUS]

Hey, I found something out about the trigger order when saving:

When you add a new trigger and save, it is saved at the bottom of the script. This means it will break if you create a new trigger that has a function that you want to use in a trigger that already existed or a trigger that you created in the current session before this new trigger. This is the known problem that forces you to put your global functions inside the header script.

However, I found out something that might be useful. If you save your map, and then close the editor, reopen the editor, load the map, and then write a syntax error in the header script (then try to save), you will see that the triggers are now defined in the order that they appear in your trigger editor window. This allows some purposeful ordering of trigger creation (the InitTrig functions) and also allows you to write libraries in regular JASS and use them in all your triggers.

The steps to make it work are:
1) Create the new trigger that will be your system or whatever.
2) Leave your trigger blank, and move it in the trigger editor to the spot you want it to be loaded.
3) Save your map.
4) Close the world editor.
5) Open the world editor and load your map.
6) Add any functions you want to use to the blank trigger.

Then you can use those functions from any other trigger below it in your code. Just remember that if you add a new trigger above this system trigger, it might work if you use functions from it on the first save, but it might also start to report errors if you try to save again after closing and reopening.

Anyway, I thought some people might like this.

 

[Wietlol]

Aka... use libraries.

When you save the map, the editor compiles all triggers/scripts into one big file, known as the "war3map.j".

Thinking code-wise for the editor, all triggers are inside a list (array) and when you create a new trigger, you just increase the array by 1 and place your new trigger in the last slot.
"But hey! Doesnt that mess with the order of the triggers?" Not really, because you dont want to rely on something like the order of triggers, so we dont care how it is.
If you want to use functions globally, then use either the header script or a precompiler like JASSHelper (vJASS).

That the order of how the triggers are used in the order of how they are shown is probably because the array will be recreated in a certain moment of the steps... which is a glitch... or at least, it looks like it.

So... It is funny to know such things, but not really useful as there are way better things to rely on.

 

[PurgeandFire]

@SAUS: Pretty cool! But is it in the order specified in the trigger editor, or is it based on when the trigger was made? (e.g. older ones go first?)

The reason I ask is because Almia's note at the end seems to conflict with your theory:

Note: All of the triggers in your map will be moved in the header,and then will be arranged based on how old they are in the Trigger Editor,starting from the oldest,which will be on top,and the newest,will be on the bottom.

If you can verify that it behaves like you said, I'll link your post in the main tutorial for the benefit of other users.

 

[SAUS]

@SAUS: Pretty cool! But is it in the order specified in the trigger editor, or is it based on when the trigger was made? (e.g. older ones go first?)

The reason I ask is because Almia's note at the end seems to conflict with your theory:


If you can verify that it behaves like you said, I'll link your post in the main tutorial for the benefit of other users.

It seems to be the order specified in the trigger editor - you just have to save and reload your map if you add new triggers (if the order matters). It's sort of hacky the way it is, and I am uncertain if it is completely reliable or not, but so far it has worked. I will test in a new blank map maybe tonight or tomorrow night.

Steps should be:
Create a trigger (TriggerA), convert it to JASS.
Create another trigger(TriggerB), convert it to JASS.
Move TriggerB above TriggerA in the trigger editor.
Add a function to TriggerB:

function triggerOrderTest takes nothing returns nothing
endfunction

Call the funciton in TriggerA's InitTrig function.
Try to save the map (it should get an error).
Comment out the call to triggerOrderTest in TriggerA's InitTrig funciton.
Try to save the map (should work).
Close wc3 map editor and reopen it -> load your test map.
Uncomment the function call and try to save it again.

That was more steps than I thought haha. Anyway, I will do it myself when I get the chance, but someone else can try it as well if they want to.

 

[Kazeon]

It's pretty simple to solve actually. We just need to move trigger A (where we call the function) beneath trigger B (that contains the function) on compilation. How? Just click on trigger A > Copy (Ctrl+C) > Delete (Del) > Paste (Ctrl+V). Then try to save the map. And voila! There you go...

But sometimes the trigger order will be re-arranged by it self in some random occasions, causing the problem to reappear. That's why, FOR GOODNESS SAKE PLEASE DON'T USE GUI!!

 

[SAUS]

It's pretty simple to solve actually. We just need to move trigger A (where we call the function) beneath trigger B (that contains the function) on compilation. How? Just click on trigger A > Copy (Ctrl+C) > Delete (Del) > Paste (Ctrl+V). Then try to save the map. And voila! There you go...

But sometimes the trigger order will be re-arranged by it self in some random occasions, causing the problem to reappear. That's why, FOR GOODNESS SAKE PLEASE DON'T USE GUI!!

I don't use GUI. I am wondering what these random occasions are or if they are even, indeed, random.

From what I've seen, any time you make a new trigger in the current session, no matter where you put it in your list, it will be at the bottom of the final map script. However, when you reload your map (close the map after successful save and reopen your map), it is where you put it in your list of triggers in the trigger editor.

This means that you can then put triggers above the trigger with the global functions and use those functions without problem until you reload the map. This is consistent with how I've seen the order of the triggers being saved. It has not been random so far and I am even using it for multiple system in my own map without problems.

 

[Almia]

I hate it when someone bumps a 3 year old thread in which I have forgotten now :v

 

[Kazeon]

I don't use GUI. I am wondering what these random occasions are or if they are even, indeed, random.

From what I've seen, any time you make a new trigger in the current session, no matter where you put it in your list, it will be at the bottom of the final map script. However, when you reload your map (close the map after successful save and reopen your map), it is where you put it in your list of triggers in the trigger editor.

This means that you can then put triggers above the trigger with the global functions and use those functions without problem until you reload the map. This is consistent with how I've seen the order of the triggers being saved. It has not been random so far and I am even using it for multiple system in my own map without problems.

I don't know in what occasion or is it random or not because I'm not very experienced about functions in GUI. The last time I created a map in GUI was when I didn't even know what function is.

I hate it when someone bumps a 3 year old thread in which I have forgotten now :v

Well, this is tutorial section. You shouldn't be surprised when finally somebody find this useful 3 years later and want to ask something about it.

 

[SAUS]

I don't know in what occasion or is it random or not because I'm not very experienced about functions in GUI. The last time I created a map in GUI was when I didn't even know what function is.

I'm writing all my stuff in JASS, but in the regular editor. I guess you could use this for full GUI libraries (with custom script to make the functions), but it would be ugly to implement into your map since you would have to fiddle with saving until it orders the way you want it to.

I can't be certain it doesn't mess up after some time or from some specific circumstances, but it has been consistent for me so far (in my map - haven't made the pure test map yet). I'll probably try to throw some screenshots together if there's anything I can show to help explain what is happening.