TGE Script Documentation

#61 I think he means, have the commands sorted by type or general function, as well as alphabetically.
Like click on "OpenAL Commands", and you get a list of all the commands related to OpenAL,
click "Sound Commands" and you get a list of all the commands related to sound.
Basically, if you get this whole thing done and plop it into a mysql database,
just have a keywords column for each table where you put in what categories the command fits in,
for example OpenAL commands could have keywords of "OpenAL sound audio music ambience".
You can easily write a search engine script with PHP that will allow people to find the functions they need,
even if they do not know the name of it.

#62 Great idea!!

The goal of this initial release is just to-do the documentation and turn it over to the GG staff (Jef T.).

I think GG (Jeff T.) already has something planned for the document, weather it be searchable etc.

I do know that it I have asked to make it searchable and updateable by those within the community, weather this pans out to be true or not is out of my control.

-Ron

#63 Ron,

can you please edit the post with your sample of the documentation to add in a few hard returns? The way it is now, it streches the whole thread to be super wide, which makes reading things really hard.

Thanks,
Josh

#64 Done.

#65 Ron,

If you would like, I can expand the intro section into much more basic terms/ideas with examples for non-coders. This could be linked in addition to the info supplied, calling it something like, "Expanded info for those new to Programming/Scripting."

Also, will the document say which .cc and .h files expose the script aware objects/functions/variables?

#66 I don't know how much more basic you're going to get with that stuff. Bitwise operators aren't things that non-coders would understand with a simpler explanation.

If you plan on doing any decent sort of scripting, you're going to have to take a few steps toward learning the language. There's only so much "...For Dummies" can do, and with programming is stops pretty early.

#67 Jared,

I do not need see a need to list which .cc file a
command/function is coded in nor which .h file it is
declared in.

Individuals who have not bought the TGE license
(pure scripter's) would have absolutly no use for it.
On the other hand, those who have purchased the license
can easily use the "Find in Files" feature of
Visual Studio to locate the function/command.

If you can make the opening more newbie'ish go for it, I
am open to all help, input and feedback.

Regards,
Ron

#68 ok so whats the command for "find in files" for the linux users?

#69 grep -i -r 'my search' ./*

#70 hi ron, i am ready to proofread dummyproof your docs whenever you like. i dont expect it to be non coder in orientation, but that still leaves a lot of latitude in delivery. i guess ill go through it with my 'dictionaries' and make it a learning experience :)

#71 Minor update:

The following ConsoleFunctions and Commands have been fully documented. Others are documented, but not in the proper format.

Function  Name
OpenALInitDriver
OpenALShutdownDriver
OpenALRegisterExtensions
alGetString
alxCreateSource
alxSourcef
alxSource3f
alxSourcei
alxGetSourcef
alxGetSource3f
alxGetSourcei
alxPlay
alxStop
alxStopAll
alxIsPlaying
alxListenerf
alListener3f
alxGetListenerf
alGetListener3f
alGetListeneri
alxGetChannelVolume
alxSetChannelVolume
dumpConsoleClasses
ExpandFilename
strcmp
stricmp
strlen
strstr
strpos
ltrim
rtrim
trim
stripChars
strlwr
strupr
strchr
strreplace
getSubStr
getWord
getWords
setWord
removeWord
getWordCount
getField
getFields
setField
removeField
getFieldCount
getRecord
getRecords
setRecord
removeRecord
getRecordCount
firstWord
restWords
detag
getTag
echo
warn
error
expandEscape
collapseEscape
quit
call
compile
exec
eval
export
deleteVariables
trace
debug
findFirstFile
findNextFile
getFileCount
getFileCRC
isFile
isWriteableFileName
fileExt
fileBase
fileName
filePath
NextToken
setLogMode
setEchoFileLoads
backtrace
isPackage
activatePackage
deactivatePackage
nameToID
isObject
cancel
isEventPending
schedule
deleteDataBlocks
telnetSetParameters
dbgSetParameters
DNetSetLogging
setNPatch
toggleNPatch
increaseNPatch
decreaseNPatch
setFSAA
increaseFSAA
decreaseFSAA
setOpenGLMipReduction
setOpenGLSkyMipReduction
setOpenGLInteriorMipReduction
setOpenGLTextureCompressionHint
setOpenGLAnisotropy
clearTextureHolds
addMaterialMapping
aiConnect
aiAddPlayer
setPowerAudioProfiles
calcExplosionCoverage
gotoWebPage
deactivateDirectInput
activateDirectInput
strToPlayerName
stripTrailingSpaces
setDefaultFov
setZoomSpeed
setFov
screenShot
panoramaScreenShot
purgeResources
lightScene
flushTextureCache
dumpTextureStats
dumpResourceStats

Regards,
Ron

#72 wonderful! excellent!

dont know why im happy, since i have no clue as to what all that stuff is 8P

#73 Ah, but the cool part here Jeff is that since it's documented, soon you'll be able to know all about those functions :-)

#74 Just got some feedback from GG staff, here is what they had to say

Ron,

Rick and Mark looked over the doco.  They thought it looked great!  A couple
of formatting suggestions were to BOLD the function name line and use a
fixed font such as Currier for the example.

We look forward to getting this released.

Thanks,

Jeff

Looks like we are in the right track here, just need some additional help to tie up other areas of the document that have not been accounted for yet.

If you are working on a section, can you kindly give me a status update.

Regards,
Ron

#75 Folks,

I have created a project and a help wanted add.
For those of you who have offered to help, could you please submit an application to the add.

I will utilize the project to keep track of the current status of the documentation as well as keep me up to date as to who is doing what.

Regards,
Ron

#76 Folks,

I have been trying to track down a solid description for "setPowerAudioProfiles". I would have looked at T2 scripts, but do not have T2.

Can anyone lend a hand? GG staff?

-Ron

#77 I'm working on the Datablocks right now, and documentation for weapons (well, documenting the heck outta the crossbow.cs class from the Torque Demo app - I've seen a number o' questions about 'em, so I decided ta work on it.) I'm not going to get ALL of the datablocks done, I'm sure - there's a couple that I haven't had to deal with yet, and probably won't have to deal with on this project. However, the ones I'm dealing with are:

ShapeBaseimageData
ItemData
ProjectileData
ExplosionData
ParticleEmitterData
ParticleData

Anyone have any particular preferences for datablock documentation format?

#78 Davis,

Once we have a solid base for datablocks I will toss it off to Jeff T for review. I will ask him to provide feedback on the document's content and formating.
This has worked well so far for the Console Functions / Commands. I have received some wonderful feedback and ideas for minor changes.

-Ron

#79 Adding a couple more datablocks to my list:

CameraData
AudioProfile
AudioDescription
MissionMarkerData

Does anyone know of any more datablocks that I might have missed?

#80 Sounds good, Ron. I'll have something sometime soon, I think - I'm still working out HOW I want to document it. Right now I've just got a list of all datablocks (that I know of) and thier possible elements (again - that I know of ;-)

Any comments on the weapons documentation that I sent you so far? Useful, or ditch it?