Script APi docs
by JezPop · in Torque 3D Beginner · 08/23/2010 (11:29 pm) · 4 replies
I would personally like to see a complete and updated version of the script documentation, although references to functions are apparent there are no examples of use and in most case there is just the name of the function itself and no explanation of what it does, this coupled with the C++ methods that have been exposed to the engine would give us; the user, a thorough understanding of the best syntatics behind what we are trying to accomplish....some UML and class diagrams wouldn't go amiss either (as if you dont have enough to do :))
About the author
#2
From the Torque Script Overview:
IMPORTANT: You can download and view the Full TorqueScript Manual by clicking here: TorqueScript Reference Manual
Note for Windows Users: Due to security measures, the OS may block the CHM after you download it. To unblock it, perform the following steps:
1. Locate CHM on your hard drive
2. Right click on the CHM, then click Properties
3. At the bottom, click the "Unblock" button
4. Apply and close the properties
Note for OSX Users: There is no default CHM viewer installed with Mac OSX. There are several free options available for download:
* Chmox
* iChm
This information is also repeated in other parts of the documentation, as well as in a recent and important blog related to documentation: History of Torque Documentation
08/24/2010 (12:08 am)
Hmmm...From the Torque Script Overview:
IMPORTANT: You can download and view the Full TorqueScript Manual by clicking here: TorqueScript Reference Manual
Note for Windows Users: Due to security measures, the OS may block the CHM after you download it. To unblock it, perform the following steps:
1. Locate CHM on your hard drive
2. Right click on the CHM, then click Properties
3. At the bottom, click the "Unblock" button
4. Apply and close the properties
Note for OSX Users: There is no default CHM viewer installed with Mac OSX. There are several free options available for download:
* Chmox
* iChm
This information is also repeated in other parts of the documentation, as well as in a recent and important blog related to documentation: History of Torque Documentation
#3
08/24/2010 (7:24 pm)
@JezPop - Did you ever look at the new manual? I'm curious to see how useful it was to you and what might be done to improve it.
#4
I cant seem to download from the above link (need to right click save as i think!)
I have some days free so i will be looking through it, at a glance it is looking much much better than the past releases, if i find any discrepancies or suggestions i will of course let you know :)
09/06/2010 (3:00 pm)
Sorry Michael, been a bit buried in other work at the moment, so sorry for the late reply.I cant seem to download from the above link (need to right click save as i think!)
I have some days free so i will be looking through it, at a glance it is looking much much better than the past releases, if i find any discrepancies or suggestions i will of course let you know :)
JezPop