= Combat styles =

== Martial Style ==

As opposed to barbaric style, the martial style relies more on training and discipline than sheer strength, soldiers are usually trained to fight with the martial style.

''Requirements'': any melee skill 0

''Weapons'': all melee weapons

<uml>
(Martial) --> (Front Charge)
(Martial) --> (Double Strike)
(Front Charge) --> (Charge Block\nReq.: Strength 80 Endurance 60)
(Front Charge) --> (Counter Strike\nReq.: Strength 80 Agility 60)
(Double Strike) --> (Counter Strike\nReq.: Strength 80 Agility 60)
(Charge Block\nReq.: Strength 80 Endurance 60) --> (Wall of Shields\nReq.: Strength 80 Endurance 80)
</uml>

'''Manoeuvre Description'''

* ''Front Charge'': One of the first thing an infantry soldier is taught is how to properly deliver a charge against the enemy, charging has a greater chance to hit and hurt an enemy but expose the attacker at risk of sustaining a counter-attack.

* ''Charge Block'': By setting up their shield and defences the soldier is able to better defend against incoming attacks and eventually deliver an efficient counter attack against the charging opponent.

* ''Double Strike'': The soldier quickly strike twice his opponent to engage his defences.

* ''Counter Strike'': By opening up his guard the soldier invite the enemy to strike him of course he runs the risk of being hit but a skilled soldier knows his enemy is more vulnerable in his attack position and the soldier is ready to exploit his attacker weak position to deliver a mighty counterstrike.

* ''Wall of Shields'': Skilled foot soldiers know their strength lies in their abilities to shield each others against the enemy to absorb their initial charge and then deliver a mighty counterattack. By setting up a wall of shields two or more cooperating foot soldiers are able to improve each others defences by creating a mighty defensive barrier.

== Sword Style ==
''Requirements'': Sword skill 0

''Weapons'': Shortsword, Longsword, Dagger

<uml>
(One-handed Sword) --> (Sword Side Trush)
(One-handed Sword) --> (Sword Lunge)
(Sword Side Trush) --> (Sword Beat Attack\nReq.: Sword 20)
(Sword Lunge) --> (Sword Beat Attack\nReq.: Sword 20)
(Sword Beat Attack\nReq.: Sword 20) --> (Sword Disengage\nReq.: Sword 40)
(Sword Disengage\nReq.: Sword 40) --> (Sword Circular Parry\nReq.: Sword 60)
</uml>

'''Manoeuvre Description'''

* ''Side Trush'': Hit with the blade edge, inflict slashing damage.

* ''Side Lunge'': Hit with the blade edge, inflict piercing damage.

* ''Sword Beat Attack'': Hit with the opponent weapons to gain priority and follow with a quick attack, inflicts more slashing damage Vs. opponents with higher Stances, can be easily blocked by opponent with defensive stances.

* ''Sword Disengage'': Beginning an attack in one direction, then quickly moving the point down in a semi-circle to attack a different location. This is used to trick the opponent into blocking the wrong direction. Gives the attacker higher priority (and a higher attack bonus for some time).

* ''Sword Circular Parry'': An advanced defensive technique, the attacker sword is twisted in a circle to catch the opponent's tip and deflect it away. It is commonly used to counter a disengage.

== Fencing ==
Fencing style is more refined and less brutal than other weapon styles, it relies more on agility and speed instead of sheer strength and muscle power.

''Requirements'': Sword skill 0, Agility 60 or more

''Weapons'': Longsword, Shortsword, Sabre

<uml>
(Fencing) --> (A)
(Fencing) --> (B)
(A) --> (Feint\nReq.: Agi 80, Sword 20)
(B) --> (Feint\nReq.: Agi 80, Sword 20)
(Feint\nReq.: Agi 80, Sword 20) --> (Risposte\nReq.: Agi 80, Sword 40)
(Risposte\nReq.: Agi 80, Sword 40) --> (D\nReq.: Agi 80, Sword 60)
</uml>

== Assassin Style ==

This style is mostly used by the stealthy characters and the warriors that favor knifes, daggers or shortswords use. It require agility, has a deadly attack power but is less good in defense. Disadvantage against "barbaric" opponent.

''Requirements'': Knife & Dagger skill 0, Melee skill 0, Sword skill 0, Light Armor skill 10, minimum Agility 100.

''Weapons'': melee, knives, daggers, shortswords

<uml>
(Assassin) --> (Lethal Takedown\nReq.: Agility 100, Knife & Dagger 10 or Sword 10 or Melee 10)
(Lethal Takedown\nReq.: Agility 100, Knife & Dagger 10 or Sword 10 or Melee 10) --> (Slit the Throat\nReq.: Agility 150, Knife & Dagger 30 or Sword 30 or Melee 30)
(Slit the Throat\nReq.: Agility 150, Knife & Dagger 30 or Sword 30 or Melee 30) --> (Dark Cloak\nReq.: Agility 200)
(Dark Cloak\nReq.: Agility 200) --> (Backstabbing Blow\nReq.: Agility 250, Knife & Dagger 60 or Sword 60 or Melee 60)
(Backstabbing Blow\nReq.: Agility 250, Knife & Dagger 60 or Sword 60 or Melee 60) --> (Bloodthirst\nReq.: Agility 300, Knife & Dagger 100 or Sword 100 or Melee 100)
</uml>

'''Manoeuvre Description'''

* ''Lethal Takedown'': Attacker jump with agility behind the opponent, grab his shoulders and take opponent to the ground with an hook kick before hitting him on the head (or neck) with the handle of his weapon, or with a punch. Fast attack that stun opponent for few second. Agressive Stance needed.

* ''Slit the Throat': Attacker excecute a quick and silent forward roll, passing behind the opponent, stand quickly and grab the opponent head, making path free to slit his throat. It requires a good timing and concentration but is able to inflict a letal wound. Player using melee, punch opponent throat.

* ''Dark Cloak'': Attacker concentrate his stealth knowledge and coats himself into shadows. As he crouches, the opponent is unable to see or touch him for a few second. Full defensive needed.

* ''Backstabbing Blow'': Attacker grabs opponent wrist, turns around on himself while pulling opponent forward and stab him in the back or inflict a powerfull punching blow. High Pierce/Blunt damage.

* ''Bloodthirst'': A fast-paced kill moove. Standing behind the opponent, attacker bring his weapon up to the right and slash it down to the left across his body, repeat the moove from top left to bottom right then finish on a down to up moove. Attacker inflict high slash damage on each moove (3). For melee users, Blunt damage with a bonus if player wearing crafted gauntlets. Bloody Stance needed.

== Barbaric Style ==

This style is designed to all the mighty warriors that likes to smash and bash in the fire of battles. Charge in and hit with the power of your strength and the blunt force of your weapon(s). A good sword user can be deadly using a blunt weapon as those use more or less the same fencing technique. Only different beeing the the balance of the weapon. This style doesn't require as much strengh as we think, the masse of the weapon contribute alone.

''Requirements'': minimum Strength 50, Mace & Hammer skill 0, Polearm & Spear skill 0, Sword skill 0, Axe skill 0.

''Weapons'': claymore, all polearm & spear, all mace & hammer, all big axes

<uml>
(Barbaric) --> (Power Attack\nReq.: Mace & Hammer 10 or Axe 10 or Sword 10 or Polearm & Spear 10)
(Power Attack\nReq.: Mace & Hammer 10 or Axe 10 or Sword 10 or Polearm & Spear 10) --> (Mighty Swing\nReq.: Mace & Hammer 30 or Axe 30 or Sword 30 or Polearm & Spear 30)
(Mighty Swing\nReq.: Mace & Hammer 30 or Axe 30 or Sword 30 or Polearm & Spear 30) --> (Furious Parry\nReq.: Strength 200, Endurance 150)
(Furious Parry\nReq.: Strength 200, Endurance 150) --> (Tricky Smash\nReq.: Mace & Hammer 70 or Axe 70 or Sword 70 or Polearm & Spear 70)
(Tricky Smash\nReq.: Mace & Hammer 70 or Axe 70 or Sword 70 or Polearm & Spear 70) --> (Whirlwind Strike\nReq.: Mace & Hammer 100 or Axe 100 or Sword 100 or Polearm & Spear 100)
</uml>

'''Manoeuvre Description'''

* ''Power Attack'': Attacker swing his weapon onto opponent body sides. A powerful attack able to cause more damage but at the expenses of accuracy.

* ''Mighty Swing': Attacker quickly kneel down and swing his weapon(s) toward opponent legs, then stand and afflict a second strike on any part of opponent body. Second hit can be blocked. Blunt damage. Powerful but less accurate. Cannot be used with defensive stances.

* ''Furious Parry'': Attacker use the masse of his weapon and smash it on opponent weapon rending him unavailable to attack for few second. Defensive Stance needed.

* ''Tricky Smash'': Standing, Attacker deliver a low hit toward opponent feet, attract his attention on blocking low, then turn around on himself and strike on opponent neck. Give a few second attack advantage as opponent is knocked backward.

* ''Whirlwind Strike'': Attacker strike down his weapon (up to down moove) once, stuning opponent for few second then deliver a powerfull circular attack, if not blocked from the start (by the target), the attacker will be able to deal damage to anyone around him. It's not particulary accurate but do high damage.

== Archery Style ==

The hunters, the rangers or even the stealthy characters might choose the bows for its high accuracy, keeping ennemy at far range. The Archer has a poor defense but he can take on a lot of ennemy in few second with deadly shots. Archery is hard to master but a well rewarding class style.
Endurance is vital for the archer, allowing him to draw longer bows, or moove around while shooting.

''Requirements'': minimum Endurance 100, Ranged skill 0.

''Weapons'': all bows

<uml>
(Archery) --> (Precise Shot\nReq.: all bows, Ranged 10)
(Precise Shot\nReq.: all bows, Ranged 10) --> (Hail of Arrows\nReq.: shortbow, Ranged 30)
(Precise Shot\nReq.: all bows, Ranged 10) --> (none yet\nReq.: longbow, Ranged 30)
(Hail of Arrows\nReq.: shortbow, Ranged 30) --> (Grip Knock\nReq.: all bows, Endurance 200)
(none yet\nReq.: longbow, Ranged 30) --> (Grip Knock\nReq.: all bows, Endurance 200)
(Grip Knock\nReq.: all bows, Endurance 200) --> (Kneeled Aim\nReq.: shortbow, Ranged 50)
(Grip Knock\nReq.: all bows, Endurance 200) --> (Ulber Shot\nReq.: longbow, Ranged 50, Endurance 300)
(Kneeled Aim\nReq.: shortbow, Ranged 50) --> (Rapid Fire\nReq.: shortbow, Ranged 70)
(Ulber Shot\nReq.: longbow, Ranged 50, Endurance 300) --> (Throught and Throught\nReq.: longbow, Ranged 70)
(Rapid Fire\nReq.: shortbow, Ranged 70) --> (Incendiary Arrows\nReq.: all bows, Ranged 100)
(Throught and Throught\nReq.: longbow, Ranged 70) --> (Incendiary Arrows\nReq.: all bows, Ranged 100)
</uml>

'''Manoeuvre Description'''

* ''Precise Shot'': Slower but more precise shot, takes longer and inflitcs higher damage.

* ''Hail of Arrows': Attacker hold several arrows in between the fingers of the draw hand (max3), allowing fast repeat shots. A quick hail of arrows, you're luck if you've not been shot.

* ''Grip Knock'': Close combat moove. Attacker gives an hit to a close opponent with the grip of his bow. Make opponent sightly moove backward. Poor defensive rate. Give attacker few second reaction. Defensive Stance needed.

* ''Kneeled Aim'': Close combat attack. Attacker kneel onto the ground then sit on his heels. Attacker raise the bow, draw the string until the back of the arrow reach the corner of his mouth with three finger and aim right into the opponent chest, almost at close range. Hight pierce damage. No defensive stance possible.

* ''Ulber Shot'': Archer draw the string very largely, which require a good endurance and release an arrow that stagger opponent for few second. Pierce damage. Stun effect.

* ''Rapid Fire'': Attacker aim the opponent, draw the string with the thumb, which allow him to walk left and right while shooting arrow very quickly. Attacker can shoot up to 10 arrows in few seconds. Bloody stance needed. Good Pierce damage, cannot pierce plate mail.

* ''Throught and Throught'': Attacker draw bow above their head then aim by laying bow horizontaly in front of him. Attacker release an arrow from great range penetrating mail and plate mail, afflecting several target (if aligned). High pierce damage.

* ''Incendiary Arrows': By alchemical means, attacker set his arrow on fire, aim and release a "rain" of arrows. Damage over time. Require a specific potion and the spell Flaming Weapon to be Off.

== Infantry Style ==

The most used style that require a good endurance and the science of shield handling. This style favor the light shields which can be lifted easier and used as weapon with a higher skill. Equally good at attack and defense, this style is at disadvantage against axes, two handed weapon or polearms. This style is good against a group of target and archers.

''Requirements'': Sword skill 0, Mace & Hammer skill 0, Axe skill 0, Shield Handling skill 0

''Weapons'': Sword, Shortsword, Sabre, Broadsword, maces, hammer, warpick, waraxe, reinforced axe, small battle axe, battle axe, axe, all light and medium shields.

<uml>
(Infantry) --> (Vertical Slash\nReq.: Shield Handling 10, Sword 10 or Mace & Hammer 10 or Axe 10)
(Vertical Slash\nReq.: Shield Handling 10, Sword 10 or Mace & Hammer 10 or Axe 10) --> (Block and Stab\nReq.: Shield Handling 30, Sword 30)
(Vertical Slash\nReq.: Shield Handling 10, Sword 10 or Mace & Hammer 10 or Axe 10) --> (Edge Barrier\nReq.: Shield Handling 30, Mace & Hammer 30 or Axe 30)
(Block and Stab\nReq.: Shield Handling 30, Sword 30) --> (Shield Slam\nReq.: Shield Handling 50)
(Edge Barrier\nReq.: Shield Handling 30, Mace & Hammer 30 or Axe 30) --> (Double Quake\nReq.: Shield Handling 50, Mace & Hammer 50 or Axe 50)
(Shield Slam\nReq.: Shield Handling 50) --> (Infrantry Feint\nReq.: Shield Handling 70, Sword 70)
(Double Quake\nReq.: Shield Handling 50, Mace & Hammer 50 or Axe 50) --> (Martial Tremor\nReq.: Shield Handling 70, Mace & Hammer 70 or Axe 70)
(Infrantry Feint\nReq.: Shield Handling 70, Sword 70) --> (Infantry Wrath\nReq.: Shield Handling 100, Sword 100 or Mace & Hammer 100 or Axe 100)
(Martial Tremor\nReq.: Shield Handling 70, Mace & Hammer 70 or Axe 70) --> (Infantry Wrath\nReq.: Shield Handling 100, Sword 100 or Mace & Hammer 100 or Axe 100)
</uml>

'''Manoeuvre Description'''

* ''Vertical Slash'': Vertical slash used to knock down your opponent. Attacker brings the weapon up and slash down across body, the shield raised in front of attacker face. Slash damage.

* ''Block and Stab'': Block opponent moove with the shield, bring other arm back and thrust forward at your opponent at any part of their body. Pierce damage.

* ''Edge Barrier'': Attacker force his shield edge toward opponent and come rest it against his body, stiking opponent main arm on the side. Attacker then afflict a powerful side slash/crush with his weapon.

* ''Shield Slam'': Block your opponent moove then deliver an hit with your shield making the opponent step backward. Blunt damage.

* ''Double Quake'': Shield facing opponent, weapon raised up, attacker gives a low blow to opponent legs, forcing him down then smash his shield tip/edge on any part of opponent body. Double blunt damage.

* ''Infantry Feint'': Attacker block hit wiht his sword, bending his blade to the opponent one then push him over before delivring a powerfull blow on opponent back with his shield. High blunt impact + pierce damage if spiked shield. Stun opponent for few second.

* ''Martial Tremor'': Fast-paced moove where attacker slam opponent with shield once then afflict several hits in a row with his weapon. Opponent feels the repetitive blunt impact which stuns him for few second. Blunt damage + up to 4 hits in a row.

