Update Perl API

Perl-API.md

@@ -700,8 +700,13 @@ UseDiscipline(spell_id, target)
 WorldKick()
 ```
 
-#### **Corpse - $corpse->Object();**
+# Corpse
 
+```perl
+$corpse->AddItem(itemnum, charges, slot)
+```
+
+```perl
 AddItem(itemnum, charges, slot)
 AddLooter(who)
 AllowMobLoot(them, slot)
@@ -726,13 +731,19 @@ WorldKick()
 RemoveCash()
 RemoveItem(lootslot)
 ResetLooter()
-   SetCash(in\_copper, in\_silver, in\_gold, in\_platinum)
+SetCash(in_copper, in_silver, in_gold, in_platinum)
 SetDecayTimer(decaytime)
 Summon(client, spell)
 UnLock()
+```
 
-#### **EntityList - $entity_list->Object();**
+# EntityList 
 
+```perl
+$entity_list->Object();
+```
+
+```perl
 CanAddHateForMob(p)
 Clear()
 ClearClientPetitionQueue()
@@ -777,7 +788,7 @@ WorldKick()
 MakeNameUnique(name)
 MessageClose(sender, skipsender, dist, type, message, ...)
 MessageGroup(sender, skipclose, type, message, ...)
-   MessageStatus(to\_guilddbid, to\_minstatus, type, message, ...)
+MessageStatus(to_guilddbid, to_minstatus, type, message, ...)
 OpenDoorsNear(opener)
 RemoveAllClients()
 RemoveAllCorpses()
@@ -801,10 +812,14 @@ WorldKick()
 RemoveTrap(delete_id)
 ReplaceWithTarget(pOldMob, pNewTarget)
 SignalAllClients(data)
-   SignalMobsByNPCID(npc\_type, signal\_id)
+SignalMobsByNPCID(npc_type, signal_id)
+```
 
-#### **Group - $group->Object(); ($group needs to be defined from my $group = $client->GetGroup())**
+# Group 
 
+ * $group needs to be fetched from an entity object, for example:  $group = $client->GetGroup())
+
+```perl
 CastGroupSpell(caster, spellid)
 DisbandGroup()
 GetHighestLevel()
@@ -823,9 +838,17 @@ WorldKick()
 SplitExp(exp, other)
 SplitMoney(copper, silver, gold, platinum)
 TeleportGroup(sender, zoneID, x, y, z)
+```
 
-#### **Raid - $raid->Object(); ($raid needs to be defined from my $raid = $client->GetRaid())**
+# Raid
 
+```perl
+$raid->Object();
+```
+
+* $raid needs to be fetched from an entity object, for example: $raid = $client->GetRaid())
+
+```perl
 BalanceHP()
 CastGroupSpell(caster, spellid)
 GetClientByIndex(number)
@@ -844,9 +867,11 @@ WorldKick()
 SplitMoney(copper, silver, gold, platinum)
 TeleportGroup(sender, zoneID, x, y, z, heading)
 TeleportRaid(sender, zoneID, x, y, z, heading)
+```
 
 #### **Mob - $mob->Object();**
 
+```perl
 AddFeignMemory(attacker)
 AddToHateList(other, hate, damage, iYellForHelp, bFrenzy, iBuffTic)
 Attack(other, Hand, FromRiposte)
@@ -856,7 +881,7 @@ WorldKick()
 BuffFadeBySlot(slot, iRecalcBonuses)
 BuffFadeBySpellID(spell_id)
 CalculateDistance(x, y, z)
-   CalculateHeadingToTarget(in\_x, in\_y)
+CalculateHeadingToTarget(in_x, in_y)
 CalculateNewPosition(x, y, z, speed, checkZ)
 CalculateNewPosition2(x, y, z, speed, checkZ)
 CameraEffect(duration, intensity, singleclient, serverwide)
@@ -867,7 +892,7 @@ WorldKick()
 CanThisClassDualWield()
 CanThisClassParry()
 CanThisClassRiposte()
-   CastSpell(spell\_id, target\_id, slot, casttime, mana\_cost, resist\_adjust)
+CastSpell(spell_id, target_id, slot, casttime, mana_cost, resist_adjust)
 CastToClient()
 CastToCorpse()
 CastToMob()
@@ -883,15 +908,15 @@ WorldKick()
 ClearFeignMemory()
 ClearSpecialAbilities()
 CombatRange()
-   Damage(from, damage, spell\_id, attack\_skill, avoidable, buffslot, iBuffTic)
+Damage(from, damage, spell_id, attack_skill, avoidable, buffslot, iBuffTic)
 DelGlobal(varname)
 Depop(StartSpawnTimer)
 DivineAura()
 DoAnim(animnum, type=1)
 DoArcheryAttackDmg()
-   DoKnockback(caster, pushback, pushup)  # $client->DoKnockback($npc, 10, 7) would appear that the NPC knocked the client back
+DoKnockback(caster, pushback, pushup)  # $client->DoKnockback($npc, 10, 7) would appear that the NPC knocked the client back
 DoMeleeSkillAttackDmg()
