Adventure Game Studio

AGS Support => Advanced Technical Forum => Topic started by: Clarvalon on Tue 06/09/2011 08:01:35

Title: [SOLVED] List of AGS functions and properties
Post by: Clarvalon on Tue 06/09/2011 08:01:35
Hi,

I was wondering whether there exists a full list of properties and functions (including parameters) available within AGS.  I'm not able to find anything on the site (search on the forums seems to be broken at the moment) and there doesn't seem to be anything like this on the wiki.  The AGS Editor help file is a great resource and does seem to cover everything, though I'm having to manually cut and paste each item which is rather time consuming.

e.g. a list similar to below would be fantastic:

Properties
int Character.x;
int Character.y
int Character.z
...

Functions:
Character.ChangeRoom(int room_number, optional int x, optional int y)
Character.ChangeRoomAutoPosition(int room_number, optional int newPosition)
Character.ChangeView(int view)
...

Thanks,
Dan
Title: Re: List of AGS functions and properties
Post by: Gilbert on Tue 06/09/2011 08:16:42
There was once M$Word (or PDF; I don't remember) version of the manual, compiled by certain members, but that would be long long time ago and the information wouldn't be up-to-date (possibly even before the script language starting to go OO) and for obvious reason of lacking motivation this was discontinued, so that's not useful even if you manage to find a download.

I'm not sure. Maybe there are some software that would crawl CHM or the Wiki pages and extract relevant info into a single file? Possibly the source release can be of help too (I think the raw materials used in generating the CHM files are there too?). One thing that I think can be of help is the database the text script editor used for autocompletion.
Title: Re: List of AGS functions and properties
Post by: Calin Leafshade on Tue 06/09/2011 08:31:39
In the source there is a built in script header file that contains everythign available to the scripts.

i think its called _builtin.ash
Title: Re: List of AGS functions and properties
Post by: Wyz on Tue 06/09/2011 11:44:34
What Steve says (actually it's located in Editor/AGS.Editor/Resources/ called agsdefns.sh), or you could open the editor binary in a text editor and scroll a bit. ;D
Title: Re: List of AGS functions and properties
Post by: Calin Leafshade on Tue 06/09/2011 12:07:26
thats right... _Builtin.ash is the header generated by the compiler for stuff like character names.
Title: Re: List of AGS functions and properties
Post by: Clarvalon on Tue 06/09/2011 13:02:38
Superb, exactly what I needed.  Thanks guys.