KSI-GS (Coding Standards)

[SaijinGohan]

I like to use b in my for loops. But anyways..

I think it should be added where code should be layered according to how how it's used. For example:

NPC Code:

---

if (strequals(#a,SaijinGohan)) {

 if (strequals(#g,Bravo Legends)) {

  say2 Yay!;

 }

}

---

The above is properly 'layered'.

NPC Code:

---

if (strequals(#a,SaijinGohan)) {

   if (strequals(#g,Bravo Legends)) {

say2 Yay!;

}}

---

The above is not properly 'layered'.

Thats my little pet peeve. It just seems easier to help people when its that way.

[Kaimetsu]

That's just a stylistic choice. The underlying code will be exactly the same either way.

[wonderboysp2p]

good god.. dont get into where to put brackets... we all have differant styles of scripting... i for one hate my damned enter key and weasal out of "layering" any chance i get...

[SaijinGohan]

Ok fine but I still think it's easier with some kind of format.

[CheeToS2]

Kai said he'd think about how to phrase this after I told him, but he never posted soooo, in the deprecated commands section:
Don't use toweapons unless you're making the script on a server without an NPCserver, OR EVIL MONKEYS FROM THE DEPTHS OF HELL WILL COME ABOVE GROUND AND EAT YOUR SOUL.

[Tseng]

Originally posted by CheeToS2
Kai said he'd think about how to phrase this after I told him, but he never posted soooo, in the deprecated commands section:
Don't use toweapons unless you're making the script on a server without an NPCserver, OR EVIL MONKEYS FROM THE DEPTHS OF HELL WILL COME ABOVE GROUND AND EAT YOUR SOUL.

I requested a disabletoweapons=true serveroption (or it to be globally disabled with the exception of classic). Stefan said he would consider the server option.

[Python523]

Originally posted by Tseng


I requested a disabletoweapons=true serveroption (or it to be globally disabled with the exception of classic). Stefan said he would consider the server option.

or just be careful =|

[Neoreno]

Mleh. Classic is supposed to be getting a conversion. So all the more insentive to hurry it up.

[Tseng]

Originally posted by Python523

or just be careful =|

That really works when stupid Levels Team members get the idea to try to add a weapon with a name that already exists?

That really works when old backup levels with toweapons are added and played on?

:-\

[wonderboysp2p]

i agree with tseng... ive uploaded old levels and found "toweapons" in there... had a good time getting disconnected about 7 times before i realized it was there too

[Tseng]

Originally posted by wonderboysp2p
i agree with tseng... ive uploaded old levels and found "toweapons" in there... had a good time getting disconnected about 7 times before i realized it was there too

I'm talking about serverside toweapons (overwrites weapons in NC), not clientside toweapons (disconnects because clientside/offline style toweapons is the kind of thing trainers inject to try to add a weapon).

[wonderboysp2p]

ooooooooooooooooooooooooooooooooooooooooooh
that's another problem heh

[prozac424242]

It is good to see people who know that programming is an art form, and there are certain rules that should apply for asthetic reasons, and to save on processor time (thus slashing away at the lag monster).

Good code should be self-documenting, but comments are encouraged - at least a purpose statement, like with your graal name and an exploination of what the npc does, at the top of the code.

There are two ways to make comments, line at a time, and in a block.

NPC Code:

---

// NPC by Prozac

// This npc is uber 1337 and will ownz all of joo!

// this line is a comment and will not be read by the parser



/////////  text lines like this help break up long scripts ///////



// for short query-action stuf like the code below

// I think its ok to put it on one line . less scrolling 

// in the code window too.



if (playerenters)  {message I Ownz joo!;}



a=0; //variable a is set to 0:  after the two slashes is a comment until you press enter

---

The comments that go on for more than one line should be put in a comment block

NPC Code:

---

/*  NPC by Prozac

This npc shows how I prefer to layout code after querying for a 

comdition, then listing more than one command.



I like to have the curly brackets on their own line 

at the start and end of the blocks, two spaces in if nested condition checks.  



In long scripts or blocks of code, I place and indent my if

 (condition) and brackets { and }   beforehand, then fill in the

 commands afterwards.  This habit helps to make sure you don't

 forget to close your brackets, that they end in the right place.



A good indentation rule is two spaces, thats what I usually end 

up doing.  But as in all art, try the general convention, then find what works for you.



And yes, all this is a comment.  Here comes the comment end..

*/



//////// code begins here //////////



if (created)

  {

   setplayerprop #c,I am here!;

   a=0;



   if (weaponsenabled)

     {

       say2 Weapons are enabled;

     }



  }

---

Forgive spelling or grammar mistakes, as its early morning and am half awake .. and half asleep .. so my consiousness is twice as big as it needs to be?

[wonderboysp2p]

heh my dad's always telling meh to use comments while programming... it's fun because you can pretend that whateber you put is a sublimnal message repeated OVER AND OVER while the script is functioning but yea...

comments are very underused in gscript (as far as ive seen)... i think it would be ince to see a script once in a while that ya know says

if (actionjewer){
message #p(1) Is A Jew!; //#p(1) is the player's account name
}

or something like that, so we have like a little helper when we're debugging other people's scripts... or scripts we made when we were "in a state where we wouldnt remember" heh...

most scripters can easily identify (looking at the triggeraction) that #p(1) would be the players account name but it saves time and is much easier to just look to the right and say "oh!"

or say, the script keeps coming up with something like
"12 is a jew!" people can say "hmm..."
"oh ok well that's the problem! #p(1) is scripted to be the players damage! they have 'account name' listed as #p(2) in the triggeraction! Silly NATs..."

it can cause more confusion if someone types the wrong thing as a comment then what the script is actually intended to do but everything's got drawbacks right?

[duzzel]

another word for scripting hmm...geek
anyways I wish there were a good tuturial that teaches people to script easier... i just don't get it