Stendhal NPC Coding: Difference between revisions

Usually we add NPCs (non-player characters) to make world more alive and to use them in Quests.

== Before you start ==

This page describes how to code an NPC. You don't need to know a lot about Java. You should, however, already have [[Configure a development environment (IDE)|setup an IDE]] and be able to compile and start a local Stendhal server.

buildNPC(zone);

private void buildNPC(final StendhalRPZone zone) {

final SpeakerNPC npc = new SpeakerNPC("Mr Healer") {

protected void createPath() {

List<Node> nodes=new LinkedList<Node>();

nodes.add(new Path.Node(9,5));

nodes.add(new Path.Node(14,5));

setPath(nodes,true);

}

protected void createDialog() {

// Lets the NPC reply with "Hallo" when a player greets him. But we could have set a custom greeting inside the ()

addGreeting();

// Lets the NPC reply when a player says "job"

addJob("I have healing abilities and I heal wounded players. I also sell #potions and antidotes.");

// Lets the NPC reply when a player asks for help

addHelp("Ask me to #heal you and I will help you or ask me #offer and I will show my shop's stuff.");

// Makes the NPC sell potions and antidote

addSeller(new SellerBehaviour(shops.get("healing")));

// Lets the NPC heal players for free

addHealer(0);

// respond about a special trigger word

addReply("potions","Please ask for my #offer.");

// use standard goodbye, but you can also set one inside the ()

addGoodbye();

}

});

// This determines how the NPC will look like. welcomernpc.png is a picture in data/sprites/npc/

npc.setEntityClass("welcomernpc");

// set a description for when a player does 'Look'

npc.setDescription("You see Mr Healer, he looks a a bit busy at the moment but perhaps he can help you anyway.");

// Set the initial position to be the first node on the Path you defined above.

npc.setPosition(9, 5);

npc.initHP(100);

zone.add(npc);

}

}

* setting its class to a [[StendhalRefactoringGraphics#NPCs|PNG image]] that exists at ''data/sprites/npc'', e.g. <code>npc.setEntityClass("welcomernpc");</code>

* setting its outfit with setOutfit method e.g. <code>npc.setOutfit(new Outfit(0, 05, 01, 06, 01));</code> - see [http://stendhalgame.org/hudson/job/stendhal_HEAD/javadoc/games/stendhal/server/entity/Outfit.html Outfit javadoc]

It is nice to set a description for when the player does ''Look''. If you don't set one, it will just say: ''You see [NPC Name].''