Stendhal Quest Coding: Difference between revisions

Jump to navigation Jump to search
← Older edit
Content deleted Content added
imported>Ufizavipupu
No edit summary
imported>Kribbel
m replace old link
 
(100 intermediate revisions by 11 users not shown)
Line 1: Line 1:
=[http://egebyromedu.co.cc UNDER COSTRUCTION, PLEASE SEE THIS POST IN RESERVE COPY]=
{{Navigation for Stendhal Top|Contributing}}
{{Navigation for Stendhal Top|Contributing}}
{{Navigation for Stendhal Contributors}}
{{Navigation for Stendhal Contributors}}

{{ TODO | Update page for changes in quest coding }}




Line 18: Line 19:
== Creating a quest skeleton ==
== Creating a quest skeleton ==


This tutorial is based on the quest "Beer For Hayunn". As this quest already exists, you may want to delete the java file locally in order to follow this tutorial.
This tutorial is based on the quest "Beer For Hayunn". As this quest already exists, you may want to delete the java file locally in order to follow this tutorial.


Quest files are put into the package games.stendhal.server.maps.quests. (If you are new to Java: this refers to the folder stendhal/src/games/stendhal/server/maps/quests).
Quest files are put into the package games.stendhal.server.maps.quests. (If you are new to Java: this refers to the folder stendhal/src/games/stendhal/server/maps/quests).
Line 24: Line 25:
Please create a new file in that folder called BeerForHayunn.java. (Note: The upper / lower case spelling is important, even on Microsoft Windows):
Please create a new file in that folder called BeerForHayunn.java. (Note: The upper / lower case spelling is important, even on Microsoft Windows):


<source lang="java">
<source lang="java">
package games.stendhal.server.maps.quests;
package games.stendhal.server.maps.quests;


Line 35: Line 36:
public class BeerForHayunn extends AbstractQuest {
public class BeerForHayunn extends AbstractQuest {


public static final String QUEST_SLOT = &quot;beer_hayunn&quot;;
public static final String QUEST_SLOT = "beer_hayunn";


@Override
@Override
Line 49: Line 50:
@Override
@Override
public String getName() {
public String getName() {
return &quot;BeerForHayunn&quot;;
return "BeerForHayunn";
}

public List<String> getHistory(final Player player) {
final List<String> res = new ArrayList<String>();
return res;
}
}
}
}
&lt;/source&gt;
</source>


Don't worry, if you don't understand a word of this; just copy it. We will explain the important parts and extend this skeleton in the following sections.
Don't worry, if you don't understand a word of this; just copy it. We will explain the important parts and extend this skeleton in the following sections.
Line 58: Line 64:
In order for the Stendhal server to pick up this file, it has to be registered in the file StendhalQuestSystem.java in the package games.stendhal.server.core.rp by adding two lines at the appropriate places:
In order for the Stendhal server to pick up this file, it has to be registered in the file StendhalQuestSystem.java in the package games.stendhal.server.core.rp by adding two lines at the appropriate places:


&lt;source lang=&quot;java&quot;&gt;
<source lang="java">
import games.stendhal.server.maps.quests.BeerForHayunn;
import games.stendhal.server.maps.quests.BeerForHayunn;


Line 64: Line 70:


loadQuest(new BeerForHayunn());
loadQuest(new BeerForHayunn());
&lt;/source&gt;
</source>


Of course in the case of this tutorial the two lines for BeerForHayunn are already there.
Of course in the case of this tutorial the two lines for BeerForHayunn are already there.
Line 70: Line 76:
== Teaching the NPC to talk ==
== Teaching the NPC to talk ==


Okay, we have now completed the preparation. Our first task is to get Hayunn to reply to the word &quot;quest&quot;.
Okay, we have now completed the preparation. Our first task is to get Hayunn to reply to the word "quest".


Therefore we add a new method called prepareQuestStep() at the end of the file BeerForHayunn, just above the last closing &quot;}&quot;. This method makes Hayunn reply to the word &quot;quest&quot; with the answer &quot;My mouth is dry, but I can't be seen to abandon this teaching room!&quot;
Therefore we add a new method called prepareQuestStep() at the end of the file BeerForHayunn, just above the last closing "}". This method makes Hayunn reply to the word "quest" with the answer "My mouth is dry, but I can't be seen to abandon this teaching room!"