* ''Infantry Wrath'': Fence your opponent weapon off with your shield then jump hit him with the weapon. Stun for few second and high slash/blunt/pierce damage with jumped movement. Very fast moove, unblockable.

== Blunt Force Style ==

The Blunt Force fighting style is particulary efficient against an armored opponent or group of opponent, especially against plate mail in close combat action. Hammers and maces allow one to maintain typicall long reach of swords while still inflicting damage to armored opponent. This fighting style is slow and can be dodged.

''Requirements'': Mace & Hammer skill 0, Axe skill 0, Strength 50

''Weapons'': all two-handed mace & hammer weapons.

<uml>
(Blunt Force) --> (Head Smash\nReq.: Mace & Hammer 10)
(Head Smash\nReq.: Mace & Hammer 10) --> (Path Open\nReq.: Mace & Hammer 30)
(Path Open\nReq.: Mace & Hammer 30) --> (Battering Ram\nReq.: Mace & Hammer 50, Strength 150)
(Battering Ram\nReq.: Mace & Hammer 50, Strength 150) --> (Grappling\nReq.: Mace & Hammer 70)
(Grappling\nReq.: Mace & Hammer 70) --> (Blunt Impact\nReq.: Mace & Hammer 100, Strength 250)
</uml>

'''Manoeuvre Description'''

* ''Head Smash'': Attacker use the head of his Mace/warhammer/hammer to smash on his opponent weapon. Slow moove, give defense advantage to attacker for few second. Blunt damage. Pierce damage if using spiked warhammer.

* ''Path Open'': Attacker slash his weapon across from left to right, fencing opponent weapon off. Attack advantage for few second.

* ''Battering Ram'': Main hand at the base of the weapon, other hand just under weapon head, attacker lean slightly then gives a battering ram like hit onto opponents legs, backs off quickly then slash down a tremendous blow with all the weight of his weapon onto destabilised opponent. High Blunt damage.

* ''Grappling'': Attacker smash down firmly his weapon on the opponent shield, grappling it, making it fall onto the ground or rending it useless. Attack advantage for few second. If the opponent do not use shield but is armored, this power attack will lower his armor defense capacity.

* ''Blunt Impact'': Attacker swirl his weapon above his head then smash it down in a powerfull move, afflicting several targets. Opponents stuned for few second. High blunt damage.

== Left-hand Style ==

This fighting style is sophisticate. It require an high flexibility and agility, beeing able to feint with suppleness and surprise the opponent with fast body and weapon moove. This style focus on the speed and attack power. Poor defense, this style is at disadvantage against shielded opponent.

''Requirements'': Sword skill 0, Knife & Dagger skill 0, Agility 50

''Weapons'': Sword, Shortsword, Knife, Dagger

<uml>
(Left-hand) --> (Horizontal Thrust\nReq.: Sword 10, Knife & Dagger 10)
(Horizontal Thrust\nReq.: Sword 10, Knife & Dagger 10) --> (Cross Parry\nReq.: Sword 30, Knife & Dagger 30)
(Cross Parry\nReq.: Sword 30, Knife & Dagger 30) --> (The Sliding\nReq.: Sword 50, Knife & Dagger 50, Agility 100)
(The Sliding\nReq.: Sword 50, Knife & Dagger 50, Agility 100) --> (Hilt Catch\nReq.: Sword 70, Knife & Dagger 70)
(Hilt Catch\nReq.: Sword 70, Knife & Dagger 70) --> (Feint of the Left-hand\nReq.: Sword 100, Knife & Dagger 100, Agility 200)
</uml>

'''Manoeuvre Description'''

* ''Horizontal Thrust'': Attacker raise sword horizontaly and parry opponent attack for few second. He, while then, lay down a bit and thrust forward at the opponent onto the chest with the dagger. Pierce damage.

* ''Cross Parry'': Attacker cross firmly his sword and dagger hilts and parry opponent attack. Attacker then push his opponent backward and quickly open his arms, giving fast slash of his weapons. Slight Defense advantage for a few second. Eventual slash damage.

* ''The Sliding'': Attacker quickly side face opponent, the tip of the sword up letting opponent weapon slide along his sword blade. Opponent is driven forward by his movement and attacker raise left hand above and stab his neck. Give time for attacker to step back.

* ''Hilt Catch'': Quickly dodge opponent attack with a side step and catch the hilt of his weapon with the dagger. Follow with a fast slash of the sword. High pierce damage. Give the attacker a defense disadvantage.

* ''Feint of the Left-hand'': Attacker engage the opponent with main weapon (sword) by doing big whirls. Attract your opponent attention on your main weapon then surprise him with a swift attack of the left-hand weapon (small weapon). Easily pierce opponent defense. Give the attacker a defense disadvantage.

== Two-Axe Style ==

The axe is a perfect compromise between sword and hammer, give the speed and slash damage of the sword and permit attacker to crush on opponent like with an hammer. This style is highly balanced but hard to master. Primary mean of defense is dodging for axe weilders. Good for speedy, deadly attack and nasty tricks.

''Requirements'': Axe skill 0, Agility 50

''Weapons'': all axes

<uml>
(Two-Axe) --> (Close Whack\nReq.: Axe 10)
(Close Whack\nReq.: Axe 10) --> (Block and Poke\nReq.: Axe 30)
(Block and Poke\nReq.: Axe 30) --> (Strike and Pull\nReq.: Axe 50)
(Strike and Pull\nReq.: Axe 50) --> (Tricked Hook\nReq.: Axe 70)
(Tricked Hook\nReq.: Axe 70) --> (Master Blow\nReq.: Axe 100)
</uml>

'''Manoeuvre Description'''

* ''Close Whack'': Power moove for close combat. Attacker whack opponent on the head with the end of his axe's haft. Blunt damage.

* ''Block and Poke'': With right-hand axe haft, attacker block opponent move and poke in the pit of his stomach by a blunt thrust of his left-hand axe-head. Blunt damage.

* ''Strike and Pull'': Swing axe aiming at the ennemy and when the haft strikes the ennemy's body, the attacker fix the axe in that position and then shift the whole body back by sliding the rear foot backward. Attack bonus. Pierce damage.

* ''Tricked Hook'': Attacker hook over the neck of opponent with axe head to compel him to move in another direction. Attacker can then smash his other axe onto the back of the opponent. Blunt damage.

* ''Master Blow'': The wielder swirl his axes around, confusing his opponent before delivring a double straight blow. The attacker use the balance of his axes to concentrate all the force of the blow into a small section of the edge so the axes has enough power to punch throught helmet or mail. High pierce damage. Bloody stance needed, bad defense for attacker.

== Wall Style ==

This style hightly favor the defense. The attacker can favor heavy shields to create a true wall around him or favor light ones and use them as weapons delivering blunt damage. Good defensive ability, this style requires a good amount of endurance to be used.

''Requirements'': Shield Handling skill 0, Strength 50, Endurance 100

''Weapons'': all shields

<uml>
(Wall) --> (Fast Block\nReq.: Shield Handling 10)
(Fast Block\nReq.: Shield Handling 10) --> (Confusion Slaps\nReq.: Shield Handling 30)
(Confusion Slaps\nReq.: Shield Handling 30) --> (Forward March\nReq.: Shield Handling 50, Endurance 200)
(Forward March\nReq.: Shield Handling 50, Endurance 200) --> (Sharp Edge\nReq.: Shield Handling 70)
(Sharp Edge\nReq.: Shield Handling 70) --> (Impervious Wall\nReq.: Shield Handling 100, Endurance 400)
</uml>

'''Manoeuvre Description'''

* ''Fast Block'': Attacker blocks quickly several of his opponent hits by swinging his shields to the right position. Ideal against sword users. Can be tricky against axe users or mace users.

* ''Confusion Slaps'': Attacker block, and use the opponent powermoove to hit back with the shield several time, knocking opponent for few second. Slight Blunt damage. Pierce damage if using spiked shield. (powermoove favor light shields. If heavy shields used, Blunt damage or Pierce damage reduced to 0)

* ''Forward March'': Attacker tighten his shields close by and charge in the oponent, pushing him backward. Annihilate opponent attack power for few second.

* ''Sharp Edge'': Attacker grasp the bottom of his shields with the other hand and drive edges into the opponent head. Blunt damage. (If using heavy shields, slower moove, attacker on a defensive disadvantage.)

* ''Impervious Wall'': Attacker Stun himself behind his shields, creating a true armored wall around him. Render attacker impervious to any melee attack for few second. Ask high Endurance level and tire the wielder.

== Two-handed Fencing Style ==

This style is very popular among the warriors, especially the tall races. A claymore permit to attack with an extra range and use the weapon lenght to do more damage. Those weapon are designed for close combat and duels. They make up for the weapon's slowness on the defence and can allow another blade to be momentarily trapped or bound up. Style Equally good in attack and defense, it require strenght, endurance and a good technique. Very effective against armored opponent. Disadvantage against small weapon users.

''Requirements'': Sword skill 0, Strength 50, Endurance 50

''Weapons'': claymore

<uml>
(Two-handed Fencing) --> (Edge Cut\nReq.: Sword 10)
(Edge Cut\nReq.: Sword 10) --> (Angry Charge\nReq.: Sword 30)
(Angry Charge\nReq.: Sword 30) --> (Metal Barrier\nReq.: Strength 200, Endurance 200)
(Metal Barrier\nReq.: Strength 200, Endurance 200) --> (The Bound\nReq.: Sword 70)
(The Bound\nReq.: Sword 70) --> (Blade Swirl\nReq.: Sword 100)
</uml>

'''Manoeuvre Description'''

* ''Edge Cut'': Attacker whirls around his claymore horizontaly from up right to down on his opponent shoulders or arms with the sharp edge of the blade. This large moove describe almost a complet circle which increase the impact force. High slash damage.

* ''Angry Charge'': Attacker start with a high stance, with claymore above his head, the tip of the sword menacing the opponent face, both hands on the pommel. Attacker extend his arms in front of him then moove forward in a charge, straight to the target. Fast Attack with high pierce damage if not blocked.

* ''Metal Barrier'': Attacker present his claymore horizontaly, left hand on the pommel, right hand grabing the blade firmly, presenting the open space to the opponent weapon for an effective block. Efficient on defensives modes. Require to wear armored gauntlets.

* ''The Bound'': Attacker firmly stop opponent attack moove by putting his weapon blade against his opponent one. He then exert a pression to drive the opponent weapon away without cuting the blades bound. Attacker get close by opponent, his blade slipping straight to the opponent body. Defense bonus + Pierce damage.

* ''Blade Swirl'': Close combat moove. Right hand on the pommel, left hand in the middle of the blade, the tip of the claymore pointed toward the ennemy's head, Attacker gives a powerfull hit on the opponent helmet with the tip of the blade, Attacker then swirl his blade around, pommel forward he excute a low sweep toward opponent legs. This combo is unstoppable, give high pierce then blunt damage. Require to wear armored gauntlets.

== Staff and Spear Style ==

Combat with a stick or a quaterstaff has a long and varied history mostly due to the fact that it is very easy to manufacture. The quaterstaff is a long, slender club like structure that is used to deliver blunt, crushing blows. It is traditionaly made of oak or ash. The lenght can vary from 1,8 to 5,4 meters. This weapons is mostly used by martial art practitioners to keep ennemy at range. All the fighting maneuvers are fast-paced. Require an high agility and accuracy. This weapon can hurt even armored opponents.

''Requirements'': Polearm & Spear skill 0, Agility 50, Endurance 50

''Weapons'': all polearm & spear weapons

<uml>
(Staff & Spear) --> (Downward Strike\nReq.: Polearm & Spear 10)
(Downward Strike\nReq.: Polearm & Spear 10) --> (Defense Manoeuver\nReq.: Endurance 100, Agility 100)
(Defense Manoeuver\nReq.: Endurance 100, Agility 100) --> (Upward Strike\nReq.: Polearm & Spear 30, Endurance 150, Agility 150)
(Upward Strike\nReq.: Polearm & Spear 30, Endurance 150, Agility 150) --> (Horizontal Stun\nReq.: Polearm & Spear 70, Endurance 200, Agility 200)
(Horizontal Stun\nReq.: Polearm & Spear 70, Endurance 200, Agility 200) --> (Thrust Fury\nReq.: Polearm & Spear 100, Endurance 300, Agility 300)
</uml>

'''Manoeuvre Description'''

* ''Downward Strike'': Staff hold by the non-dominant hand at the base of the weapon, other hand placed a quarter of the way up the staff. Attacker then drop the top hand to deliver a blow with the quarterstaff on opponent mid-section. Then, the warrior deliver an overhead blow to the back of the ennemy as he crouche over in pain. Double blunt damage.

* ''Defense Manoeuver'': Attacker block any blow by mooving his dominant hand which should be placed a quarter of the way up the staff. Bottom hand remain stationary while the dominant hand move in the direction that the blow is coming from. This moove is very precise and permit attacker to block most of the attack.

* ''Upward Strike'': Attacker left shoulder face opponent left shoulder. Long range. Attacker step forward opponent, knees sightly bent, attacker give a quick blow at the left side of opponent head with the left tip of the quaterstaff. Attacker then quickly change side and bring the right end of the staff up in a blow at the opposite side of opponent head. Double Blunt damage.

* ''Horizontal Stun'': Body well cocked for maximum striking force, holding the staff straight behind him, attacker deliver a powerful horizontal strike at any part of opponent body. Bloody Stance. An hit delivred with this moove stun the opponent for few second. Too much use of this maneuver tire the weilder.

* ''Thrust Fury'': A multiple smash and hit maneuver. Attacker Start by holding the staff with one hand while resting the butt firmly on the ground. Attacker give a slight hit of the staff onto opponent weapon fencing it off. He then grab staff with both hand and thrust onto opponent chest (blunt damage with staf, pierce with polearm). Then, quickly give a large hit of the staff bottom onto opponent back, turns on himself and thrust once more with the tip of the staff. 3 hits in a row into a fast-paced moove.

== Wasp Style ==

The use of two daggers permit the wielder a very fast-paced combat. The warrior can moove around easily, dodges blows and afflict multiple slash in a row. Strategicaly this style consist in a constant harassment of the opponent. The upmost point of this style is to always keep the dagger forward, in an intimidation moove, highly offensive. This fighting style has a poor defense power, the attack delivred aren't very powerfull but constant.

''Requirements'': Knife & Dagger skill 0, Agility 50

''Weapons'': knife, dagger

<uml>
(Wasp) --> (Scratch\nReq.: Knife & Dagger 10)
(Scratch\nReq.: Knife & Dagger 10) --> (Blackmail\nReq.: Knife & Dagger 30, Agility 100)
(Blackmail\nReq.: Knife & Dagger 30, Agility 100) --> (Mooving Target\nReq.: Agility 200)
(Mooving Target\nReq.: Agility 200) --> (Assault\nReq.: Knife & Dagger 70)
(Assault\nReq.: Knife & Dagger 70) --> (Blade Storm\nReq.: Knife & Dagger 100)
</uml>

'''Manoeuvre Description'''

* ''Scratch'': Attacker in an agressive stance, moove from left to right in a confusing motion, then jump on the opponent left side and gives two quick stabs. 2 pierce damage in a row.

* ''Blackmail'': Attacker hold both dagger vertically, the tip pointing to the ground. Attacker quickly grasp opponent weapon hilt with a dagger while afflicting quick cuts with the other dagger on opponent hands and forearms. Can give up to 4 little slash hits in a row.

* ''Mooving Target'': Attacker has strong foot forward, rear heel up, weapon in front of solar plexus, the other protect the throat. This stance permit attacker to moove left and right around the opponent, excecuting quick slashes of his blade on any part of the opponent body (up to 10 little slashes in a row depending on opponent defensive power). Defensive stance. Slight slash damage.

* ''Assault'': Attacker sprint charge a short distance straight onto opponent and suddently step to the left, thrust onto opponent body while passing by with right dagger and turn around on himself giving a large slash across body of his left dagger onto opponent back. 2 hits in a row with good pierce and slash damage.

