Neverwinter Nights 2 Legends AI Plugin: December 29, 2016 Marshall Vyper

Neverwinter Nights 2
Legends AI Plugin
Version 2.0
December 29, 2016
Marshall Vyper
Version 2.0 Legends AI Plugin
Document Revision Information
Revision Date Author Description

1.60 October 18, 2011 Marshall Vyper Initial document.
1.8 October 4, 2012 Marshall Vyper New 1.8 Options added
1.86 November 15, 2012 Marshall Vyper New Features and Images
2.0 December 29, 2016 Marshall Vyper New 2.0 Updates
Plugin Revision Information
Revision Date Author Description

1.60 October 18, 2011 Marshall Vyper Initial Release.
1.70 December 18, 2011 Marshall Vyper Hak and Script Re-Org
1.80 October 4, 2012 Marshall Vyper New 1.8 options added
1.81 October 16, 2012 Marshall Vyper Misc Bug Fixes. See
upgrade doc
1.86 November 15, 2012 Marshall Vyper Bug fixes and features, see
Upgrade Doc.
1.88 March 1, 2013 Marshall Vyper Codebase update
1.92 December 23, 2013 Marshall Vyper Fixed colored name bugs.
1.93 July 13, 2015 Marshall Vyper Bug fixes and features, see
Upgrade Doc.
2.0 December 29, 2016 Marshall Vyper New 2.0 Updates, see
Upgrade Doc.
Prepared by Marshall Vyper Page 2 of 29

Table of Contents
TABLE OF CONTENTS ............................................................................................................................. 3

INTRODUCTION ........................................................................................................................................ 4
FEATURES................................................................................................................................................... 4
LEGENDS PLUGINS .................................................................................................................................. 4
What’s a Plugin ...................................................................................................................................... 4
Important To Know................................................................................................................................. 5
PART 1 – GETTING STARTED ................................................................................................................ 6
What’s in the File ................................................................................................................................... 6
YouTube Video Walkthroughs ................................................................................................................ 7
Installation.............................................................................................................................................. 7
PART 2 – TRYING IT OUT ..................................................................................................................... 13
Tutorial 1 – The Commoner, The Guard, and The Idiot ....................................................................... 13
Tutorial 2 – Out on Patrol .................................................................................................................... 16
Tutorial 3 – Tired of It All .................................................................................................................... 18
Tutorial 4 – Kobold Invasion................................................................................................................ 19
Tutorial 5 – Rogues and Wizards ......................................................................................................... 20
PART 3 - PRE-SCRIPTS ........................................................................................................................... 21
PART 4 – ALL FUNCTIONS.................................................................................................................... 22
AI Profiles............................................................................................................................................. 22
Spawn In Condition .............................................................................................................................. 25
Combat Behavior .................................................................................................................................. 25
Roam Behavior ..................................................................................................................................... 26
Waypoint Route .................................................................................................................................... 27
Roam Range ......................................................................................................................................... 27
Sleep Chance ........................................................................................................................................ 28
Day / Night Posts .................................................................................................................................. 28
Exterior Chase Range........................................................................................................................... 28
Interior Chase Range: .......................................................................................................................... 28
No Plot On Retreat ............................................................................................................................... 28
Bartender Tag....................................................................................................................................... 28
Random NPC Activities ........................................................................................................................ 28
Random Task Range ............................................................................................................................. 29
Unequip during Animations.................................................................................................................. 29
Change Task Frequency ....................................................................................................................... 29
FINAL SUMMARY ................................................................................................................................... 29

Introduction
Getting tired of fighting dumb monsters? Wish your NPC's would do what they were
told or at least what you wanted them to do? Looking for a village where the people are
doing more than standing around? You've come to the right place because we at the
Legends Labs have decided to add a couple of IQ points to your mobile objects, and
we've done it in such a way as to make it easy for you to actually use. No more looking
for obscure variable names or modifying scripts to make your NPC's do various things.
With a simple to use GUI you can make your creatures sneak around, break off an attack
or even run away cowardly. Plus, you can have your villagers wander around, perform
patrols, switch between day and night time postings and even have them go to sleep!
Read on brave builder for details on how to accomplish all of this and more!
Features
There are many various combinations of things you can do with the Legends AI. Some
of the features this plugin can do for you are listed below:
 Make NPC's and creatures sleep at night

 Have guards go out on patrol
 Make your NPC's explore the market place
 Let them wander on a short leash
 Make your Wizards actually cast their spells
 Have sneaky rogues jump you from behind
 Have NPC change their activities based on events like time of day
 Easy to use GUI
 Works great with the Legends Spawn Plugin
