AI:BrainTutorialLua - Revision history

Jabantiz at 04:54, 30 August 2013

2013-08-30T04:54:01Z

Jabantiz at 04:30, 30 August 2013

2013-08-30T04:30:56Z

Jabantiz at 04:26, 30 August 2013

2013-08-30T04:26:30Z

Jabantiz at 03:45, 30 August 2013

2013-08-30T03:45:41Z

Jabantiz at 02:41, 30 August 2013

2013-08-30T02:41:12Z

Jabantiz at 01:02, 30 August 2013

2013-08-30T01:02:51Z

Jabantiz: Created page with "Creating a new brain in lua will allow you to override the default AI, it will not allow you to extend the default AI however. You can change the script and reload it without ha..."

2013-08-30T00:53:09Z

Created page with "Creating a new brain in lua will allow you to override the default AI, it will not allow you to extend the default AI however. You can change the script and reload it without ha..."

New page

Creating a new brain in lua will allow you to override the default AI, it will not allow you to extend the default AI however. You can change the script and reload it without having to recompile and restart the server however. In this tutorial I will show you how to create a lua AI that will duplicate the default AI code in the server core.

=Set Up the Spawn Script=
First thing you need to do is tell the spawn to use the AI defined in the lua script, this is done by calling [[LUA:SetLuaBrain|SetLuaBrain()]], you can also tell the script how often the AI code needs to run with [[LUA:SetBrainTick|SetBrainTick()]]
<pre>
function spawn(NPC)
SetLuaBrain(NPC)
SetBrainTick(NPC, 200)
end
</pre>

You will also want to make sure the brain is set when they respawn
<pre>
function respawn(NPC)
spawn(NPC)
end
</pre>

Finally you need to add the "Think" function, this will be called every time the AI code needs to be run. The server will pass 2 parameters to this function, the first is the NPC this spawn script is attached to, the second is the NPC's current target.

<pre>
function Think(NPC, Target)

end
</pre>

We are now ready to program the AI.

=Programing The New Brain=

← Older revision		Revision as of 04:54, 30 August 2013
Line 136:		Line 136:
	</pre>		</pre>

−	Finally lets check the encounter size to ensure it is empty, after all we	+	Finally lets check the encounter size with [[LUA:GetEncounterSize\|GetEncounterSize()]] to ensure it is empty, after all if this NPC is not in combat then there should not be any one in its encounter list.
		+	<pre>
		+	-- Nothing in the hate list so we are not in combat so no one should be in our encounter list
		+	if GetEncounterSize(NPC) > 0 then
		+	ClearEncounter(NPC)
		+	end
		+	</pre>
		+
		+	And that is it, this script will replicate the default AI the server core uses for the vast majority of spawns.
		+
		+	=Complete Script=
		+	<pre>
		+	local MAX_CHASE_DISTANCE = 80
		+
		+	function Think(NPC, Target)
		+	-- Make sure the NPC is not mezzed or stunned
		+	if not IsMezzedOrStunned(NPC) then
		+	-- Get the most hated spawn
		+	local mostHated = GetMostHated(NPC)
		+
		+	-- Get runback distance
		+	local runback_distance = GetRunbackDistance(NPC)
		+	-- Check to see if we got a mostHated
		+	if mostHated ~= nil then
		+
		+	-- Check to see if the target and the most hated are the same
		+	if Target == nil or not CompareNPCs(mostHated, Target) then
		+	-- Not the same so lets make them the same
		+	SetTarget(NPC, mostHated)
		+	FaceTarget(NPC, mostHated)
		+	end
		+
		+	-- We have a hate target so lets check if we are already in combat
		+	if not IsInCombat(NPC) then
		+	-- Not in combat so lets put the NPC in combat
		+	SetInCombat(NPC, true)
		+	end
		+
		+	-- Check distance to run back location
		+	if runback_distance > MAX_CHASE_DISTANCE then
		+	-- Clear the hate list
		+	ClearHate(NPC)
		+	-- Clear the encounter list
		+	ClearEncounter(NPC)
		+	else
		+	-- Get the distance between the spawns for combat calcs
		+	local distance = GetDistance(NPC, Target, 1)
		+
		+	-- Check if not currently casting and the NPC has not recovered from casting or can cast a spell
		+	if not IsCasting(NPC) and (not HasRecovered(NPC) or not ProcessSpell(NPC, mostHated, distance)) then
		+	FaceTarget(NPC, mostHated)
		+	-- Attempt a melee attack, will also make the NPC move close to its target if it is out of range
		+	ProcessMelee(NPC, mostHated, distance)
		+	end
		+	end
		+	else
		+	-- nothing in hate list
		+
		+	-- check to see if the NPC is still flagged in combat
		+	if IsInCombat(NPC) then
		+	-- Still in combat, lets take the NPC out of combat
		+	SetInCombat(NPC, false)
		+
		+	-- Check if not a pet, or if a pet and the owner is not a player
		+	if not IsPet(NPC) or not IsPlayer(GetOwner(NPC)) then
		+	-- Set HP to max
		+	SetHP(NPC, GetMaxHP(NPC))
		+	end
		+	end
		+
		+	-- Check to see if we have a run back location
		+	if runback_distance > 0 then
		+	-- We have a run back location so lets go to it
		+	Runback(NPC)
		+	end
		+
		+	-- Nothing in the hate list so we are not in combat so no one should be in our encounter list
		+	if GetEncounterSize(NPC) > 0 then
		+	ClearEncounter(NPC)
		+	end
		+
		+	end
		+	end
		+
		+	end
		+
		+	function spawn(NPC)
		+	SetLuaBrain(NPC)
		+	SetBrainTick(NPC, 200)
		+	end
		+
		+	function respawn(NPC)
		+	spawn(NPC)
		+	end
		+	</pre>

