Game Development Community

T2d docs in CHM form. (find it here!)

by Jason Swearingen · in Torque Game Builder · 10/13/2005 (11:29 am) · 9 replies

The t2d.net docs have all SimObjects and ConsoleFunctions documented (in the .chm)


I have got a lot of complements from people using my t2d.net wrapper, saying that the docs I provide are absolutely kickass compared to the stuff you get from t2d.

So i'd like to point out for all you t2d owners, that you can use the Torque.T2D.ConsoleFunctions and Torque.T2D.SimulationObjects sections of the t2d.net docs for reference while writing your own t2d torquescript.

might be worth taking a look if you hate the docs provided.

(the t2d.net docs are located in the t2d.net install zip, find it here.)

#1
10/13/2005 (11:33 am)
Also included are Datablocks and their fields, and also the 'optional' arguments you can pass to torquescript via object creation (i call them constructorBlocks, but i think in torquescript they are still called datablocks)
#2
10/13/2005 (11:36 am)
I don't want to install t2d.net, but I would like to take a look at the Windows help file. I downloaded the resource, but all I see is the file T2D.NET.Beta1.Install.exe
#3
10/13/2005 (1:54 pm)
That's a self-extracting RAR file. you can run it and decompress to an empty directory, or open it using a program like winRAR.

inside you'll find the .chm in the doc folder.
#4
10/13/2005 (2:16 pm)
Thanks Jason, that is really useful, even for a non- T2D.NET user.
#5
10/13/2005 (2:17 pm)
I've not looked at the help files yet, but if they are as good as the feedback you've received suggests, have you thought about porting it over to the T2D section of TDN?
#6
10/13/2005 (2:30 pm)
@Gary: only a little. if i can upload the .zip and .chm directly sure. if it has to be in wiki format then no (there is probably over a thousand pages of docs)

it's also formated in a t2d.net - centric way.. so some ... errr.. "less observant" people might get confused about the purpose of the docs.
#7
10/13/2005 (2:34 pm)
It's all the same information that's available elsewhere (I think), but the cool thing about the .chm file is it's a compiled help file that's fully cross referenced, searchable and indexed. Also lists Torque Core classes and functions alongside T2D stuff, which is a bonus.
#8
10/13/2005 (2:37 pm)
And by responding to this thread I am not saying I "hate" the docs provided. That's kinda harsh Jason :-)

I appreciate the T2D 1.0.2 docs and usually have Acrobat reader open to read those PDFs as well.
#9
10/13/2005 (2:43 pm)
Yeah, what Alex said. :) not just the t2d specific functions/classes, but the Torque Core stuff too.

and it's fully searchable, crossreferenced, and you can even save your favorites too.

and i list the c++ file and line number the function is defined on, if you want to go look at it's implementation yourself.

I try to make the t2d.net specific functionality very obvious when you are reading the docs, so you most likely wont get confused by my functional additions.