Legends Plugins
What’s a Plugin
The legends plugin system is a framework of scripts and tools utilized on the
Development Persistent World known as Legends. There are many plugins already
written as well as upcoming releases that perform a variety of tasks from simple NPC
bantering to an entire Quest System. The concept of the Legends plugins is that they are
easy to drop into an existing world without the need for other dependent packages. There
is no Core Plugin, there are no third party script or hak requirements for them to work
and they are easy to install, standardized and always come with comprehensive
documentation. Every attempt has been made to ensure installing a plugin requires
minimal modifications to existing persistent world code and configuration.

Important To Know
The next important aspect of a Legends plugin is that they can leverage each other’s code
to form a complete system. The code is never duplicated from plugin-to-plugin so you
only have one set of code. For example, even though the Legends Loot Plugin uses parts
of the Legends Spawn Plugin, installing both plugins will not cause you to have double
code. This is because each plugin comes with a standardized script set.
Each Legends plugin is released as a standard version. For example, all Legends
plugins have a 1.93 version and a 2.0 version. If you need to upgrade one of your
plugins, it is a best practice to upgrade them all. You should never downgrade a
plugin lower than another. When upgrading plugins, ensure you click “Yes” when
you are asked to overwrite an existing file.
Figure 1 - Master Script Overwrite

Part 1 – Getting Started

What’s in the File
By now you’ve already opened the archive with all the files needed for the Legends AI
Plugin to work in a test module or your persistent world. Included in the archive are
several files, each of which are described below:
leg_ai.erf This file contains all the content for builders. It will add all
the scripts and waypoints that are needed for the plugin to
operate. There are 99 scripts, 36 waypoints. Each set of
blueprints will appear under the category “Legends AI” so
as to not become mixed up with other blueprints. Scripts all
start with “leg_ai _” or “leg_all_” depending on what
function it performs.
Note, some of the stock scripts are included in this with

slight modifications to them to resolve bugs from the built
in AI.
leg_ai_manual.pdf This manual which includes the tutorials and how-to use the
AI plugin.
leg_ai_upgrade.pdf This file contains any notes and important information you
should be aware of BEFORE you upgrade or install a plugin
when you already have a pre-existing plugin that is in use.
leg_ai.hak This is the hak pak that contains various modified portions
of Tony K’s AI as well as VFX’s for NPC activities.
leg_ai.dll This is the NWN2 Toolset plugin that allows you to manage
and configure AI on NPCs with ease.
leg_master.dll This is the NWN2 Toolset plugin that allows you to manage
and configure all other Legends plugins and is included in
all plugin packages.
leg_master.hak This is the master hak pak file that several legends plugins
leverage resources from. They are kept here to avoid
duplication of resources in several plugins that share them.
It is included in all plugin packages.
setup.exe This is the installer.

YouTube Video Walkthroughs

All Legends Plugins at the time of release have video walkthroughs that will assist you in
the installation, configuration and typical use of each Legends Plugin. Visit the channel
http://www.youtube.com/user/DJMarshallV to see these video series. They are detailed
and can answer many questions.
Installation
To install this plugin you must perform several tasks. You can install this into your
existing persistent world or if you just wish to try it out, make a brand new module and
follow these steps.
1. There are 2 pre-requisites that must be installed prior to installing any Legends
plugin. They are .NET framework 3.5 and the MySQL Connector v6.9.8. You
can find them at the following sites:
 .NET: http://www.microsoft.com/download/en/details.aspx?id=21
 MySQL: http://www.mysql.com/downloads/connector/net/ or
http://www.nwn2legends.com/plugins
2. Run the setup.exe file to put the files in their correct locations. If you prefer not
to use the setup.exe, all the files are included to be placed manually. Ensure the
toolset is not running during the installation.
Figure 2 - Install Wizard

3. Once the installation is complete, open your NWN2 Toolset and load either a new
module or an existing module to work with. Select “Plugins” from the top menu
and ensure you see “Legends AI Plugin” and “Legends # Master Configurator #”
Figure 3 - Plugin Menu
If you do not see these entries, then select View -> Options from the top menu.
On the general tab, ensure that “Allow Plugins” is set to “Load all Plugins”
Figure 4 - Security Settings
4. From the file menu, choose Import and navigate to your Neverwinter Nights 2
player directory. This is usually located in “My Documents\Neverwinter Nights
2”. There you will find an “Erf” folder that contains the file leg_ai.erf. Select it.
It will then begin the import process into your module. You may be prompted
with a notice that looks similar to the following. This is because you may already
have the required nwnx scripts if using nwnx in your module and other
leg_all_master scripts. If you are installing a newer version plugin than any

