Game Development Community

We need something like this for TorqueScript...

by Sasuga · in Site Feedback · 02/22/2010 (2:16 pm) · 5 replies

We need something like this for TorqueScript: http://www.nwnlexicon.com/

#1
02/22/2010 (10:00 pm)
Here's something similar:

tdn.garagegames.com/wiki/TorqueScript_Console_Functions_1

It's a bit behind the times. Hopefully they'll get back to work on the documentation, and update the main page here with the latest stuff:

www.torquepowered.com/documentation/torque-3d
#2
02/23/2010 (9:06 am)
Thanks Jaimi!

I actually found the http://tdn.garagegames.com/wiki/TorqueScript_Console_Functions_1 shortly after making my post. I didn't change this thread/post through because I can tell via the forums it is incomplete.

For example I'm not finding: setCursorPos() ( Canvas.setCursorPos() ) on the list.

A function that I've found more than a few people have had issues with over the years: http://www.torquepowered.com/search?q=setCursorPos%28&x=0&y=0

While what you found me is good, it is not great, since it is incomplete.

I'm asking that someone at GarageGames get started one for T3D that is up to date (with any T3D changes) and at least on its way to being complete. (I like how the NWNLexicon says that it is 98.38% complete.)

=-=-=-=-=

As for this: http://www.torquepowered.com/documentation/torque-3d

I've been banging my head on that since I've purchased T3D. It does not get into the functions at all (even though it has a section called "functions" that explains about how functions in general work).

It has some nice tutorials which I've gone through and played around with, and it explains syntax, case statements, true/false statements, and gives a general idea of how programming (or... umm... scripting) works to anyone who's never done it before, but it is not a Lexicon or reference for the skilled person who just needs to be able to look up a function really quick.

=-=-=-=-=-=-=

I've actually been digging through T3D's code a little bit to find Script Functions, but what about people who buy the non-source code version of T3D? (It didn't exist when I got T3D, or I would have probably bought the non-source-code version.)

=-=-=-=-=-=-=

I need a reference to know if functions like setCursorPos() exist. That way I know they do and I can use them. Otherwise I have to dig into the source code and see if it exists, if I don't find it I either have to program or script it myself, and before I waste all that effort and time I often as in IRC and wait sitting on my hands for a few hours (or playing a game) while I hope someone responds to me with the knowledge that it exists or not... and someone not knowing if it exists doesn't mean it doesn't exist, and so I might be re-writing a part of the game engine or scripting language that has already been written which is not only a waste of time, but redundant and foolish... And the fact that I paid $1000.00 for a game engine so I don't have to write something that someone else has already written for me (that I paid for).

=-=-=-=-=
So, I truly, truly, truly, truly, truly, truly, truly, TRULY, am very thankful to Jaimi and I mean no disrespect to him/(you Jaimi) when I say this, but: We need something like this for T3D: http://www.nwnlexicon.com/
#3
02/23/2010 (9:42 am)

This has come up quite a number of times. Improvements to the script docs is in the working but the ability to generate reference documentation actually comes with every version of Torque 3D.

dumpConsoleClasses();
dumpConsoleFunctions();

As far as I'm aware, a precompiled CHM will ship with 1.1 final.
#4
02/23/2010 (10:59 am)
Now we're getting somewhere! Thanks Rene!

I still think something like the NWNLexicon except T3DLexicon would be great, since these dumps don't seem to discuss parameters, outputs, expected behaviors, error handling, etc. However, this certainly helps a lot! Thanks!
#5
02/23/2010 (11:02 am)

Yep, the Lexicon looks nice. Or MSDN-like docs for TS... that would be my picture of an ideal :)