SRL Archive - Outdated Tutorials

• Indenting will be two spaces per level. You can indent by selecting text in SCAR and pressing Ctrl+Shift+U and Ctrl+Shift+I.
• Margins will be set to 80 characters. Try not to make too long lines.
• The begin statement appears on its own line. The end statement always
matches the begin statement by columns. Example:
• Do not combine two or more statements on a single line. Write each on its own line.
• Use semicolons at the end of the lines where appropriate. SCAR allows lines without semicolons but you should use them everywhere, except after var, begin, then, else repeat, do and before else.
• Use spaces after commas and arithmetical signs.
Example:
• There shall never be white space between an open parenthesis and the next character.
Example:
• Object Pascal language reserved words and key words shall always be completely lowercase. Never capitalize words that SCAR displays in bold. It's completely unnecessary and looks ugly!
• Routine names shall always begin with a capital letter and be camel-capped for readability.
Example:
• Routines shall be given names meaningful to their content. Routine name DoStuffWithSyAndSy is not meaningful, but name OutputProgressReport is.
• Where possible, procedure and function formal parameters of the same type shall be combined into one statement
Example:
• All formal procedure and function parameter names will be meaningful to their purpose.
• All functions should always return some value. Do not rely on SCAR initializing procedure return value automatically!
• Variables will be given names meaningful to their purpose. That includes local and loop control variables, although in this case single character names are acceptable.
• Boolean variable names must be descriptive enough so that their meanings of True and False values will be clear.
• Variable declarations start in next line after var statement and are indented.
Example:
• Use of global variables is discouraged. However, they may be used when necessary. Global variable naming rules are as follow:
Forms and controls are prefixed with their individual prefixes. Examples: frmMainForm, lblUser, txtPassword, imgPreview etc. DTMs will be marked with dtm prefix as in dtmFishingSpot. Character sets will be marked with chr prefix as in chrChatChars. Bitmaps will be marked with bmp prefix as in bmpFishingNet. Include global variables will be marked with g prefix then include initials as in gOsiStartTime. Normal global variables will be marked with g prefix as in gNumFishCaught.
• Type names that are reserved words shall be completely lowercase as in string. For other variable names, the first letter shall be uppercase, and the rest shall be camel-capped for clarity as in Integer.
• The most likely case to execute in an if/then/else statement shall be placed in the then clause, with less likely cases residing in the else clause(s). This improves performance as well as readability.
• If multiple conditions are being tested in an if statement, conditions should be arrange from left to right in order of least to most computation intensive. If condition statement is complex, replace it with function or Boolean variable with a meaningful name. This improves readability and makes code self-documenting.
• Use of informational file header is encouraged for all script and include files.
Use Script > Script Properties from SCAR menu to enter script information.

These standards ensures readability of your code and enables easier maintaining of scripts written by other people.

[Source = http://kaitnieks.com/scar/scriptingsta/ ]

Wow. Finally I can bring my scripts up to standards :D. Thanks for the tut, there's just so much disputes over Standards out there I realize that sometimes it may be hard finding valid info :(.

Nice tut ;)

From: botmaster
Wow. Finally I can bring my scripts up to standards :D. Thanks for the tut, there's just so much disputes over Standards out there I realize that sometimes it may be hard finding valid info :(.

Nice tut ;)

This isn't just a Tut these are THE original standards (if you look at citation) :D

WONDERFULL
everyone always talks about "standards" and people know what most of them are but ther isnt like one guide saying what "THE standsards" are. good job!

iv read the site a while ago, the only standard i picked up is the use of the prefix dtm and bmp for the handles.
you might have noticed iv got dtmBankers or dtmWater in a few scripts

theres also some small useful ones like putting the conditons of if statements in their most likely order

but this was useful to look at when i was writing stuff that would go into SRL

Been following these since a month into my SCAR scripting "career" :cool:

I posted a download for the post source anyone who wants to feel free to redistribute this…

Ok, most of that makes sense to me (i think :o), but there's one thing i don't understand:

Type names that are reserved words shall be completely lowercase as in string. For other variable names, the first letter shall be uppercase, and the rest shall be camel-capped for clarity as in Integer.

What does camel-capped mean?

Ok, most of that makes sense to me (i think :o), but there's one thing i don't understand:

Type names that are reserved words shall be completely lowercase as in string. For other variable names, the first letter shall be uppercase, and the rest shall be camel-capped for clarity as in Integer.

What does camel-capped mean?

ok dang i not been doin some of that stuff better hop to it =p

Aren't these from kaitnieks.com..? Maybe you should credit kait for making the standards, if they are from kaitnieks.com

From: GoF
Aren't these from kaitnieks.com..? Maybe you should credit kait for making the standards, if they are from kaitnieks.com

