Full Java Npc Scripting Tutorial!

Subject: Full Java Npc Scripting Tutorial! Sat Jan 30, 2010 4:04 pm

Big NPC Scripting Tut

Have you ever wanted to script your own NPC?
Did you fail?
Well take a look at this Tutorial!

Contents

Tutorial 1 [The base of a NPC scripting]
Tutorial 2 [How to fix the NPC if you got a problem with it]
Tutorial 3 [The NPC commands]
Tutorial 4 [The Text commands]
Nice JavaScript Editors

TUTORIAL 1 [The basics of NPC scripting]

Spoiler:

So you want to learn the basics?
Okay! Here we go.
We will make a simple NPC and teach you on the way.
To begin with. You should download a JavaScript editor below at the Javascript editor downloads.
When you have done that, you are ready to start!
Open the program. Go to file and open and then go to your servers main folder and then you go to scripts folder--> NPC folder. If you dont know how to do that, then you should not have a private server at all because its just to go to the NPC folder inside scripts folder in your Server folder. Ok?
When you have got that far, choose a npc to edit.
Click open (remember we are still using the script editor!).
Now, (if you haven't made an new empty NPCID.js) it should get up some weird text.
(It may look weird to you if you are a beginner at this)
Do not panic.(Lol)
All you have to do is to delete the text. (Hotkey - CTRL + A and then delete)
Now you can start scripting!

To begin with, type this at the top:

Code:: var status = 0;

Explanation:

Code:: This is the variable to the status that we will get into later. Ignore the = 0 part. It doesn't really matter. the function start will make it -1 anyways. If you want to add a new variable you always have to make a var [Name]; at the top or the variable might not work.

When you have added that script, your first variable is set. Under this variable, you can set more variables.
That depends on what you will use them for but we will go into that later.

Now, you have to add the string that actually makes your NPC work.

Code:

function start() {
status = -1;
action(1, 0, 0);
}

This makes the script actually work. You may notice that because of the function_start(). This has to be included in every npc script you are making.

Now you can go in game and talk to your NPC!... JOKES! The npc is not done yet..
Now you will have to add a string for the ACTIONS to work. Still, the above string is the base of the script. Did you notice that action(1, 0, 0); ? Well I did.
What do that variable do? We will come into that now.
Add this string to the script:

Code:

function action(mode, type, selection) {

This means that action is a function that has 3 variables. mode, type and selection. So the action(1, 0, 0) from before will be in the order as this one. So mode is 1, type is 0 and selection is 0.

Now we can add our modes.

Code:

if (mode == -1)
cm.sendOk("Goodbye then!");
cm.dispose();
else {
if (mode == 0 && status == 1) {
cm.dispose();
return;
}

The mode variable, actually takes care of if you have clicked End Chat or finished talking to a NPC. The mode == -1 checks if you have clicked a negative button like, No. The mode == 0 and status == 1 checks the status assigned for choices. The status == 1 should be changed if you have a question in another status. We will not talk about that cm.sendOK in this tut. Please check out Tutorial 3 if you want to knwo about it.

There is ONE more mode that we will add.. It is the one that checks if we did go backwards or forwards in the script.

Code:

if (mode == 1)
status++;
else
status--;

You should now knwo about what the modes do. Yes, they take care of the status's actions. Now lets explain what the status++; actually does. Did you remember the status == -1; variable under function_start()? Now you may have noticed what I mean? It is actually adding +1 when you are going to next window(in-game)/status(in-script). The status--; is subtracting -1 when you are going to previous window(in-game)/status(in-script).

Now are we done? The answer is both no and yes. If you want the npc to not say anything, yes. If you want the npc to actually do anything, no. The script will wonder "Hey! What to do with the statuses then? It's useless!". It isn't useless if you add this if statement:

Code:: if (status == 0) {

This is a npc window(in-game)/status(in-script). If you are gonna add more statuses, You wil?l have to add +1 to the number all the time. For example: If you have status ==1, and want to add a new status, that status will have to be status == 2. But it won't do anything if you leave without the commands (Tutorial 3).

Now you have your first NPC window! Gratz! Now we will add a simple cm.sendNext(""); into it.

Code:: cm.sendNext("Hello there! The Credits Go to henki. I want to teach you how to script NPCs!");

There will be an explanation in tut 3.
Now we will add a new status. This time it has to be "else" because if its not status 0 = if the mode added +1 to the variable "status" it will be 1.

Code:: } else if (status == 1) {

You won't need a explanation for this. The explanation is in the status == 0 explanation.

Now we will make the player choose between two choices.

Code:: cm.sendSimple("So, why are you talking to me? \r\n #L0##bI want to learn NPC scripting#k#l /r/n #L1##bNevermind#k#l");

Tutorial 3/4 for explanation.

Now we will add the 3rd status

Code:: } else if (status == 2) {

Same as status == 0/1

Now I'm gonna explain some of the cm.sendSimple. The L0 and L1 you see, is selection text commands and for them to take you somewhere when you click one, we have to add selections.

Code:: if (selection == 0) {

When you have clicked a selection at the sendSimple, you will be taken to this strings. the selections L0 = selection == 0, L1 = selection == 1 and so on..

Now when we click the first choice, we will be taken to selection 0. But now we will make that one do something.

Code:: cm.sendOk("Then you have to read the tutorial. See ya!");

Tutorial 3 still. Razz

Now we want to add a selection for the second choice.

Code:
} else if (selection == 1) {

and because the second choice says "Nevermind" we want the npc to quit the conversation.

Code:
cm.dispose();

Tutorial 3....

Now we will add some end branches and another dispose and were done!
This is the final result:

Code:: function start() {
status = -1;
action(1, 0, 0);
}

function action(mode, type, selection) {
if (mode == -1) {
cm.dispose();
} else {
if (mode == 0 && status == 1) {
cm.dispose();
return;
}
if (mode == 1)
status++;
else
status--;
if (status == 0) {
cm.sendNext("Hello there! All credits to henki! I want to teach you how to script NPCs!");
} else if (status == 1) {
cm.sendSimple("So, why are you talking to me? \r\n #L0##bI want to learn NPC scripting#k#l \r\n #L1##bNevermind#k#l");
} else if (status == 2) {
if (selection == 0) {
cm.sendOk("Then you have to go read the tutorial. Cya!");
} else if (selection == 1) {
cm.dispose();
}
}
}
}

Now press file->Save and you can try out the new made npc!

Im gonna talk about the more/equals/less symbols.
If you want to check (for example) if a player has less ITEMID than AMMOUNT, you type:

Code:
if (cm.haveItem(ITEMID) < AMMOUNT) {

So. The < actually checks if ITEMID is less than AMMOUNT

If you want to check if a player has more ITEMID than AMMOUNT, you type:

Code:
if (cm.haveItem(ITEMID) > AMMOUNT) {

So. The > actually checks if ITEMID is more than AMMOUNT

If you want to check if a player has ITEMID equals AMMOUNT, you type:

Code:
if (cm.haveItem(ITEMID) = AMMOUNT) {

So. The = actually checks if ITEMID equals AMMOUNT

Wait! There is more..

If you want to check if a player has ITEMID less OR equals to AMMOUNT, you type:

Code:
if (cm.haveItem(ITEMID) <= AMMOUNT) {

So. The <= actually checks if ITEMID less OR equals to AMMOUNT

If you want to check if a player has ITEMID more OR equals to AMMOUNT, you type:

Code:
if (cm.haveItem(ITEMID) >= AMMOUNT) {

So. The >= actually checks if ITEMID more OR equals to AMMOUNT

Fast walktrough:

(ID) < (AMMOUNT) = less than
(ID) > (AMMOUNT) = more than
(ID) = (AMMOUNT) = equals
(ID) <= (AMMOUNT) = less OR equals
(ID) >= (AMMOUNT) = more OR equals

EXTRA NPC SCRIPT TEMPLATES:

Quote:
Npc that you cannot leave with no or end chat:

Code:: var status = -1;

function start()
{
status = -1;
action(1, 0, 0);
}

function action(mode, type, selection) {
if (mode == 1)
status++;
if (status == 0) {

}
}

TUTORIAL 2 how to fix a NPC if you got a problem with it

Spoiler:

Fixing the npc...
Have your npc never started to talk?
Or do you DC after talking to it?
Maybe the npc stops talking when you click a button in the conversation window?
I will tell you how to fix those problems. It's easy

We will look into: "Have your npc never started to talk?"

Open up your javascript editor and open the npc script from there or make a new javascript tab and paste in the script itself. Or if you dont want to download the JS Editors in this tut, open up the npc script manually with notepad.

If you are using a JS Editor, simply click the check for errors button (if there is any. AJAX JS Editor has one.) The normal error of the npc isn't working is syntax errors. The syntax errors is when you for example have forgot any " in for example,

Code:: cm.sendOk("hello);

This is a normal mistake and can easily be fixed because of that.
But if you are using notepad, (not notepad++) you have to search the errors manually and that is not recommended.

Another syntax error can be following:

You have forgotten any } or { anywhere or made an extra } or { anywhere.
Add/Delete at the place it should be/is on.

And another one:

You are using this:

Code:: cm.sendOk("hello!";

You noticed you forgot one )? Yeah, thats a syntax error too.
Or you maybe added an extra ) or (? that will be syntax error too.

Now on to the next part!

"Do you DC after talking to the npc or clicking a button in the npc's conversation window?"

It may be a simple syntax error with the cm.gainItem.
Lets say you wanted it to be like this:

Code:: } else if (status == 1) {
cm.gainItem(1049200);
cm.sendOk("Here you go! A random item!");
cm.dispose();
}

The NPC is actually dumb at this moment. He does not know how many items he shall give. So you have to add this instead of the old one:

Code:: cm.gainItem(1049200, 1);

or

Code:: cm.gainItem(1049200,1);

Doesn't matter..

There is one more thing that may cause this error. ( This error will not occour in the newest versions. )
Let's say you typed:

Code:: cm.sendNext("Hello! Pick a category: \r\n \r\n #L0##bI WANNA GO HOME#l \r\n #L1##bNevermind#k#l");

This will create a window with a next button and make a selection window at the same time. That will not work.
You have to type like this all the time for a simple selection window.

Code:: cm.sendSimple("Hello! Pick a category: \r\n \r\n #L0##bI WANNA GO HOME#l \r\n #L1##bNevermind#k#l");

Got it? Yes? Good!

Now onto the next part.

"The npc stops talking when you click the button?"

There is 2 things that can lead to this error. The first is:

LAG! Seriously. It can be because of lag or you might have to reload the map.

The second is:

You do not have any text dialog command like cm.sendOk("");...
Well. This is not a problem if you are adding some items/etc. commands in there.

TUTORIAL 3 [The NPC commands]

Spoiler:

Spoiler:

If Statements:

Jobs terms that will be used for above statement:

Spoiler:

The commands in the spoiler actually makes the npc do what the commands is used for. Some of these commands do need a variable to work.
Like this one:
First, set a var at the top.

Code:: var text;

Second make the actions.

Code:: if (status == 0) {
cm.sendGetText("Tell me, what is 1+1?");
} else if (status == 1) {
text = cm.getText();
cm.sendYesNo("So, your answer is #b" + text + " #keh?");
} else if (status == 2) {
if (text = "2") {
cm.gainMesos(1000000);
cm.sendOk("yay! you did it! Here you get 1 mill mesos.");
cm.dispose();
} else {
cm.sendOk("Sry but thats the wrong answer. Try again next time!");
cm.dispose();
}
}

The npc asks a character for the answer of 1+1=. The player will be able to type in the answer in a box. If its the right answer, the player will be awarded 1 mill, otherwise the player will get none and be told to try again.

Also, some of these npc commands is IF commands. Let's get an example of, cm.isGuest()
This command checks wether a player is a guest or not. For it to work, we want to do this:

Code:: if (cm.getPlayer().isGuest() == 1) {

This checks if the character is a guest and then do actions.

There is commands that needs to get the player before being used too. Like this one:

Code:: cm.giveSkill(SKILLID);
cm.getPlayer().sendKeymap(KEY);

This sends SKILLID to KEY

There is more, like:

Code:: cm.getPlayer().gainExp(AMMOUNT);

This gives AMMOUNT of exp to the player.

Please ask if you need to learn more cm.getPlayer(). commands.

TUTORIAL 4 [The Text commands]

Spoiler:

JavaScript Editors

Spoiler:

Credits goes to:

Henki13
bboy242[/spoiler]
Very Happy