Game Development Community

Fragmented Torquescript documentation

by Alex Rice · in Torque Game Builder · 05/23/2006 (12:14 am) · 5 replies

Why is the torquescript documentation on TDN broken up into partially finished sections with a dangling reference to "Elixir"?

Quote:Console Objects Fields and Methods Quick Reference
TorqueScript Quick Reference
TorqueScript Console Functions Reference
TorqueScript Command Reference
TGB Reference Guide

IMHO all of these should be combined into one reference guide. It sucks to browse 5 different guides when trying to figure out how to do something in TGB. Thanks for listening.
NextNext Thread
PrevPrevious Thread
More from Torque Game Builder


Torque Owner Alex Rice
Default Studio Name
#1
05/23/2006 (12:30 am)
(continued) The Wiki is nifty and all, but it's no substitute for actual editing and technical writing.

I was looking for the Simset documentation (which I have looked at on TDN several times in recent days) . Where did it go? I give up browsing for it, do the google search on garagegames.com, browse until I see a TDN result, and strike gold with "Console Objects Fields and Methods Quick Reference Part 13".

Sorry for the bitching - but it's posted under "Suggestions"

Torque Owner Alex Rice
Default Studio Name
#2
05/23/2006 (3:57 pm)
Here is a method one can generate consolidated Torque Core + TGB documentation.
www.garagegames.com/mg/forums/result.thread.php?qt=44649

Torque Owner Ryan Killian
#3
05/28/2006 (1:17 pm)
This is sort of related, but I think the documentation could really use an accurate description of what loads what in what sequence.

I've been through several tutorials, all of which mention functions and files that don't exist. Main.cs and Game.cs seem to serve a similar purpose but it's not at all clear why or how and games "packaged" through the emulator don't show things that are present when I hit "run game" in the editor. I, with a CS background, have a guess on that but someone using this more as a factory than an SDK may be frustrated. Yes, it's a WIP now, but I think that even if nothing else gets cleaned up, there should be a very straightforward explanation of the startup sequence.

Torque Owner Anthony Fullmer
#4
05/29/2006 (4:37 pm)
@Alex, I am going to make an assumption that you are upset because the name "part 13" doesn't have anything to do with SimSets. Thus, were anyone simply browsing based on the names of the articles (such as yourself) they wouldn't have any idea where to find very specific information. I guess in this specific instance, I am the one to blame here. When I ported that reference onto the TDN, I was trying to figure out a good way to organize all of the information. Initially I wanted to put it all in one document, but as the many sections can attest, the size of the file would have made it impossible to edit, and possibly to access (since TDN tries to keep a page under 32KB). However, the other alternative that I opted not to choose, would have been to break each of the 84 objects into their own file, a very time consuming process, especially when testing links between pages.

So, instead I tried to place as many objects and descriptions as possible into one page until it became too large, and then create another section and move on. My apologies for the confusion that resulted, feel free to break the objects into their own separate pages.

Torque Owner Alex Rice
Default Studio Name
#5
05/29/2006 (6:22 pm)
@Ryan- I made a suggestion a while back for all tutorials to be prefaced with - applies to or written for- and a version #. The API has changed a bit since T2D was first in Alpha release.

@Anthony- no worries I know you put a lot of work into it. In retrospect, there is probably a table of contents document that I missed. So I was confused by all the numeric section names.