previously existing plugin versions, select YES when it asks to overwrite any
scripts, however if the version number on this plugin is lower than any other
plugin you already have, select NO when overwriting “leg_” scripts. If all the
plugins you have are the same version, it will not matter which option you choose.
Figure 5 - ERF Import Notice
5. If this is your first Legends plugin, then you will need to enter some default
information, otherwise, you will simply need to activate your new AI Plugin.
From the Plugins top menu, choose “Leg # Master Configurator #” then click the
“Configuration” button. Ensure the Legends AI Plugin is set to active.
Figure 6 - Legends Master Configurator

 CHECK BOXES = These checkboxes are to activate and deactivate the

various plugins. The will install any hakpak and set any module variables
that are required.
 CAMPAIGN LEVEL OBJECTS = Selecting this causes the legends

plugin code to look for and use SCRIPTS in the campaign folder that is
configured on your module. If you do not have a campaign configured
and are not keeping scripts there, then do NOT select this option. Select
this ONLY if you are keeping all your scripts in the campaign folder.
NOTE: Importing ERF files causes scripts to end up in the module folder.
You can manually move them to the campaign folder if you wish to go
this route.
 PRE 1.88 PLUGINS = If your module uses or will use any Legends
Plugin that is a lower version number than 1.88, you will NEED this
checkbox turned on. Since version 1.88, configuration data has been
relocated. Older versions will not find this data unless you have this
option checked. As noted previously, best practice is to run all plugins at
the same release version.
 DATABASE OPTIONS = Some Legends plugins require an NWNX and

MySQL database backend. The Legends AI plugin does NOT require a
database and as such, this section can be left as is.

6. Once you’ve completed the configuration, click Finish and then note there are two
other buttons available to use.
Figure 7 - Master Configurator
 UPDATE MODULE SCRIPTS = This button will update the module

properties with all of the appropriate module scripts with Legends Master
scripts. The following events are updated. If an existing script is found in
the required events, the Master Configurator will copy it, modify it, and
place the new modified copy in place thus preserving your existing code
functionality. If you wish to manually perform this step, you will need to
ensure the following scripts are being called in the appropriate events.
NOTE: Using this button will only place scripts in events that the
currently active plugins require.
i. leg_all_mastermod_itemacquired – On Item Acquired Event
ii. leg_all_mastermod_itemactivated – On Item Activated Event
iii. leg_all_mastermod_itemunacquire – On Item UnAcquire Event
iv. leg_all_mastermod_ondeath – On Player Death Event
v. leg_all_mastermod_onheartbeat – On Module Heartbeat Event
vi. leg_all_mastermod_onload – On Module Load Event
vii. leg_all_mastermod_onrest – On Player Rest Event

 UPDATE ALL AREA SCRIPTS = This button will open each area of
your module and update its OnClientEnter and OnExit script. If your
areas do not have any script in these events, it will install one that will
perform what it needs. If however you already have scripts in these
events, the Master Configurator will create a copy of your script, modify
the code within it to call the code it needs without interfering with the
activities of your existing script and place this new script in the event
instead. If you choose NOT to do this, you will need to manually ensure
that the “leg_all_masteronenter” script is called in each areas On Client
Enter event and the “leg_all_masteronexit” script is called in each areas
On Exit event.
7. Next, open up the Legends AI Plugin and select Configuration. This is where you
will configure the plugin to suit your needs.
Figure 8 - AI Configuration
 NO PLOT ON RETREAT = Setting this checkbox will set any new creatures or
Legends Spawn Waypoints to default to no plot when the creature attempts to run
away as a result of chasing a player too far from its home location. The option
can still be turned on and off on a per spawn/creature basis however this option
simply sets the default. NOTE: Previous creatures that have already been created
will not be changed as a result of this.

Part 2 – Trying it Out

Tutorial 1 – The Commoner, The Guard, and The Idiot
Now that you’ve completed the installation and area prep process, you’re probably
itching to get started with the plugin. This tutorial will demonstrate the Legends AI for
creating guards who stand at their spawn in location, commoners who walk around to
various locations within the village market place, as well as the village idiot who just
wanders aimlessly talking to himself and others.
In order to accomplish our goal for this tutorial, we will need three NPC characters.
Select three existing NPC’s from the blueprints and make copies of them. Any three will
do. The important part is to ensure their Faction is set to Commoner so they do not fight
each other.
Next, designate one NPC to be your guard, select its blueprint and load the Legends AI
plugin. From the File menu choose Edit -> Creature Blueprint. You will be presented
with the AI GUI for this blueprint. Select the “Roam Behavior” combo box and set it to
“Guard”. Click *Save to save the behavior in the NPC’s Default AI profile (more on AI
profiles later). Then click Finish and quit the AI plugin. Place your new guard
somewhere in an area in your module.
Figure 9 - Guard AI Profile
Perform the same tasks for the other 2 NPC’s however designate one of them to be a
village idiot and the other to be your commoner. For the village idiot, we’ll set his Roam
Behavior to “Mobile without Stops”, and set his Roam Range to 10 meters. The final
NPC will have his Roam Behavior set to “Mobile with Stops” and a Roam Range of 30
meters. Place these two NPC’s somewhere in your area.

