Perl API Reference: NPC (156 methods)

Browse the complete Perl API documentation for the NPC class. Search through 156 methods and 249 events to find the exact function signatures, parameters, and usage examples you need for your EQ-Emulator scripts.

Methods

$npc->AI_SetRoambox(distance, max_x, min_x, max_y, min_y, max_delay, min_delay); # void
$npc->AI_SetRoambox(distance, max_x, min_x, max_y, min_y, max_delay); # void
$npc->AI_SetRoambox(distance, max_x, min_x, max_y, min_y); # void
$npc->AddAISpellEffect(spell_effect_id, base_value, limit_value, max_value); # void
$npc->AddDefensiveProc(spell_id, chance); # void
$npc->AddItem(item_id, charges, equip_item, aug1, aug2, aug3); # void
$npc->AddItem(item_id, charges, equip_item, aug1, aug2); # void
$npc->AddItem(item_id, charges, equip_item, aug1); # void
$npc->AddItem(item_id, charges, equip_item, aug1, aug2, aug3, aug4); # void
$npc->AddItem(item_id, charges, equip_item, aug1, aug2, aug3, aug4, aug5); # void
$npc->AddItem(item_id, charges, equip_item, aug1, aug2, aug3, aug4, aug5, aug6); # void
$npc->AddItem(item_id); # void
$npc->AddItem(item_id, charges); # void
$npc->AddItem(item_id, charges, equip_item); # void
$npc->AddLootTable(); # void
$npc->AddLootTable(loottable_id); # void
$npc->AddMeleeProc(spell_id, chance); # void
$npc->AddRangedProc(spell_id, chance); # void
$npc->AssignWaypoints(grid_id); # void
$npc->CalculateNewWaypoint(); # void
$npc->ChangeLastName(name); # void
$npc->CheckHandin(); # bool
$npc->CheckNPCFactionAlly(faction_id); # int
$npc->ClearLastName(); # void
$npc->CountItem(item_id); # uint32
$npc->CountLoot(); # uint32_t
$npc->DescribeSpecialAbilities(c); # void
$npc->DisplayWaypointInfo(client); # void
$npc->DoClassAttacks(target); # void
$npc->GetAccuracyRating(); # int
$npc->GetAttackDelay(); # int
$npc->GetAttackSpeed(); # float
$npc->GetAvoidanceRating(); # int
$npc->GetCombatState(); # bool
$npc->GetCopper(); # uint32_t
$npc->GetGold(); # uint32_t
$npc->GetGrid(); # int
$npc->GetGuardPointX(); # float
$npc->GetGuardPointY(); # float
$npc->GetGuardPointZ(); # float
$npc->GetHealScale(); # float
$npc->GetKeepsSoldItems(); # bool
$npc->GetLDoNLockedSkill(); # uint16
$npc->GetLDoNTrapSpellID(); # uint16
$npc->GetLDoNTrapType(); # uint8
$npc->GetLootList(); # array
$npc->GetLoottableID(); # uint32_t
$npc->GetMaxDMG(); # uint32_t
$npc->GetMaxDamage(target_level); # uint32_t
$npc->GetMaxWp(); # int
$npc->GetMinDMG(); # uint32_t
$npc->GetNPCAggro(); # bool
$npc->GetNPCFactionID(); # int
$npc->GetNPCHate(mob); # int64_t
$npc->GetNPCSpellsEffectsID(); # uint32
$npc->GetNPCSpellsID(); # uint32_t
$npc->GetNPCStat(stat); # float
$npc->GetNPCTintIndex(); # uint32
$npc->GetPetSpellID(); # int
$npc->GetPlatinum(); # uint32_t
$npc->GetPrimSkill(); # uint32_t
$npc->GetPrimaryFaction(); # int
$npc->GetScore(); # int
$npc->GetSecSkill(); # uint32_t
$npc->GetSilver(); # uint32_t
$npc->GetSlowMitigation(); # float
$npc->GetSp2(); # uint32_t
$npc->GetSpawn(); # Spawn2*
$npc->GetSpawnKillCount(); # uint32_t
$npc->GetSpawnPointH(); # float
$npc->GetSpawnPointID(); # uint32_t
$npc->GetSpawnPointX(); # float
$npc->GetSpawnPointY(); # float
$npc->GetSpawnPointZ(); # float
$npc->GetSpellFocusDMG(); # int
$npc->GetSpellFocusHeal(); # int
$npc->GetSpellScale(); # float
$npc->GetSwarmOwner(); # uint32_t
$npc->GetSwarmTarget(); # uint32_t
$npc->GetWaypointMax(); # int
$npc->HasAISpellEffect(spell_effect_id); # bool
$npc->HasItem(item_id); # bool
$npc->HasSpecialAbilities(); # bool
$npc->IsAnimal(); # bool
$npc->IsGuarding(); # bool
$npc->IsLDoNLocked(); # bool
$npc->IsLDoNTrapDetected(); # bool
$npc->IsLDoNTrapped(); # bool
$npc->IsMultiQuestEnabled(); # bool
$npc->IsOnHatelist(mob); # bool
$npc->IsRaidTarget(); # bool
$npc->IsRareSpawn(); # bool
$npc->IsResumedFromZoneSuspend(); # bool
$npc->IsTaunting(); # bool
$npc->IsUnderwaterOnly(); # bool
$npc->MerchantCloseShop(); # void
$npc->MerchantOpenShop(); # void
$npc->ModifyNPCStat(stat, value); # void
$npc->MoveTo(x, y, z, h, save); # void
$npc->MoveTo(x, y, z); # void
$npc->MoveTo(x, y, z, h); # void
$npc->MultiQuestEnable(); # void
$npc->NextGuardPosition(); # void
$npc->PauseWandering(pause_time); # void
$npc->PickPocket(thief); # void
$npc->RecalculateSkills(); # void
$npc->ReloadSpells(); # void
$npc->RemoveAISpellEffect(spell_effect_id); # void
$npc->RemoveDefensiveProc(spell_id); # void
$npc->RemoveFromHateList(mob); # void
$npc->RemoveItem(item_id); # void
$npc->RemoveItem(item_id, quantity); # void
$npc->RemoveItem(item_id, quantity, slot_id); # void
$npc->RemoveMeleeProc(spell_id); # void
$npc->RemoveRangedProc(spell_id); # void
$npc->ResumeWandering(); # void
$npc->ReturnHandinItems(c); # void
$npc->SaveGuardSpot(x, y, z, heading); # void
$npc->SaveGuardSpot(); # void
$npc->SaveGuardSpot(clear); # void
$npc->ScaleNPC(npc_level); # void
$npc->ScaleNPC(npc_level, override_special_abilities); # void
$npc->SendPayload(payload_id); # void
$npc->SendPayload(payload_id, payload_value); # void
$npc->SetCopper(amt); # void
$npc->SetGold(amt); # void
$npc->SetGrid(grid); # void
$npc->SetKeepsSoldItems(keeps_sold_items); # void
$npc->SetLDoNLocked(is_locked); # void
$npc->SetLDoNLockedSkill(skill_value); # void
$npc->SetLDoNTrapDetected(is_detected); # void
$npc->SetLDoNTrapSpellID(spell_id); # void
$npc->SetLDoNTrapType(trap_type); # void
$npc->SetLDoNTrapped(is_trapped); # void
$npc->SetNPCAggro(in_npc_aggro); # void
$npc->SetNPCFactionID(faction_id); # void
$npc->SetNPCTintIndex(index); # void
$npc->SetPetSpellID(amount); # void
$npc->SetPlatinum(amt); # void
$npc->SetPrimSkill(skill_id); # void
$npc->SetSaveWaypoint(wp); # void
$npc->SetSecSkill(skill_id); # void
$npc->SetSilver(amt); # void
$npc->SetSimpleRoamBox(box_size, move_distance); # void
$npc->SetSimpleRoamBox(box_size, move_distance, move_delay); # void
$npc->SetSimpleRoamBox(box_size); # void
$npc->SetSp2(set_spawn_group_id); # void
$npc->SetSpellFocusDMG(new_spell_focus_dmg); # void
$npc->SetSpellFocusHeal(new_spell_focus_heal); # void
$npc->SetSwarmTarget(target_id); # void
$npc->SetTaunting(on); # void
$npc->SetWaypointPause(); # void
$npc->SignalNPC(signal_id); # void
$npc->StartSwarmTimer(duration); # void
$npc->StopWandering(); # void
$npc->UpdateWaypoint(wp_index); # void