&lt;source lang=&quot;java&quot;&gt;
<source lang="java">
public void prepareQuestStep() {
public void prepareQuestStep() {


// get a reference to the Hayunn npc
// get a reference to the Hayunn npc
SpeakerNPC npc = npcs.get(&quot;Hayunn Naratha&quot;);
SpeakerNPC npc = npcs.get("Hayunn Naratha");


// add a reply on the trigger phrase &quot;quest&quot; to Hayunn
// add a reply on the trigger phrase "quest" to Hayunn
npc.addReply(&quot;quest&quot;, &quot;My mouth is dry, but I can't be seen to abandon this teaching room!&quot;);
npc.addReply("quest", "My mouth is dry, but I can't be seen to abandon this teaching room!");
}
}
&lt;/source&gt;
</source>




There is one little step left before we can test it: We need to tell the server to execute our new method. There is already a method called &quot;addToWorld&quot; which will be executed on server start. So we add a call to our method in &quot;addToWorld&quot;:
There is one little step left before we can test it: We need to tell the server to execute our new method. There is already a method called "addToWorld" which will be executed on server start. So we add a call to our method in "addToWorld":


&lt;source lang=&quot;java&quot;&gt;
<source lang="java">
@Override
@Override
public void addToWorld() {
public void addToWorld() {
Line 94: Line 100:
prepareQuestStep();
prepareQuestStep();
}
}
&lt;/source&gt;
</source>


Okay, all done? Please start the server (depending on whether you are using an IDE or not you might have to compile or build first). Go to Hayunn and say &quot;quest&quot;, after starting the conversation with &quot;hi&quot;. He should now respond with the sentence &quot;My mouth is dry, but I can't be seen to abandon this teaching room!&quot;.
Okay, all done? Please start the server (depending on whether you are using an IDE or not you might have to compile or build first). Go to Hayunn and say "quest", after starting the conversation with "hi". He should now respond with the sentence "My mouth is dry, but I can't be seen to abandon this teaching room!".




== Commonly used conversation phrases ==
== Commonly used conversation phrases ==


Good, Hayunn now replies to the trigger &quot;quest&quot;. He does not, however, reply to &quot;task&quot;. All other NPCs accept both words as synonym. A simple solution would be to add a second ''npc.addReply'' line. But there is a better way which makes it very easy to add additional synonyms later. We predefined lists of commonly used [http://arianne.cvs.sf.net/viewvc/arianne/stendhal/src/games/stendhal/server/entity/npc/ConversationPhrases.java?view=markup ConversationPhrases]. If there are already conversation phrases defined for the triggers that you would like to add, you should use the phrases.
Good, Hayunn now replies to the trigger "quest". He does not, however, reply to "task". All other NPCs accept both words as synonym. A simple solution would be to add a second ''npc.addReply'' line. But there is a better way which makes it very easy to add additional synonyms later. We predefined lists of commonly used [https://github.com/arianne/stendhal/blob/master/src/games/stendhal/server/entity/npc/ConversationPhrases.java ConversationPhrases]. If there are already conversation phrases defined for the triggers that you would like to add, you should use the phrases.


Let's adjust the above sample by using ''ConversationPhrases.QUEST_MESSAGES'' instead of the hard coded word &quot;quest&quot;:
Let's adjust the above sample by using ''ConversationPhrases.QUEST_MESSAGES'' instead of the hard coded word "quest":


&lt;source lang=&quot;java&quot;&gt;
<source lang="java">
public void prepareQuestStep() {
public void prepareQuestStep() {


// get a reference to the Hayunn npc
// get a reference to the Hayunn npc
SpeakerNPC npc = npcs.get(&quot;Hayunn Naratha&quot;);
SpeakerNPC npc = npcs.get("Hayunn Naratha");


// add a reply on quest related trigger phrases to Hayunn
// add a reply on quest related trigger phrases to Hayunn
npc.addReply(ConversationPhrases.QUEST_MESSAGES,
npc.addReply(ConversationPhrases.QUEST_MESSAGES,
&quot;My mouth is dry, but I can't be seen to abandon this teaching room!&quot;);
"My mouth is dry, but I can't be seen to abandon this teaching room!");
}
}
&lt;/source&gt;
</source>


Please compile and restart your server. Hayunn should now respond to &quot;quest&quot;, &quot;task&quot;, and &quot;favor&quot;, after you started the talk by saying &quot;hi&quot;.
Please compile and restart your server. Hayunn should now respond to "quest", "task", and "favor", after you started the talk by saying "hi".


== Blue trigger words ==
== Blue trigger words ==


As you probably know NPCs can say words in blue, words that they expect to be repeated by the player. We want to add such words for &quot;beer&quot; and &quot;tavern&quot;. As we have done before, we will add npc.addReply lines for those words.
As you probably know NPCs can say words in blue, words that they expect to be repeated by the player. We want to add such words for "beer" and "tavern". As we have done before, we will add npc.addReply lines for those words.


So, how do we get the words colored blue? Simple, add a &quot;#&quot; in front of them. If you actually want to include a #-character, you need to repeat it.
So, how do we get the words colored blue? Simple, add a "#" in front of them. If you actually want to include a #-character, you need to repeat it.


&lt;source lang=&quot;java&quot;&gt;
<source lang="java">
public void prepareQuestStep() {
public void prepareQuestStep() {


// get a reference to the Hayunn npc
// get a reference to the Hayunn npc
SpeakerNPC npc = npcs.get(&quot;Hayunn Naratha&quot;);
SpeakerNPC npc = npcs.get("Hayunn Naratha");


// ask for a beer and explain it
// ask for a beer and explain it
npc.addReply(ConversationPhrases.QUEST_MESSAGES,
npc.addReply(ConversationPhrases.QUEST_MESSAGES,
&quot;Please bring me a #beer.&quot;);
"Please bring me a #beer.");


// explain blue words
// explain blue words
npc.addReply(&quot;beer&quot;, &quot;Margaret sells beers in the #tavern.&quot;);
npc.addReply("beer", "Margaret sells beers in the #tavern.");
npc.addReply(&quot;tavern&quot;, &quot;If you don't know where the inn is, you could ask old Monogenes.&quot;);
npc.addReply("tavern", "If you don't know where the inn is, you could ask old Monogenes.");


// an example for escaping #
// an example for escaping #
npc.addReply(&quot;trading&quot;, &quot;http://stendhal.game-host.org/wiki/index.php/StendhalFAQ##Trading&quot;);
npc.addReply("trading", "http://stendhal.game-host.org/wiki/index.php/StendhalFAQ##Trading");
}
}
&lt;/source&gt;
</source>


You know the drill: Compile, restart and try it out.
You know the drill: Compile, restart and try it out.
Retrieved from "https://meet.konsthol.eu/w/index.php?title=Stendhal_Quest_Coding"