Page 1 of 1

Usecode Documentation

Posted: Sun Apr 25, 2004 9:33 am
by Wizardry Dragon
Would anybody use it if I made all my usecode notes up nice and posted them?

- Wizardry Dragon

Re: Usecode Documentation

Posted: Sun Apr 25, 2004 10:23 am
by dino
I think I would. :) I like seeing new resources.

Re: Usecode Documentation

Posted: Sun Apr 25, 2004 10:25 am
by Dominus
Yes, please. Usecode documentation is much needed. I'd be interested to integrate it with Exult Studio documentation somehow.

Re: Usecode Documentation

Posted: Sun Apr 25, 2004 11:28 am
by Wizardry Dragon
Well, I'll rewrite my notes into something comphrehendable and post them :)

- Wizardry Dragon

Re: Usecode Documentation

Posted: Sun Apr 25, 2004 2:22 pm
by Mighty Dog
Excellent, that will make creating my new world all the much easier.

Re: Usecode Documentation

Posted: Sun Apr 25, 2004 2:42 pm
by Wizardry Dragon
That is where all my notes come from - the notes I take as I observe how things work when I script tem into my little world :-)

Re: Usecode Documentation

Posted: Sun Apr 25, 2004 5:51 pm
by drcode
That'd be great. We could also use them to look for bugs and improvements. Note that we can pretty much make the language do whatever we want.

Re: Usecode Documentation

Posted: Sun Apr 25, 2004 5:58 pm
by Wizardry Dragon
It would be really neat if someone could get the UI_give_item() and UI_get_item() functions to treat the Avatar's backpack as an array.

Functions specific to adding to and subtracting from the party gold would be much appreciated. In fact, a function kind of like converse but for buy {} or sell {} would be most appreciated.

Special FX such as spellcasting don't seem to work well either. Trying to make succesive spells go off in order just results in them going off at the same time. (Trying to do a flashy ritual kinda along the lines of the FoV mage's)

Just some thoughts.

- Wizardry Dragon

Re: Usecode Documentation

Posted: Sun Apr 25, 2004 6:22 pm
by Wizardry Dragon
Here is my first hack at documentation.
This mostly details what I see as the most common, basic function usecode is used for, and that is conversations.

http://crpgn.org/ucc_doc.txt

I *will* expand on this, just my hands are getting a little sore tonight :-)

- Wizardry Dragon

Re: Usecode Documentation

Posted: Mon Apr 26, 2004 3:30 pm
by Wizardry Dragon
*ahem*

Thoughts?

I know it isn't much, but I wouldn't want it to be glossed over; that's kinda why I didn't take the initative to do this earlier, I thought it would be.

- Wizardry Dragon

Re: Usecode Documentation

Posted: Tue Apr 27, 2004 12:58 am
by Dominus
he he, I like the cliffhangers "This section coming soon."
But so far it is well written. Especially not too dry as one could suspect of such a document.
Keep going....

Re: Usecode Documentation

Posted: Tue Apr 27, 2004 2:54 am
by wjp
I'm at work right now so can't read it through thoroughly, but I did notice you aren't using the new-style 'converse' block, in which you can use 'case' instead of if statements.

Check content/islefaq/usecode.uc in the exult sources for a sample of the exact usage.

Re: Usecode Documentation

Posted: Tue Apr 27, 2004 4:39 am
by artaxerxes
well, I like it a lot. It's easy to read, yet instructive.
Keep the same style and I'll buy your books! ;-)

Time for advanced content now.

Artaxerxes

Re: Usecode Documentation

Posted: Tue Apr 27, 2004 8:57 am
by Wizardry Dragon
I'm an old school programmer :-)

I will make a note, between the older version and the new version.

- Wizardry Dragon

Re: Usecode Documentation

Posted: Tue Apr 27, 2004 9:29 am
by Wizardry Dragon
Case is more complicated to understand anyways, I'm trying to ease people into it :-)

I plan on addidng many more advanced functions as I expeirment more with the advanced functions. Right now my implementations of the more advanced functions are pretty limited in scope, so I need to test further.

- Wizardry Dragon

Re: Usecode Documentation

Posted: Tue Apr 27, 2004 11:46 am
by drcode
I like the fact that you're teaching by example.

Re: Usecode Documentation

Posted: Tue Apr 27, 2004 12:16 pm
by Wizardry Dragon
That's the way I've always learned the best through, so that's the way I try to teach :-)

So, if I were to work on this more, could this find a place in the docs? :-)

- Wizardry Dragon

Re: Usecode Documentation

Posted: Tue Apr 27, 2004 12:39 pm
by Dominus
hey, there was never a doubt in my mind. This will surely go into the documentation :-)
Probably as an external file as it will probably be much too big for the Studio doc.

Re: Usecode Documentation

