Common.ai Reference?

Hello,

This is the first time I've visited these forums, and I noticed that there is a forum specifically dedicated to AI discussions, which is awesome. Since AI scripting and such has really interested me in War3, I figured this is as good a place as any to make my debut post... Anyway, I'll get to the point..

Over the past several weeks, I've been exhaustively testing just about every function defined in common.ai, and I've started to put together a sort of reference document explaining the functions, what they do, how to call them, etc...

I'm wondering if there's already a document like this out there, and I just haven't discovered it. If there is, then it will save me the trouble of doing it, and if not, then I guess I'll continue on with mine...

There have been many people ask of such a document but none has been made. That would be a great contribution I think. I could help out a lot if you would like. Post a way to chat with ya and I'll do that like. MSN or Yahoo or IRC or whatever we could get some great stuff done.

I've got MSN, and my email address is: [email protected]

Problem is, between work and family, it's hard to predict when I'll have time to chat, and when I do my time will probably be limited, but we'll work something out, whether we correspond mostly in emails, or whatever... :D

So far I've got about 2/3 or so of the normal functions in common.ai documented to some degree. Those aren't too hard, since I can just look at the code and make an educated guess about what it's doing, and then test it out some. After that I figured I'd start on the natives, which are a tad harder, then probably look at some of the variables and constants defined in common.ai. In all, it shouldn't be an incredible task to get a basic reference done, just kinda time consuming.

Anyway, shoot me an email sometime, and if you want I'll just send you what I have done, so you can take a look at it and offer suggestions, additions, tell me it sucks, or whatever. 8)

Well, I've finished working on my rough reference of common.ai (attached below). I've documented all of the functions in common.ai except for the native functions. The reason I decided not to document the natives right now is that most of them are covered by one of the various other written functions anyway, so most people won't need to use them too much. If enough people want it, then I might document the native functions as well...

The document is by no means 100% accurate. Most of the information in there was gleaned from my own observations and interpretations. I tried to test all of the functions as much as possible, but some of them still weren't entirely clear, and a couple I'm still not sure about at all. I think I'm at least 95% correct, however. :D

Anyway, feel free to make comments or suggestions about anything in there. It's kind of a work in progress, so any insight is helpful. :gsmile: My next project is probably going to be a series of tutorials, the first of which will most likely be a detailed tutorial on creating a simple campaign AI (it's not too hard, but you gotta start somewhere). That is, when I find time to write one between work, and working on my own campaign...