Figure 10 – Village Idiot Configuration
The key difference between our village idiot and our commoner is that the idiot will roam
randomly with no real desire to visit any particular locations in the area, however our
commoner will want to visit certain places. The big question is HOW does our
commoner know what locations are viable to visit? To answer this question, we must do
one more thing to our area.
In the Waypoints blueprints under the Legends AI category, place several “Stop
Waypoints” around your area within 30 meters of each other (as this is what we’ve set as
a maximum range for our commoner).
Figure 11 - Stop Waypoint Blueprint

Figure 12 - Stop Waypoints
Compile all your scripts and fire up the module and take a look around. You will find
your guard is standing quietly there, your village idiot will be roaming aimlessly and your
commoner will be randomly walking around visiting some of your Stop Waypoint
locations.

Tutorial 2 – Out on Patrol

Here will learn to create a patrol route for our guard and have him or her walk it
relentlessly like any good guard should. Afterwards, we'll spice it up by having our
guard walk a nighttime route when the evening sets in.
First, we’ll need to create a patrol guard by copying another NPC blueprint or custom
making your own. This is the same procedure as in tutorial #1. Once you have your
NPC, fire up the Legends AI plugin with his blueprint selected. Set his Roam Range to
about 30 meters (or set it to roughly the maximum distance between waypoints for a
waypoint route you will create later). Set the Roam Behavior to Mobile without Stops
and enter a new waypoint route. For this tutorial we will use “patrolroute1”. Ensure
there are no spaces to unusual characters in the name and every patrol route in your
module should have a unique name.
Finally choose a patrol route style. Circular means the NPC will follow all the patrol
routes, and upon reaching the last waypoint, will start again at waypoint 1. Straight Line
will cause our NPC to simply walk the route backwards from highest waypoint to lowest
in the set. For this tutorial we will select Straight Line, back and forth.
Finally Click the *Save button to save this AI as the NPC’s Default AI, then click Finish
and quit the AI plugin. (More on AI Profiles later).
Figure 13 - Patroller
Place your NPC in your area and then select the Custom Waypoint called “Patrol
Waypoint” under the Legends AI category. Place 4 waypoints down in various locations
within 30 meters of each other; using Shift-Click on each waypoint, select all 4 of them
and then right click on any one and choose “Create Waypoint Set” from the drop down

menu. In the dialog box that follows, ensure you keep the WP_ part and add
“patrolroute1”. This must match what you entered in the AI plugin earlier for this NPC.
Figure 14 - Patrol Route 1
That’s it! Re-compile all scripts again as 2 new scripts will have been created called
wn_patrolroute1 and wp_patrolroute1 to help manage the patrol. Load your module and
observe your new guard follow your new route.
At this point, you can create a second waypoint set called “WN_patrolroute1” and your
NPC will follow the second patrol route in the evenings and night.

Tutorial 3 – Tired of It All

In this tutorial, we'll look at making our NPC's go to sleep at night and even have them go
to a designated sleeping area to catch their beauty rest. Perhaps half of the kobolds in a
camp will get tired and want to sleep at night giving players a chance for surprise attack
or maybe you just want the town drunk to finally pass out. This can be easily
accomplished and we’ll demonstrate it in this tutorial.
First, we’ll want to create or copy an NPC that we will use for sleeping. For this tutorial
we are just going to select Duncan from the blueprints list and make a copy.
NOTE: Some character models refuse to play the laying down animation during sleep.
As such, it may appear they are awake when in fact they are not. This seems to be some
sort of engine bug and to date; I have not found a way around it. The floating Zzz’s near
the NPC is a dead giveaway however that they are indeed, asleep.
Using the AI plugin, change Duncan’s Spawn In Behavior to “Sleep at Night” and enter
100 in the Sleep Chance field. Click *Save and then Finish to make this Duncan’s
default AI profile and place him in your area and load the module up. It may be a good
idea to set the start time of the module to something close to night so you won’t have to
wait long for the results.
Figure 15 - Sleeping Duncan
If you’ll notice, it doesn’t really matter where our NPC happens to be when the time
comes along for them to sleep, they will just lay down and go to sleep wherever they
happen to be. This may not be desired so we can make a change to assist with this.

Open your area again, and in a desired location or locations, place a Sleep Waypoint
found in the custom waypoints under the Legends AI category. Load your module up
again in game and watch the results this time. Any NPC’s that are configured to sleep
will proceed to a randomly selected “Sleep Waypoint” before collapsing and sleeping
until morning. This allows you to create areas with bedrolls to simulate NPC’s choosing
to go to sleep in particular locations.
Tutorial 4 – Kobold Invasion