Posted: Wed Apr 28, 2004 6:28 pm
by Wizardry Dragon
Whatever works :-)

I will post an expanded version once I have finished experimenting further.

- Wizardry Dragon

Re: Usecode Documentation

Posted: Wed Apr 28, 2004 8:43 pm
by SB-X
What might help, along the same lines, is a usecode function list for BG/SI. I have such a list for SI, but it is nowhere near being finished.
There are many utility functions that you can use if you include U7 usecode. (legal issues with this in new games, but that's not my problem)

I also have a flag list that is much more complete, but not enough for me to post yet. This will be helpful for people modifying SI. (or cheating)

Re: Usecode Documentation

Posted: Thu Apr 29, 2004 7:13 am
by nadir
We could set up a Wiki so that creating this documentation can be a collaborative effort.

Re: Usecode Documentation

Posted: Thu Apr 29, 2004 10:15 am
by Wizardry Dragon
I plan to add a function list as a reference. Think of it like the Borland Delphi documentation. I'm making the User Manual now, and I will add the Language Reference after :-)

Is the documentation script for php.net downloadable/open-source? (I didn't see anything to that effect, but perhaps there's a reason I have glasses ... :-)

That is a really nice looking system and if I were to set up a system for users to contribute notes, that looks like a pretty solid one. Plus, it's geared towards the same sort of documentation.

- Wizardry Dragon

Re: Usecode Documentation

Posted: Thu Apr 29, 2004 10:22 am
by Wizardry Dragon
Never mind, I found it in the php.net CVS using their webby thing :-) If I set up a system like that, would people use that?

- Wizardry Dragon

Re: Usecode Documentation

Posted: Thu Apr 29, 2004 10:27 am
by Dominus
At least the people here who voiced their interest in Exult Studio before, I'd think.
Sounds promising...

Re: Usecode Documentation

Posted: Thu Apr 29, 2004 10:32 am
by Wizardry Dragon
Now to tinker with it until it works :-)

Thanks for showing interest, nice to know I'm not the only one that'd use it :-)

- Wizardry Dragon

Re: Usecode Documentation

Posted: Thu Apr 29, 2004 10:52 am
by drcode
Yes, that would be really helpful. And with people starting to look at the usecode compiler, we'll find ways to improve it.

Re: Usecode Documentation

Posted: Thu Apr 29, 2004 11:02 am
by Wizardry Dragon
Hmm. I can't get this thing to seem to work. Could someone do me a favour and grab the phpdocs module from the php cvs and see if they can't get it working?

- Wizardry Dragon

Re: Usecode Documentation

Posted: Thu Apr 29, 2004 11:08 am
by artaxerxes
I think it's a brilliant idea. It would be even nicer if it was somehow tied to the exult web site, instead of on a separate site altogether. And who knows, if we have a wiki on exult, we might even put in it the documentation and the FAQ (if it is possible to export it to a text file for inclusion in the packages).

Artaxerxes

Re: Usecode Documentation

Posted: Thu Apr 29, 2004 11:28 am
by Wizardry Dragon
I like the php.net documentation system better than wiki. Not as easy to setup (still having problems) but it's a very solid and very attractive looking system.

Not to mention it's specifically suited towards documenting a programming language :-)

If the Exult team could trust me/us with a piece of their site, then by all means, that would be cool :-)

- Wizardry Dragon

Re: Usecode Documentation

Posted: Thu Apr 29, 2004 11:32 am
by Dominus
I would prefer to have it on-site as well (and giving my "vote" on this)

Re: Usecode Documentation

Posted: Thu Apr 29, 2004 11:47 am
by Wizardry Dragon
Thanks Dominus :-)
Well then, perhaps you or one of the Exult team could set that system up, if we can get some consensus going :-)

- Wizardry Dragon

Re: Usecode Documentation

Posted: Fri Apr 30, 2004 7:29 am
by Dominus
Well then, perhaps you or one of the Exult team could set that system up, if we can get some consensus going :-)
Not me, probably best would be for you to have access rights here...

(Just looking at the list and our activity.. you wouldn't belive there are 14 developers of Exult...)

Re: Usecode Documentation

Posted: Fri Apr 30, 2004 12:20 pm
by Wizardry Dragon
Well, that would be ideal, but I didn't imagine you would trust me with that :-)

- Wizardry Dragon

Re: Usecode Documentation

Posted: Sat May 01, 2004 2:39 pm
by Wizardry Dragon
Okay, here's what I propose, I'll whip a system up, post it on my site with the info I have right now, and then the team can take a look, see if they like it, and if they do we can move it over here.

Sound good? :-)

- Wizardry Dragon

Re: Usecode Documentation

Posted: Mon May 03, 2004 11:58 pm
by nadir
Sounds good

I would do it myself if I had the time :(

Tristan