* ''Blade Storm'': Attacker moove forward, forming a up to down slash across body whirl with his arms in a very fast-paced moove, tips of the daggers pointing to the ground. When close enough of the opponent, attacker jump and plant his dagger onto opponent shoulder or neck until the hilt. Multiple slash damages and a last high pierce damage hit. Very difficult to parry.

== Fists and Feet Style ==

This style is the art of using the body as a weapon. It require from the warrior an high concentration and accuracy, not only for the fighting technique but also because a strong mental is needed. The Fists and Feet user must constantly advance quickly and stay in a very close range to be more efficient. Size or force of the warrior doesn't matter as long as they master their technique and strategy. Can be very efficient against long range weapon if able to get closer to target.

''Requirements'': Melee skill 0, Agility 50, Strength 50

''Weapons'': none

<uml>
(Fists and Feet) --> (One-inch Punch\nReq.: Melee 10)
(One-inch Punch\nReq.: Melee 10) --> (Vertical Rebound Punch\nReq.: Melee 30, Endurance 100, Agility 100, Strength 100)
(Vertical Rebound Punch\nReq.: Melee 30, Endurance 100, Agility 100, Strength 100) --> (Roundhouse Kick\nReq.: Melee 70)
(Roundhouse Kick\nReq.: Melee 70) --> (Defensive Stance\nReq.: Endurance 200, Agility 200)
(Defensive Stance\nReq.: Endurance 200, Agility 200) --> (The Great Chain\nReq.: Melee 100)
</uml>

'''Manoeuvre Description'''

* ''One-inch Punch'': Attacker stand with his fists very close to the target. He then make a quick movement of the wrist which is held with the knuckles facing out on a horizontal axis, the wrist is then moved up and a strike is produced with the botton two knuckles. Generate a tremendous amount of impact force at very close distance. High blunt damage. Damage increased if a Kran or if armored gauntlets.

* ''Vertical Rebound Punch'': The limb directly in front of the chest, elbow down, Attacker sprint jump over opponent and deliver a first vertical punch down on opponent body. The vertical nature of the punch allows attacker to absord the rebound of the punch which increase the power of the second blow given afterward while landing. Double blunt damage, the second beeing bigger. Damage increased if a Kran or if wearing armored gauntlets.

* ''Roundhouse Kick'': Can be done targeting the low, middle or high opponent body part. Side facing opponent, Attacker throw his leg, hips rotating into the kick in order to convey more power in it, using abdominal muscles in the act of rotation for more effect. Attacker raise up on the ball of his foot while kicking to allow greater pivoting speed and increase the power. Attacker hits with the shin which reduce the kick's reach but does more damage. Up to 2 hits in a row. High blunt damage.

* ''Defensive Stance'': Attacker jump up avoiding sweep attack, or switch left to right to avoid straight attack, using arms as barriers to block opponent attack. If two hits blocked in a row, a charge counter-attack is enabled. Average Blunt damage. High defensive rate. Defensive stances needed.

* ''The Great Chain'': Fast-paced chain. Attacker step quickly to the left, block opponent attack with right arm and deliver a quick and powerfull punch with the joined fingers of the left hand onto ennemy's face. Attacker then excecute a low sweep kick in opponent legs which makes him fall backward, enough for attacker to throw a second and powerfull jumping punch on the stomach. Triple Blunt damage. Impossible to parry. A few second Stagger debuff to opponent.

== Long Knife Style ==

The "long knifes" are sturdy weapons with thick and curved blades able to undergoes harsh blows. Sabre users can afflict powerfull hits, and pierce even the toughest armor for the best practitioners. The very structure of those weapons permit a fencing style of cut aswell as thrust. The Long Knife Style is very particular and can surprise the unaware opponents. Low defensive capacity, this style is all in the parry and counter-strike strategy. A close combat style.

''Requirements'': Sword skill 0

''Weapons'': Sabre, Broadsword, Falchion

<uml>
(Long Knife) --> (Moulane Cut\nReq.: Sword 10)
(Moulane Cut\nReq.: Sword 10) --> (Slipping Thrust\nReq.: Sword 30)
(Slipping Thrust\nReq.: Sword 30) --> (Sword Fury\nReq.: Sword 50)
(Sword Fury\nReq.: Sword 50) --> (T Cross\nReq.: Sword 70)
(T Cross\nReq.: Sword 70) --> (Whirl Confusion\nReq.: Sword 100)
</uml>

'''Manoeuvre Description'''

* ''Moulane Cut'': En garde in front of opponent, attacker flips the sword from left to right with a slight moove of his wrist. Very fast attack which deliver an high cut damage to unaware ennemy.

* ''Slipping Thrust'': Standing in front of opponent, attacker with strong leg forward will block an attack buy giving a slight hit on ennemy's weapon. His sword will stay bound to the ennemy's blade, slips against it then bounce up to give an hit on the head. Thrust damage.

* ''Sword Fury'': Attacker block an attack with right sabre, driving opponent weapon down then deliver a quick and powerfull slash across body from left to right, turn around on himself and reiterate. Double high slash damage. Hard to parry.

* ''T Cross'': Attacker crosses his blades perpenducularly, orientating the crossing point for it to face opponent at any moment. If a hit is taken in the defensive block, attacker counter strike with right sword, inflicting a powerfull straight cut onto opponent body. Defensive stance needed. Good cut damage.

* ''Whirl Confusion'': Attacker makes a quick vertical whirl with his right hand weapon while mooving toward opponent, unable to parry the charge without some slight slash damage. Attacker finish on a quick low slash onto opponent legs. Multiple slight slash damage if oponent on defensive stance. High slash damage onto the legs. Stun for few seconds.

== Swordmaster Style ==

The swordmaster dual-weilding is able to moove around his target and realise beautifull technical swing of his swords, mostly with the same type of weapon in each hands. This style is generaly not used in a battle field due to it beeing hard to learn and difficult to master (hard to learn to use the left hand as good as the right). This Style is good in a one on one situation but very less good against a group of target or against archers. It's mostly a parry and riposte style. Wielder of two swords must be able to quickly switch stances and sword position to keep the inbalance.

''Requirements'': Sword skill 0

''Weapons'': Shortsword, Longsword, Broadsword

<uml>
(Swordmaster) --> (Offensive Defense\nReq.: Sword 10)
(Offensive Defense\nReq.: Sword 10) --> (The Scissor\nReq.: Sword 30)
(The Scissor\nReq.: Sword 30) --> (The Embrace\nReq.: Sword 50)
(The Embrace\nReq.: Sword 50) --> (Counter-Swing\nReq.: Sword 70)
(Counter-Swing\nReq.: Sword 70) --> (Blade Stream\nReq.: Sword 100)
</uml>

'''Manoeuvre Description'''

* ''Offensive Defense'': Attacker use the defensive blade to find and bind opponent's blade(s) and shift them out of line as the offensive blade moves in with a cut or thrust as the opponent's exposed body. Defensive Stance required.

* ''The Scissor'': Attacker trap opponent weapon(s) in the distal space between his crossed blades and then close the space with a scissoring motion to keep the opposing weapon(s) trapped as attacker thrust both blades simultaneously into ennemy's face, throat or body. Both defense and attack point. Defensive Stance needed.

* ''The Embrace'': Attacker face opponent legs spreads and arms opponent, tip of his sword pointing up, he hit opponent weapon(s) with left hand then excecute a large slash across body from left to right on opponent chest. High slash damage. Normal Stance required.

* ''Counter Swing'': Attacker block an incoming hit with his left hand sword then immediatly swing with main sword (right hand) toward the forearm of the opponent's main arm. Attacker then follow-up with a attack to opponent legs. Double slash damage. Agressive stance neeeded.

* ''Blade Stream'': Attacker slashes an X at opponent, first from top to bottom and then bottom to top. Attacker then makes a diagonal slash with the right sword, top-right to bottom-left, spin left and uses this momentum to deal a horizontal right to left slash with left sword. Fast-paced moove with 4 slash damage in a row. Bloody stance needed.

[[Category:Engine documents]] [[Category:Server Design]]

Behavior Operations

2014-08-03T06:37:52Z

Eonwind: /* Memorize Operation */