Here we will look at a small kobold camp where some will choose to fight with their
melee weapons while others will use their range weapons and even try to back off a little
when you approach.
Sometimes you may have a group of creatures that you’d like to behave differently in a
battle from each other. Perhaps some you’d like to use their range weapons, others you
prefer to use their melee weapons. This can all be accomplished using the same creature
blueprint. For this tutorial, we are going to leverage the Legends Spawn Plugin. By
using the Legends Spawn Plugin (see the http://www.nwn2legends.com web site for
more information about this plugin), we can store a creature’s AI configuration on an
actual Spawn point rather than the creature blueprint.
Open or create a new module with both the Legends Spawn Plugin and the Legends AI
plugin installed. Create a copy of a standard kobold and place 2 spawn points in your
area. In each of these spawn points, we will want to spawn 1 of our kobold. So far, these
two spawns / kobolds will behave exactly the same which, is to melee fight (and cast
spells) with no other preferences.
Select one of your spawn points and fire up the Legends AI plugin. This time however
select File -> Edit -> Spawn Waypoint. Now you are able to configure a creature’s AI
based upon the spawn point instead of the creature’s blueprint.
For combat behavior for this spawn waypoint choose “Ranged” and then click *Save and
then Finish. Ensure you equip your kobold with both a melee weapon AND a ranged
weapon with ammo.
Upon loading this module up in game, you will notice that when entering combat, one
kobold will prefer to use melee weapons while the other will prefer to use Ranged
weapons.
This tutorial demonstrates two things. First, the ability for creatures and NPC’s to have
different combat choices. Be careful however because a creature who is forced to use
Ranged weapons will avoid casting spells! The second thing we learn from this tutorial
is that we can have less creature blueprints, simply by placing the AI information on the
spawn point instead of the creature blueprint.

Tutorial 5 – Rogues and Wizards

Having a powerful wizard backed up by a sneaky rogue can be quite a challenge,
especially when you're alone. Here we'll look at wizards who cast their spells whilst
sneaky rogues jump into the fight hoping for a kill shot.
In the last tutorial, we battled a few pesky kobolds however in this one; we’ll be
interested in taking on something with a little more skill. For this tutorial, we are going
to create a level 5 rogue and a level 5 wizard. You can easily do this by copying the
Human blueprint from the stock blueprints lists and then modifying each one’s class and
level, as well as hit points and associated attribute (Dexterity and Intelligence). Once
you’ve made these changes, it is advisable to press the “Reset Package Defaults” button
on the Basics screen to ensure your creatures are assigned some skills and spells. Double
check they are both set to hostile and then spawn them in using the Legends Spawn
plugin.
As for AI, you can leave the wizard as is however we can change the rogue a little. Edit
either the spawn waypoint or the rogue itself if not using the spawn plugin and set his
Spawn in Behavior to Stealthy. This will cause him to be hidden when he spawns in.
Note that players with a good listen and/or spot check may still detect him so you may
consider adjusting his Hide and Move Silently skills appropriately. Also double check
that your wizard is equipped with spells that you actually want him to cast.
Load this up in game and observe the results.

Part 3 - Pre-Scripts
A new feature starting with the Legends AI plugin version 1.86 is the ability to have
creatures run 3rd party scripts in their AI prior to the Legends AI scripts firing. Each
event that is used by the Legends AI plugin will allow you to specify your 3rd party script
to be called.
To use this new feature, select a creature blueprint or a Legends Spawn Waypoint and run
the AI plugin. Select File -> Pre-Run Scripts and then the appropriate object.
Figure 16 - Pre-Run Script Selection
Each Event listed above will give you the option to select a script that will be run before
the Legends AI code. This is useful for adding such features as fire/acid damage events
to trolls in the On Damaged event that would normally not be available when using the
Legends AI.

Part 4 – All Functions