@@ Line 109: / Line 109: @@
 </pre>
-And that is it for the "if mostHated ~= nil then", we will now go into the else portion of the code for when there is no one in the hate list.  First we should check to see if the NPC is still in combat, if it is we should bring it out of combat.  The NPC should be set to full health if it is not the pet of a player.  To set the HP to full we can use [[LUA:SetHP|SetHP]] and get the max HP for the NPC with [[LUA:GetMaxHP|GetMaxHP()]].  To check if it is a pet we would use [[LUA:IsPet|IsPet()]], if it is a pet we can get the owner with [[LUA:GetOwner|GetOwner()]] and check if the owner is a player with [[LUA:IsPlayer|IsPlayer()]].
+And that is it for the "if mostHated ~= nil then", we will now go into the else portion of the code for when there is no one in the hate list.  First we should check to see if the NPC is still in combat, if it is we should bring it out of combat.  The NPC should be set to full health if it is not the pet of a player.  To set the HP to full we can use [[LUA:SetHP|SetHP()]] and get the max HP for the NPC with [[LUA:GetMaxHP|GetMaxHP()]].  To check if it is a pet we would use [[LUA:IsPet|IsPet()]], if it is a pet we can get the owner with [[LUA:GetOwner|GetOwner()]] and check if the owner is a player with [[LUA:IsPlayer|IsPlayer()]].
 <pre>
 else
@@ Line 135: / Line 135: @@
 end
 </pre>

@@ Line 106: / Line 106: @@
 		ProcessMelee(NPC, mostHated, distance)
 	end
 end
 </pre>

@@ Line 75: / Line 75: @@
 		-- Not in combat so lets put the NPC in combat
 		SetInCombat(NPC, true)
 end
 </pre>

@@ Line 1: / Line 1: @@
-Creating a new brain in lua will allow you to override the default AI, it will not allow you to extend the default AI however.  You can change the script and reload it without having to recompile and restart the server however.  In this tutorial I will show you how to create a lua AI that will duplicate the default AI code in the server core.
+Creating a new brain in lua will allow you to override the default AI, it will not allow you to extend the default AI however.  You can change the script and reload it without having to recompile and restart the server however.  LUA AI needs to cover every aspect of combat, including putting the NPC into combat.  In this tutorial I will show you how to create a lua AI that will duplicate the default AI code in the server core.
 =Set Up the Spawn Script=
@@ Line 28: / Line 28: @@
 =Programing The New Brain=
-LUA AI needs to cover every aspect of combat, including putting the NPC into combat
+The first thing we need to do is check to see if the NPC can do anything, if they are mezzed or stunned then they can't do anything and we can skip the rest of the code.  We can check if this is the case by calling [[LUA:IsMezzedOrStunned|IsMezzedOrStunned()]], this will return true if the NPC is mezzed or stunned

← Older revision		Revision as of 01:02, 30 August 2013
Line 28:		Line 28:

	=Programing The New Brain=		=Programing The New Brain=
		+	LUA AI needs to cover every aspect of combat, including putting the NPC into combat