LUA:SpawnScripts

LUA - Spawn Scripts

Return to: LUA | Tutorials | Portal | Forum | Project Manager | Bug Tracker

Spawn Scripts are used to bring a spawn to life, the most common use is to add dialog but it is possible to write your own custom AI completely overriding the default behavior provided in the server core.

Functions

Aggro Aggro is called when the spawn aggros a player due to faction function aggro(Spawn, Spawn) end

Attacked Attacked is called when the spawn enters combat function attacked(Spawn, Spawn) end

Aggro Aggro is called when the spawn aggros a player due to faction function aggro(Spawn, Spawn) end

Attacked Attacked is called when the spawn enters combat function attacked(Spawn, Spawn) end

Aggro

Aggro is called when the spawn aggros a player due to faction

function aggro(Spawn, Spawn)
end

Attacked

Attacked is called when the spawn enters combat

function attacked(Spawn, Spawn)
end

Auto Attack Tick

Auto Attack Tick is called when the spawn makes an attack with the primary weapon

function auto_attack_tick(Spawn, Spawn)
end

Can Use Command

can_use_command is called when an entity command is used on a spawn. Return true to allow the command to be used, false to not. This check only applies if this function is in the script. The third parameter is the name of the spell/entity command.

function can_use_command(NPC, Spawn, String)
    return true
end

Casted On

Casted On is called when a spell is casted on the spawn, the third parameter is the name of the spell/entity command

function casted_on(Spawn, Spawn, String)
end

Combat Reset

Combat Reset is called when the spawn leaves combat

function CombatReset(Spawn)
end

Death

Death is called when the spawn dies

function death(Spawn, Spawn)
end

Group Dead

Group dead is called when the last member of a spawn group is killed

function group_dead(Spawn, Spawn)
end

Hailed

Hailed is called when a player hails the spawn

function hailed(Spawn, Spawn)
end

Hailed Busy

Hailed Busy is called when a player hails the spawn while it is in combat

function hailed_busy(Spawn, Spawn)
end

Health Changed

Health Changed is called whenever the spawns health changes in either direction

function healthchanged(Spawn, Spawn)
end

Hear Say

Hear Say is called whenever a player uses /say with a spawn targeted

function hear_say(NPC, Spawn, Msg)
end

Killed

Killed is called whenever the spawn kills something

function killed(Spawn, Spawn)
end

Random Chat

Random Chat is never called and its purpose is lost, code for it still remains so it is listed here just for reference

function randomchat(Spawn, String)
end

Respawn

Respawn is called when the spawn respawns

function respawn(Spawn)
end

Spawn

Spawn is called when the spawn spawns for the first time

function spawn(Spawn)
end

Targeted

Targeted is called whenever a player targets the spawn

function targeted(Spawn, Spawn)
end

Think

Think is used to override AI and is called every time the AI needs to run

function Think(Spawn, Spawn)
end

Tutorials

Coming Soon.

Spawn Script Template In order to have a spawn script that can be submitted to the server you must follow a certain structure. Use this Spawn Script Template for the spawn scripts. This will have a break down of the code with an explanation of what each part does, and it will also have the full template that you can copy and paste into your editor like notepad++.