Below we will review all of the options available to NPC’s using the Legends AI plugin.
The tutorials above demonstrate many features but not all of them. This section discusses
all of the options, checkboxes and features.
AI Profiles
A note on AI profiles is in order. Typically and most of the time your NPC will use a
single AI profile. A profile is an AI configuration that the NPC will perform, like
chopping wood, or sleeping at night or patrolling on a route.
Sometimes however you want an NPC or even a Boss in a dungeon to perform different
things based on different events. This is where multiple AI profiles can come in handy.
Multi-AI Profiles go hand in hand with the Legends Special Effects plugin (which comes
packaged with the Legends Quest Plugin).
The Legends Special Effects plugin has the ability to capture changing events and create
reactions to them. These events can be things like an enemy taking damage, an NPC
reaching a certain waypoint, a time of day or even if a player steps on a trigger or has a
conversation. Included in the Special Effects plugin are a number of different reactions
that can happen when one of these events occur and one of those reactions is the ability to
change an NPC’s AI profile.
Where can this be used? Let’s say you have a boss encounter and you want your boss
standing in a room performing a worship animation when the player arrives. At the end
of a conversation with the player, the Boss then changes his AI to stop worshipping and
use his ranged weapon to fight. Then let’s suggest that once the boss is almost dead, he
changes his AI to run away following a set of waypoints? This can all be accomplished
with multiple AI profiles and the Special Effects plugin.
It is beyond the scope of this document to explain the Special Effects events and how
they are triggered however below shows how to setup the 3 AI profiles our boss enemy
will have.
First, select your boss NPC blueprint or spawn waypoint and load the AI profile on it.
You’ll notice the AI profile selected is called “Default” in the dropdown box and no other
profiles exist.

Figure 17 - Default AI Profile
This Default profile will always be the profile that is active when a creature first spawns
or is placed in your world. For this example, we want our boss to perform a worship
animation. To do this, we change the Roam Behavior to “Random NPC Activities”, click
the “Worship” checkbox on the right, set the Random Task Range to “1” and check the
“Unequip During Animations” checkbox.
Figure 18 - Worshipping NPC

Click the *Save button. Next we will create our Boss’ second AI profile which is to do
battle with his ranged weapon. To create a second profile, you just give the profile a
descriptive name and type it into the Profile Pull down box as so:
Figure 19 - Create New Profile
Once you’ve created a new profile, change the Combat Behavior to “Ranged” and click
*Save.
Finally, we’ll create a third profile for walking a patrol route as described above. Type a
new profile name. In this case we’ll call it “Run Away On Route 1”. Adjust the
Waypoint Route to use a route (see the Patrol Route tutorial above).
Figure 20 - Escape Profile

Once complete you can click Finish. You now have an NPC with three different AI
profiles which can be called upon by the Legends Special Effects plugin. To see an
excellent demonstration of an NPC with multi-AI profiles, you can watch this tutorial on
YouTube:
https://www.youtube.com/playlist?list=PLThXIzv2_sKXZhPdpFmggLbNU1BsPMhi-
Or Visit my YouTube Channel noted at the beginning section of this document.
Spawn In Condition
The Spawn In Condition is what the NPC will do when they first appear in the game
world. The options are:
 Dead – The NPC will be dead. This is useful for littering the world with corpses,
dead animals or some NPC body in your story that the players can find. Or they
could just be ambience.
 Prone – This causes an NPC to lay down almost as if they were dead but they are
still alive and can have a conversation or otherwise interacted with.
 Sleep At Night – This option will cause the NPC to sleep at night. If a Sleep
Waypoint is nearby, they will walk to it first.
 Sleep Constantly – This option causes the NPC to sleep anytime day or night.
 Stealthy – This option causes the NPC to try to hide from the players as best they
can for sneak attacking.
Combat Behavior
This option is how the NPC will fight. Will they try to range? Will the try to run? Will
they prefer magic over everything else? The default is Offensive. The options are:
 Ambusher – The NPC will go stealthy or invisible and attack, then run away and
try to do it again before re-engaging.
 Cowardly – These NPC’s will try to run away in a fight.
 Defensive – The NPC will try to use defensive combat feats if they have them and
parry.
 Magic – The NPC will prioritize spell casting above all else.
 Offensive – This is the NPC default and causes them to fight melee without
regard to their own defense.
 Ranged – This will cause the NPC to prefer ranged weapons and will retreat a few
steps to try and use it however will switch to melee if they are cornered.

Roam Behavior
This is how an NPC will behave when they are not in combat. When using the legends
AI, the default behavior out of combat is to wander near their spawn in location.
 Barmaid – Select this option if you wish to activate the Barmaid AI on an NPC.
By activating this option you will also want to enter the tag of a matching
Bartender NPC as well. The behavior will cause the barmaid to wander around a
room talking and taking orders with the other NPC’s that happen to be nearby.
She will also return to the bar to pick up drink orders. Note, actual items are not
exchanged, this is for atmosphere only. There are two important waypoints that
must be placed when using this AI behavior. They are located in the Waypoints
blueprints in the Legends AI -> Bar grouping called “Barmaid’s Drink Pickup”
and “Barmaid’s Rest Stop”. Place these somewhere in your tavern so the barmaid
will know where to go for these activities.
 Bartender – This is the matching bartender that will work with the barmaid and
carry on conversation with them. There are two important waypoints located in
the Waypoints blueprints in the Legends AI -> Bar grouping called “Bartender
NPC” and “Bartender Keg”. Place the first one where you would like the
bartender to stand and the other where you would like him to walk to pour drinks.
 Guard – This behavior will cause the NPC to stand facing their spawn in
