pa/eqemu-server
2
0
Fork 0
mirror of https://github.com/EQEmu/Server.git synced 2026-06-23 08:28:21 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Updated Perl API (markdown)

Chris Miles
2018-07-01 19:30:11 -05:00
parent 868409feaa
commit eaac3326b0
1 changed files with 137 additions and 139 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Perl-API.md
+137 -139
@@ -905,89 +905,76 @@ TeleportRaid(sender, zoneID, x, y, z, heading)
* Important Note! Most of the $mob objects also work when used with $client * Important Note! Most of the $mob objects also work when used with $client
```perl ```perl
$mob->AddFeignMemory(attacker) $mob->AddFeignMemory(client* attacker)
$mob->AddToHateList(other, hate, damage, iYellForHelp, bFrenzy, iBuffTic) $mob->BehindMob(mob* other = 0, [float x = 0.0f], [float y= 0.0f])
$mob->Attack(other, Hand, FromRiposte)
$mob->BehindMob(other, playerx, playery)
$mob->BuffFadeAll() $mob->BuffFadeAll()
$mob->BuffFadeByEffect(effectid, skipslot) $mob->BuffFadeByEffect(int effect_id, int skip_slot = -1)
$mob->BuffFadeBySlot(slot, iRecalcBonuses) $mob->BuffFadeBySlot(int slot, bool recalc_bonuses = true)
$mob->BuffFadeBySpellID(spell_id) $mob->BuffFadeBySpellID(uint16 spell_id)
$mob->CalculateDistance(x, y, z) $mob->CalculateDistance(float x, float y, float z)
$mob->CalculateHeadingToTarget(in_x, in_y) $mob->CalculateHeadingToTarget(float x, float y)
$mob->CalculateNewPosition(x, y, z, speed, checkZ) $mob->CanClassEquipItem(uint32 item_id)
$mob->CalculateNewPosition2(x, y, z, speed, checkZ)
$mob->CameraEffect(duration, intensity, singleclient, serverwide)
$mob->CanBuffStack(spellid, caster_level, iFailIfOverwrite)
$mob->CanClassEquipItem(item_id)
$mob->CanThisClassDodge() $mob->CanThisClassDodge()
$mob->CanThisClassDoubleAttack() $mob->CanThisClassDoubleAttack()
$mob->CanThisClassDualWield() $mob->CanThisClassDualWield()
$mob->CanThisClassParry() $mob->CanThisClassParry()
$mob->CanThisClassRiposte() $mob->CanThisClassRiposte()
$mob->CastSpell(spell_id, target_id, slot, casttime, mana_cost, resist_adjust)
$mob->CastToClient() $mob->CastToClient()
$mob->CastToCorpse() $mob->CastToCorpse()
$mob->CastToMob() $mob->CastToMob()
$mob->CastToNPC() $mob->CastToNPC()
$mob->CastingSpellID() $mob->CastingSpellID()
$mob->ChangeSize(in_size, bNoRestriction) $mob->ChangeSize(float in_size, [bool no_restriction = false])
$mob->Charmed() $mob->Charmed()
$mob->CheckAggro(other) $mob->CheckAggro(mob* other)
$mob->CheckAggroAmount(spellid) $mob->CheckAggroAmount(uint16 spell_id)
$mob->CheckHealAggroAmount(spellid) $mob->CheckHealAggroAmount(uint16 spell_id, uint32 possible_heal_amt)
$mob->CheckLoS(other) $mob->CheckLoS(mob*)
$mob->CheckLoSToLoc(x, y, z, mob_size) $mob->CheckLoSToLoc(float x, float y, float z, float mob_size)
$mob->ClearFeignMemory() $mob->ClearFeignMemory()
$mob->ClearSpecialAbilities() $mob->ClearSpecialAbilities()
$mob->CombatRange() $mob->CombatRange(mob* target)
$mob->Damage(from, damage, spell_id, attack_skill, avoidable, buffslot, iBuffTic) $mob->Depop(startspawntimer = true)
$mob->DelGlobal(varname)
$mob->Depop(StartSpawnTimer)
$mob->DivineAura() $mob->DivineAura()
$mob->DoAnim(animnum, type=1) $mob->DoAnim(int animation_number, [int type = 0])
$mob->DoArcheryAttackDmg() $mob->DoKnockback(mob* caster, uint32 push_back_amount, uint32 push_up_amount)
$mob->DoKnockback(caster, pushback, pushup)  # $client->DoKnockback($npc, 10, 7) would appear that the NPC knocked the client back
$mob->DoMeleeSkillAttackDmg()
$mob->DoSpecialAttackDamage(target, skill, max_damage, min_damage, hate_override)
$mob->DoThrowingAttackDmg()
$mob->DontBuffMeBefore() $mob->DontBuffMeBefore()
$mob->DontDotMeBefore() $mob->DontDotMeBefore()
$mob->DontHealMeBefore() $mob->DontHealMeBefore()
$mob->DontRootMeBefore() $mob->DontRootMeBefore()
$mob->DontSnareMeBefore() $mob->DontSnareMeBefore()
$mob->Emote(format, ...) $mob->DoubleAggro(mob* other)
$mob->EntityVariableExists() $mob->Emote(string message)
$mob->FaceTarget(MobToFace, update) $mob->EntityVariableExists(string id)
$mob->FindBuff(spellid) $mob->FaceTarget([mob* target = 0])
$mob->FindGroundZ(x, y, z_offset) $mob->FindBuff(uint16 spell_id)
$mob->FindType(type, bOffensive, threshold) $mob->FindGroundZ(float x, float y, float z_offset)
$mob->GMMove(x, y, z, heading) $mob->FindType(uint8 type, [bool offensive = false], [uint16 threshold = 100])
$mob->GMMove(float x, float y, float z, [float heading = 0.01])
$mob->Gate() $mob->Gate()
$mob->GetAA(aa_id) $mob->GetAA(uint32 rank_id)
$mob->GetAAByAAID(uint32 aa_id)
$mob->GetAC() $mob->GetAC()
$mob->GetAccuracyRating()
$mob->GetAvoidanceRating()
$mob->GetAGI() $mob->GetAGI()
$mob->GetATK() $mob->GetATK()
$mob->GetAttackDelay() $mob->GetActSpellCasttime(uint16 spell_id, uint32 cast_time)
$mob->GetActSpellCasttime(spell_id, casttime) $mob->GetActSpellCost(uint16 spell_id, int32 cost)
$mob->GetActSpellCost(spell_id, cost) $mob->GetActSpellDamage(uint16 spell_id, int32 value)
$mob->GetActSpellDamage(spell_id, value) $mob->GetActSpellDuration(uint16 spell_id, int32 duration)
$mob->GetActSpellDuration(spell_id, duration) $mob->GetActSpellHealing(uint16 spell_id, int32 value)
$mob->GetActSpellHealing(spell_id, value) $mob->GetActSpellRange(uint16 spell_id, float range)
$mob->GetActSpellRange(spell_id, range)
$mob->GetAggroRange() $mob->GetAggroRange()
$mob->GetAllowBeneficial() $mob->GetAllowBeneficial()
$mob->GetAppearance() $mob->GetAppearance()
$mob->GetArmorTint(material_slot) $mob->GetArmorTint(uint8 material_slot)
$mob->GetAssistRange() $mob->GetAssistRange()
$mob->GetBaseGender() $mob->GetBaseGender()
$mob->GetBaseRace() $mob->GetBaseRace()
$mob->GetBaseSize()
$mob->GetBeard() $mob->GetBeard()
$mob->GetBeardColor() $mob->GetBeardColor()
$mob->GetBodyType() $mob->GetBodyType()
$mob->GetBuffSlotFromType(type) $mob->GetBuffSlotFromType(uint16 type)
$mob->GetCHA() $mob->GetCHA()
$mob->GetCR() $mob->GetCR()
$mob->GetCasterLevel(spell_id) $mob->GetCasterLevel(spell_id)
@@ -997,42 +984,44 @@ $mob->GetCleanName()
$mob->GetCorruption() $mob->GetCorruption()
$mob->GetDEX() $mob->GetDEX()
$mob->GetDR() $mob->GetDR()
$mob->GetDamageAmount(tmob) $mob->GetDamageAmount(mob* target_mob)
$mob->GetDeity() $mob->GetDeity()
$mob->GetDrakkinDetails() $mob->GetDrakkinDetails()
$mob->GetDrakkinHeritage() $mob->GetDrakkinHeritage()
$mob->GetDrakkinTattoo() $mob->GetDrakkinTattoo()
$mob->GetEntityVariable() $mob->GetEntityVariable(string id)
$mob->GetEquipment(material_slot) $mob->GetEquipment(uint8 material_slot)
$mob->GetEquipmentColor(material_slot) $mob->GetEquipmentColor(uint8 material_slot)
$mob->GetEquipmentMaterial(material_slot) $mob->GetEquipmentMaterial(uint8 material_slot)
$mob->GetEyeColor1() $mob->GetEyeColor1()
$mob->GetEyeColor2() $mob->GetEyeColor2()
$mob->GetFR() $mob->GetFR()
$mob->GetFlurryChance() $mob->GetFlurryChance()
$mob->GetFollowID() $mob->GetFollowID()
$mob->GetGender() $mob->GetGender()
$mob->GetGlobal(varname)
$mob->GetHP() $mob->GetHP()
$mob->GetHPRatio() $mob->GetHPRatio()
$mob->GetHairColor() $mob->GetHairColor()
$mob->GetHairStyle() $mob->GetHairStyle()
$mob->GetHandToHandDamage()
$mob->GetHandToHandDelay()
$mob->GetHaste() $mob->GetHaste()
$mob->GetHateAmount(tmob, is_dam) $mob->GetHateAmount(mob* mob, [bool is_damage = false])
$mob->GetHateDamageTop(other) $mob->GetHateDamageTop(mob* other)
$mob->GetHateList() $mob->GetHateList()
$mob->GetHateRandom() $mob->GetHateRandom()
$mob->GetHateTop() $mob->GetHateTop()
$mob->GetHeading() $mob->GetHeading()
$mob->GetHelmTexture() $mob->GetHelmTexture()
$mob->GetHerosForgeModel(uint8 material_slot)
$mob->GetID() $mob->GetID()
$mob->GetINT() $mob->GetINT()
$mob->GetInvul() $mob->GetInvul()
$mob->GetItemHPBonuses() $mob->GetItemHPBonuses()
$mob->GetItemStat(itemid, stat) $mob->GetItemStat(uint32 item_id, string stat)
$mob->GetLevel() $mob->GetLevel()
$mob->GetLevelCon(iOtherLevel) $mob->GetLevelCon(uint8 other_level)
$mob->GetLevelHP(tlevel) $mob->GetLevelHP(uint8 level)
$mob->GetLuclinFace() $mob->GetLuclinFace()
$mob->GetMR() $mob->GetMR()
$mob->GetMana() $mob->GetMana()
@@ -1046,33 +1035,37 @@ $mob->GetMaxMana()
$mob->GetMaxSTA() $mob->GetMaxSTA()
$mob->GetMaxSTR() $mob->GetMaxSTR()
$mob->GetMaxWIS() $mob->GetMaxWIS()
$mob->GetModSkillDmgTaken() $mob->GetMeleeMitigation()
$mob->GetModVulnerability() $mob->GetModSkillDmgTaken(int skill_id)
$mob->GetMonkHandToHandDamage() $mob->GetModVulnerability(uint8 resist)
$mob->GetMonkHandToHandDelay()
$mob->GetNPCTypeID() $mob->GetNPCTypeID()
$mob->GetName() $mob->GetName()
$mob->GetNimbusEffect1()
$mob->GetNimbusEffect2()
$mob->GetNimbusEffect3()
$mob->GetOwnerID() $mob->GetOwnerID()
$mob->GetPR() $mob->GetPR()
$mob->GetPetID() $mob->GetPetID()
$mob->GetPetOrder() $mob->GetPetOrder()
$mob->GetPetType() $mob->GetPetType()
$mob->GetPhR()
$mob->GetRace() $mob->GetRace()
$mob->GetResist(type) $mob->GetResist(type)
$mob->GetReverseFactionCon(iOther) $mob->GetReverseFactionCon(iother)
$mob->GetRunAnimSpeed() $mob->GetRunAnimSpeed()
$mob->GetRunspeed() $mob->GetRunspeed()
$mob->GetSTA() $mob->GetSTA()
$mob->GetSTR() $mob->GetSTR()
$mob->GetShieldTarget() $mob->GetShieldTarget()
$mob->GetSize() $mob->GetSize()
$mob->GetSkill(skill_num) $mob->GetSkill(int skill_id)
$mob->GetSkillDmgTaken() $mob->GetSkillDmgTaken(int skill_id)
$mob->GetSpecialAbility(special_ability) $mob->GetSpecialAbility(int special_ability)
$mob->GetSpecialAbilityParam(special_ability, param) $mob->GetSpecialAbilityParam(int special_ability, int param)
$mob->GetSpecializeSkillValue(spell_id) $mob->GetSpecializeSkillValue(uint16 spell_id)
$mob->GetSpellHPBonuses() $mob->GetSpellHPBonuses()
$mob->GetSpellStat(spell_id, identifier, slot) # Slot is optional. $mob->GetSpellIDFromSlot(slot)
$mob->GetSpellStat(uint32 spell_id, string stat, uint8 slot)
$mob->GetTarget() $mob->GetTarget()
$mob->GetTexture() $mob->GetTexture()
$mob->GetWIS() $mob->GetWIS()
@@ -1088,23 +1081,33 @@ $mob->GetY()
$mob->GetZ() $mob->GetZ()
$mob->GetZoneID() $mob->GetZoneID()
$mob->GoToBind() $mob->GoToBind()
$mob->HasNPCSpecialAtk() $mob->HalveAggro(mob* other)
$mob->HasNPCSpecialAtk(string ability_string)
$mob->HasOwner()
$mob->HasPet()
$mob->HasProcs() $mob->HasProcs()
$mob->HasShieldEquiped()
$mob->HasTwoHandBluntEquiped()
$mob->HasTwoHanderEquipped()
$mob->HateSummon() $mob->HateSummon()
$mob->Heal() $mob->Heal()
$mob->HealDamage(amount[, caster]) $mob->HealDamage(int32 amount, [mob* caster = 0])
$mob->InterruptSpell(spellid) $mob->InterruptSpell([uint16 spell_id = 0xffff])
$mob->IsAIControlled() $mob->IsAIControlled()
$mob->IsAmnesiad()
$mob->IsBeacon() $mob->IsBeacon()
$mob->IsBeneficialAllowed() $mob->IsBeneficialAllowed(mob* target)
$mob->IsBlind()
$mob->IsCasting() $mob->IsCasting()
$mob->IsClient() $mob->IsClient()
$mob->IsCorpse() $mob->IsCorpse()
$mob->IsDoor() $mob->IsDoor()
$mob->IsEliteMaterialItem(uint8 material_slot)
$mob->IsEngaged() $mob->IsEngaged()
$mob->IsEnraged() $mob->IsEnraged()
$mob->IsImmuneToSpell(spell_id, caster) $mob->IsFeared()
$mob->IsInvisible(other) $mob->IsImmuneToSpell(uint16 spell_id, [mob* caster = nullptr])
$mob->IsInvisible([mob* other = 0])
$mob->IsMeleeDisabled() $mob->IsMeleeDisabled()
$mob->IsMezzed() $mob->IsMezzed()
$mob->IsMob() $mob->IsMob()
@@ -1112,88 +1115,83 @@ $mob->IsMoving()
$mob->IsNPC() $mob->IsNPC()
$mob->IsNPCCorpse() $mob->IsNPCCorpse()
$mob->IsObject() $mob->IsObject()
$mob->IsPet()
$mob->IsPlayerCorpse() $mob->IsPlayerCorpse()
$mob->IsRoamer() $mob->IsRoamer()
$mob->IsRooted() $mob->IsRooted()
$mob->IsRunning() $mob->IsRunning()
$mob->IsSilenced()
$mob->IsStunned() $mob->IsStunned()
$mob->IsTargetable()
$mob->IsTargeted() $mob->IsTargeted()
$mob->IsTrap() $mob->IsTrap()
$mob->IsWarriorClass() $mob->IsWarriorClass()
$mob->Kill() $mob->Kill()
$mob->MakePet(spell_id, pettype, name) $mob->MakePet(uint16 spell_id, string pet_type, [string name = nullptr])
$mob->MakeTempPet(spell_id, name, duration, target, sticktarg?)
$mob->Mesmerize() $mob->Mesmerize()
$mob->Message(type, message) $mob->Message(uint32 emote_color_type, string message)
$mob->Message_StringID(type, string_id, distance) $mob->ModSkillDmgTaken(int skill, int16 value)
$mob->ModSkillDmgTaken() $mob->ModVulnerability(uint8 resist, int16 value)
$mob->ModVulnerability() $mob->ProcessSpecialAbilities(string str)
$mob->NPCSpecialAttacks(parse, permtag, reset, remove) $mob->RangedAttack(mob* other)
$mob->ProcessSpecialAbilities(str) $mob->RemoveFromFeignMemory(client* attacker)
$mob->ProjectileAnim(mob, item_id, IsArrow, speed, angle, tilt, arc) $mob->RemoveNimbusEffect(int32 effect_id)
$mob->QuestReward(client, silver, gold, platinum) $mob->ResistSpell(uint8 resist_type, uint16 spell_id, [mob* caster = nullptr])
$mob->RangedAttack()
$mob->RemoveFromFeignMemory(attacker)
$mob->RemoveNimbusEffect(effectid)
$mob->ResistSpell(resist_type, spell_id, caster)
$mob->RogueAssassinate(other) $mob->RogueAssassinate(other)
$mob->Say(format, language_id) $mob->Say(string message)
$mob->SendAppearanceEffect(effect1, effect2, effect3, effect4, effect5, specificclient) $mob->SeeHide()
$mob->SendIllusion(race, gender, texture, helmtexture, face, hairstyle, haircolor, beard, beardcolor, drakkin_heritage, drakkin_tattoo, $mob->drakkin_details, size) $mob->SeeImprovedHide()
$mob->SendPosUpdate(iSendToSelf) $mob->SeeInvisible()
$mob->SeeInvisibleUndead()
$mob->SendPosUpdate([uint8 send_to_self = 0])
$mob->SendPosition() $mob->SendPosition()
$mob->SendTo(new_x, new_y, new_z) $mob->SendTo(float new_x, float new_y, float new_z)
$mob->SendToFixZ(new_x, new_y, new_z) $mob->SendToFixZ(float new_x, float new_y, float new_z)
$mob->SendWearChange(material_slot) $mob->SendWearChange(uint8 material_slot)
$mob->SetAllowBeneficial() $mob->SetAA(int aa_id, int points, [int charges = 0])
$mob->SetAppearance(app, iIgnoreSelf) $mob->SetAllowBeneficial(bool value)
$mob->SetBodyType(type, overwrite_orig?) $mob->SetAppearance(int appearance [0|1|2|3|4], [ignore_self = true])
$mob->SetBodyType(int32 type, [bool overwrite_orig = false])
$mob->SetCurrentWP(waypoint) $mob->SetCurrentWP(waypoint)
$mob->SetDeltas(delta_x, delta_y, delta_z, delta_h) $mob->SetDeltas(float delta_x, float delta_y, float delta_z, float delta_h)
$mob->SetDisableMelee() $mob->SetDisableMelee(bool value)
$mob->SetEntityVariable(id_num, var) $mob->SetEntityVariable(string id, string var)
$mob->SetExtraHaste(Haste) $mob->SetExtraHaste(int haste)
$mob->SetFlurryChance() $mob->SetFlurryChance(uint8 value)
$mob->SetFlyMode(0|1|2|3) $mob->SetFlyMode(uint8 flymode[0|1|2|3])
$mob->SetFollowID(id) $mob->SetFollowID(id)
$mob->SetGender(gender) $mob->SetGender(int32 gender)
$mob->SetGlobal(varname, newvalue, options, duration, other) $mob->SetHP(int32 hp)
$mob->SetHP(hp) $mob->SetHate(mob* other, [int32 hate = 0], [int32 damage = 0])
$mob->SetHate(other, hate, damage) $mob->SetHeading(float heading)
$mob->SetHeading(iHeading) $mob->SetInvisible(uint8 state)
$mob->SetInvisible(state) $mob->SetInvul(bool set_invulnerable)
$mob->SetInvul(invul) $mob->SetLD(bool value)
$mob->SetLD(value) $mob->SetLevel(uint8 in_level, [bool command = false])
$mob->SetLevel(in_level, command)
$mob->SetMana(amount) $mob->SetMana(amount)
$mob->SetMaxHP() $mob->SetMaxHP()
$mob->SetOOCRegen() $mob->SetOOCRegen(int32 new_ooc_regen)
$mob->SetOwnerID(NewOwnerID) $mob->SetOwnerID(uint16 new_owner_id)
$mob->SetPetID(NewPetID) $mob->SetPetID(uint16 new_pet_id)
$mob->SetPetOrder(i) $mob->SetPetOrder(i)
$mob->SetRace(race) $mob->SetRace(int32 race)
$mob->SetRunAnimSpeed(in) $mob->SetRunAnimSpeed(int8 speed)
$mob->SetRunning() $mob->SetRunning(bool value)
$mob->SetShieldTarget(mob) $mob->SetShieldTarget(mob)
$mob->SetSlotTint(material_slot, red_tint, green_tint, blue_tint) $mob->SetSpecialAbility(int ability, int value)
$mob->SetSpecialAbility(ability, value) $mob->SetSpecialAbilityParam(int ability, int param, int value)
$mob->SetSpecialAbilityParam(ability, param, value)
$mob->SetTarget(mob) $mob->SetTarget(mob)
$mob->SetTargetDestSteps(target_steps) $mob->SetTargetDestSteps(uint8 target_steps)
$mob->SetTargetable(targetable) $mob->SetTargetable(bool targetable)
$mob->SetTexture(texture) $mob->SetTexture(int32 texture)
$mob->Shout(format, ...) $mob->Shout(string message)
$mob->SignalClient(client, data) $mob->SignalClient(client* client, uint32 data)
$mob->SpellEffect(effect, duration, finish_delay, zone_wide, unk20, perm_effect, client) # duration, finish_delay, zone_wide, unk20, $mob->perm_effect, and client are Optional.
$mob->SpellFinished(spell_id, spell_target, mana_cost)
$mob->Spin() $mob->Spin()
$mob->StartEnrage() $mob->StartEnrage()
$mob->Stun(duration) # in whole seconds $mob->Stun(int duration)
$mob->TarGlobal(varname, value, duration, npcid, charid, zoneid) $mob->TempName(string name)
$mob->TempName(name) $mob->ThrowingAttack(mob* other)
$mob->ThrowingAttack() $mob->TryMoveAlong(float distance, float angle, bool send)
$mob->TypesTempPet(typesid, name, duration, follow, target, sticktarg);
$mob->WearChange(material_slot, texture, color)
$mob->WipeHateList() $mob->WipeHateList()
``` ```