TorqueScript sequence diagrams for starter.fps
by Danner Jones · 07/28/2004 (8:24 am) · 12 comments
Download Code File
The attached file contains 16 sequence diagrams split into 3 packages. They follow the flow of Torque running the starter.fps "demo". The sequence diagrams show interaction between scripts and the engine.
The intended purpose is to introduce newcomers into the flow of scripts. While not all details are covered, following the flow from beginning to end will allow newcomers the chance to see some of what's offered as "stock" in the common scripts as well as their interaction with the engine and a "mod". I chose starter.fps as an example, but starter.racing and tutorial.base are nearly identical in flow.
Besides the general sequence diagrams, I've included a number of "documentation" type of diagrams.
1. An "exec Summary" diagram which shows, in order, what scripts are exec'd when loading starter.fps.
2. A diagram listing the message callbacks used by starter.fps.
3. General overview of messages (server and client) used by common (MsgLoadInfo, MsgLoadDescription, etc.).
The included file is in Jude format. Jude is a free UML modeller. This was my first time using Jude and was relatively pleased. I was going to use Visio but realized many people don't use that or have a copy. Since Jude is free, I went with that.
edit: I tried uploading the zip with JPG images but it weighed in at 1.3 meg and there's a limit of 200k.
I've put a file you can reach here.
If that link won't work directly, try this page.
If anyone wants to host this more permanantly, feel free. There's no copyright on the diagrams - I just want to share, if they help.
The attached file contains 16 sequence diagrams split into 3 packages. They follow the flow of Torque running the starter.fps "demo". The sequence diagrams show interaction between scripts and the engine.
The intended purpose is to introduce newcomers into the flow of scripts. While not all details are covered, following the flow from beginning to end will allow newcomers the chance to see some of what's offered as "stock" in the common scripts as well as their interaction with the engine and a "mod". I chose starter.fps as an example, but starter.racing and tutorial.base are nearly identical in flow.
Besides the general sequence diagrams, I've included a number of "documentation" type of diagrams.
1. An "exec Summary" diagram which shows, in order, what scripts are exec'd when loading starter.fps.
2. A diagram listing the message callbacks used by starter.fps.
3. General overview of messages (server and client) used by common (MsgLoadInfo, MsgLoadDescription, etc.).
The included file is in Jude format. Jude is a free UML modeller. This was my first time using Jude and was relatively pleased. I was going to use Visio but realized many people don't use that or have a copy. Since Jude is free, I went with that.
edit: I tried uploading the zip with JPG images but it weighed in at 1.3 meg and there's a limit of 200k.
I've put a file you can reach here.
If that link won't work directly, try this page.
If anyone wants to host this more permanantly, feel free. There's no copyright on the diagrams - I just want to share, if they help.
About the author
#2
07/10/2004 (6:00 pm)
Yep I get the same exact thing.
#3
07/10/2004 (6:46 pm)
I've changed it to a zip of the .jude file. I've no idea why a browser would think .jude is malicious unless you already had Jude installed and it tried opening directly?
#4
07/10/2004 (8:06 pm)
I just realized that the link to the freewebs account is *free* but the sequence diagrams show a LOT of proprietary information about the torque engine. If GG feels it's too detailed to keep on a "free" server, let me know and I'll remove it pronto. 
#5
r/Alex
Edit: spelling error
07/27/2004 (6:58 pm)
Thanks for the link on JUDE. I've been using Visio that came with Visual Studio .NET but unfortunately some of my friends do not own one.r/Alex
Edit: spelling error
#6
By the way, I believe Microsoft has a free Visio Viewer for those that don't have a Visio license.
Nick
07/28/2004 (11:49 pm)
Great resource!By the way, I believe Microsoft has a free Visio Viewer for those that don't have a Visio license.
Nick
#7
07/30/2004 (5:52 am)
Will this open with Dia? Or am I going to need to download Jude?
#8
Jude is freeware - a Java based UML modeller. I have nothing to do with Jude, just used it to create the diagrams.
07/30/2004 (10:55 am)
These are just Jude files for now. The zip DOES include JPG images of all the sequences. You won't be able to text-search against them though, like you could with Jude. For the record, I've had no need to text search them myself.Jude is freeware - a Java based UML modeller. I have nothing to do with Jude, just used it to create the diagrams.
#9
I put up a web page with all the diagrams:
www.pinolisoftware.com/torque/torque_diagrams.htm
08/02/2004 (5:43 pm)
Thanks, Dan!I put up a web page with all the diagrams:
www.pinolisoftware.com/torque/torque_diagrams.htm
#10
08/03/2004 (6:07 am)
Excellent, thanks Keith!
#11
08/06/2004 (8:28 am)
Which version of Jude did you use to create the sequence diagrams? I'm using ver 1.2.7 and get an error message when I try to open the TorqueScript_starter.fps.jude file. The error messages just says "Could not open the file".
#12
According to the release notes, 1.3 added the ability to compress files. I do know that the jude files are compressed as standard zip files with a jude extension so that must be the default. You can rename it to .zip and try extracting the contents to a new file and try loading that into 1.2.7. The release notes don't mention anything specific about breaking the save format so I'm hoping it's just the compression.
-ner
08/06/2004 (9:57 am)
I would guess/bet I'm using 1.3 as that's the current version on their website. I'm at work now so I can't check it out, but I'll be sure and post back here tonight.According to the release notes, 1.3 added the ability to compress files. I do know that the jude files are compressed as standard zip files with a jude extension so that must be the default. You can rename it to .zip and try extracting the contents to a new file and try loading that into 1.2.7. The release notes don't mention anything specific about breaking the save format so I'm hoping it's just the compression.
-ner
Torque Owner Chris Suiter
Huh?