direction. They will not casually animate with other nearby NPC’s and will not
move unless they enter combat. Once combat is complete, they will return to
their spawn in location and face their original direction.
 Immobile – This causes the NPC to behave just like a guard with the exception
that the NPC will turn in place and interact with other NPC’s in conversations.
They will also perform various random animations such as yawning or talking to
themselves. Useful for merchants that you don’t want wandering from their stalls.
 Mobile With Stops – This is similar to the default random wander behavior with
one slight difference. A special NPC waypoint in the Legends AI group called
“Stop Waypoint” can be placed around the NPC. The NPC will wander around
randomly however they will tend to gravitate to one of these Stop Waypoints.
This is useful if you want to force your NPC’s to randomly visit certain locations
in a village for example. Ensure you set their roam range high enough for them to
travel to these locations.
 Mobile Without Stops – This is the default behavior for NPC’s and it simply
causes them to randomly wander around interacting with other NPC’s that are
nearby.
 Random NPC Activities – This option gives you much more control over what
you want your NPC’s to do. Each activity is marked as a checkbox on the right
when this behavior is selected. You can choose one or more different activities to

have your NPC perform. Hand in hand with each of these activities is a matching
waypoint found in the Legends AI -> NPC Tasks waypoint blueprint group. To
activate this behavior, place matching waypoints down near the NPC for each
checkbox you have selected. The NPC will then randomly choose one of their
behaviors and walk to the nearest un-occupied waypoint and perform that task.
Optionally you can specify the maximum distance they will travel to find a
waypoint as well as how often they should change from one activity to another.
Waypoint Route
This text field when not empty will force an NPC to start walking a set of placed
waypoints. (See the tutorial above on how this works). This field is used to define the
BASE NAME of the waypoint set you wish them to follow. A waypoint set will have the
format “WP_<BASE NAME>” for daytime routes and “WN_<BASE NAME>” for
nighttime routes should they be configured to use different ones depending on time of
day. The BASE NAME is the unique name for a specific route set and must be entered in
this field without the preceding WP_ or WN_.
Patrol Style
This is only used when a Waypoint Route is configured. Normally each waypoint in a
waypoint set is numbered from 1 to the highest waypoint in the set. What happens when
the NPC reaches the last waypoint is determined by this option.
 Circular Patrol Route - When an NPC starts following a waypoint set, they will
travel to the last waypoint and return back to waypoint 1 and start again. It is
desirable to place the waypoints in such a way such that the last waypoint in the
set is near the first one in a loop of sorts.
 Straight Line Back and Forth – This behavior will cause the NPC to turn around
and walk a waypoint set in reverse once they reach the last one. Again, once they
return to the first waypoint, they will again follow the set forwards.
NOTE: This BASE NAME is also used for guard posts as well. Two special waypoints
in the Legends AI group called “Daytime Post” and “Night Time Post” can be used here
as well. If a WP set doesn’t exist but a matching POST waypoint does, the NPC will go
to that waypoint and simply stand guard.
Roam Range
This value is how far in meters the NPC will walk before the AI system instructs them to
return to their home location. For NPC’s that you wish to wander long distances, make
this number high. For smaller camps or areas where you don’t want your monsters to
wander far, set this low. The default is 5 meters.

Sleep Chance
If an NPC is configured to sleep, this is a percentage change from 1-100 they will
actually fall asleep at all. Useful if you want only a portion of a camp of monsters to fall
asleep at night for example and not all of them.
Day / Night Posts

If you are creating patrol routes and / or posts for NPC’s using the Waypoint Route
option above and you wish them to switch from one route or post during the day and a
different one at night, you must check this checkbox on.
Exterior Chase Range

When an NPC chases another NPC or player during combat this is the maximum range
the NPC will follow before they give up on the chase and return back to their home
location. This range is for exterior areas only. The default is 35 meters.
Interior Chase Range:

This is exactly the same as the Exterior Chase Range except for interior areas. The
default is 35 meters.
No Plot On Retreat
When an NPC reaches their maximum chase range in combat and decide to retreat back
home, the default behavior is for them to become plot so that players cannot harm them
after the NPC disengages until the reach their home location where they will heal and
return to normal. This can be overridden with this checkbox.
NOTE: A global override in the AI configuration can cause this behavior for all NPC’s.
Bartender Tag
This is the TAG of a bartender that would be configured on a Barmaid when used
together with both maid and bartender so the barmaid knows who is who.
Random NPC Activities

These checkboxes are used with the Random NPC Activities roam behavior. Selecting
one or more of these will cause the NPC to perform the associated action.

Random Task Range

This is the maximum distance an NPC will travel to find a matching waypoint for their
task. If they cannot find an un-occupied waypoint within this range, the NPC will fail to
move or perform any action.
Unequip during Animations