-   DoSpecialAttackDamage(target, skill, max\_damage, min\_damage, hate_override)
+DoSpecialAttackDamage(target, skill, max_damage, min_damage, hate_override)
 DoThrowingAttackDmg()
 DontBuffMeBefore()
 DontDotMeBefore()
@@ -1034,7 +1059,7 @@ WorldKick()
 HasProcs()
 HateSummon()
 Heal()
-   HealDamage(amount\[, caster\])
+HealDamage(amount[, caster])
 InterruptSpell(spellid)
 IsAIControlled()
 IsBeacon()
@@ -1067,7 +1092,7 @@ WorldKick()
 MakeTempPet(spell_id, name, duration, target, sticktarg?)
 Mesmerize()
 Message(type, message)
-   Message\_StringID(type, string\_id, distance)
+Message_StringID(type, string_id, distance)
 ModSkillDmgTaken()
 ModVulnerability()
 NPCSpecialAttacks(parse, permtag, reset, remove)
@@ -1077,21 +1102,21 @@ WorldKick()
 RangedAttack()
 RemoveFromFeignMemory(attacker)
 RemoveNimbusEffect(effectid)
-   ResistSpell(resist\_type, spell\_id, caster)
+ResistSpell(resist_type, spell_id, caster)
 RogueAssassinate(other)
 Say(format, language_id)
 SendAppearanceEffect(effect1, effect2, effect3, effect4, effect5, specificclient)
-   SendIllusion(race, gender, texture, helmtexture, face, hairstyle, haircolor, beard, beardcolor, drakkin\_heritage, drakkin\_tattoo, drakkin_details, size)
+SendIllusion(race, gender, texture, helmtexture, face, hairstyle, haircolor, beard, beardcolor, drakkin_heritage, drakkin_tattoo, drakkin_details, size)
 SendPosUpdate(iSendToSelf)
 SendPosition()
-   SendTo(new\_x, new\_y, new_z)
+SendTo(new_x, new_y, new_z)
-   SendToFixZ(new\_x, new\_y, new_z)
+SendToFixZ(new_x, new_y, new_z)
 SendWearChange(material_slot)
 SetAllowBeneficial()
 SetAppearance(app, iIgnoreSelf)
 SetBodyType(type, overwrite_orig?)
 SetCurrentWP(waypoint)
-   SetDeltas(delta\_x, delta\_y, delta\_z, delta\_h)
+SetDeltas(delta_x, delta_y, delta_z, delta_h)
 SetDisableMelee()
 SetEntityVariable(id_num, var)
 SetExtraHaste(Haste)
@@ -1117,7 +1142,7 @@ WorldKick()
 SetRunAnimSpeed(in)
 SetRunning()
 SetShieldTarget(mob)
-   SetSlotTint(material\_slot, red\_tint, green\_tint, blue\_tint)
+SetSlotTint(material_slot, red_tint, green_tint, blue_tint)
 SetSpecialAbility(ability, value)
 SetSpecialAbilityParam(ability, param, value)
 SetTarget(mob)
@@ -1126,8 +1151,8 @@ WorldKick()
 SetTexture(texture)
 Shout(format, ...)
 SignalClient(client, data)
-   SpellEffect(effect, duration, finish\_delay, zone\_wide, unk20, perm\_effect, client) # duration, finish\_delay, zone\_wide, unk20, perm\_effect, and client are Optional.
+SpellEffect(effect, duration, finish_delay, zone_wide, unk20, perm_effect, client) # duration, finish_delay, zone_wide, unk20, perm_effect, and client are Optional.
-   SpellFinished(spell\_id, spell\_target, mana_cost)
+SpellFinished(spell_id, spell_target, mana_cost)
 Spin()
 StartEnrage()
 Stun(duration) # in whole seconds
@@ -1137,15 +1162,22 @@ WorldKick()
 TypesTempPet(typesid, name, duration, follow, target, sticktarg);
 WearChange(material_slot, texture, color)
 WipeHateList()
+```
 
-#### **NPC - $npc->Object();**
+# NPC
 
+Example:
+```perl
+$npc->GetLoottableID();
+```
+
+```perl
 AI_SetRoambox(iDist, iMaxX, iMinX, iMaxY, iMinY, iDelay)
-   AddAISpell(priority, spell\_id, type, mana\_cost, recast\_delay, resist\_adjust)
+AddAISpell(priority, spell_id, type, mana_cost, recast_delay, resist_adjust)
-   AddCash(in\_copper, in\_silver, in\_gold, in\_platinum)
+AddCash(in_copper, in_silver, in_gold, in_platinum)
 AddItem(itemid, charges, equipitem)
 AddLootTable()
-   AddDefensiveProc(spellid, chance)    
+AddDefensiveProc(spellid, chance)   
 AddMeleeProc(spellid, chance)
 AddRangedProc(spellid, chance)
 AssignWaypoints(grid)
@@ -1228,6 +1260,7 @@ WorldKick()
 StartSwarmTimer(duration)
 StopWandering()
 UpdateWaypoint(wp_index)
+```
 
 #### **Quest Item**