| 09-23-2004, 05:58 PM | #1 |
What I need is to get as many people as I can to help me get a listing of the WE Triggers and their JASS counterparts. Even if you only have 30 minutes to spare, all contributes are helpful and I will list your name and contact info in the credits, so this will be a good way to get your name out there  If you'd like to help then I thank you a thousand times over. It's taken me a long time to type out this thread, but I hope it will attract enough helpers to make up it up. Please post that you are going to help, which range of triggers you're going to do, and what you'd like recorded as your contact info. For example: I don't have much time, but I'd love to help. I'll start from "Cinematic - Clear Text Messages" and go to "Countdown Timer - Change Timer Window Time Color". You can use my forum name here and the email address in the profile! If you have any questions, please post them in the thread. Also, if you finish the section that you reserved, you're more than welcome to pick out a new section. If you can't finish the section, then make sure you point that out to me when you post the work that you did finish. Thank you, everyone! If you'd like to see the document in a semi-updated state, click here The Tools I recommend using the following: 1) Warcraft III TFT World Editor to get each trigger, its action text, and its comment. 2) Jass Editor to get the Jass functions (Download it here) 3) Notepad or any other standard text editor so you can reguarly save your progress. The Process 1) Open up the World Editor and create a new map so you can play with the triggers. 2) Open up the Trigger Editor (F4). 3) Create a new trigger (ctrl+T). 4) Create a new action (ctrl+R). 5) Browse to the trigger you're going to document. For this example, I'll use the "Wait (Game-Time)" trigger 6) On the last line of your text document, enter the name of the trigger. Wait (Game-Time) 7) On the next line, enter the action text. Use your best judgement when substituting for values that the user is supposed to enter. I'll include samples below. Wait <real> game-time seconds 8) On the next line, enter the function call. I'll explain below how to find it. PolledWait takes real duration returns nothing 9) And back to the Action window, if there is a comment for the trigger, enter it on the next line. Make sure your window is big enough to see the full comment. They only ever spawn two lines, so you may need to stretch it horizontally for it all to fit! The duration of this wait is specified in game-time seconds. This is a polled wait, so it may last slightly longer than requested. 10) When you're done, skip a line, and go back to repeat steps 5-10. A Proper Entry By following the italicized text above, you'd get this: Wait (Game-Time) Wait <real> game-time seconds PolledWait takes real duration returns nothing The duration of this wait is specified in game-time seconds. This is a polled wait, so it may last slightly longer than requested. The Action Text The action text is somewhat varied, so it takes some generic reasoning to substitute values in for it. Sometimes a default value is already selected, and sometimes it's not. If you're unsure of what type of variable it's asking for, consult the function definition. The order of paramaters in the trigger will be the same as those in the function's definition. This will be especially helpful for enumerated variables (ones were it gives you a specific list of choices to pick from). Grabbing the Function Call Grabbing a function call is a multi-step process in itself, especially if you're not familiar with them. 1) If there are any red values in your trigger, click on them and enter whatever it defaults too. It doesn't matter what you pick here. 2) The OK button she be enabled now, so select it. 3) On the Trigger Editor window, select the Edit menu and click on Convert to Custom Text. When the message box pops up, click OK. 4) Look at your trigger to find the name of the function. Your trigger should be empty aside from the one function you just entered, so you should see something like this at the top: function Trig_Untitled_Trigger_001_Actions takes nothing returns nothing ... your function here ... endfunction 5) Once you have the name of your function, go to Jass Editor (the program I asked you to download in the Tools section). On the right-hand side is a column. On the top of that column is a text box with binoculars next to it. Enter the name of your function in there and it should appear in the list below it. 6) Click on the name of your function in the list and it's definition should appear at the bottom of the window. 7) Copy (highlight the text and use ctrl+c) that exact definition into your text file. 8) Back on the trigger editor window, push ctrl+Z to turn it back into a trigger so you can get your next action. Other Notes If you know what you're doing, you don't need to follow my steps exactly so long as the end product is correct. Here is how multiple functions would appear in your text document: Do Nothing Do nothing DoNothing takes nothing returns nothing Wait Wait <real> seconds TriggerSleepAction takes real timeout returns nothing The duration of this wait is specified in real-time seconds. Wait (Game-Time) Wait <real> game-time seconds PolledWait takes real duration returns nothing The duration of this wait is specified in game-time seconds. This is a polled wait, so it may last slightly longer than requested. Animation - Queue Unit Animation Queue <unit>'s <string> animation QueueUnitAnimationBJ takes unit whichUnit, string whichAnimation returns nothing Areas Under Construction And lastly, I will do my best to keep a record here of which triggers are currently being worked on so that we don't have everyone doing the same thing. RaeVanMorlock Do Nothing to Leaderboard - Change Player Style |
| 09-24-2004, 09:02 PM | #2 |