Problems with the Torque 3d documentation

#1 Do you own Torque 3D?

#2

Quote:The documentation shows well the syntax of the Troque Script. But not the game specific functions. (Vector calculation and a lot of other things).

On TDN there is a big list of script commands like that - it's not complete, and it's for TGE, but there are references for most common functions you'd use for things like string and vector manipulation (as well as a ton of other stuff). Also reference for the console methods of each different class. I'm not sure if anything like that exists for T3D, but I'd bet that most of that stuff still applies.

#3 I own Torsion and a content pack, but use the trail version of
Torque 3d.
Bevore I buy Torque 3d, I want to write a little game.
Why is this important?

#4 Phillip was just concerned about piracy of the engine. We've had a lot of people with unlicensed copies of the engine pop up in the forums this past week. Don't worry, what you're doing is fine.

You probably won't be able to access the older documentation stored on TDN as I'm pretty sure TDN still limits what you see to only the products you have. I'm not sure if you could access it or not.

Anyway, you can also view all the methods available to a class by using dump() in the console like so, yourobject.dump().

#5 There is also a preliminary .chm file available in the only documentation. It is being re-generated for the 1.1 Beta and 1.1 final release, but it has some nice reference. You can find this under the Using the Docs article, look for "Script Reference".

#6

Quote:
Anyway, you can also view all the methods available to a class by using dump() in the console like so, yourobject.dump().

Scott you say "also" as if you offered a suggestion before this one. before this you told him what he "probably won't be able to" do.

Call me crazy but I think it's absolutely ridiculous that there is NO online reference for torquescript in T3D. telling a customer to dump the methods all over the console doesn't count as a reference and the chm indicates that it's impossible to do trig functions in torquescript.

Vampir is looking for a reference because T3D has no documentation or reference for trig operations, matrix operations, vector operations, string operations, file I/O etc. the current chm does list object classes and methods, but not basic high-level script functions available in torquescript. there's no documentation indicating the function mATan() exists for instance. someone please add this to the chm file. I think customers will find this material useful...

once the chm is finally updated with the high-level script functions, it still won't include another very important part of torquescript vampir is looking for: object callbacks. GG has never taken the basic step of providing users any kind of reference for torquescript object callbacks.

As programmers, you guys should KNOW that this kind of material is essential to using a programming language. the fact that it's not available indicates at most a lack of consideration for customers, and at the very least a basic incompetence. Michael, here's a documentation suggestion: Why dont you guys try posting an online, html reference for torquescript? like an actual page on this site which lists script functions. I know, sounds crazy doesnt it? ;) This reference should include high-level script functions, script objects, and script object methods. thats what I would do for documentation. I think users of this site would find it useful...

Also, please note my use of the word "reference" rather than "documentation". lack of documentation is understandable but lack of basic references for things like mATan() and onRemove() is simply unacceptable.

#7

Quote:
As programmers, you guys should KNOW that this kind of material is essential to using a programming language. the fact that it's not available indicates at most a lack of consideration for customers, and at the very least a basic incompetence.

Harsh fomulated. But it is (unfortunately) the truth. Michael Perry did (two years ago?) a announcement how good the documentation will be in the next months. But nothing happend. Sorry Michael.
I wrote him a mail with the offer to help him with the docs. But i got no response.

#8 The best feature is useless if no one knows.
Thank you that they have tried to help me.
I'm waiting for a complete documentation.

#9 Which e-mail did you send it to Thomas?

#10 @Vampir - The documentation you are looking for currently exists. Mich continues to work hard getting all that is Torque Documentation in one easy to read/manageable location. If you are just starting out with Torque, just look around and ask questions. When I first started to use Torque I did this exact thing. I know these url's because I still have these pages bookmarked from when I was first starting out.

String Manipulation Functions

Math Functions

Also, are you talking about game specific functionality? That is usually expressed through game tutorials. If you have a game tutorial that explains specific functionality that you want to see, let us know. We definitely encourage feedback!

#11 @Michael: I sent the mail to email address removed by moderator ...

#12 @Steven, where is the reference for object callbacks?

I need a reference listing callbacks like onRemove(), onWake(), onInitialControlSet(), etc.

BTW, as I mentioned in my message above, you guys really need to consider moving away from the whole "documentation" thing and just get up a some quick references. I believe Mich has been working hard on comprehensive documentation for the greater part of a millenium now. I know it takes time, but the fact is this should've been done before this product was available for purchase.

Torque is the only engine I've come across which doesnt have comprehensive reference docs although it's one of the oldest engines on the market. No one should have to post a thread just to find out how to do matrix operations in torquescript.

#13 Michael, regarding the reference docs, (written) tutorials and accompanying files for the T3D Artist package, is there an ETA on when they will be updated? It would be helpful if the docs you provide in future had a version number and date on the front page so we'd have some idea if there have been any changes.

Will there be some kind of official announcement somewhere when they are updated? Everything GG does seems to be forum based and it's not obvious from looking at the Documentation thread:

> when the last update was
> when the next update will be
> where to get said update

#14 @Thomas
Don't worry, Michael should still have gotten your post unedited as I'm sure he's watching the thread. I just removed it as that's his personal email.

#15 @Thomas - No wonder. My personal e-mail is stacked up with about 300 unread messages. I've neglected it since I got my company e-mail. If it is work related, you should have e-mailed me as a company. If your offer still stands, I definitely could use the help.

#16 @screeg - I tried uploading new documentation yesterday, but it failed. The method for pushing new documentation online is a bit of a pain:

1. Write docs
2. Generate docs
3. Copy built docs to the website repository
4. Commit SVN
5. SSH into a server using terminal
6. Call a .sh script to pull down repository, then push the docs online using a network command

Steps 1-5 work, but step 6 is completely borked. In November, we switched all of our repository DNS. I can relocate my local repositories fine, but no one bothered to change the .sh script on the server. That means I cannot push documentation online. I've submitted a support request to OPS, but I do not have an ETA from them.

Is this frustrating? Very. Is the process inefficient? Absolutely. Is there anything I can directly do about this? Unfortunately no, and it kills me to not have control over my documentation.

When I can get the new documentation up, I will make sure it is updated in the 1.1 Beta blog. I am also working on a visible versioning system for the docs, with a changelog.

#17 Please Read This Thread