Question about docs regarding objects in torque and routines
by Tom Baldry · in Torque Game Engine · 11/06/2003 (4:02 am) · 9 replies
Is there some docs/links that state "Here are all the objects that come with the engine and a list of routines (methods) each one has"
Say you define objects. Each object has built-in methods (subroutines). I was hoping for a list of them. I'm trying to implement a moving platform that follows the same type of pathnodes as the NPC follows in example.fps
I'm also wondering exactly how are "dynamic fields" in the mission editor accessed? Do they appear as variables in the scripting language?
Basicallt the main thing I'd like is a list of predefined objects I can create. Plus all available methods for each object. For example: I know there is a class called StaticShapeData; and I would like to know everything about it for scripting purposes. Where would I find the info?
Any help is much appreciated =)
Tom.
Say you define objects. Each object has built-in methods (subroutines). I was hoping for a list of them. I'm trying to implement a moving platform that follows the same type of pathnodes as the NPC follows in example.fps
I'm also wondering exactly how are "dynamic fields" in the mission editor accessed? Do they appear as variables in the scripting language?
Basicallt the main thing I'd like is a list of predefined objects I can create. Plus all available methods for each object. For example: I know there is a class called StaticShapeData; and I would like to know everything about it for scripting purposes. Where would I find the info?
Any help is much appreciated =)
Tom.
#2
I could probably get the info digging through the engine stuff but I was hoping for a better doc meant for scripters
For example; there is a line in that doc that you posted Ron, that's for scipting and if I look at the link it brings me to a page thats really simple.
The only docs for scripting I've found so far is:
http://www.garagegames.com/downloads/TGE_Console_Cmds.rtf
Which is a set of routines that are available, but I need a list of objects the engine has and what routines (methods) there are available to them. I kind of assumed there would be a scripting reference guide for the engine that comes with the sdk. =)
Tom.
11/06/2003 (7:49 am)
That's more engine stuff, I was really talking more about scripting.I could probably get the info digging through the engine stuff but I was hoping for a better doc meant for scripters
For example; there is a line in that doc that you posted Ron, that's for scipting and if I look at the link it brings me to a page thats really simple.
The only docs for scripting I've found so far is:
http://www.garagegames.com/downloads/TGE_Console_Cmds.rtf
Which is a set of routines that are available, but I need a list of objects the engine has and what routines (methods) there are available to them. I kind of assumed there would be a scripting reference guide for the engine that comes with the sdk. =)
Tom.
#3
11/06/2003 (7:55 am)
%obj.dump();
#4
Find an object that you wish to list all the methods for and .dump(); it.
11/06/2003 (8:47 am)
Do as Matt suggested..Find an object that you wish to list all the methods for and .dump(); it.
#5
Check out common\client\scriptDoc.cs in the example.
11/06/2003 (9:01 am)
There's code to do a console documentation dump that you can run through Doxygen (or read yourself if you're brave).Check out common\client\scriptDoc.cs in the example.
#6
It's a bit frustrating 8|
11/09/2003 (1:22 pm)
Cheers guys and the dump thing did help a bit but surely there's more docs about this engine than I can find, there's loads of people with loads of comments but no decent documentation. It's making things that should take a few days take a week.It's a bit frustrating 8|
#7
http://www.garagegames.com/index.php?sec=mg&mod=resource&page=view&qid=2034
?
nm, it doesn't work out of the box, false alarm.
Buzz in IRC is that Doxygen should be able to generate said docs.
11/09/2003 (2:09 pm)
Have you tried this:http://www.garagegames.com/index.php?sec=mg&mod=resource&page=view&qid=2034
?
nm, it doesn't work out of the box, false alarm.
Buzz in IRC is that Doxygen should be able to generate said docs.
#8
There are no step-by-step guides through Torque, partially because Torque is sufficiently inter-related and complex that, like a tapestry, following a single thread is difficult without explaining the others. You have to understand the various component parts and how they relate, and be willing to figure things out yourself...
11/09/2003 (2:09 pm)
Most of the script functionality is relatively straightforward, to me at least. I can usually decipher what's going on with a few minutes effort; especially if it's just a matter of figuring out what methods a script function is calling.There are no step-by-step guides through Torque, partially because Torque is sufficiently inter-related and complex that, like a tapestry, following a single thread is difficult without explaining the others. You have to understand the various component parts and how they relate, and be willing to figure things out yourself...
#9
I don't think it has a reference guide like you want but it has some good tutorials that helped me get started.
http://tork.zenkel.com/_tutorials/Coding-Scripting/General/TorqueScriptingTutorials.php
Specifically, this is a general scripting guide to help people get started.
With this site and some playing around you should get the hang of the basics without too much trouble. Also do the four tutorials in the main documentation area.
I can see where your having troubles, my only small criticism of the engine is the lack of documentation for the scripting. However when you consider how cheap and good the engine is, it really is a very small criticism. Every other aspect to the whole product greatly exceeded my expectations.
11/11/2003 (5:04 am)
Have you seen this site? http://tork.zenkel.com/I don't think it has a reference guide like you want but it has some good tutorials that helped me get started.
http://tork.zenkel.com/_tutorials/Coding-Scripting/General/TorqueScriptingTutorials.php
Specifically, this is a general scripting guide to help people get started.
With this site and some playing around you should get the hang of the basics without too much trouble. Also do the four tutorials in the main documentation area.
I can see where your having troubles, my only small criticism of the engine is the lack of documentation for the scripting. However when you consider how cheap and good the engine is, it really is a very small criticism. Every other aspect to the whole product greatly exceeded my expectations.
Associate Ron Yacketta