From: Bam Bam
[Source = http://kaitnieks.com/scar/scriptingsta/ ]

Everyone adapts their own standards anyway. Mine are like:

procedure DoSomething(Param : Integer);
var
  I : Integer;
begin
 I:= Param * (Param * 100) / 100;
 if(Something)then
   begin
    DoSomething;
    Etc;
   end
 else
   DoSomethingElse; 
end;

From: Bam Bam

[Source = http://kaitnieks.com/scar/scriptingsta/ ]

:)
edit: beaten by Spky, only one minute!!!1!11!!!

Awesome tut for beginners; maybe this should get stickied?

Nice bump Smartz :p

i think this si worth a bump, I havnt found a place to be as detailed and definative as this. I wil have to change a few things.

yes!! smei colons!!!!!

no!! no caps :( lol

If this got stickyfied it would be my first sticky :)

Edit:

Thanks Wizzup :)

First Sticky. ;)

A little late, but thanks for these Bam Bam. They make scripts look very neat, which is a necessity for running any type of script.

Useful for organizing the scripts!

i wish someone could learn me scripting step by step send me mail if u want to

kk great you don't need to post ur URL on my script. You script your way i'll script mine. So don't be a narb and just post ur URL and nothing else.

Thanks for helping me!

Thanks Nice tut! Really Helped.

Thanks for this dude, I am VERY new to scripting. I will make all my scripts to these standerds. Thanks!

Bookmarked as a checklist for when my first script is done. Ty for writing.

Thanks, I never knew if there were certain standards when making a script, but now I do.. :)

Gr8 tut…Were was somthing i dident understod but Thanks for making this tut it helped me a lot :p

Nice tut. Helped me alot.

thank you

Ty bam this helped me

Great tutorial, thanks =)

This has actually made scripting 100x easier for me, by making everything clearer to read and identify for when i make mistakes or when i want to add something to the script. Thanks man.

wow, I never actually knew the standards. This is great, thanks.

Pizzownage

thank you! I am learning so much with all of these scripts!

oops last post i meant tuts not scripts, not thinking :D

Thanks, I believe there are many different versions of 'correct' standards but if i go by yours i can't go far wrong :)

Many Thanks
ShadowMinion [exppo]

Thanks, helped sooo much now i can bring my standards up to what is truly expected :)

Exppo

p.s: Thanks a milllioooon…

Good thing I found this before I started scripting!

From: Bam Bam

[*]Use semicolons at the end of the lines where appropriate. SCAR allows lines without semicolons but you should use them everywhere, except after var, begin, then, else repeat, do and before else.

I don't mean to sound like the syntax police… but semicolons in pascal work different; unlike C for example, pascal dosn't use semi's for a line terminator… instead semi's are used as separators…

Just think:
"Should I put in a semicolon? Only if the next thing is a statement!"


yes its not a problem for the compiler… it's just redundant :D


There is some more information about it on this website (also a resource that I used for this post):
http://everything2.com/index.pl?node_id=1108617

hope I was of some help.

This will probably just confuse everyone however…. meh… maybe someone else might be able to explain it better :P lol

Well the scripting is much like VB but the semicolons remind me of Java and C++.

Once i get a bit of time, i will try to learn the language.. they are all pretty much the same once you understand the core logic behind it… so i hope it isn't too hard to pick up. :)

thanks.. i really needed this:D
thanks to you that my script has better standards now
thanks:)
rep++ for you for helping me:cool:

From: pvh
thanks.. i really needed this:D
thanks to you that my script has better standards now
thanks:)
rep++ for you for helping me:cool:

You know, thank you.
I don't get a whole lot of that even when I do manage to make myself useful. xD

- Bam Bam

brilliant! just what ive been looking for, THANKYOU

veary nice tut. i have lerned so much, thanks.

i have a question so the stuff that i just looked at about making scripts i need to include in all mine to become jr member

finally…i have been working on my first script but I could not locate any set standard rules. Now i can learn the right way!

rep++ :)

Good to know the standards:)

This is great to follow if you write without a standard. I use them as guidelines and not rules. I'm all for letting the code flow freely and then fixing readability!

This will help with some scripting. Good for posting it now people know the standards.

This helped a lot Thank you

Hah. Thanks very much. I appreciate the easy access to the standards in this forum, especially since I've been trying to learn everything I can about scripting.

wonderful, thanks :).. If I know c++, vb, php/mysql, perl, and html/css this should be a walk in the park?

Bump… people read this through thoroughly … Great Thread!

Yes, because you really need to bump stickies…

From: Da 0wner
Yes, because you really need to bump stickies…

True, but I guess I wanted people to notice it…

Oh yeah, the bold text or the latest post thing?

yes… [/endofconversation]

Hmm…someone should create a script where you copy and paste your script into a form, and it makes your script have the official standards. Kind of like that SRL Member Application Tool Script, but after you paste you script in and click ok, it fixes it up for you.

EDIT: I am sure that tweaking that script a bit would do the job…perhaps. :p

Not really…that script is really simple :D. This would take more time.

Code formatters already exist. The point of this tutorial is to teach people how to format their code properly without relying on one of these tools.

Its like spell check vs just knowing how to spell.

Nielsie made a formatter.

What about constants? Should they be all caps, or just named like any other variable?

From: A Random Guy
What about constants? Should they be all caps, or just named like any other variable?

It's really up to the scripter. Personally, I use all caps. This is a standard in Java, and it easily distinguishes between whether you have a constant/variable/proc/func.