A “Behavior” in NPCClient is a script defined in [[NPC_Behavior_Data_Structures#npcbehave.xml|npcbehave.xml]] to run to make the npc behave a certain way. It is almost like
a state, for AI designers used to state machine npcs. Example behaviors might include “guard
patrol”, “wander in forest”, “fight attackers”, “smith an item”. Before we talk about how
everything fits together we will go over what is possible in npcclient with these detailed behavior
scripts. The following is a list and reference description of each behavior script operation or
command you can use. They are put together in sequences called beaviors as will be described later in [[Behaviors_and_Reactions]].

== Assess Operation ==
(Net load: 1, CPU Load 1)

{|
!Parameter
!Type
!Default
!Description
|-
|physical
|string
|
|The prefix for the physical perception.
|-
|magical
|string
|
|The prefix for the magical perception.
|-
|overall
|string
|
|The perfix for the overall perception.
|}

Each of the physical, magical, or overall will be assessed as; "extremely weaker", "much weaker", "weaker", "equal", "stronger", "much stronger" or "extremely stronger".

Ex: <assess overall="$target overall" />

Typical reaction to catch the response to this would be as shown in the example below. $target is used here to make sure the correct assessment is matched to the same target. A npc will
not react if the target has changed before the response is received.

Ex: <react event="assess equal" type="$target overall" .../>
<react event="assess weaker" type="$target overall" .../>

== Auto Memorize Operation ==
(Net load: 1, CPU Load 1)

{|
!Parameter
!Type
!Default
!Description
|-
|types
|string
|
|Comma separated list of types. "all", can be used to memorize everything to all.
|-
|enable
|bool
|true
|Enables or disables the types.
|-
|}

Auto memorize is a way to turn on and off memorizing of perception. This will be memorize without actually needing to react to thees. Related to the [[Behavior_Operations#Share_Memories_Operation|Share Memories Operation]].

Ex: <auto_memorize types="all" />
<auto_memorize types="Hunting Ground,Marked" />
<auto_memorize types="Marked" enable="false" />

You can use a reaction without a behavior lists to enable the NPC to receive perceptions to be memorized if enabled.

Ex: <react type="location sensed" />

== Build Operation ==
(Net load: 1, CPU Load 1)

{|
!Parameter
!Type
!Default
!Description
|-
|pickupable
|boolean
|false
|If false the building deployed will not be pickupable by the players
|}

Build a building as specified bye the NPC's current held building spot as set by the [[Tribe Scripting]] [[Tribe_Scripting#LocateBuildingSpot|locateBuildingSpot]] function.

Ex: <build />

== Busy Operation ==
(Net load: 1, CPU Load 1)

{|
!Parameter
!Type
!Default
!Description
|-
|}

Mark a NPC as busy. This will cancle the [[Behavior_Operations#Idle_Operation|Idle Operation]]

Ex: <busy />

== Cast Operation ==
(Net load: 1, CPU Load 1)

{|
!Parameter
!Type
!Default
!Description
|-
|spell
|string
|
|The name of the spell to cast.
|-
|k
|float
|1.0
|The kFactor to use when casting the spell.
|}

Cast a spell on the current selected target.

Ex: <cast spell="Flame Strike" k="3.0" />

== Change Brain Operation ==
(Net load: 1, CPU Load 1)

{|
!Parameter
!Type
!Default
!Description
|-
|brain
|string
|
|The name of the brain to load.
|-
|brain
|reload
|
|Reload the standard NPC the brain stored in the sc_npc_definition table.
|-
|}

Change the brain of the current selected target.

Ex: <change_brain brain="Charmed" />

== Chase Operation ==
(Net load: 3, CPU Load 3)

{|
!Parameter
!Type
!Default
!Description
|-
|anim
|string
|
|The animation to use for the chase.
|-
|adaptiv_vel_script
|string
|
|A [[NPCClient math script]] used to adjust the adaptivVelocityScale. Additional variables defined for this script is "Distance" to the target of the chase and "AdaptivVelScale" that is the value used to adjust velocity. 1.1 will increase the velocity by 10%.
|-
|type
|nearest_actor, nearest_npc, nearest_player, owner, target
|
|nearest_* is the nearest entity of that type. target is current target.
|-
|range
|float
|2.0
|The range to search for target of the chase.
|-
|chase_range
|float
| -1
|The range at where the chase should give up and issue a "<target> out of chase" perception. -1 is default to disable the max range check.
|-
|offset
|float
|0.5
|The distance to stop before the target of the chase. [[NPC Variables]] will be replaced. Expressions will be resolved. See [[Behavior_Offset|Offset]] for more details.
|-
|offset_angle
|float
|0.0
|Size of the arc used to distribute the chase when approaching the target. The angle is in degrees.
|-
|offset_relative_heading
|bool
|false
|Make the offset relative to the target heading. [[NPC Variables]] will be replaced. See [[Behavior_Offset|Offset]] for more details.
|-
|vel
|float,$WALK,$RUN
|Default is to use the velocity from the behavior.
|The velocity to use when chasing.
|-
|ang_vel
|float
|
|0 is to use the default from the behavior.
|-
|collision
|string
|collision
|The name of the perception to be used when a collision perception is to be fired.
|-
|out_of_bounds
|string
|out of bounds
|The name of the perception to be used when a out of bounds perception is to be fired.
|-
|in_bounds
|string
|in bounds
|The name of the perception to be used when a in bound perception is to be fired.
|}

Chasing a player is one example where both turning and moving at the same time are required to
give a realistic effect to the behavior. We have <move> and <rotate> but this one does them
together and intelligently to follow a targeted player or entity. Normally, this will be used to get
npc’s to chase after players if players run away during a fight.

Ex: <chase type="enemy" anim="walk" range=”2” />

In this example, the npc will play the animation called “walk” while moving and turning as
appropriate to reduce his range to his most hated enemy. Of course, he is limited by his speed and
if the player can run faster than he can chase, he will never catch the player. An "<target> out of chase" perception
will be fired in this case.

The “type” attribute of the operation can be either “enemy” as shown here, “owner” to follow the
NPC’s owner around, or “nearest” to chase after the nearest player at the time the operation was
initiated. This operation will continue until interrupted by another behavior or until the distance to
the target from the npc is less than the range specified. (2 is the default if no range is specified.)
This operation sends DR messages whenever it turns or changes course, plus the DR messages to
start the forward motion and animation, and to stop them. The CPU load is somewhat heavy
because CD must be performed as the npc is chasing, since his path is not predetermined.

== Circle Operation ==
(Net load: 3, CPU Load: 2)

{|
!Parameter
!Type
!Default
!Description
|-
|anim
|string
|
|The animation to use for the operation.
|-
|radius
|float
|Mandatory, no default value
|Radius to move NPC around with.
|-
|angle
|float
|2PI
|The angle to move. Calculated if 0 and duration not 0.
|-
|duration
|float
|0
|The duration to move in circle. Calculated if 0.
|-
|ang_vel
|float
|
|The angular velocity to use when moving in the circle. Calculated if 0.
|}

Moving the NPC around in a circle. The following example will move the npc around using the velocity defined in the behavior in one complete circle in 10 sec.

Ex: <circle anim="walk" radius=”2” duration="10" />

== Control Operation ==
(Net load: 3, CPU Load: 2)

{|
!Parameter
!Type
!Default
!Description
|-
|}

Take control of an player an move with the player.

Ex: <control />

== Copy_Locate Operation ==
(Net load: 0, CPU Load: 1)

{|
!Parameter
!Type
!Default
!Description
|-
|source
|string
|Mandatory, no default value
|The source locate to copy from.
|-
|destination
|float
|Mandatory, no default value
|The destination locate to copy to.
|}

Copy one locate from source to destination. Built in function like Wander and Navigate use the Active locate.

Ex: <locate obj="some thing" destination="SpecialPlace" />
<copy_locate source="SpecialPlace" destination="Active" />

== Debug Operation ==
(Net load: 0, CPU Load: 0)

{|
!Parameter
!Type
!Default
!Description
|-
|level
|int
|Mandatory
|The level of debug to turn on for current NPC.
|-
|exclusive
|string
|
|Will set on exclusive logging for this NPC.
|}

Turn on and of debug printouts on the server console. Used for debuging of script operations. Level 1-4 Only the biggest events, 5-9 Medium number of events, 10-15 and more is maximum output.

Ex: <debug level=”2” />

== Dequip Operation ==
(Net load: 0, CPU Load: 0)

{|
!Parameter
!Type
!Default
!Description
|-
|slot
|string
|Mandatory
|The slot to dequip an move back into inventory.
|}

Dequip an item held by the NPC in the given slot.

Ex: <dequip slot="righthand" />

== Drop Operation ==
(Net load: 0, CPU Load: 0)

{|
!Parameter
!Type
!Default
!Description
|-
|slot
|string
|Mandatory
|The slot from which the item is to be dropped.
|}

This operation allows an NPC to drop an item he has in inventory on the ground.

Ex: <drop slot="lefthand" />

== Eat Operation ==
(Net load: 0, CPU Load: 0)

{|
!Parameter
!Type
!Default
!Description
|-
|resource
|string,tribe:wealth
|Mandatory
|The resource to reward the tribe when eating.
|}

Simple simulation that the tribe would gain things like flesh from eating at a dead entity withing a range of 1.0. The tribe wealth resource would be read from the wealt_resource_name field in the [[NPC_Behavior_Data_Structures#tribes#tribes|tribes]] table.

Ex: <eat resource="tribe:wealth" />
<eat resource="Flesh" />

== Emote Operation ==
(Net load: 0, CPU Load: 0)

{|
!Parameter
!Type
!Default
!Description
|-
|cmd
|string
|
|The emote cmd to be used as defined in the emote.xml file. Including leading /.
|}
This operation allows an NPC to do an emotion.

Ex: <emote cmd="/greet" />

== Equip Operation ==
(Net load: 0, CPU Load: 0)

{|
!Parameter
!Type
!Default
!Description
|-
|item
|string
|Mandatory
|The name of the item to equip
|-
|slot
|string
|Mandatory
|The sloot to dquip the item in
|-
|count
|int
|1
|The number of items to equip. Will be forced to at least 1.
|}

Equip one item from inventory into the given slot.

Ex: <equip item="Sword" slot="righthand" count="1" />

== Hate List Operation ==
(Net load: 0, CPU Load: 0)

{|
!Parameter
!Type
!Default
!Description
|-
|delta
|float
|
|Add delta to hate list.
|-
|absolute
|float
|
|Set the hate value.
|-
|max
|float
|
|Hate should have a max value
|-
|min
|float
|
|Hate should have a min value
|-
|perception
|bool
|false
|Use perception instead of target to find target.
|}

Adjust the hate list for an npc. The current target or perception target is the target entry for the adjustment.

Ex: <hate_list delta="0.5" max="10.0" />

Ex: <locate obj="perception" />
<hate_list absolute="5.0" />

Is equvivalent with:

<hate_list perception="yes" absolute="5.0" />

== Idle Operation ==
(Net load: 1, CPU Load 1)

{|
!Parameter
!Type
!Default
!Description
|-
|}

Mark a NPC as idle. This operation cancle the [[Behavior_Operations#Busy_Operation|Busy operation]].

Ex: <idle />

== Invisible Operation ==
(Net load: 0, CPU Load: 0)

{|
!Parameter
!Type
!Default
!Description
|}
No parameters.

This operation makes the NPC invisible through the toggle visibility command. See [[Behavior_Operations#Visible_Operation|Visible Operation]].

Ex: <invisible />

== Locate Operation ==
(Net load: 0, CPU Load 0)

{|
!Parameter
!Type
!Default
!Description
|-
|obj
|See table below.
|Mandatory
|The object to locate. [[NPC Variables]] will be replaced.
|-
|failure
|string
|
|A perception to fire if fails to locate the given obj.
|-
|static
|boolean
|false
|For location the search could be made static. Se description for more details.
|-
|range
|float
| -1
|The maximum range to locate within. -1 represents infinite.
|-
|random
|boolean
|false
|If true a random return within the radius will be made. Otherwise the nearest entry will be returned.
|-
|outside_region
|boolean
|false
|Set this to true if the locate operation should consider entities outside region as well if a region is defined. [[NPC Variables]] will be replaced.
|-
|invisible
|boolean
|false
|Set this to true if the locate operation should consider invisible objects
|-
|invincible
|boolean
|false
|Set this to true if the locate operation should consider invincible objects.
|-
|destination
|string
|Active
|Set the destination [[NPC locate location]]. [[NPC Variables]] will be replaced.
|}

Obj can be one of the following:
{|
!obj
!Description
|-
|<string>
|Locate a location. This is the default if none of the following obj types is matched.
|-
|actor
|Located nearest actor
|-
|building_spot
|Locate a building spot from the npc's building spot.
|-
|dead
|Nearest dead actor
|-
|entity:name:<name>
|Entity with given name
|-
|entity:pid:<pid>
|Entity with given pid
|-
|friend
|Nearest visible friend (NPC)
|-
|local_region
|Locate region in current sector.
|-
|ownbuffer
|Locate the own buffer.
|-
|owner
|Locate the owner, if this NPC is owned (Pets and stuff)
|-
|perception
|The location of the last received perception.
|-
|player
|Nearest player
|-
|point
|Random point
|-
|region
|Locate a random point within the region of the NPC.
|-
|self
|Locate your self
|-
|spawn
|Spawn location of the npc.
|-
|target
|Locate a target. The target will be the most hated from the NPC [[hate list]].
|-
|tribe:home
|Locate the npcs [[Tribes|tribe]] home place.
|-
|tribe:memory:string
|Locate something from the [[Tribes]] memory. See the [[Behavior_Operations#ShareMemories_Operation|ShareMemories]] and [[Behavior_Operations#Memorize_Operation|Memorize]] operation.
|-
|tribe:resource
|Locate a resource location from the memory of the [[Tribes|tribe]].
|-
|tribe:target
|Locate the most hated target for this tribe. The target will be the most hated from all the NPCs [[hate list]] in the tribe.
|-
|waypoint
|Will locate a waypoint.
|-
|waypoint:group:string
|Locate a waypoint from a given group
|-
|waypoint:name:string
|Locate a waypoint by name.
|}

This operation is one of the more flexible and crucial operations in npc scripting. It allows the
scripter to have his npc “find” a certain thing or type of thing, and remember that location for other
scripting commands later such as turning, moving or attacking. The operation will store the position
found in the NPCs as active postion and calcualte the neares waypoint and store that in the active_waypoint.
For location it is possible to make the first search a static search. So that the first time the npc
do this operation it could search for a "Baker" location. The next time the operation is used it will
use the results of the first time even if there might be Bakers closer at that time.

Ex: <locate obj="perception" />
<locate obj="target" />
<locate obj="furnace" range="50" />
<locate obj="waypoint" failure="no waypoint found" />

Example 1 finds the last perception received by the current npc and sets the active target location to
the location of that perception. This allows npcs who receive “Talk” perceptions to turn to face the
person talking to them. It allows npcs who have a spell cast on them to turn to face the caster, and
so on.

Example 2 finds the location of the currently active “enemy” of the NPC, which is the entity with
the highest score on the NPC’s [[hate list]], and sets that location as the active target location for other
operations. This allows NPCs to turn to face the person they are attacking, chase attackers who are
retreating, etc.

Example 3 uses predefined lists of named location types to find the closest one to the npc and sets
the active target location to the coordinates specified there. This is the most subtle of the 3, and in
some ways the most powerful so it deserves more discussion. Consider the following pictures:

http://www.planeshift.it/download/docs/npc_pic1.png

Here we have two blacksmith shops with similar items but different layouts. They might be side by
side or they might be in entirely different cities. LocTypes specify a list of Anvil locations, or a list
of Furnace locations, as marked by the stars on these pictures. When Example 3 says to locate the
nearest furnace, an NPC in smithy #1 will find his furnace while the NPC in smithy #2 will find his
own furnace. They will be able to share one script for moving between these points and acting like
a real blacksmith in their own location, even though they are in totally different smithy shops.

This will become even more important when we implement player housing and player shops. It
will be possible with the scripts we have already today for a player to build the blacksmith shop of
his own design and for him to hire an npc smith to come work in that shop. The Smith NPC he
hired will be able to “know” how to get around the player’s shop magically.

Something intended to be supported here but not actually implemented yet was the ability to locate
named objects or entities as well, so an NPC could locate a sword someone dropped on the ground
and things like this. Better integration with the entity system and perhaps integration with data
from the maps themselves rather than externally generated lists of points could make this even more
powerful.

== Loop Operation ==
(Net load: 0, CPU Load: 0)

{|
!Parameter
!Type
!Default
!Description
|-
|iterations
|int
|0
|Number of iterations to do in this loop. No iterations attribute or a value of -1 is loop forever.
|}

This operation allows you to loop a section of your script a certain number of times. This is mostly
useful for city npcs such as smiths and tavern barkeeps. Behaviors in general will loop if not
replaced by another behavior, but if you want subloops within the script, this is an easy way to do it.

Ex:
<loop iterations="20">
<locate obj="fire" range="10" />
<navigate anim="walk" />
<wait anim="stand" duration="30" />
<locate obj="anvil" range="10" />
<navigate anim="walk" />
<wait anim="hammer" duration="20" />
</loop>

In this example, the blacksmith is scripted to walk back and forth between his fire and his anvil 20
times before moving on to the next operation in his script to act like a blacksmith.

This operation does not affect the network at all and does not have CPU overhead.

== Melee Operation ==
(Net load: 1, CPU Load: 2)

{|
!Parameter
!Type
!Default
!Description
|-
|seek_range
|float
|0.0
|The range to search for new targets in melee
|-
|melee_range
|float[0.5-3.0]
|3.0
|The range where melee can be done. Max 3.0 to prevent npc/server conflicts.
|-
|attack_type
|string
|default
|The name of a special attack defined in the 'attacks' table. If this attribute is not set an ordinary attack will be queued. [[NPC Variables]] will be replaced.
|-
|stance
|string
|normal
|The stance to use when attacking. [[NPC Variables]] will be replaced.
|-
|tribe
|boolean
|false
|When set to true the tribe [[hate list]] will be used to select target. If true and NPC not member of a tribe the NPC [[hate list]] will be used as a fall back. [[NPC Variables]] will be replaced.
|-
|outside_region
|boolean
|false
|Set to true to fight even outside region if a region is defined. [[NPC Variables]] will be replaced.
|-
|invisible
|boolean
|false
|Will melee operation fight invisible entities
|-
|invincible
|boolean
|false
|Will melee operation fight invincible entities.
|}

The <melee> operation handles starting and ending fights for the NPC. It finds the most hated
enemy in range and tells the server to attack him. If there is no enemy in range, it finds the nearest
enemy that it does hate and prepares to chase him.

Ex: <melee seek_range="10" melee_range="3" />

The “melee_range” attribute specifies how far away the enemies can be while still fighting without
the npc needing to move. 3 meters is the maximum of how far away a player can be to hit the npc
also, so in most cases this is a good value. The “seek_range” specifies how far around himself the
npc should look for other enemies if none are found within the melee_range. If there are no
enemies within the seek_range, the npc starts to calm down and his current behavior (making his
‘melee’ operation active) is lowered in priority. If an enemy is found within the seek_range, the
NPC’s active enemy is set to this found person so the <chase type=”enemy”> operation can run
after him.

This operation’s only network load is informing the server of its melee target and attack mode, and
switching these occasionally as people die, etc. The CPU load is in periodically (2x per second)
checking the [[hate list]] for the NPC to make sure the most hated person is being fought. If no one on
the [[hate list]] is within the melee range, a more expensive operation is done to find any hated people
within the seek_range, but this operation isn’t performed very often.

See the NPC [[hate list]] for further details about the [[hate list]].

== Memorize Operation ==
(Net load: 0, CPU Load: 0)

Tribe operation.

{|
!Parameter
!Type
!Default
!Description
|}
No Parameters.

This is an operation that only will have effect for tribe members. The NPC will memorize the current perception as a private memory.
See the [[Behavior_Operations#Share_Memories_Operation|Share Memories Operation]] for how to make the memories known to other members of the tribe.

Ex: <memorize />

== Move Operation ==
(Net load: 0, CPU Load: 5)

{|
!Parameter
!Type
!Default
!Description
|-
|anim
|string
|
|The animation to use when moving.
|-
|duration
|float
|0.0
|The duration this move should have. The default is probably no good.
|-
|vel
|float,$WALK,$RUN
|Default is to use the velocity from the behavior.
|The velocity to use when moving.
|-
|ang_vel
|float
|0.0
|By defining a ang_vel the movement will be much like the [[Behavior_Operations#Circle_Operation|Circle Operation]].
|-
|collision
|string
|collision
|The name of the perception to be used when a collision perception is to be fired.
|-
|out_of_bounds
|string
|out of bounds
|The name of the perception to be used when a out of bounds perception is to be fired.
|-
|in_bounds
|string
|in bounds
|The name of the perception to be used when a in bound perception is to be fired.
|}

The most basic behavior operation in npcclient is <move>. It simply tells the npc to move forward
at a certain speed in the direction he is currently pointing, and to play a named animation while
doing so.

Ex: <move vel="1" anim="walk" />
<move anim="walk" vel="$WALK" out_of_bounds="move_outside_region" />

This operation has no preset end or duration, so it will go until the behavior is preempted by another
higher priority behavior such as the one to turn, triggered by a collision perception. (See the next
section for a more detailed explanation of how behaviors pre-empt each other and change
priorities.)

This operation has low networking overhead since all it does is trigger a single Dead Reckoning
(DR) update to start the forward motion. It does have CPU overhead during the entire duration of it
running though, since there is no way for npcclient to know what it might hit along this path. Every
500msec this operation wakes up and checks its latest movement for collisions, generating a
perception called “collision” for the behavior script to react to. Also at each 500msec checkpoint,
it checks the owner NPC’s region setting (such as “sunny meadow” in the example above), and if
there is a region specifed, the operation checks its current position to make sure the NPC is still “in
bounds”. If the NPC has made it outside the region in the last half second, it fires a perception
called “out of bounds”. It will not fire another “out of bounds” perception until an “in bounds”
perception has been detected.

== MovePath Operation ==
(Net load: 2, CPU Load: 3)

{|
!Parameter
!Type
!Default
!Description
|-
|path
|string
|Mandatory
|The name of the path to use for the movement.
|-
|anim
|string
|
|The name of the animation to use for this movement
|-
|direction
|FORWARD,REVERSE
|FORWARD
|The direction to move along the path
|}

This operation tell the NPC to move in a predefined path. The path is a named entity in the path network.
From a start waypoint to and end waypoint with any number of path points in between. The path will either
be followed in the forward or reverse direction. Upon start of this the npc will be forced to the
start position of the path. The following example will move the NPC the reverse path to the clock tower.
Ex: <movepath path="Clock Tower" direction="REVERSE" />

Ex: <behavior "Ring the Clock">
<movepath path="Clock Tower" />
<wait anim="Ring the Clock" />
<movepath path="Clock Tower" direction="REVERSE" />
</behavior>

Current implementation will extrapolate on the server and send updates to the client.

The following old description isn't quite in line with current implementation. Sure it should be possible
to send the path to the client and do the math there. Suggest to include that as a option to the current
implementation. With today implementation the movement could be interrupted and it will stop when finished
with the path. To get the looping behavior either the behavior should be set to looping or a loop should
be created.

--Start old description:

This operation is another very easy one: <movepath>. It tells the npc to set its preset path to a 3d
spline specified in another file by name. Each client will take care of playing the right animations
along the spline as the npc progresses. The intent of this operation was really simply for birds to be
able to fly through the air as decoration rather than any gameplay reason. Aside from birds, most
creatures do not follow 3d spline paths in their normal behaviors.

Ex: <movepath path="bird1" />

This operation has no present end or duration, and will actually loop if not stopped by another
behavior.

This operation has almost no network overhead, as the packed bytes of the spline are sent 1 time
across the network to anyone needing to see this npc, and no other network activity happens until
the <movepath> operation is interrupted.

This operation also has almost zero CPU overhead, because there is no collision detection and no
bounds checking on this type of movement. The reasoning is that since predefined paths are being
followed, it is up to the designer/scripter to ensure that the path goes where they want it to and does
not hit anything along the way.

--End old description

== MoveTo Operation ==
(Net load: 0, CPU Load: 3)

{|
!Parameter
!Type
!Default
!Description
|-
|x
|float
|0.0
|X-coordinate to move to
|-
|y
|float
|0.0
|Y-coordinate to move to
|-
|z
|float
|0.0
|Z-coordinate to move to
|-
|vel
|float,$WALK,$RUN
|Default is to use the velocity from the behavior.
|The velocity to use when moving.
|-
|anim
|string
|
|The name of the animation to use
|}

This operation tells the npc to turn and face a certain point in
3d space, then move in a straight line to that location at a certain speed. The turn is not animated,
so if you want an animated turn, you need a <rotate> op in front of this (see below). <moveto> also
specifies an animation name to play while performing this move.

Ex: <moveto x="-38" y="0" z="-169" anim="walk" />

When this operation is executed, the angle necessary to point in the right direction towards this 3d
coordinate is calculated and the DR message to start the anim, start the movement and set the
rotation angle so it will look correct is sent. Then the operation calculates the time it will take to
traverse the distance at the specified speed and suspends itself for that length of time before waking
up and completing. Thus, this operation has zero processing during these ½ second update
opportunities. No CD checking is done and no bounds checking is done.

When the operation wakes up a few seconds later, the <moveto> is considered complete, and
npcclient sends another DR message to stop the movement.

While this operation is very cheap, it is also not very flexible because the coordinates are in the
NPCType and not in the NPC. Thus any NPC using this NPC Type with this command in it is
going to have to be willing to move to this exact 3d coordinate.

== Navigate Operation ==
(Net load: 1, CPU Load 1)

{|
!Parameter
!Type
!Default
!Description
|-
|anim
|string
|
|The animation to use in the navigation.
|-
|failure
|string
|
|The perception to fire if the operation fails.
|}

The <navigate> operation is a placeholder right now and is simpler than it will be in the future. It is
designed to work with <locate> and it moves the NPC in a straight line to the target location found
by the <locate> operation.

Ex: <navigate anim="walk" />

The only thing the operation specifies is the animation to play while moving. It works much like
<moveto> but uses the locate target destination instead of a single fixed location. The only network
overhead are the Start and Stop DR messages, and the only CPU overhead is calculating how long
to sleep between starting and stopping.

For more complex movement the [[Behavior_Operations#Wander_Operation|Wander Operation]] should be
used that will use the path network to navigate. Though if there are no path directly to the location
to where the NPC should go a combination of Wander and Navigate could be used. Like this example
where wander is used to navigate using waypoints and navigate is used navigate into the exact
position of the tavern.

Ex <locate obj="tavern" static="yes" random="yes" range="800" > 
<wander />
<navigate />

== NOP Operation ==
(Net load: 0, CPU Load: 0)

{|
!Parameter
!Type
!Default
!Description
|-
|}
This is a no operation operation. It does absolutely nothing, though each behavior needs to have a set of operations, if nothing else insert this nop operation.

Ex: <nop />

== Percept Operation ==
(Net load: 0, CPU Load: 0)

{|
!Parameter
!Type
!Default
!Description
|-
|event
|string
|
|The name of the perception event to fire. [[NPC Variables]] will be replaced.
|-
|target
|self,tribe,all,target
|self
|The recipient of this perception
|-
|type
|string
|(null)
|The perception type. [[NPC Variables]] will be replaced.
|-
|range
|float
|0.0
|If set to something greater than 0.0 this perception will only be delivered if within that range.
|-
|condition
|string
|
|A [[NPCClient math script]] that if set will be evaluated and any non zero return value will cause the perception event to be fired.
|-
|failed_event
|string
|
|The event to percept if the condition fail. [[NPC Variables]] will be replaced.
|-
|delayed
|float
|0.0
|The amount of time to delay before the perception is fired. [[NPC Variables]] will be replaced.
|}
This operation allows an NPC to fire a custom [[Behaviors_and_Reactions#Perceptions|perception]] to himself.

Ex: <percept event="done wandering" />
<percept event="need help" target="tribe" range="50" />
<percept event="GoToSleep" condition="DiurnalNight" delayed="10" />

== Pickup Operation ==
(Net load: 0, CPU Load: 0)

{|
!Parameter
!Type
!Default
!Description
|-
|obj
|string,perception
|perception
|The object to pick up. (Only perception implemented)
|-
|count
|int
|1
|Number of objects to pick up
|-
|equip
|slot
|
|name of slot to equip the item in (Not implemented)
|}
This operation allows an NPC to pickup an item he finds on the ground, and optionally equip(Not implemented) it if he can use it. Only objects that are pickable will be picked up.

Ex: <pickup obj="perception" count="2" />
<pickup obj="perception" equip="righthand" /> (Not Implemented)

== Release Control Operation ==
(Net load: 0, CPU Load: 0)

{|
!Parameter
!Type
!Default
!Description
|-
|}
Release the control of a player.

Ex: <release_control />

== Reproduce Operation ==
(Net load: 0, CPU Load: 0)

Tribe operation.

{|
!Parameter
!Type
!Default
!Description
|-
|type
|string
|
|The tribe member type for this. [[NPC Variables]] will be replaced.
|}

The reproduce operation will spawn the target with the type given. Tribes will use this to create different types of members (See: [[Tribe_Scripting#Select|Select]] statement in [[Tribe Scripting]]).

Ex: <reproduce type="Warrior" />

To make make a copy of your self

Ex: <locate obj="self" />
<reproduce />

== Resurrect Operation ==
(Net load: 0, CPU Load: 0)

Tribe operation.

{|
!Parameter
!Type
!Default
!Description
|}
No Parameters.

This operation will resurrect a tribe member within the radius of tribe home.

Ex: <resurrect />

This operation should be placed in an behavior that will be executed for dead NPCs. The reaction should
as well have the when_dead flag set.

Ex: <behavior name="Resurrect" completion_decay="200" growth="0" initial="0" when_dead="yes">
<resurrect/>
</behavior>
<react event="tribe:resurrect" behavior="Resurrect" inactive_only="yes" when_dead="yes" />

== Reward Operation ==
(Net load: 0, CPU Load: 0)

Tribe operation.

{|
!Parameter
!Type
!Default
!Description
|-
|resource
|string,tribe:wealth
|Mandatory
|The resource to reward to the tribe. [[NPC Variables]] will be replaced.
|-
|count
|int
|1
|The number of resource to reward.
|}

Will reward a tribe with a resource. Using the special ''tribe:wealth'' keyword will result in a lockup in the tribe for whats the wealth resource.

Ex: <reward resource="Gold Ore" count="2" />
<reward resource="tribe:wealth" />

== Rotate Operation ==
(Net load: 1, CPU Load: 0)

{|
!Parameter
!Type
!Default
!Description
|-
|type
|See table below.
|Mandatory
|The type of rotation operation to perform.
|-
|ang_vel
|float
|0.0
|Angular velocity in degree. If 0 the NPC default angular velocity will be used.
|-
|anim
|string
|
|The animation to use for the rotation operation
|-
|max
|float
|0.0
|For inregion and random a range can be defined.
|-
|min
|float
|0.0
|For inregion and radom a range can be defined.
|-
|value
|float
|0.0
|For absolute and relative a value to add in degrees should be given.
|}

{|
!Type
!Description
|-
|inregion
|
|-
|random
|
|-
|absolute
|
|-
|relative
|
|-
|locatedest
|Face in the direciton of the last located position.
|-
|locaterotation
|Face in the direction of the last located rotation angle.
|-
|target
|
|-
|}

This operation <rotate> can be used to turn to a certain angle, to turn a relative amount, to turn a
random amount or to turn to face a previously located object. This turn is animated, to give a more
realistic look.

Ex: <rotate type="random" min="90" max="270" anim="walk" vel="30" />
<rotate type="locatedest" anim="walk" vel="90" />

The first example here is a random turn of between 90 and 270 degrees from the current heading,
with an angular velocity of 30 degrees per second, while playing the “walk” animation. 30 degrees
per second means that the maximum turn of 270 degrees will take the npc 9 seconds.

In the second example, we have already used our <locate> operation to find a point of interest near
us, and we want to turn to point directly at it. Here a different (faster) angular velocity is specified
but other angles aren’t necessary because they are implied by the current position of the NPC and
the located special destination.

This operation requires a DR update to start and stop the rotation, as the only networking overhead.
CPU overhead is also minimal since npcclient calculates the time required to turn the full amount
and puts this script to sleep for that many msec until the turn is done, then stops it.

== Script Operation ==
(Net load: 0, CPU Load: 0)

{|
!Parameter
!Type
!Default
!Description
|-
|name
|string
|Mandatory
|The name of the script
|}

Run a progression script. Target and Actor env is set for the script at the server.
Ex: <script name="my_script" />

== Sequence Operation ==
(Net load: 0, CPU Load: 0)

{|
!Parameter
!Type
!Default
!Description
|-
|name
|string
|Mandatory
|The name of the sequence to control
|-
|cmd
|start,stop,loop
|Mandatory
|The control of the sequence to issue.
|-
|count
|int
|1
|The number of times to loop the sequence.
|}

Sequences are defined in the map file. They can be started, stopped, or played a number of time with the loop command. This allow the NPC to interact with large animation of world objects. This
could be a winch that should run only when manned, a folding bridge or door that open and close etc.
Ex: <sequence name="winch_up" cmd="start" />

== Set Buffer Operation ==
(Net load: 0, CPU Load: 0)

{|
!Parameter
!Type
!Default
!Description
|-
|buffer
|string
|Mandatory
|The name of the buffer.
|-
|value
|string
|Mandatory
|The value to set for the buffer.
|-
|type
|npc,tribe
|npc
|The type of buffer to set.
|}

Set either a NPC or a Tribe buffer. [[NPC Variables]] $NBUFFER[Buffer] (NPC Buffer) and $TBUFFER[Buffer] (Tribe Buffer) are replaced multiple places with the value of the buffer.

Ex: <set_buffer buffer="Building" value="Small Tent" />

== Share Memories Operation ==
(Net load: 0, CPU Load: 0)

Tribe operation.

{|
!Parameter
!Type
!Default
!Description
|}
No parameters

This operation will share all private memories of the NPC with the tribe. Private memories is created with the [[Behavior_Operations#Memorize_Operation|Memorize Operation]]. They can be retrived by the [[Behavior_Operations#Locate_Operation|Locate Operation]] using tribe:memory:"memory name". Memories can also be crated using the [[Behavior_Operations#Auto_Memorize_Operation|Auto Memorize Operation]].

Ex: <share_memories />

== Sit Operation ==
(Net load: 0, CPU Load: 0)

{|
!Parameter
!Type
!Default
!Description
|}
No parameters.

Sit tells the npc to sit down. Use [[Behavior_Operations#Standup_Operation|standup operation]] to stand up again.
Ex: <sit />

== Standup Operation ==
(Net load: 0, CPU Load: 0)

{|
!Parameter
!Type
!Default
!Description
|}
No parameters.

Standup tells the npc to stand up. Use [[Behavior_Operations#Sit_Operation|sit operation]] to sit down again.
Ex: <standup />

== Talk Operation ==
(Net load: 0, CPU Load: 0)

{|
!Parameter
!Type
!Default
!Description
|-
|target
|boolean
|true
|Talk to current target
|-
|text
|string
|
|The string to send
|-
|public
|boolean
|true
|Should this talk go to everyone in range, or only the target if public=false.
|-
|type
|say,me,my,narrate
|say
|The type of talk.
|-
|command
|string
|
|A perception to send to target if it is a NPC. [[NPC Variables]] will be replaced.
|}

If target is false, this will queue a talk command to the server from the NPC. If target is true and a target exists the same talk command will be sent to the server but a "''command''" perception will be sent to the
target as well. The target will than be able to react to this perception.

Ex: <talk target="true" text="Kneel in front of me." command="kneel" />
<talk type="me" text="is angry" />
<talk target="true" text="This message is only for you" public="false" />

== Teleport Operation ==
(Net load: 0, CPU Load: 0)

{|
!Parameter
!Type
!Default
!Description
|-
|}

Teleport the NPC to the current active location.

Ex: <teleport />

== Transfer Operation ==
(Net load: 0, CPU Load: 0)

{|
!Parameter
!Type
!Default
!Description
|-
|item
|string,tribe:wealth
|Mandatory
|The name of the item to transfer. [[NPC Variables]] will be replaced.
|-
|target
|tribe
|Mandatory
|The target for this transfer.
|-
|count
|int
|-1
|Number of items to transfer. -1 is all items.
|}

Transfere a number of item from one NPC to the target.

Ex: <transfer item="tribe:wealth" target="tribe" />

This example will transfer all of the tribe wealth from the NPC to the tribe.

== Tribe Home Operation ==
(Net load: 0, CPU Load: 0)

Tribe operation.

{|
!Parameter
!Type
!Default
!Description
|}
No Parameters.

Move the tribe home to the last active position of the NPC. This operation will issue a "tribe:home moved" perception to all members of the tribe.

Ex: <tribe_home />

== Tribe Type Operation ==
(Net load: 0, CPU Load: 0)

Tribe operation.

{|
!Parameter
!Type
!Default
!Description
|-
|type
|string
|
|Change tribe member type.
|-
|}
No Parameters.

Change the Tribe Member type of the current NPC to the new type.

Ex: <tribe_type type="Queen" />

== Unbuild Operation ==
(Net load: 0, CPU Load: 0)

Tribe operation.

{|
!Parameter
!Type
!Default
!Description
|-
|}

Unbuild a building. The building has to be targeted.

Ex: <unbild />

== Visible Operation ==
(Net load: 0, CPU Load: 0)

{|
!Parameter
!Type
!Default
!Description
|}
No Parameters.

This operation makes the NPC visible if it where invisible. See [[Behavior_Operations#Invisible_Operation|Invisible Operation]].

Ex: <visible />

== Wait Operation ==
(Net load: 0, CPU Load: 0)

{|
!Parameter
!Type
!Default
!Description
|-
|duration
|float
|Mandatory
|The duration to wait. [[NPC Variables]] will be replaced.
|-
|random
|float
|0.0
|The random duration to wait. [[NPC Variables]] will be replaced.
|-
|anim
|string
|
|The animation to play while waiting.
|}

This operation makes the NPC wait a specified length of time before progressing to the next
operation. It will loop an animation during this time also for you, so you can use it for crafting
actions, guard monitoring, or whatever you need that is a timed animated activity.

Ex: <wait duration="30" anim="stand" />
<wait duration="$NBUFFER[Sit_Duration]" anim="sit" />

This example tells the NPC to play the “stand” animation and do nothing for 30 seconds. This
requires a network DR message with the specified animation, and another to stop the animation
when the duration is over. There is almost no CPU required because the script goes to sleep for the
duration and is woken up automatically at the end.

As with any other scripted operation, this operation can be interrupted if another behavior preempts
this one from completing. So if an npc is playing the above operation, and just standing there for
30 seconds, and is attacked by someone, presumably an attack behavior would become top priority
and the npc would stop waiting and attack back.

This concludes the section on the detailed operations possible with npc scripting today. Now we
will discuss how these operations work together to define behaviors and how behaviors interact
with each other.

== Wander Operation ==
(Net load: 2, CPU Load 1)

{|
!Parameter
!Type
!Default
!Description
|-
|anim
|string
|
|The animation to play while wandering.
|-
|vel
|float
|
|
|-
|random
|boolean
|false
|Turn on never ending random wandering.
|-
|underground
|boolean
|invalid
|If not set ignore underground, set true only wander underground, if set false never wander underground waypoints
|-
|underwater
|boolean
|invalid
|If not set ignore underwater, set true only wander underwater, if set false never wander underwater waypoints
|-
|private
|boolean
|invalid
|If not set ignore private, set true only wander private, if set false never wander private waypoints
|-
|public
|boolean
|invalid
|If not set ignore public, set true only wander public, if set false never wander public waypoints.
|-
|city
|boolean
|invalid
|If not set ignore city, set true only wander city, if set false never wander city waypoints.
|-
|indoor
|boolean
|invalid
|If not set ignore indoor, set true only wander indoor, set false never wander indoor waypoints.
|}

Using random <move> and <rotate> operations works well for creating randomized wandering
behaviors in open, outdoor spaces and scripters should be using that approach there. However, in tighter, indoor areas like the hydlaa sewers or the dungeon, a more specific type of randomness is required.

The <wander> operation makes the npc in question walk between an independently defined set of
“waypoints”. Each waypoint is a 3d coordinate and a tolerance radius. The radius adds a ‘fuzzy’
factor so that multiple npcs sharing the same set of waypoints will not all walk to the exact same
centimeter location. Even in tight locations, a tolerance radius of .5-1m will be a lot better than 0m. Waypoints will be created with the path system available as GM commands.

Ex: <wander anim="walk" />

As you see, the only thing specified by the wander operation is the animation to play while
wandering. The NPC starts by walking to the nearest waypoint to its current location, then follows
the waypoint choices to decide where to go next. This operation will take the NPC to the current active
waypoint as selected by the last [[Behavior_Operations#Locate_Operation|Locate Operation]].

Each waypoint have a set off properties. It can be marked as indoor,underground,underwater,private,public, or city.
If the wander operations in specified with the indoor flag set to true only waypoints with the indoor attribute set to true will be used when wandering. Changing
waypoint attributes can be done by the GM command /path (TBD, Not impemented yet, has to be done in DB for now).'

Each waypoint is connected with a [[Sc_waypoint_linksTable|path]]. The path has a set of properites like TELEPORT, NO_WANDER, ONEWAY.

This operation is very light on the network because it is all straight-line navigation between known,
preset points. There is 1 DR update per point hit by the npc. It is also quite light on CPU power
requirements because the points are known, which means no collision detection has to be done.

One tricky thing about this is that normally non-horizontal walking is accomplished on the client
with collision detection with the ground/stairs. In order to get the most accurate-looking result on
the client, the client DOES do collision detection on these npcs. However, npcclient does simple
linear interpolation between the starting and ending y-coordinates of the 2 waypoints as an
approximation. Thus the server and client will not have the identical y-coordinate in all cases. This
should almost never be noticeable, though.

== Watch Operation ==
(Net load: 0, CPU Load: 0)

{|
!Parameter
!Type
!Default
!Description
|-
|type
|nearest_actor,nearest_npc,nearest_player,owner,target
|Mandatory
|The type of watch to do.
|-
|range
|float
|0.0
|The watch range. A perception will be generated when watched entity move out of range.
|-
|invisible
|boolean
|false
|Set to true to watch invisible entities.
|-
|invincible
|boolean
|false
|Set to true to watch invincible entities.
|-
|search_range
|float
|2.0
|When watching nearest, this range set the limit for how fare that entity can be.
|}

Watch over nearby entities. The "nearest out of range","owner out of range", or "target out of range" perception will be generated when the watched entity move out of range.

Ex: <behavior name="Watch">
<watch type="owner" range="3.0" />
</behavior>
<react event="owner out of range" behavior="follow_chase" />

In this example the NPC will watch the owner. If the owner move out of the watch range 3.0 the "owner out of range" perception will be fired and the new follow_chase behavior will start.

== Work Operation ==
(Net load: 0, CPU Load: 0)

{|
!Parameter
!Type
!Default
!Description
|-
|type
|dig,fish,harvest
|Mandatory
|The type of work to do
|-
|resource
|string,tribe:wealth
|Mandatory
|Resource to work for or by using the keyword tribe:wealth look up in the tribe to find the resource.
|}

Order an NPC to start digging for a resource. The keyword "tribe:wealth" will cause the resource to be looked up in the wealth_resource_nic field in the [[NPC_Behavior_Data_Structures#tribes|tribes]] table if the NPC is part of a tribe.

Ex: <work type="dig" resource="tribe:wealth" />
<work type="dig" resource="Gold Ore" />

[[Category:Engine documents]] [[Category:NPCClient Design]] [[Category:NPCClient Scripting]]

Behavior Operations

2014-08-03T06:35:49Z

Eonwind: /* Melee Operation */

A “Behavior” in NPCClient is a script defined in [[NPC_Behavior_Data_Structures#npcbehave.xml|npcbehave.xml]] to run to make the npc behave a certain way. It is almost like
a state, for AI designers used to state machine npcs. Example behaviors might include “guard
patrol”, “wander in forest”, “fight attackers”, “smith an item”. Before we talk about how
everything fits together we will go over what is possible in npcclient with these detailed behavior
scripts. The following is a list and reference description of each behavior script operation or
command you can use. They are put together in sequences called beaviors as will be described later in [[Behaviors_and_Reactions]].

== Assess Operation ==
(Net load: 1, CPU Load 1)

{|
!Parameter
!Type
!Default
!Description
|-
|physical
|string
|
|The prefix for the physical perception.
|-
|magical
|string
|
|The prefix for the magical perception.
|-
|overall
|string
|
|The perfix for the overall perception.
|}

Each of the physical, magical, or overall will be assessed as; "extremely weaker", "much weaker", "weaker", "equal", "stronger", "much stronger" or "extremely stronger".

Ex: <assess overall="$target overall" />

Typical reaction to catch the response to this would be as shown in the example below. $target is used here to make sure the correct assessment is matched to the same target. A npc will
not react if the target has changed before the response is received.

Ex: <react event="assess equal" type="$target overall" .../>
<react event="assess weaker" type="$target overall" .../>

== Auto Memorize Operation ==
(Net load: 1, CPU Load 1)

{|
!Parameter
!Type
!Default
!Description
|-
|types
|string
|
|Comma separated list of types. "all", can be used to memorize everything to all.
|-
|enable
|bool
|true
|Enables or disables the types.
|-
|}

Auto memorize is a way to turn on and off memorizing of perception. This will be memorize without actually needing to react to thees. Related to the [[Behavior_Operations#Share_Memories_Operation|Share Memories Operation]].

Ex: <auto_memorize types="all" />
<auto_memorize types="Hunting Ground,Marked" />
<auto_memorize types="Marked" enable="false" />

You can use a reaction without a behavior lists to enable the NPC to receive perceptions to be memorized if enabled.

Ex: <react type="location sensed" />

== Build Operation ==
(Net load: 1, CPU Load 1)

{|
!Parameter
!Type
!Default
!Description
|-
|pickupable
|boolean
|false
|If false the building deployed will not be pickupable by the players
|}

Build a building as specified bye the NPC's current held building spot as set by the [[Tribe Scripting]] [[Tribe_Scripting#LocateBuildingSpot|locateBuildingSpot]] function.

Ex: <build />

== Busy Operation ==
(Net load: 1, CPU Load 1)

{|
!Parameter
!Type
!Default
!Description
|-
|}

Mark a NPC as busy. This will cancle the [[Behavior_Operations#Idle_Operation|Idle Operation]]

Ex: <busy />

== Cast Operation ==
(Net load: 1, CPU Load 1)

{|
!Parameter
!Type
!Default
!Description
|-
|spell
|string
|
|The name of the spell to cast.
|-
|k
|float
|1.0
|The kFactor to use when casting the spell.
|}

Cast a spell on the current selected target.

Ex: <cast spell="Flame Strike" k="3.0" />

== Change Brain Operation ==
(Net load: 1, CPU Load 1)

{|
!Parameter
!Type
!Default
!Description
|-
|brain
|string
|
|The name of the brain to load.
|-
|brain
|reload
|
|Reload the standard NPC the brain stored in the sc_npc_definition table.
|-
|}

Change the brain of the current selected target.

Ex: <change_brain brain="Charmed" />

== Chase Operation ==
(Net load: 3, CPU Load 3)

{|
!Parameter
!Type
!Default
!Description
|-
|anim
|string
|
|The animation to use for the chase.
|-
|adaptiv_vel_script
|string
|
|A [[NPCClient math script]] used to adjust the adaptivVelocityScale. Additional variables defined for this script is "Distance" to the target of the chase and "AdaptivVelScale" that is the value used to adjust velocity. 1.1 will increase the velocity by 10%.
|-
|type
|nearest_actor, nearest_npc, nearest_player, owner, target
|
|nearest_* is the nearest entity of that type. target is current target.
|-
|range
|float
|2.0
|The range to search for target of the chase.
|-
|chase_range
|float
| -1
|The range at where the chase should give up and issue a "<target> out of chase" perception. -1 is default to disable the max range check.
|-
|offset
|float
|0.5
|The distance to stop before the target of the chase. [[NPC Variables]] will be replaced. Expressions will be resolved. See [[Behavior_Offset|Offset]] for more details.
|-
|offset_angle
|float
|0.0
|Size of the arc used to distribute the chase when approaching the target. The angle is in degrees.
|-
|offset_relative_heading
|bool
|false
|Make the offset relative to the target heading. [[NPC Variables]] will be replaced. See [[Behavior_Offset|Offset]] for more details.
|-
|vel
|float,$WALK,$RUN
|Default is to use the velocity from the behavior.
|The velocity to use when chasing.
|-
|ang_vel
|float
|
|0 is to use the default from the behavior.
|-
|collision
|string
|collision
|The name of the perception to be used when a collision perception is to be fired.
|-
|out_of_bounds
|string
|out of bounds
|The name of the perception to be used when a out of bounds perception is to be fired.
|-
|in_bounds
|string
|in bounds
|The name of the perception to be used when a in bound perception is to be fired.
|}

Chasing a player is one example where both turning and moving at the same time are required to
give a realistic effect to the behavior. We have <move> and <rotate> but this one does them
together and intelligently to follow a targeted player or entity. Normally, this will be used to get
npc’s to chase after players if players run away during a fight.

Ex: <chase type="enemy" anim="walk" range=”2” />

In this example, the npc will play the animation called “walk” while moving and turning as
appropriate to reduce his range to his most hated enemy. Of course, he is limited by his speed and
if the player can run faster than he can chase, he will never catch the player. An "<target> out of chase" perception
will be fired in this case.

The “type” attribute of the operation can be either “enemy” as shown here, “owner” to follow the
NPC’s owner around, or “nearest” to chase after the nearest player at the time the operation was
initiated. This operation will continue until interrupted by another behavior or until the distance to
the target from the npc is less than the range specified. (2 is the default if no range is specified.)
This operation sends DR messages whenever it turns or changes course, plus the DR messages to
start the forward motion and animation, and to stop them. The CPU load is somewhat heavy
because CD must be performed as the npc is chasing, since his path is not predetermined.

== Circle Operation ==
(Net load: 3, CPU Load: 2)

{|
!Parameter
!Type
!Default
!Description
|-
|anim
|string
|
|The animation to use for the operation.
|-
|radius
|float
|Mandatory, no default value
|Radius to move NPC around with.
|-
|angle
|float
|2PI
|The angle to move. Calculated if 0 and duration not 0.
|-
|duration
|float
|0
|The duration to move in circle. Calculated if 0.
|-
|ang_vel
|float
|
|The angular velocity to use when moving in the circle. Calculated if 0.
|}

Moving the NPC around in a circle. The following example will move the npc around using the velocity defined in the behavior in one complete circle in 10 sec.

Ex: <circle anim="walk" radius=”2” duration="10" />

== Control Operation ==
(Net load: 3, CPU Load: 2)

{|
!Parameter
!Type
!Default
!Description
|-
|}

Take control of an player an move with the player.

Ex: <control />

== Copy_Locate Operation ==
(Net load: 0, CPU Load: 1)

{|
!Parameter
!Type
!Default
!Description
|-
|source
|string
|Mandatory, no default value
|The source locate to copy from.
|-
|destination
|float
|Mandatory, no default value
|The destination locate to copy to.
|}

Copy one locate from source to destination. Built in function like Wander and Navigate use the Active locate.

Ex: <locate obj="some thing" destination="SpecialPlace" />
<copy_locate source="SpecialPlace" destination="Active" />

== Debug Operation ==
(Net load: 0, CPU Load: 0)

{|
!Parameter
!Type
!Default
!Description
|-
|level
|int
|Mandatory
|The level of debug to turn on for current NPC.
|-
|exclusive
|string
|
|Will set on exclusive logging for this NPC.
|}

Turn on and of debug printouts on the server console. Used for debuging of script operations. Level 1-4 Only the biggest events, 5-9 Medium number of events, 10-15 and more is maximum output.

Ex: <debug level=”2” />

== Dequip Operation ==
(Net load: 0, CPU Load: 0)

{|
!Parameter
!Type
!Default
!Description
|-
|slot
|string
|Mandatory
|The slot to dequip an move back into inventory.
|}

Dequip an item held by the NPC in the given slot.

Ex: <dequip slot="righthand" />

== Drop Operation ==
(Net load: 0, CPU Load: 0)

{|
!Parameter
!Type
!Default
!Description
|-
|slot
|string
|Mandatory
|The slot from which the item is to be dropped.
|}

This operation allows an NPC to drop an item he has in inventory on the ground.

Ex: <drop slot="lefthand" />

== Eat Operation ==
(Net load: 0, CPU Load: 0)

{|
!Parameter
!Type
!Default
!Description
|-
|resource
|string,tribe:wealth
|Mandatory
|The resource to reward the tribe when eating.
|}

Simple simulation that the tribe would gain things like flesh from eating at a dead entity withing a range of 1.0. The tribe wealth resource would be read from the wealt_resource_name field in the [[NPC_Behavior_Data_Structures#tribes#tribes|tribes]] table.

Ex: <eat resource="tribe:wealth" />
<eat resource="Flesh" />

== Emote Operation ==
(Net load: 0, CPU Load: 0)

{|
!Parameter
!Type
!Default
!Description
|-
|cmd
|string
|
|The emote cmd to be used as defined in the emote.xml file. Including leading /.
|}
This operation allows an NPC to do an emotion.

Ex: <emote cmd="/greet" />

== Equip Operation ==
(Net load: 0, CPU Load: 0)

{|
!Parameter
!Type
!Default
!Description
|-
|item
|string
|Mandatory
|The name of the item to equip
|-
|slot
|string
|Mandatory
|The sloot to dquip the item in
|-
|count
|int
|1
|The number of items to equip. Will be forced to at least 1.
|}

Equip one item from inventory into the given slot.

Ex: <equip item="Sword" slot="righthand" count="1" />

== Hate List Operation ==
(Net load: 0, CPU Load: 0)

{|
!Parameter
!Type
!Default
!Description
|-
|delta
|float
|
|Add delta to hate list.
|-
|absolute
|float
|
|Set the hate value.
|-
|max
|float
|
|Hate should have a max value
|-
|min
|float
|
|Hate should have a min value
|-
|perception
|bool
|false
|Use perception instead of target to find target.
|}

Adjust the hate list for an npc. The current target or perception target is the target entry for the adjustment.

Ex: <hate_list delta="0.5" max="10.0" />

Ex: <locate obj="perception" />
<hate_list absolute="5.0" />

Is equvivalent with:

<hate_list perception="yes" absolute="5.0" />

== Idle Operation ==
(Net load: 1, CPU Load 1)

{|
!Parameter
!Type
!Default
!Description
|-
|}

Mark a NPC as idle. This operation cancle the [[Behavior_Operations#Busy_Operation|Busy operation]].

Ex: <idle />

== Invisible Operation ==
(Net load: 0, CPU Load: 0)

{|
!Parameter
!Type
!Default
!Description
|}
No parameters.

This operation makes the NPC invisible through the toggle visibility command. See [[Behavior_Operations#Visible_Operation|Visible Operation]].

Ex: <invisible />

== Locate Operation ==
(Net load: 0, CPU Load 0)

{|
!Parameter
!Type
!Default
!Description
|-
|obj
|See table below.
|Mandatory
|The object to locate. [[NPC Variables]] will be replaced.
|-
|failure
|string
|
|A perception to fire if fails to locate the given obj.
|-
|static
|boolean
|false
|For location the search could be made static. Se description for more details.
|-
|range
|float
| -1
|The maximum range to locate within. -1 represents infinite.
|-
|random
|boolean
|false
|If true a random return within the radius will be made. Otherwise the nearest entry will be returned.
|-
|outside_region
|boolean
|false
|Set this to true if the locate operation should consider entities outside region as well if a region is defined. [[NPC Variables]] will be replaced.
|-
|invisible
|boolean
|false
|Set this to true if the locate operation should consider invisible objects
|-
|invincible
|boolean
|false
|Set this to true if the locate operation should consider invincible objects.
|-
|destination
|string
|Active
|Set the destination [[NPC locate location]]. [[NPC Variables]] will be replaced.
|}

Obj can be one of the following:
{|
!obj
!Description
|-
|<string>
|Locate a location. This is the default if none of the following obj types is matched.
|-
|actor
|Located nearest actor
|-
|building_spot
|Locate a building spot from the npc's building spot.
|-
|dead
|Nearest dead actor
|-
|entity:name:<name>
|Entity with given name
|-
|entity:pid:<pid>
|Entity with given pid
|-
|friend
|Nearest visible friend (NPC)
|-
|local_region
|Locate region in current sector.
|-
|ownbuffer
|Locate the own buffer.
|-
|owner
|Locate the owner, if this NPC is owned (Pets and stuff)
|-
|perception
|The location of the last received perception.
|-
|player
|Nearest player
|-
|point
|Random point
|-
|region
|Locate a random point within the region of the NPC.
|-
|self
|Locate your self
|-
|spawn
|Spawn location of the npc.
|-
|target
|Locate a target. The target will be the most hated from the NPC [[hate list]].
|-
|tribe:home
|Locate the npcs [[Tribes|tribe]] home place.
|-
|tribe:memory:string
|Locate something from the [[Tribes]] memory. See the [[Behavior_Operations#ShareMemories_Operation|ShareMemories]] and [[Behavior_Operations#Memorize_Operation|Memorize]] operation.
|-
|tribe:resource
|Locate a resource location from the memory of the [[Tribes|tribe]].
|-
|tribe:target
|Locate the most hated target for this tribe. The target will be the most hated from all the NPCs [[hate list]] in the tribe.
|-
|waypoint
|Will locate a waypoint.
|-
|waypoint:group:string
|Locate a waypoint from a given group
|-
|waypoint:name:string
|Locate a waypoint by name.
|}

This operation is one of the more flexible and crucial operations in npc scripting. It allows the
scripter to have his npc “find” a certain thing or type of thing, and remember that location for other
scripting commands later such as turning, moving or attacking. The operation will store the position
found in the NPCs as active postion and calcualte the neares waypoint and store that in the active_waypoint.
For location it is possible to make the first search a static search. So that the first time the npc
do this operation it could search for a "Baker" location. The next time the operation is used it will
use the results of the first time even if there might be Bakers closer at that time.

Ex: <locate obj="perception" />
<locate obj="target" />
<locate obj="furnace" range="50" />
<locate obj="waypoint" failure="no waypoint found" />

Example 1 finds the last perception received by the current npc and sets the active target location to
the location of that perception. This allows npcs who receive “Talk” perceptions to turn to face the
person talking to them. It allows npcs who have a spell cast on them to turn to face the caster, and
so on.

Example 2 finds the location of the currently active “enemy” of the NPC, which is the entity with
the highest score on the NPC’s [[hate list]], and sets that location as the active target location for other
operations. This allows NPCs to turn to face the person they are attacking, chase attackers who are
retreating, etc.

Example 3 uses predefined lists of named location types to find the closest one to the npc and sets
the active target location to the coordinates specified there. This is the most subtle of the 3, and in
some ways the most powerful so it deserves more discussion. Consider the following pictures:

http://www.planeshift.it/download/docs/npc_pic1.png

Here we have two blacksmith shops with similar items but different layouts. They might be side by
side or they might be in entirely different cities. LocTypes specify a list of Anvil locations, or a list
of Furnace locations, as marked by the stars on these pictures. When Example 3 says to locate the
nearest furnace, an NPC in smithy #1 will find his furnace while the NPC in smithy #2 will find his
own furnace. They will be able to share one script for moving between these points and acting like
a real blacksmith in their own location, even though they are in totally different smithy shops.

This will become even more important when we implement player housing and player shops. It
will be possible with the scripts we have already today for a player to build the blacksmith shop of
his own design and for him to hire an npc smith to come work in that shop. The Smith NPC he
hired will be able to “know” how to get around the player’s shop magically.

Something intended to be supported here but not actually implemented yet was the ability to locate
named objects or entities as well, so an NPC could locate a sword someone dropped on the ground
and things like this. Better integration with the entity system and perhaps integration with data
from the maps themselves rather than externally generated lists of points could make this even more
powerful.

== Loop Operation ==
(Net load: 0, CPU Load: 0)

{|
!Parameter
!Type
!Default
!Description
|-
|iterations
|int
|0
|Number of iterations to do in this loop. No iterations attribute or a value of -1 is loop forever.
|}

This operation allows you to loop a section of your script a certain number of times. This is mostly
useful for city npcs such as smiths and tavern barkeeps. Behaviors in general will loop if not
replaced by another behavior, but if you want subloops within the script, this is an easy way to do it.

Ex:
<loop iterations="20">
<locate obj="fire" range="10" />
<navigate anim="walk" />
<wait anim="stand" duration="30" />
<locate obj="anvil" range="10" />
<navigate anim="walk" />
<wait anim="hammer" duration="20" />
</loop>

In this example, the blacksmith is scripted to walk back and forth between his fire and his anvil 20
times before moving on to the next operation in his script to act like a blacksmith.

This operation does not affect the network at all and does not have CPU overhead.

== Melee Operation ==
(Net load: 1, CPU Load: 2)

{|
!Parameter
!Type
!Default
!Description
|-
|seek_range
|float
|0.0
|The range to search for new targets in melee
|-
|melee_range
|float[0.5-3.0]
|3.0
|The range where melee can be done. Max 3.0 to prevent npc/server conflicts.
|-
|attack_type
|string
|default
|The name of a special attack defined in the 'attacks' table. If this attribute is not set an ordinary attack will be queued. [[NPC Variables]] will be replaced.
|-
|stance
|string
|normal
|The stance to use when attacking. [[NPC Variables]] will be replaced.
|-
|tribe
|boolean
|false
|When set to true the tribe [[hate list]] will be used to select target. If true and NPC not member of a tribe the NPC [[hate list]] will be used as a fall back. [[NPC Variables]] will be replaced.
|-
|outside_region
|boolean
|false
|Set to true to fight even outside region if a region is defined. [[NPC Variables]] will be replaced.
|-
|invisible
|boolean
|false
|Will melee operation fight invisible entities
|-
|invincible
|boolean
|false
|Will melee operation fight invincible entities.
|}

The <melee> operation handles starting and ending fights for the NPC. It finds the most hated
enemy in range and tells the server to attack him. If there is no enemy in range, it finds the nearest
enemy that it does hate and prepares to chase him.

Ex: <melee seek_range="10" melee_range="3" />

The “melee_range” attribute specifies how far away the enemies can be while still fighting without
the npc needing to move. 3 meters is the maximum of how far away a player can be to hit the npc
also, so in most cases this is a good value. The “seek_range” specifies how far around himself the
npc should look for other enemies if none are found within the melee_range. If there are no
enemies within the seek_range, the npc starts to calm down and his current behavior (making his
‘melee’ operation active) is lowered in priority. If an enemy is found within the seek_range, the
NPC’s active enemy is set to this found person so the <chase type=”enemy”> operation can run
after him.

This operation’s only network load is informing the server of its melee target and attack mode, and
switching these occasionally as people die, etc. The CPU load is in periodically (2x per second)
checking the [[hate list]] for the NPC to make sure the most hated person is being fought. If no one on
the [[hate list]] is within the melee range, a more expensive operation is done to find any hated people
within the seek_range, but this operation isn’t performed very often.

See the NPC [[hate list]] for further details about the [[hate list]].

== Memorize Operation ==
(Net load: 0, CPU Load: 0)

Tribe operation.

{|
!Parameter
!Type
!Default
!Description
|}
No Parameters.

This is an operation that only will have effect for tribe members. The NPC will memorize the current perception as a private memory.
See the [[Behavior_Operations#ShareMemories_Operation|ShareMemories Operation]] for how to make the memories known to other members of the tribe.

Ex: <memorize />

== Move Operation ==
(Net load: 0, CPU Load: 5)

{|
!Parameter
!Type
!Default
!Description
|-
|anim
|string
|
|The animation to use when moving.
|-
|duration
|float
|0.0
|The duration this move should have. The default is probably no good.
|-
|vel
|float,$WALK,$RUN
|Default is to use the velocity from the behavior.
|The velocity to use when moving.
|-
|ang_vel
|float
|0.0
|By defining a ang_vel the movement will be much like the [[Behavior_Operations#Circle_Operation|Circle Operation]].
|-
|collision
|string
|collision
|The name of the perception to be used when a collision perception is to be fired.
|-
|out_of_bounds
|string
|out of bounds
|The name of the perception to be used when a out of bounds perception is to be fired.
|-
|in_bounds
|string
|in bounds
|The name of the perception to be used when a in bound perception is to be fired.
|}

The most basic behavior operation in npcclient is <move>. It simply tells the npc to move forward
at a certain speed in the direction he is currently pointing, and to play a named animation while
doing so.

Ex: <move vel="1" anim="walk" />
<move anim="walk" vel="$WALK" out_of_bounds="move_outside_region" />

This operation has no preset end or duration, so it will go until the behavior is preempted by another
higher priority behavior such as the one to turn, triggered by a collision perception. (See the next
section for a more detailed explanation of how behaviors pre-empt each other and change
priorities.)

This operation has low networking overhead since all it does is trigger a single Dead Reckoning
(DR) update to start the forward motion. It does have CPU overhead during the entire duration of it
running though, since there is no way for npcclient to know what it might hit along this path. Every
500msec this operation wakes up and checks its latest movement for collisions, generating a
perception called “collision” for the behavior script to react to. Also at each 500msec checkpoint,
it checks the owner NPC’s region setting (such as “sunny meadow” in the example above), and if
there is a region specifed, the operation checks its current position to make sure the NPC is still “in
bounds”. If the NPC has made it outside the region in the last half second, it fires a perception
called “out of bounds”. It will not fire another “out of bounds” perception until an “in bounds”
perception has been detected.

== MovePath Operation ==
(Net load: 2, CPU Load: 3)

{|
!Parameter
!Type
!Default
!Description
|-
|path
|string
|Mandatory
|The name of the path to use for the movement.
|-
|anim
|string
|
|The name of the animation to use for this movement
|-
|direction
|FORWARD,REVERSE
|FORWARD
|The direction to move along the path
|}

This operation tell the NPC to move in a predefined path. The path is a named entity in the path network.
From a start waypoint to and end waypoint with any number of path points in between. The path will either
be followed in the forward or reverse direction. Upon start of this the npc will be forced to the
start position of the path. The following example will move the NPC the reverse path to the clock tower.
Ex: <movepath path="Clock Tower" direction="REVERSE" />

Ex: <behavior "Ring the Clock">
<movepath path="Clock Tower" />
<wait anim="Ring the Clock" />
<movepath path="Clock Tower" direction="REVERSE" />
</behavior>

Current implementation will extrapolate on the server and send updates to the client.

The following old description isn't quite in line with current implementation. Sure it should be possible
to send the path to the client and do the math there. Suggest to include that as a option to the current
implementation. With today implementation the movement could be interrupted and it will stop when finished
with the path. To get the looping behavior either the behavior should be set to looping or a loop should
be created.

--Start old description:

This operation is another very easy one: <movepath>. It tells the npc to set its preset path to a 3d
spline specified in another file by name. Each client will take care of playing the right animations
along the spline as the npc progresses. The intent of this operation was really simply for birds to be
able to fly through the air as decoration rather than any gameplay reason. Aside from birds, most
creatures do not follow 3d spline paths in their normal behaviors.

Ex: <movepath path="bird1" />

This operation has no present end or duration, and will actually loop if not stopped by another
behavior.

This operation has almost no network overhead, as the packed bytes of the spline are sent 1 time
across the network to anyone needing to see this npc, and no other network activity happens until
the <movepath> operation is interrupted.

This operation also has almost zero CPU overhead, because there is no collision detection and no
bounds checking on this type of movement. The reasoning is that since predefined paths are being
followed, it is up to the designer/scripter to ensure that the path goes where they want it to and does
not hit anything along the way.

--End old description

== MoveTo Operation ==
(Net load: 0, CPU Load: 3)

{|
!Parameter
!Type
!Default
!Description
|-
|x
|float
|0.0
|X-coordinate to move to
|-
|y
|float
|0.0
|Y-coordinate to move to
|-
|z
|float
|0.0
|Z-coordinate to move to
|-
|vel
|float,$WALK,$RUN
|Default is to use the velocity from the behavior.
|The velocity to use when moving.
|-
|anim
|string
|
|The name of the animation to use
|}

This operation tells the npc to turn and face a certain point in
3d space, then move in a straight line to that location at a certain speed. The turn is not animated,
so if you want an animated turn, you need a <rotate> op in front of this (see below). <moveto> also
specifies an animation name to play while performing this move.

Ex: <moveto x="-38" y="0" z="-169" anim="walk" />

When this operation is executed, the angle necessary to point in the right direction towards this 3d
coordinate is calculated and the DR message to start the anim, start the movement and set the
rotation angle so it will look correct is sent. Then the operation calculates the time it will take to
traverse the distance at the specified speed and suspends itself for that length of time before waking
up and completing. Thus, this operation has zero processing during these ½ second update
opportunities. No CD checking is done and no bounds checking is done.

When the operation wakes up a few seconds later, the <moveto> is considered complete, and
npcclient sends another DR message to stop the movement.

While this operation is very cheap, it is also not very flexible because the coordinates are in the
NPCType and not in the NPC. Thus any NPC using this NPC Type with this command in it is
going to have to be willing to move to this exact 3d coordinate.

== Navigate Operation ==
(Net load: 1, CPU Load 1)

{|
!Parameter
!Type
!Default
!Description
|-
|anim
|string
|
|The animation to use in the navigation.
|-
|failure
|string
|
|The perception to fire if the operation fails.
|}

The <navigate> operation is a placeholder right now and is simpler than it will be in the future. It is
designed to work with <locate> and it moves the NPC in a straight line to the target location found
by the <locate> operation.

Ex: <navigate anim="walk" />

The only thing the operation specifies is the animation to play while moving. It works much like
<moveto> but uses the locate target destination instead of a single fixed location. The only network
overhead are the Start and Stop DR messages, and the only CPU overhead is calculating how long
to sleep between starting and stopping.

For more complex movement the [[Behavior_Operations#Wander_Operation|Wander Operation]] should be
used that will use the path network to navigate. Though if there are no path directly to the location
to where the NPC should go a combination of Wander and Navigate could be used. Like this example
where wander is used to navigate using waypoints and navigate is used navigate into the exact
position of the tavern.

Ex <locate obj="tavern" static="yes" random="yes" range="800" > 
<wander />
<navigate />

== NOP Operation ==
(Net load: 0, CPU Load: 0)

{|
!Parameter
!Type
!Default
!Description
|-
|}
This is a no operation operation. It does absolutely nothing, though each behavior needs to have a set of operations, if nothing else insert this nop operation.

Ex: <nop />

== Percept Operation ==
(Net load: 0, CPU Load: 0)

{|
!Parameter
!Type
!Default
!Description
|-
|event
|string
|
|The name of the perception event to fire. [[NPC Variables]] will be replaced.
|-
|target
|self,tribe,all,target
|self
|The recipient of this perception
|-
|type
|string
|(null)
|The perception type. [[NPC Variables]] will be replaced.
|-
|range
|float
|0.0
|If set to something greater than 0.0 this perception will only be delivered if within that range.
|-
|condition
|string
|
|A [[NPCClient math script]] that if set will be evaluated and any non zero return value will cause the perception event to be fired.
|-
|failed_event
|string
|
|The event to percept if the condition fail. [[NPC Variables]] will be replaced.
|-
|delayed
|float
|0.0
|The amount of time to delay before the perception is fired. [[NPC Variables]] will be replaced.
|}
This operation allows an NPC to fire a custom [[Behaviors_and_Reactions#Perceptions|perception]] to himself.

Ex: <percept event="done wandering" />
<percept event="need help" target="tribe" range="50" />
<percept event="GoToSleep" condition="DiurnalNight" delayed="10" />

== Pickup Operation ==
(Net load: 0, CPU Load: 0)

{|
!Parameter
!Type
!Default
!Description
|-
|obj
|string,perception
|perception
|The object to pick up. (Only perception implemented)
|-
|count
|int
|1
|Number of objects to pick up
|-
|equip
|slot
|
|name of slot to equip the item in (Not implemented)
|}
This operation allows an NPC to pickup an item he finds on the ground, and optionally equip(Not implemented) it if he can use it. Only objects that are pickable will be picked up.

Ex: <pickup obj="perception" count="2" />
<pickup obj="perception" equip="righthand" /> (Not Implemented)

== Release Control Operation ==
(Net load: 0, CPU Load: 0)

{|
!Parameter
!Type
!Default
!Description
|-
|}
Release the control of a player.

Ex: <release_control />

== Reproduce Operation ==
(Net load: 0, CPU Load: 0)

Tribe operation.

{|
!Parameter
!Type
!Default
!Description
|-
|type
|string
|
|The tribe member type for this. [[NPC Variables]] will be replaced.
|}

The reproduce operation will spawn the target with the type given. Tribes will use this to create different types of members (See: [[Tribe_Scripting#Select|Select]] statement in [[Tribe Scripting]]).

Ex: <reproduce type="Warrior" />

To make make a copy of your self

Ex: <locate obj="self" />
<reproduce />

== Resurrect Operation ==
(Net load: 0, CPU Load: 0)

Tribe operation.

{|
!Parameter
!Type
!Default
!Description
|}
No Parameters.

This operation will resurrect a tribe member within the radius of tribe home.

Ex: <resurrect />

This operation should be placed in an behavior that will be executed for dead NPCs. The reaction should
as well have the when_dead flag set.

Ex: <behavior name="Resurrect" completion_decay="200" growth="0" initial="0" when_dead="yes">
<resurrect/>
</behavior>
<react event="tribe:resurrect" behavior="Resurrect" inactive_only="yes" when_dead="yes" />

== Reward Operation ==
(Net load: 0, CPU Load: 0)

Tribe operation.

{|
!Parameter
!Type
!Default
!Description
|-
|resource
|string,tribe:wealth
|Mandatory
|The resource to reward to the tribe. [[NPC Variables]] will be replaced.
|-
|count
|int
|1
|The number of resource to reward.
|}

Will reward a tribe with a resource. Using the special ''tribe:wealth'' keyword will result in a lockup in the tribe for whats the wealth resource.

Ex: <reward resource="Gold Ore" count="2" />
<reward resource="tribe:wealth" />

== Rotate Operation ==
(Net load: 1, CPU Load: 0)

{|
!Parameter
!Type
!Default
!Description
|-
|type
|See table below.
|Mandatory
|The type of rotation operation to perform.
|-
|ang_vel
|float
|0.0
|Angular velocity in degree. If 0 the NPC default angular velocity will be used.
|-
|anim
|string
|
|The animation to use for the rotation operation
|-
|max
|float
|0.0
|For inregion and random a range can be defined.
|-
|min
|float
|0.0
|For inregion and radom a range can be defined.
|-
|value
|float
|0.0
|For absolute and relative a value to add in degrees should be given.
|}

{|
!Type
!Description
|-
|inregion
|
|-
|random
|
|-
|absolute
|
|-
|relative
|
|-
|locatedest
|Face in the direciton of the last located position.
|-
|locaterotation
|Face in the direction of the last located rotation angle.
|-
|target
|
|-
|}

This operation <rotate> can be used to turn to a certain angle, to turn a relative amount, to turn a
random amount or to turn to face a previously located object. This turn is animated, to give a more
realistic look.

Ex: <rotate type="random" min="90" max="270" anim="walk" vel="30" />
<rotate type="locatedest" anim="walk" vel="90" />

The first example here is a random turn of between 90 and 270 degrees from the current heading,
with an angular velocity of 30 degrees per second, while playing the “walk” animation. 30 degrees
per second means that the maximum turn of 270 degrees will take the npc 9 seconds.

In the second example, we have already used our <locate> operation to find a point of interest near
us, and we want to turn to point directly at it. Here a different (faster) angular velocity is specified
but other angles aren’t necessary because they are implied by the current position of the NPC and
the located special destination.

This operation requires a DR update to start and stop the rotation, as the only networking overhead.
CPU overhead is also minimal since npcclient calculates the time required to turn the full amount
and puts this script to sleep for that many msec until the turn is done, then stops it.

== Script Operation ==
(Net load: 0, CPU Load: 0)

{|
!Parameter
!Type
!Default
!Description
|-
|name
|string
|Mandatory
|The name of the script
|}

Run a progression script. Target and Actor env is set for the script at the server.
Ex: <script name="my_script" />

== Sequence Operation ==
(Net load: 0, CPU Load: 0)

{|
!Parameter
!Type
!Default
!Description
|-
|name
|string
|Mandatory
|The name of the sequence to control
|-
|cmd
|start,stop,loop
|Mandatory
|The control of the sequence to issue.
|-
|count
|int
|1
|The number of times to loop the sequence.
|}

Sequences are defined in the map file. They can be started, stopped, or played a number of time with the loop command. This allow the NPC to interact with large animation of world objects. This
could be a winch that should run only when manned, a folding bridge or door that open and close etc.
Ex: <sequence name="winch_up" cmd="start" />

== Set Buffer Operation ==
(Net load: 0, CPU Load: 0)

{|
!Parameter
!Type
!Default
!Description
|-
|buffer
|string
|Mandatory
|The name of the buffer.
|-
|value
|string
|Mandatory
|The value to set for the buffer.
|-
|type
|npc,tribe
|npc
|The type of buffer to set.
|}

Set either a NPC or a Tribe buffer. [[NPC Variables]] $NBUFFER[Buffer] (NPC Buffer) and $TBUFFER[Buffer] (Tribe Buffer) are replaced multiple places with the value of the buffer.

Ex: <set_buffer buffer="Building" value="Small Tent" />

== Share Memories Operation ==
(Net load: 0, CPU Load: 0)

Tribe operation.

{|
!Parameter
!Type
!Default
!Description
|}
No parameters

This operation will share all private memories of the NPC with the tribe. Private memories is created with the [[Behavior_Operations#Memorize_Operation|Memorize Operation]]. They can be retrived by the [[Behavior_Operations#Locate_Operation|Locate Operation]] using tribe:memory:"memory name". Memories can also be crated using the [[Behavior_Operations#Auto_Memorize_Operation|Auto Memorize Operation]].

Ex: <share_memories />

== Sit Operation ==
(Net load: 0, CPU Load: 0)

{|
!Parameter
!Type
!Default
!Description
|}
No parameters.

Sit tells the npc to sit down. Use [[Behavior_Operations#Standup_Operation|standup operation]] to stand up again.
Ex: <sit />

== Standup Operation ==
(Net load: 0, CPU Load: 0)

{|
!Parameter
!Type
!Default
!Description
|}
No parameters.

Standup tells the npc to stand up. Use [[Behavior_Operations#Sit_Operation|sit operation]] to sit down again.
Ex: <standup />

== Talk Operation ==
(Net load: 0, CPU Load: 0)

{|
!Parameter
!Type
!Default
!Description
|-
|target
|boolean
|true
|Talk to current target
|-
|text
|string
|
|The string to send
|-
|public
|boolean
|true
|Should this talk go to everyone in range, or only the target if public=false.
|-
|type
|say,me,my,narrate
|say
|The type of talk.
|-
|command
|string
|
|A perception to send to target if it is a NPC. [[NPC Variables]] will be replaced.
|}

If target is false, this will queue a talk command to the server from the NPC. If target is true and a target exists the same talk command will be sent to the server but a "''command''" perception will be sent to the
target as well. The target will than be able to react to this perception.

Ex: <talk target="true" text="Kneel in front of me." command="kneel" />
<talk type="me" text="is angry" />
<talk target="true" text="This message is only for you" public="false" />

== Teleport Operation ==
(Net load: 0, CPU Load: 0)

{|
!Parameter
!Type
!Default
!Description
|-
|}

Teleport the NPC to the current active location.

Ex: <teleport />

== Transfer Operation ==
(Net load: 0, CPU Load: 0)

{|
!Parameter
!Type
!Default
!Description
|-
|item
|string,tribe:wealth
|Mandatory
|The name of the item to transfer. [[NPC Variables]] will be replaced.
|-
|target
|tribe
|Mandatory
|The target for this transfer.
|-
|count
|int
|-1
|Number of items to transfer. -1 is all items.
|}

Transfere a number of item from one NPC to the target.

Ex: <transfer item="tribe:wealth" target="tribe" />

This example will transfer all of the tribe wealth from the NPC to the tribe.

== Tribe Home Operation ==
(Net load: 0, CPU Load: 0)

Tribe operation.

{|
!Parameter
!Type
!Default
!Description
|}
No Parameters.

Move the tribe home to the last active position of the NPC. This operation will issue a "tribe:home moved" perception to all members of the tribe.

Ex: <tribe_home />

== Tribe Type Operation ==
(Net load: 0, CPU Load: 0)

Tribe operation.

{|
!Parameter
!Type
!Default
!Description
|-
|type
|string
|
|Change tribe member type.
|-
|}
No Parameters.

Change the Tribe Member type of the current NPC to the new type.

Ex: <tribe_type type="Queen" />

== Unbuild Operation ==
(Net load: 0, CPU Load: 0)

Tribe operation.

{|
!Parameter
!Type
!Default
!Description
|-
|}

Unbuild a building. The building has to be targeted.

Ex: <unbild />

== Visible Operation ==
(Net load: 0, CPU Load: 0)

{|
!Parameter
!Type
!Default
!Description
|}
No Parameters.

This operation makes the NPC visible if it where invisible. See [[Behavior_Operations#Invisible_Operation|Invisible Operation]].

Ex: <visible />

== Wait Operation ==
(Net load: 0, CPU Load: 0)

{|
!Parameter
!Type
!Default
!Description
|-
|duration
|float
|Mandatory
|The duration to wait. [[NPC Variables]] will be replaced.
|-
|random
|float
|0.0
|The random duration to wait. [[NPC Variables]] will be replaced.
|-
|anim
|string
|
|The animation to play while waiting.
|}

This operation makes the NPC wait a specified length of time before progressing to the next
operation. It will loop an animation during this time also for you, so you can use it for crafting
actions, guard monitoring, or whatever you need that is a timed animated activity.

Ex: <wait duration="30" anim="stand" />
<wait duration="$NBUFFER[Sit_Duration]" anim="sit" />

This example tells the NPC to play the “stand” animation and do nothing for 30 seconds. This
requires a network DR message with the specified animation, and another to stop the animation
when the duration is over. There is almost no CPU required because the script goes to sleep for the
duration and is woken up automatically at the end.

As with any other scripted operation, this operation can be interrupted if another behavior preempts
this one from completing. So if an npc is playing the above operation, and just standing there for
30 seconds, and is attacked by someone, presumably an attack behavior would become top priority
and the npc would stop waiting and attack back.

This concludes the section on the detailed operations possible with npc scripting today. Now we
will discuss how these operations work together to define behaviors and how behaviors interact
with each other.

== Wander Operation ==
(Net load: 2, CPU Load 1)

{|
!Parameter
!Type
!Default
!Description
|-
|anim
|string
|
|The animation to play while wandering.
|-
|vel
|float
|
|
|-
|random
|boolean
|false
|Turn on never ending random wandering.
|-
|underground
|boolean
|invalid
|If not set ignore underground, set true only wander underground, if set false never wander underground waypoints
|-
|underwater
|boolean
|invalid
|If not set ignore underwater, set true only wander underwater, if set false never wander underwater waypoints
|-
|private
|boolean
|invalid
|If not set ignore private, set true only wander private, if set false never wander private waypoints
|-
|public
|boolean
|invalid
|If not set ignore public, set true only wander public, if set false never wander public waypoints.
|-
|city
|boolean
|invalid
|If not set ignore city, set true only wander city, if set false never wander city waypoints.
|-
|indoor
|boolean
|invalid
|If not set ignore indoor, set true only wander indoor, set false never wander indoor waypoints.
|}

Using random <move> and <rotate> operations works well for creating randomized wandering
behaviors in open, outdoor spaces and scripters should be using that approach there. However, in tighter, indoor areas like the hydlaa sewers or the dungeon, a more specific type of randomness is required.

The <wander> operation makes the npc in question walk between an independently defined set of
“waypoints”. Each waypoint is a 3d coordinate and a tolerance radius. The radius adds a ‘fuzzy’
factor so that multiple npcs sharing the same set of waypoints will not all walk to the exact same
centimeter location. Even in tight locations, a tolerance radius of .5-1m will be a lot better than 0m. Waypoints will be created with the path system available as GM commands.

Ex: <wander anim="walk" />

As you see, the only thing specified by the wander operation is the animation to play while
wandering. The NPC starts by walking to the nearest waypoint to its current location, then follows
the waypoint choices to decide where to go next. This operation will take the NPC to the current active
waypoint as selected by the last [[Behavior_Operations#Locate_Operation|Locate Operation]].

Each waypoint have a set off properties. It can be marked as indoor,underground,underwater,private,public, or city.
If the wander operations in specified with the indoor flag set to true only waypoints with the indoor attribute set to true will be used when wandering. Changing
waypoint attributes can be done by the GM command /path (TBD, Not impemented yet, has to be done in DB for now).'

Each waypoint is connected with a [[Sc_waypoint_linksTable|path]]. The path has a set of properites like TELEPORT, NO_WANDER, ONEWAY.

This operation is very light on the network because it is all straight-line navigation between known,
preset points. There is 1 DR update per point hit by the npc. It is also quite light on CPU power
requirements because the points are known, which means no collision detection has to be done.

One tricky thing about this is that normally non-horizontal walking is accomplished on the client
with collision detection with the ground/stairs. In order to get the most accurate-looking result on
the client, the client DOES do collision detection on these npcs. However, npcclient does simple
linear interpolation between the starting and ending y-coordinates of the 2 waypoints as an
approximation. Thus the server and client will not have the identical y-coordinate in all cases. This
should almost never be noticeable, though.

== Watch Operation ==
(Net load: 0, CPU Load: 0)

{|
!Parameter
!Type
!Default
!Description
|-
|type
|nearest_actor,nearest_npc,nearest_player,owner,target
|Mandatory
|The type of watch to do.
|-
|range
|float
|0.0
|The watch range. A perception will be generated when watched entity move out of range.
|-
|invisible
|boolean
|false
|Set to true to watch invisible entities.
|-
|invincible
|boolean
|false
|Set to true to watch invincible entities.
|-
|search_range
|float
|2.0
|When watching nearest, this range set the limit for how fare that entity can be.
|}

Watch over nearby entities. The "nearest out of range","owner out of range", or "target out of range" perception will be generated when the watched entity move out of range.

Ex: <behavior name="Watch">
<watch type="owner" range="3.0" />
</behavior>
<react event="owner out of range" behavior="follow_chase" />

In this example the NPC will watch the owner. If the owner move out of the watch range 3.0 the "owner out of range" perception will be fired and the new follow_chase behavior will start.

== Work Operation ==
(Net load: 0, CPU Load: 0)

{|
!Parameter
!Type
!Default
!Description
|-
|type
|dig,fish,harvest
|Mandatory
|The type of work to do
|-
|resource
|string,tribe:wealth
|Mandatory
|Resource to work for or by using the keyword tribe:wealth look up in the tribe to find the resource.
|}

Order an NPC to start digging for a resource. The keyword "tribe:wealth" will cause the resource to be looked up in the wealth_resource_nic field in the [[NPC_Behavior_Data_Structures#tribes|tribes]] table if the NPC is part of a tribe.

Ex: <work type="dig" resource="tribe:wealth" />
<work type="dig" resource="Gold Ore" />

[[Category:Engine documents]] [[Category:NPCClient Design]] [[Category:NPCClient Scripting]]