Some animations have their own item visual while other animations do not work
correctly if an item is equipped in their hand. This checkbox forces the NPC to remove
any items in hand before performing these activities.
Change Task Frequency

When an NPC has multiple activities selected or there are more than one of the same
activity waypoint nearby, this is how often the NPC will move from one to another.
Final Summary
The Legends AI has been in use for several years and has been designed to fit the play
style of a gamer when possible. Some quirks do exist however it still lends itself to be an
easy to use and powerful system of control for NPC’s and creatures. I suspect this AI
will have some revisions in the future to enhance it with even more features however it
still works quite well for persistent worlds and single player module builders.
This system was originally designed for the NWN 2 Persistent World known as Legends.
This quest based world leverages its area space quite well by having multiple camps and
events in each area that are separate from each other by type, quest and objective. This
means we couldn’t have patrols wandering around areas or different objectives
interfering with other objectives. We also need an AI that allowed our creatures to fight
with some intelligence hence why it was created.
If you have questions you can find me, the author, Marshall (aka Marshall V) in the
NWN 2 community forums, sometimes in the NWN IRC channels or just email me at
marshallv@nwn2legends.com or join me on my forums at http://www.nwn2legends.com
I hope you enjoy this system and feel free to season to your individual needs and tastes!
Have Fun and Happy Building!

Neverwinter Nights 2 Legends AI Plugin: December 29, 2016 Marshall Vyper

Uploaded by

Document Information

Original Description:

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Neverwinter Nights 2 Legends AI Plugin: December 29, 2016 Marshall Vyper

Uploaded by

Copyright:

Available Formats

Neverwinter Nights 2

Document Revision Information

Revision Date Author Description

Plugin Revision Information

Revision Date Author Description

Prepared by Marshall Vyper Page 2 of 29

TABLE OF CONTENTS ............................................................................................................................. 3

Prepared by Marshall Vyper Page 3 of 29

 Make NPC's and creatures sleep at night

Prepared by Marshall Vyper Page 4 of 29

Figure 1 - Master Script Overwrite

Prepared by Marshall Vyper Page 5 of 29

Part 1 – Getting Started

Note, some of the stock scripts are included in this with

setup.exe This is the installer.

Prepared by Marshall Vyper Page 6 of 29

YouTube Video Walkthroughs

Figure 2 - Install Wizard

Prepared by Marshall Vyper Page 7 of 29

Figure 3 - Plugin Menu

Figure 4 - Security Settings

Prepared by Marshall Vyper Page 8 of 29

Figure 5 - ERF Import Notice

Figure 6 - Legends Master Configurator

Prepared by Marshall Vyper Page 9 of 29

 CHECK BOXES = These checkboxes are to activate and deactivate the

 CAMPAIGN LEVEL OBJECTS = Selecting this causes the legends

 DATABASE OPTIONS = Some Legends plugins require an NWNX and

Prepared by Marshall Vyper Page 10 of 29

Figure 7 - Master Configurator

 UPDATE MODULE SCRIPTS = This button will update the module

i. leg_all_mastermod_itemacquired – On Item Acquired Event

ii. leg_all_mastermod_itemactivated – On Item Activated Event

iii. leg_all_mastermod_itemunacquire – On Item UnAcquire Event

iv. leg_all_mastermod_ondeath – On Player Death Event

v. leg_all_mastermod_onheartbeat – On Module Heartbeat Event

vi. leg_all_mastermod_onload – On Module Load Event

vii. leg_all_mastermod_onrest – On Player Rest Event

Prepared by Marshall Vyper Page 11 of 29

Prepared by Marshall Vyper Page 12 of 29

Part 2 – Trying it Out

Figure 9 - Guard AI Profile

Prepared by Marshall Vyper Page 13 of 29

Figure 10 – Village Idiot Configuration

Figure 11 - Stop Waypoint Blueprint

Prepared by Marshall Vyper Page 14 of 29

Figure 12 - Stop Waypoints

Prepared by Marshall Vyper Page 15 of 29

Tutorial 2 – Out on Patrol

Prepared by Marshall Vyper Page 16 of 29

Figure 14 - Patrol Route 1

Prepared by Marshall Vyper Page 17 of 29

Tutorial 3 – Tired of It All

Figure 15 - Sleeping Duncan

Prepared by Marshall Vyper Page 18 of 29

Tutorial 4 – Kobold Invasion

Prepared by Marshall Vyper Page 19 of 29

Tutorial 5 – Rogues and Wizards

Load this up in game and observe the results.

Prepared by Marshall Vyper Page 20 of 29

Figure 16 - Pre-Run Script Selection

Prepared by Marshall Vyper Page 21 of 29