Documentation Request

[Tyhm]

A good clarification for the documentation too.
onCreated - serverside - [this is an example, please don't expect me to be right] called when the NPC is created by the NPCServer, typically when the level is first uploaded or when the NPCServer is restarted. In the case of Non Database NPCs (See Database NPCs, [and that would be a link]), this is also called when the level is updated.
- clientside - called when the NPC is first encountered by the player and thus 'created' locally. Also called when the level is updated. [maybe, depends on if people still use "update level" to restart the NPCs fresh, and if it works clientside, and if it works serverside, all three questions at once.]
onPlayerEnters - serverside - called whenever any player enters the level by any means - walking, warping, connecting, reconnecting, anything. Also checked when the NPCServer restarts or the level is updated, but only if there is a player still in the level (to the NPC, the player just "entered" - "enter" and "poof into existance" are synonimous)
onPlayerEnters - clientside - called whenever the player enters the level. For checking if another player entered their level, you'd need [link to functioncall here].
onHit - serverside - called whenever any damage is dealt to this NPC by any source...

I'm sure I'm beating a dead horse by this point, just speaking to hear myself talk - ye who write the documentation, you get what I'm sayin' right?

[Rick]

Originally Posted by Tyhm

ye who write the documentation, you get what I'm sayin' right?

You're one of them. If you arn't, you should be. Get to work wenchy!

[ApothiX]

onCreated() is pretty straight forward, though.. If you go into the level, the NPC is created clientside, when you change the script, it is created serverside.

[Raeiphon]

I dont think there's any documentation on the mudlib functions, only syntax.. Wouldn't mind some documentation on that

[Python523]

Originally Posted by Raeiphon

I dont think there's any documentation on the mudlib functions, only syntax.. Wouldn't mind some documentation on that

Why would you care? It's not like you can play around with them.

[Warcaptain]

Rwar we should be able to play around with them!

[upsilon]

since they seem crutial to getting any non-trivial chunk of work done in gscript, someone who understands them pretty thoroughly should start a page on the wiki exclusively for triggerserver triggerclient and triggeraction, and object.trigger. distinctions between them, non pseudo code examples without confusing or non-descript variable names for the parameter.. descriptions of each parameter, stuff like that.

I racked my brain the other day trying to figure out how to use them all, and they seem to have overlapping functionality, but totally differ in their usage. Ive manage to get a triggerserver working so far. I could help out on that part of the page

Reguardless of that though, i think they deserve special attention.

[JkWhoSaysNi]

I think it would be nice if we had examples of each function. Kinda like php's documentation. All of the functions are listed but, useless mostly. changeimgpart(float,float,float,float,float); isn't useful without knowing what the params are supposed to be.

It'd be good if I could just type changeimgpart into the search box on wiki.graal.us and get an explanation of what it does and a couple of examples of how to use it.

I usually end up finding a function name in the wiki and then typing it into the forums search to get an example of usage.

[Skrobo2]

I still think someone should type up a GS2 equivalent of commands.rtf. And cover everything that can be done with Gscript, not just some of it. I find myself adding new things that I learn to my commands.rtf quite a bit. The wiki is nice, but I'd rather have a file to open, instead of having to go online.

And before someone quotes Okie again.

Originally Posted by ApothiX

Run graal4 with the command line option "-listscriptfunctions" and open the file it generates.

I know I've said this before, and I know what he said. I did as he said and the list I got was not that helpfull. We need something that gives a short explanation like in commands.rtf.

Like this:

NPC Code:

---

// simple npc manipulation:

setimg("filename");	      changes the npc’s image

setimgpart("filename",x,y,width,height);	      changes the npc’s image and only displays the rectangle (x,y,width,height) of it

hide();		      hides the npc

show();		      shows an hidden npc

dontblock();	      lets the npc don’t block the player anymore

drawoverplayer();	      draws the npc over the player

drawunderplayer();	      draws the npc under the player

drawaslight();	      draws the npc above day/night

blockagain();	      turns off the four previous flags

canbecarried();	      the npc can now be lifted and carried by the player

cannotbecarried();	      turns off the previous flag

canbepushed();	      the npc can now be pushed by the player

cannotbepushed();	      turns off the previous flag

canbepulled();	      the npc can now be pulled by the player

cannotbepulled();	      turns off the previous flag

cannotwarp();  	      disables link warping (dnpc) (server-side)

canwarp();  	      enables link warping (dnpc) (server-side)

canwarp2();  	      enables link warping for overworld links (dnpc) (server-side)

noplayeronwall();  	      players aren’t counted as a wall in onwall() or onwall2()

timershow();	      lets the npc’s timeout be shown

showcharacter();		displays a player character instead of the npc image

throwcarry();		throws the carried object

*followplayer;		 Removed in GS2

hidelocal();		hides the npc (only for the current player)

showlocal();		shows an hidden npc (only for the current player)

dontblocklocal();		lets the npc don’t block the player anymore (only for the current player)

blockagainlocal();		turns off the three block flags (only for the current player)

destroy();			deletes the npc

shootball();		shoots a ball directly to the player

---

[_Z3phyr_]

My mental version of commands.rtf is this:

- Same as GS1, but with () marks... and start off every code block by declaring a function.



---

But yeah though Skrobo, you keep doing what you're doing man with that commands.rtf and I, along with everyone else who is trying to teach themselves GS2 but has no one to teach them, will love you long time.

[Skrobo2]

Problem is, I don't know GS2 well, myself. It'd be nice if Skyld or someone could do this. Most of it is just syntaxing, but things have been removed and there are new additions to the scripting language such as GUI windows and particles.

[Tyhm]

- shoot real,real,real,real,real,real,string,string
Not only is this posted numerous times, only once does it list it as
shoot x,y,z,angle,zangle,power,ani,aniparams;
which STILL omits the most useful bit of information from the original documentation:
angle is in radians, and what number you set Power to to make it a classic-style goes-until-it-hits-a-wall projectile.

[jake13jake]

Function prototypes are not documentation by any means.

[Tyhm]

http://wiki.graal.net/index.php/Crea...ev/Old_GScript

Well, I mean, we got stuff like

NPC Code:

---

move dx,dy,time,options;	                  moves the npc, options: cachtype(0,1,2) + 

                                                      blockcheck(4) + eventwhendone(8) + 

                                                      applydir(16)

---

...so I can figure out dx, dy is going to be something like -8, 0 for Move 8 tiles left, and time's probably going to be in seconds, so if you say 1 it'll move those 8 tiles in one second...
So what's cachtype 0,1,and 2? I imagine it's standard-issue binary, 0 means no cachtype, 1 means cachtype 1, 2 means cachtype 2, 3 means both 1 and 2...but what do they DO in vague terms?
Blockcheck 4, I imagine it detects blocking tiles - does it detect water? Chairs? Beds? Lava? Shallows?
Eventwhendone, I remember this being terrifically useful - but what event did it call? With what parameters/arguments?
Applydir? Will that turn the NPC automatically?
I'll grant, I could do some of this legwork myself, but EventWhenDone, that's infinite possible event-calls to detect for...

-5 minutes later-
It's a good thing I keep everything.

From NewFeatures2001.txt:

Originally Posted by Stefan

There are also nice options to makes things very simple:
- cachingmode:
- 0: previous movements will be finished immediatelly
- 1: movements will be cached, the previous movements
will only be finished when the cache is too large
(distance to go >5);
this caching can be used on server-side npcs to
make the movement look like non-laggy even when
there are little delays sometimes
- 2: the movement will just be appended to the movement
list; you can add up to 100 movements
- blockcheck: add 4 to the options when you want the
npc to stop when there is a wall blocking the npc
- informmewhendone: if you add 8 to the options then the
script will be called with a 'movementfinished' flag
when the the npc has stopped walking; catch this event
with
if (movementfinished) {...}
if you want to do something when the npc has stopped
(e.g. walking in a different direction)
- applydirection: add 16 to the options if you want the
game to automatically set the direction of the npc
depending on the movement direction (can be good
when using movement caching)

I wonder if I have access to add the old NewFeatures to the Wiki myself...
Nope, sure don't. Oh well.

[Riot]

Originally Posted by Tyhm

I wonder if I have access to add the old NewFeatures to the Wiki myself...
Nope, sure don't. Oh well.

You do, login to the Bible with your Graal account information and you can add a new page or edit an already existing one.