function list

This is a moderated forum that collects tutorials, guides, and references for creating Transcendence extensions and scripts.
User avatar
bimbel
Militia Lieutenant
Militia Lieutenant
Posts: 181
Joined: Wed Jul 05, 2006 8:22 am
Location: Germany
Contact:

Darth Saber wrote:The obvious answer to that is yes; however, the function list in downloadable HTML format is from 2007 - three years ago. Since then we have progressed from .98d to RC8. It is also notable that many of the functions in that list did not include adequate examples of syntax usage, or explanations. This is why there is a need for an updated version which contains not only the function's name and syntax, but also an example of its usage. Some of us were not born omniscient, therefore we need help in many forms. This would be a valuable reference guide.
alterecco wrote:There is also a link to a single page function list here: http://xelerus.de/functions.txt. Perhaps it will suit you better?
You should use http://xelerus.de/doc_function_txt.php as link! When you visit it the current functions will be dumped into the text you'll be redirected to!
alterecco wrote:Please realize that there are people working on the function list in their free time, and it is a lot of work to do this. I myself have updated the functions from the start up to a certain point, and the next chance I have I will continue. The real props go to Betelgeuse who must have spent forever to compile that list. There is no omniscience involved in this process, just a lot of work and experimenting.

That said, please feel free to contribute to the function list on xelerus. I am sure one with editor rights (afaik, bimbel, Betel, digdug and me) would be happy to recieve your help.
Styro wrote:It would also probably be better to have the information as a wiki so when people find errors they can correct them.
And we're all glad that you do the work :) And I'm willingly to give rights to the people out there that want to help! The problem with the wiki is that when you add a new function you need to add it to all category list manually! Want to remove a function? You need to remove it from all lists manually!

The function list on xelerus generates all these list automatically on the fly! And changing to the wiki will increase the workload on the people who spend their freetime!
User avatar
alterecco
Fleet Officer
Fleet Officer
Posts: 1658
Joined: Wed Jan 14, 2009 3:08 am
Location: Previously enslaved by the Iocrym

I personally like xelerus for what it provides... If people were willing to post corrections/addendums for functions on xelerus somewhere I am sure they could easily be updated. The problem is always coming up with the correct description and text in general, so just saying "Please fix function x, it is incorrect" does not go as far as "Function x is incorrect, here is what it really does and here is what I suggest it should say".

As for some common syntax, I have had some chats with Betel about this on IRC, and I think we have settled on something that is ok (it could use more work for some of the odd cases). In general the function syntax itself follows the syntax given by George in his function help listings (generated by fncHelp). The most recent one on the forums if for RC5 and is here. I can not remember if there are any big changes since RC5, so for now it should suffice.

Functions 1-78 on xelerus were recently updated to this syntax (I have not made it further). I would appreciate anyone taking a look at them and bringing opinions to the table.

Thanks styro for posting on the shpOrderEscort. I have updated the listing on xelerus to reflect this. If anyone has any updates, please post in another thread in Script References (perhaps a Xelerus function updates thread would be in order?)
User avatar
alterecco
Fleet Officer
Fleet Officer
Posts: 1658
Joined: Wed Jan 14, 2009 3:08 am
Location: Previously enslaved by the Iocrym

As a further note, here is a list maintained by digdug on the functions missing from xelerus to be up to data with the latest RC

http://transcendence.pastebin.com/f1b6d75f
User avatar
digdug
Fleet Admiral
Fleet Admiral
Posts: 2620
Joined: Mon Oct 29, 2007 9:23 pm
Location: Decoding hieroglyphics on Tan-Ru-Dorem

updated the list of functions NOT on Xelerus
http://transcendence.pastebin.com/LqQnZ15h
User avatar
alterecco
Fleet Officer
Fleet Officer
Posts: 1658
Joined: Wed Jan 14, 2009 3:08 am
Location: Previously enslaved by the Iocrym

I have unstickied this thread, since this process is now taking place on xelerus. However, there is no amount of cudos big enough to Betelguese for the work he did here. You got it all started, and saw it through!! Thx.
Post Reply