thegrandlibrary-ref/zaela-Server
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
zaela-Server/utils/doc_scripts/generator/perlsample.yml
Xackery Xtal d284802447 Moved perlparse to generator
2018-01-18 22:17:28 -08:00

13374 lines
280 KiB
YAML
Executable file
Raw Permalink Blame History

scopes:
- name: NPC
functions:
- name: AI_SetRoambox
summary: AI_SetRoambox.
example: |2-
```perl
my $iDist = 1;
my $iMaxX = 1;
my $iMinX = 1;
my $iMaxY = 1;
my $iMinY = 1;
my $iDelay = 1;
$npc->AI_SetRoambox($iDist, $iMaxX, $iMinX, $iMaxY, $iMinY, $iDelay); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
iDist||
iMaxX||
iMinX||
iMaxY||
iMinY||
iDelay||
- name: AddAISpell
summary: adds a npc a i spell.
example: |2-
```perl
my $priority = 1;
my $spell_id = 1;
my $type = 1;
my $mana_cost = 1;
my $recast_delay = 1;
my $resist_adjust = 1;
$npc->AddAISpell($priority, $spell_id, $type, $mana_cost, $recast_delay, $resist_adjust); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
priority|int|
spell_id|int|
type|int|
mana_cost||
recast_delay||
resist_adjust||
- name: AddCash
summary: adds a npc cash.
example: |2-
```perl
my $in_copper = 1;
my $in_silver = 1;
my $in_gold = 1;
my $in_platinum = 1;
$npc->AddCash($in_copper, $in_silver, $in_gold, $in_platinum); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
in_copper||
in_silver||
in_gold||
in_platinum||
- name: AddDefensiveProc
summary: adds a npc defensive proc.
example: |2-
```perl
my $spellid = 1;
my $chance = 1;
$npc->AddDefensiveProc($spellid, $chance); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
spellid||
chance||
- name: AddItem
summary: adds a npc item.
example: |2-
```perl
my $itemid = 1;
my $charges = 1;
$npc->AddItem($itemid, $charges); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
itemid||
charges|int|
- name: AddLootTable
summary: adds a npc loot table.
example: |2-
```perl
my $loottable_id = 1;
$npc->AddLootTable($loottable_id); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
loottable_id||
- name: AddMeleeProc
summary: adds a npc melee proc.
example: |2-
```perl
my $spellid = 1;
my $chance = 1;
$npc->AddMeleeProc($spellid, $chance); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
spellid||
chance||
- name: AddRangedProc
summary: adds a npc ranged proc.
example: |2-
```perl
my $spellid = 1;
my $chance = 1;
$npc->AddRangedProc($spellid, $chance); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
spellid||
chance||
- name: AssignWaypoints
summary: AssignWaypoints.
example: |2-
```perl
my $grid = 1;
$npc->AssignWaypoints($grid); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
grid||
- name: CalculateNewWaypoint
summary: CalculateNewWaypoint.
example: |2-
```perl
$npc->CalculateNewWaypoint(); # Returns void
```
argument: ""
- name: CheckNPCFactionAlly
summary: CheckNPCFactionAlly.
example: |2-
```perl
my $other_faction = 1;
my $val = $npc->CheckNPCFactionAlly($other_faction);
quest::say($val); # Returns int
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
other_faction||
- name: ClearItemList
summary: ClearItemList.
example: |2-
```perl
$npc->ClearItemList(); # Returns void
```
argument: ""
- name: CountLoot
summary: CountLoot.
example: |2-
```perl
my $val = $npc->CountLoot();
quest::say($val); # Returns uint
```
argument: ""
- name: DisplayWaypointInfo
summary: DisplayWaypointInfo.
example: |2-
```perl
my $to = 1;
$npc->DisplayWaypointInfo($to); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
to||
- name: DoClassAttacks
summary: DoClassAttacks.
example: |2-
```perl
my $target = 1;
$npc->DoClassAttacks($target); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
target||
- name: GetAccuracyRating
summary: gets a npc accuracy rating.
example: |2-
```perl
my $val = $npc->GetAccuracyRating();
quest::say($val); # Returns uint
```
argument: ""
- name: GetAttackDelay
summary: gets a npc attack delay.
example: |2-
```perl
my $val = $npc->GetAttackDelay();
quest::say($val); # Returns double
```
argument: ""
- name: GetAttackSpeed
summary: gets a npc attack speed.
example: |2-
```perl
my $val = $npc->GetAttackSpeed();
quest::say($val); # Returns double
```
argument: ""
- name: GetAvoidanceyRating
summary: gets a npc avoidancey rating.
example: |2-
```perl
my $val = $npc->GetAvoidanceyRating();
quest::say($val); # Returns uint
```
argument: ""
- name: GetCopper
summary: gets a npc copper.
example: |2-
```perl
my $val = $npc->GetCopper();
quest::say($val); # Returns uint
```
argument: ""
- name: GetGold
summary: gets a npc gold.
example: |2-
```perl
my $val = $npc->GetGold();
quest::say($val); # Returns uint
```
argument: ""
- name: GetGrid
summary: gets a npc grid.
example: |2-
```perl
my $val = $npc->GetGrid();
quest::say($val); # Returns int
```
argument: ""
- name: GetGuardPointX
summary: gets a npc guard point x.
example: |2-
```perl
my $val = $npc->GetGuardPointX();
quest::say($val); # Returns double
```
argument: ""
- name: GetGuardPointY
summary: gets a npc guard point y.
example: |2-
```perl
my $val = $npc->GetGuardPointY();
quest::say($val); # Returns double
```
argument: ""
- name: GetGuardPointZ
summary: gets a npc guard point z.
example: |2-
```perl
my $val = $npc->GetGuardPointZ();
quest::say($val); # Returns double
```
argument: ""
- name: GetLoottableID
summary: gets a npc loottable i d.
example: |2-
```perl
my $val = $npc->GetLoottableID();
quest::say($val); # Returns uint
```
argument: ""
- name: GetMaxDMG
summary: gets a npc max d m g.
example: |2-
```perl
my $val = $npc->GetMaxDMG();
quest::say($val); # Returns uint
```
argument: ""
- name: GetMaxDamage
summary: gets a npc max damage.
example: |2-
```perl
my $tlevel = 1;
my $val = $npc->GetMaxDamage($tlevel);
quest::say($val); # Returns uint
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
tlevel||
- name: GetMaxWp
summary: gets a npc max wp.
example: |2-
```perl
my $val = $npc->GetMaxWp();
quest::say($val); # Returns int
```
argument: ""
- name: GetMerchantProbability
summary: gets a npc merchant probability.
example: |2-
```perl
my $val = $npc->GetMerchantProbability();
quest::say($val); # Returns uint
```
argument: ""
- name: GetMinDMG
summary: gets a npc min d m g.
example: |2-
```perl
my $val = $npc->GetMinDMG();
quest::say($val); # Returns uint
```
argument: ""
- name: GetNPCFactionID
summary: gets a npc npcf action i d.
example: |2-
```perl
my $val = $npc->GetNPCFactionID();
quest::say($val); # Returns int
```
argument: ""
- name: GetNPCHate
summary: gets a npc npch ate.
example: |2-
```perl
my $in_ent = 1;
my $val = $npc->GetNPCHate($in_ent);
quest::say($val); # Returns int
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
in_ent||
- name: GetNPCSpellsID
summary: gets a npc npcs pells i d.
example: |2-
```perl
my $val = $npc->GetNPCSpellsID();
quest::say($val); # Returns uint
```
argument: ""
- name: GetPetSpellID
summary: gets a npc pet spell i d.
example: |2-
```perl
my $val = $npc->GetPetSpellID();
quest::say($val); # Returns uint
```
argument: ""
- name: GetPlatinum
summary: gets a npc platinum.
example: |2-
```perl
my $val = $npc->GetPlatinum();
quest::say($val); # Returns uint
```
argument: ""
- name: GetPrimSkill
summary: gets a npc prim skill.
example: |2-
```perl
my $val = $npc->GetPrimSkill();
quest::say($val); # Returns uint
```
argument: ""
- name: GetPrimaryFaction
summary: gets a npc primary faction.
example: |2-
```perl
my $val = $npc->GetPrimaryFaction();
quest::say($val); # Returns int
```
argument: ""
- name: GetScore
summary: gets a npc score.
example: |2-
```perl
my $val = $npc->GetScore();
quest::say($val); # Returns int
```
argument: ""
- name: GetSecSkill
summary: gets a npc sec skill.
example: |2-
```perl
my $val = $npc->GetSecSkill();
quest::say($val); # Returns uint
```
argument: ""
- name: GetSilver
summary: gets a npc silver.
example: |2-
```perl
my $val = $npc->GetSilver();
quest::say($val); # Returns uint
```
argument: ""
- name: GetSlowMitigation
summary: gets a npc slow mitigation.
example: |2-
```perl
my $val = $npc->GetSlowMitigation();
quest::say($val); # Returns double
```
argument: ""
- name: GetSp2
summary: gets a npc sp2.
example: |2-
```perl
my $val = $npc->GetSp2();
quest::say($val); # Returns uint
```
argument: ""
- name: GetSpawnKillCount
summary: gets a npc spawn kill count.
example: |2-
```perl
my $val = $npc->GetSpawnKillCount();
quest::say($val); # Returns uint
```
argument: ""
- name: GetSpawnPointH
summary: gets a npc spawn point h.
example: |2-
```perl
my $val = $npc->GetSpawnPointH();
quest::say($val); # Returns double
```
argument: ""
- name: GetSpawnPointID
summary: gets a npc spawn point i d.
example: |2-
```perl
my $val = $npc->GetSpawnPointID();
quest::say($val); # Returns uint
```
argument: ""
- name: GetSpawnPointX
summary: gets a npc spawn point x.
example: |2-
```perl
my $val = $npc->GetSpawnPointX();
quest::say($val); # Returns double
```
argument: ""
- name: GetSpawnPointY
summary: gets a npc spawn point y.
example: |2-
```perl
my $val = $npc->GetSpawnPointY();
quest::say($val); # Returns double
```
argument: ""
- name: GetSpawnPointZ
summary: gets a npc spawn point z.
example: |2-
```perl
my $val = $npc->GetSpawnPointZ();
quest::say($val); # Returns double
```
argument: ""
- name: GetSpellFocusDMG
summary: gets a npc spell focus d m g.
example: |2-
```perl
my $val = $npc->GetSpellFocusDMG();
quest::say($val); # Returns uint
```
argument: ""
- name: GetSpellFocusHeal
summary: gets a npc spell focus heal.
example: |2-
```perl
my $val = $npc->GetSpellFocusHeal();
quest::say($val); # Returns uint
```
argument: ""
- name: GetSwarmOwner
summary: gets a npc swarm owner.
example: |2-
```perl
my $val = $npc->GetSwarmOwner();
quest::say($val); # Returns uint
```
argument: ""
- name: GetSwarmTarget
summary: gets a npc swarm target.
example: |2-
```perl
my $val = $npc->GetSwarmTarget();
quest::say($val); # Returns uint
```
argument: ""
- name: GetWaypointMax
summary: gets a npc waypoint max.
example: |2-
```perl
my $val = $npc->GetWaypointMax();
quest::say($val); # Returns uint
```
argument: ""
- name: IsAnimal
summary: is a npc animal.
example: |2-
```perl
my $val = $npc->IsAnimal();
quest::say($val); # Returns bool
```
argument: ""
- name: IsGuarding
summary: is a npc guarding.
example: |2-
```perl
my $val = $npc->IsGuarding();
quest::say($val); # Returns bool
```
argument: ""
- name: IsOnHatelist
summary: is a npc on hatelist.
example: |2-
```perl
my $p = 1;
my $val = $npc->IsOnHatelist($p);
quest::say($val); # Returns bool
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
p||
- name: ModifyNPCStat
summary: ModifyNPCStat.
example: |2-
```perl
my $identifier = 1;
my $newValue = 1;
$npc->ModifyNPCStat($identifier, $newValue); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
identifier||
newValue||
- name: MoveTo
summary: MoveTo.
example: |2-
```perl
my $mtx = 1;
my $mty = 1;
my $mtz = 1;
my $mth = 1;
my $saveguard = 1;
$npc->MoveTo($mtx, $mty, $mtz, $mth, $saveguard); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
mtx||
mty||
mtz||
mth||
saveguard|bool|
- name: NextGuardPosition
summary: NextGuardPosition.
example: |2-
```perl
$npc->NextGuardPosition(); # Returns void
```
argument: ""
- name: PauseWandering
summary: PauseWandering.
example: |2-
```perl
my $pausetime = 1;
$npc->PauseWandering($pausetime); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
pausetime||
- name: PickPocket
summary: PickPocket.
example: |2-
```perl
my $thief = 1;
$npc->PickPocket($thief); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
thief||
- name: RemoveAISpell
summary: RemoveAISpell.
example: |2-
```perl
my $spell_id = 1;
$npc->RemoveAISpell($spell_id); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
spell_id|int|
- name: RemoveCash
summary: RemoveCash.
example: |2-
```perl
$npc->RemoveCash(); # Returns void
```
argument: ""
- name: RemoveDefensiveProc
summary: RemoveDefensiveProc.
example: |2-
```perl
my $spellid = 1;
$npc->RemoveDefensiveProc($spellid); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
spellid||
- name: RemoveFromHateList
summary: RemoveFromHateList.
example: |2-
```perl
my $ent = 1;
$npc->RemoveFromHateList($ent); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
ent||
- name: RemoveItem
summary: RemoveItem.
example: |2-
```perl
my $item_id = 1;
my $quantity = 1;
$npc->RemoveItem($item_id, $quantity); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
item_id|int|
quantity|int|
- name: RemoveMeleeProc
summary: RemoveMeleeProc.
example: |2-
```perl
my $spellid = 1;
$npc->RemoveMeleeProc($spellid); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
spellid||
- name: RemoveRangedProc
summary: RemoveRangedProc.
example: |2-
```perl
my $spellid = 1;
$npc->RemoveRangedProc($spellid); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
spellid||
- name: ResumeWandering
summary: ResumeWandering.
example: |2-
```perl
$npc->ResumeWandering(); # Returns void
```
argument: ""
- name: SaveGuardSpot
summary: SaveGuardSpot.
example: |2-
```perl
my $iClearGuardSpot = 1;
$npc->SaveGuardSpot($iClearGuardSpot); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
iClearGuardSpot||
- name: SetCopper
summary: sets a npc copper.
example: |2-
```perl
my $amt = 1;
$npc->SetCopper($amt); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
amt||
- name: SetGold
summary: sets a npc gold.
example: |2-
```perl
my $amt = 1;
$npc->SetGold($amt); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
amt||
- name: SetGrid
summary: sets a npc grid.
example: |2-
```perl
my $grid_ = 1;
$npc->SetGrid($grid_); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
grid_||
- name: SetMerchantProbability
summary: sets a npc merchant probability.
example: |2-
```perl
my $Probability = 1;
$npc->SetMerchantProbability($Probability); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
Probability||
- name: SetNPCFactionID
summary: sets a npc npcf action i d.
example: |2-
```perl
my $in = 1;
$npc->SetNPCFactionID($in); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
in||
- name: SetPetSpellID
summary: sets a npc pet spell i d.
example: |2-
```perl
my $amt = 1;
$npc->SetPetSpellID($amt); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
amt||
- name: SetPlatinum
summary: sets a npc platinum.
example: |2-
```perl
my $amt = 1;
$npc->SetPlatinum($amt); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
amt||
- name: SetPrimSkill
summary: sets a npc prim skill.
example: |2-
```perl
my $skill_id = 1;
$npc->SetPrimSkill($skill_id); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
skill_id||
- name: SetSaveWaypoint
summary: sets a npc save waypoint.
example: |2-
```perl
my $waypoint = 1;
$npc->SetSaveWaypoint($waypoint); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
waypoint||
- name: SetSecSkill
summary: sets a npc sec skill.
example: |2-
```perl
my $skill_id = 1;
$npc->SetSecSkill($skill_id); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
skill_id||
- name: SetSilver
summary: sets a npc silver.
example: |2-
```perl
my $amt = 1;
$npc->SetSilver($amt); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
amt||
- name: SetSp2
summary: sets a npc sp2.
example: |2-
```perl
my $sg2 = 1;
$npc->SetSp2($sg2); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
sg2||
- name: SetSpellFocusDMG
summary: sets a npc spell focus d m g.
example: |2-
```perl
my $NewSpellFocusDMG = 1;
$npc->SetSpellFocusDMG($NewSpellFocusDMG); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
NewSpellFocusDMG||
- name: SetSpellFocusHeal
summary: sets a npc spell focus heal.
example: |2-
```perl
my $NewSpellFocusHeal = 1;
$npc->SetSpellFocusHeal($NewSpellFocusHeal); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
NewSpellFocusHeal||
- name: SetSwarmTarget
summary: sets a npc swarm target.
example: |2-
```perl
my $target_id = 1;
$npc->SetSwarmTarget($target_id); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
target_id|int|
- name: SetTaunting
summary: sets a npc taunting.
example: |2-
```perl
my $tog = 1;
$npc->SetTaunting($tog); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
tog||
- name: SetWaypointPause
summary: sets a npc waypoint pause.
example: |2-
```perl
$npc->SetWaypointPause(); # Returns void
```
argument: ""
- name: SignalNPC
summary: SignalNPC.
example: |2-
```perl
my $_signal_id = 1;
$npc->SignalNPC($_signal_id); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
_signal_id||
- name: StartSwarmTimer
summary: StartSwarmTimer.
example: |2-
```perl
my $duration = 1;
$npc->StartSwarmTimer($duration); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
duration|int|
- name: StopWandering
summary: StopWandering.
example: |2-
```perl
$npc->StopWandering(); # Returns void
```
argument: ""
- name: UpdateWaypoint
summary: UpdateWaypoint.
example: |2-
```perl
my $wp_index = 1;
$npc->UpdateWaypoint($wp_index); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
wp_index||
- name: Client
functions:
- name: AccountID
summary: AccountID.
example: |2-
```perl
my $val = $client->AccountID();
quest::say($val); # Returns uint
```
argument: ""
- name: AccountName
summary: AccountName.
example: |2-
```perl
my $val = $client->AccountName();
quest::say($val); # Returns string
```
argument: ""
- name: AddAAPoints
summary: adds a client a a points.
example: |2-
```perl
my $number = 1;
$client->AddAAPoints($number); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
number|int|
- name: AddAlternateCurrencyValue
summary: adds a client alternate currency value.
example: |2-
```perl
my $currency_id = 1;
my $amount = 1;
$client->AddAlternateCurrencyValue($currency_id, $amount); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
currency_id||
amount||
- name: AddCrystals
summary: adds a client crystals.
example: |2-
```perl
my $RadiantCount = 1;
my $EbonCount = 1;
$client->AddCrystals($RadiantCount, $EbonCount); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
RadiantCount||
EbonCount||
- name: AddEXP
summary: adds a client e x p.
example: |2-
```perl
my $add_exp = 1;
my $conlevel = 1;
$client->AddEXP($add_exp, $conlevel); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
add_exp||
conlevel||
- name: AddLevelBasedExp
summary: adds a client level based exp.
example: |2-
```perl
my $exp_percentage = 1;
my $max_level = 1;
$client->AddLevelBasedExp($exp_percentage, $max_level); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
exp_percentage||
max_level|int|
- name: AddMoneyToPP
summary: adds a client money to p p.
example: |2-
```perl
my $copper = 1;
my $silver = 1;
my $gold = 1;
my $platinum = 1;
my $updateclient = 1;
$client->AddMoneyToPP($copper, $silver, $gold, $platinum, $updateclient); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
copper|int|
silver|int|
gold|int|
platinum|int|
updateclient||
- name: AddPVPPoints
summary: adds a client p v p points.
example: |2-
```perl
my $Points = 1;
$client->AddPVPPoints($Points); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
Points||
- name: AddSkill
summary: adds a client skill.
example: |2-
```perl
my $skillid = 1;
my $value = 1;
$client->AddSkill($skillid, $value); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
skillid||
value|int|
- name: Admin
summary: Admin.
example: |2-
```perl
my $val = $client->Admin();
quest::say($val); # Returns int
```
argument: ""
- name: AssignTask
summary: AssignTask.
example: |2-
```perl
my $TaskID = 1;
my $NPCID = 1;
my $enforce_level_requirement = 1;
$client->AssignTask($TaskID, $NPCID, $enforce_level_requirement); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
TaskID||
NPCID||
enforce_level_requirement|bool|
- name: AssignToInstance
summary: AssignToInstance.
example: |2-
```perl
my $instance_id = 1;
$client->AssignToInstance($instance_id); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
instance_id|int|
- name: AutoSplitEnabled
summary: AutoSplitEnabled.
example: |2-
```perl
my $val = $client->AutoSplitEnabled();
quest::say($val); # Returns bool
```
argument: ""
- name: BreakInvis
summary: BreakInvis.
example: |2-
```perl
$client->BreakInvis(); # Returns void
```
argument: ""
- name: CalcEXP
summary: CalcEXP.
example: |2-
```perl
my $conlevel = 1;
my $val = $client->CalcEXP($conlevel);
quest::say($val); # Returns int
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
conlevel||
- name: CalcPriceMod
summary: CalcPriceMod.
example: |2-
```perl
my $other = 1;
my $val = $client->CalcPriceMod($other);
quest::say($val); # Returns double
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
other||
- name: CanHaveSkill
summary: CanHaveSkill.
example: |2-
```perl
my $skill_id = 1;
my $val = $client->CanHaveSkill($skill_id);
quest::say($val); # Returns bool
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
skill_id||
- name: ChangeLastName
summary: ChangeLastName.
example: |2-
```perl
my $in_lastname = "test";
$client->ChangeLastName($in_lastname); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
in_lastname|string|
- name: CharacterID
summary: CharacterID.
example: |2-
```perl
my $val = $client->CharacterID();
quest::say($val); # Returns uint
```
argument: ""
- name: CheckIncreaseSkill
summary: CheckIncreaseSkill.
example: |2-
```perl
my $skillid = 1;
my $chancemodi = 1;
my $val = $client->CheckIncreaseSkill($skillid, $chancemodi);
quest::say($val); # Returns bool
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
skillid||
chancemodi||
- name: CheckSpecializeIncrease
summary: CheckSpecializeIncrease.
example: |2-
```perl
my $spell_id = 1;
$client->CheckSpecializeIncrease($spell_id); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
spell_id|int|
- name: ClearCompassMark
summary: ClearCompassMark.
example: |2-
```perl
$client->ClearCompassMark(); # Returns void
```
argument: ""
- name: ClearZoneFlag
summary: ClearZoneFlag.
example: |2-
```perl
my $zone_id = 1;
$client->ClearZoneFlag($zone_id); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
zone_id|int|
- name: Connected
summary: Connected.
example: |2-
```perl
my $val = $client->Connected();
quest::say($val); # Returns bool
```
argument: ""
- name: DecreaseByID
summary: DecreaseByID.
example: |2-
```perl
my $type = 1;
my $amt = 1;
my $val = $client->DecreaseByID($type, $amt);
quest::say($val); # Returns bool
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
type|int|
amt||
- name: DeleteItemInInventory
summary: DeleteItemInInventory.
example: |2-
```perl
my $slot_id = 1;
my $quantity = 1;
$client->DeleteItemInInventory($slot_id, $quantity); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
slot_id||
quantity|int|
- name: Disconnect
summary: Disconnect.
example: |2-
```perl
$client->Disconnect(); # Returns void
```
argument: ""
- name: DropItem
summary: DropItem.
example: |2-
```perl
my $slot_id = 1;
$client->DropItem($slot_id); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
slot_id||
- name: Duck
summary: Duck.
example: |2-
```perl
$client->Duck(); # Returns void
```
argument: ""
- name: Escape
summary: Escape.
example: |2-
```perl
$client->Escape(); # Returns void
```
argument: ""
- name: ExpeditionMessage
summary: ExpeditionMessage.
example: |2-
```perl
my $ExpdID = 1;
my $Message = 1;
$client->ExpeditionMessage($ExpdID, $Message); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
ExpdID||
Message||
- name: FailTask
summary: FailTask.
example: |2-
```perl
my $TaskID = 1;
$client->FailTask($TaskID); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
TaskID||
- name: ForageItem
summary: ForageItem.
example: |2-
```perl
$client->ForageItem(); # Returns void
```
argument: ""
- name: Freeze
summary: Freeze.
example: |2-
```perl
$client->Freeze(); # Returns void
```
argument: ""
- name: GMKill
summary: GMKill.
example: |2-
```perl
$client->GMKill(); # Returns void
```
argument: ""
- name: GetAAExp
summary: gets a client a a exp.
example: |2-
```perl
my $val = $client->GetAAExp();
quest::say($val); # Returns uint
```
argument: ""
- name: GetAALevel
summary: gets a client a a level.
example: |2-
```perl
my $aaskillid = 1;
my $val = $client->GetAALevel($aaskillid);
quest::say($val); # Returns uint
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
aaskillid||
- name: GetAAPercent
summary: gets a client a a percent.
example: |2-
```perl
my $val = $client->GetAAPercent();
quest::say($val); # Returns uint
```
argument: ""
- name: GetAAPoints
summary: gets a client a a points.
example: |2-
```perl
my $val = $client->GetAAPoints();
quest::say($val); # Returns uint
```
argument: ""
- name: GetAccountAge
summary: gets a client account age.
example: |2-
```perl
my $val = $client->GetAccountAge();
quest::say($val); # Returns double
```
argument: ""
- name: GetAccountFlag
summary: gets a client account flag.
example: |2-
```perl
my $flag = 1;
my $val = $client->GetAccountFlag($flag);
quest::say($val); # Returns string
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
flag||
- name: GetAggroCount
summary: gets a client aggro count.
example: |2-
```perl
my $val = $client->GetAggroCount();
quest::say($val); # Returns int
```
argument: ""
- name: GetAllMoney
summary: gets a client all money.
example: |2-
```perl
my $val = $client->GetAllMoney();
quest::say($val); # Returns int
```
argument: ""
- name: GetAnon
summary: gets a client anon.
example: |2-
```perl
my $val = $client->GetAnon();
quest::say($val); # Returns uint
```
argument: ""
- name: GetAugmentAt
summary: gets a client augment at.
example: |2-
```perl
my $slot = 1;
my $aug_slot = 1;
$client->GetAugmentAt($slot, $aug_slot); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
slot|int|
aug_slot||
- name: GetAugmentIDAt
summary: gets a client augment ida t.
example: |2-
```perl
my $slot_id = 1;
my $augslot = 1;
my $val = $client->GetAugmentIDAt($slot_id, $augslot);
quest::say($val); # Returns int
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
slot_id||
augslot||
- name: GetBaseAGI
summary: gets a client base a g i.
example: |2-
```perl
my $val = $client->GetBaseAGI();
quest::say($val); # Returns uint
```
argument: ""
- name: GetBaseCHA
summary: gets a client base c h a.
example: |2-
```perl
my $val = $client->GetBaseCHA();
quest::say($val); # Returns uint
```
argument: ""
- name: GetBaseDEX
summary: gets a client base d e x.
example: |2-
```perl
my $val = $client->GetBaseDEX();
quest::say($val); # Returns uint
```
argument: ""
- name: GetBaseFace
summary: gets a client base face.
example: |2-
```perl
my $val = $client->GetBaseFace();
quest::say($val); # Returns uint
```
argument: ""
- name: GetBaseINT
summary: gets a client base i n t.
example: |2-
```perl
my $val = $client->GetBaseINT();
quest::say($val); # Returns uint
```
argument: ""
- name: GetBaseSTA
summary: gets a client base s t a.
example: |2-
```perl
my $val = $client->GetBaseSTA();
quest::say($val); # Returns uint
```
argument: ""
- name: GetBaseSTR
summary: gets a client base s t r.
example: |2-
```perl
my $val = $client->GetBaseSTR();
quest::say($val); # Returns uint
```
argument: ""
- name: GetBaseWIS
summary: gets a client base w i s.
example: |2-
```perl
my $val = $client->GetBaseWIS();
quest::say($val); # Returns uint
```
argument: ""
- name: GetBecomeNPCLevel
summary: gets a client become npcl evel.
example: |2-
```perl
my $val = $client->GetBecomeNPCLevel();
quest::say($val); # Returns uint
```
argument: ""
- name: GetBindHeading
summary: gets a client bind heading.
example: |2-
```perl
my $index = 1;
my $val = $client->GetBindHeading($index);
quest::say($val); # Returns double
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
index||
- name: GetBindX
summary: gets a client bind x.
example: |2-
```perl
my $index = 1;
my $val = $client->GetBindX($index);
quest::say($val); # Returns double
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
index||
- name: GetBindY
summary: gets a client bind y.
example: |2-
```perl
my $index = 1;
my $val = $client->GetBindY($index);
quest::say($val); # Returns double
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
index||
- name: GetBindZ
summary: gets a client bind z.
example: |2-
```perl
my $index = 1;
my $val = $client->GetBindZ($index);
quest::say($val); # Returns double
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
index||
- name: GetBindZoneID
summary: gets a client bind zone i d.
example: |2-
```perl
my $index = 1;
my $val = $client->GetBindZoneID($index);
quest::say($val); # Returns uint
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
index||
- name: GetCarriedMoney
summary: gets a client carried money.
example: |2-
```perl
my $val = $client->GetCarriedMoney();
quest::say($val); # Returns int
```
argument: ""
- name: GetCharacterFactionLevel
summary: gets a client character faction level.
example: |2-
```perl
my $faction_id = 1;
my $val = $client->GetCharacterFactionLevel($faction_id);
quest::say($val); # Returns int
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
faction_id||
- name: GetClientVersion
summary: gets a client client version.
example: |2-
```perl
my $val = $client->GetClientVersion();
quest::say($val); # Returns uint
```
argument: ""
- name: GetClientVersionBit
summary: gets a client client version bit.
example: |2-
```perl
my $val = $client->GetClientVersionBit();
quest::say($val); # Returns uint
```
argument: ""
- name: GetCorpseCount
summary: gets a client corpse count.
example: |2-
```perl
my $val = $client->GetCorpseCount();
quest::say($val); # Returns int
```
argument: ""
- name: GetCorpseID
summary: gets a client corpse i d.
example: |2-
```perl
my $corpse = 1;
my $val = $client->GetCorpseID($corpse);
quest::say($val); # Returns int
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
corpse||
- name: GetCorpseItemAt
summary: gets a client corpse item at.
example: |2-
```perl
my $corpse_id = 1;
my $slotid = 1;
my $val = $client->GetCorpseItemAt($corpse_id, $slotid);
quest::say($val); # Returns int
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
corpse_id||
slotid||
- name: GetCustomItemData
summary: gets a client custom item data.
example: |2-
```perl
my $slot_id = 1;
my $identifier = 1;
my $val = $client->GetCustomItemData($slot_id, $identifier);
quest::say($val); # Returns string
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
slot_id||
identifier||
- name: GetDiscSlotBySpellID
summary: gets a client disc slot by spell i d.
example: |2-
```perl
my $spell_id = 1;
my $val = $client->GetDiscSlotBySpellID($spell_id);
quest::say($val); # Returns int
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
spell_id|int|
- name: GetDuelTarget
summary: gets a client duel target.
example: |2-
```perl
my $val = $client->GetDuelTarget();
quest::say($val); # Returns uint
```
argument: ""
- name: GetEXP
summary: gets a client e x p.
example: |2-
```perl
my $val = $client->GetEXP();
quest::say($val); # Returns uint
```
argument: ""
- name: GetEbonCrystals
summary: gets a client ebon crystals.
example: |2-
```perl
my $val = $client->GetEbonCrystals();
quest::say($val); # Returns uint
```
argument: ""
- name: GetEndurance
summary: gets a client endurance.
example: |2-
```perl
my $val = $client->GetEndurance();
quest::say($val); # Returns uint
```
argument: ""
- name: GetEnduranceRatio
summary: gets a client endurance ratio.
example: |2-
```perl
my $val = $client->GetEnduranceRatio();
quest::say($val); # Returns uint
```
argument: ""
- name: GetFace
summary: gets a client face.
example: |2-
```perl
my $val = $client->GetFace();
quest::say($val); # Returns uint
```
argument: ""
- name: GetFactionLevel
summary: gets a client faction level.
example: |2-
```perl
my $char_id = 1;
my $npc_id = 1;
my $p_race = 1;
my $p_class = 1;
my $p_deity = 1;
my $pFaction = 1;
my $tnpc = 1;
my $val = $client->GetFactionLevel($char_id, $npc_id, $p_race, $p_class, $p_deity, $pFaction, $tnpc);
quest::say($val); # Returns int
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
char_id|int|
npc_id|int|
p_race||
p_class||
p_deity||
pFaction||
tnpc||
- name: GetFeigned
summary: gets a client feigned.
example: |2-
```perl
my $val = $client->GetFeigned();
quest::say($val); # Returns bool
```
argument: ""
- name: GetFreeSpellBookSlot
summary: gets a client free spell book slot.
example: |2-
```perl
my $start_slot = 1;
my $val = $client->GetFreeSpellBookSlot($start_slot);
quest::say($val); # Returns int
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
start_slot||
- name: GetGM
summary: gets a client g m.
example: |2-
```perl
my $val = $client->GetGM();
quest::say($val); # Returns bool
```
argument: ""
- name: GetGroup
summary: gets a client group.
example: |2-
```perl
$client->GetGroup(); # Returns void
```
argument: ""
- name: GetGroupPoints
summary: gets a client group points.
example: |2-
```perl
my $val = $client->GetGroupPoints();
quest::say($val); # Returns uint
```
argument: ""
- name: GetHorseId
summary: gets a client horse id.
example: |2-
```perl
my $val = $client->GetHorseId();
quest::say($val); # Returns uint
```
argument: ""
- name: GetHunger
summary: gets a client hunger.
example: |2-
```perl
my $val = $client->GetHunger();
quest::say($val); # Returns int
```
argument: ""
- name: GetIP
summary: gets a client i p.
example: |2-
```perl
my $val = $client->GetIP();
quest::say($val); # Returns uint
```
argument: ""
- name: GetInstanceID
summary: gets a client instance i d.
example: |2-
```perl
my $val = $client->GetInstanceID();
quest::say($val); # Returns uint
```
argument: ""
- name: GetInstrumentMod
summary: gets a client instrument mod.
example: |2-
```perl
my $spell_id = 1;
my $val = $client->GetInstrumentMod($spell_id);
quest::say($val); # Returns uint
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
spell_id|int|
- name: GetItemAt
summary: gets a client item at.
example: |2-
```perl
my $slot = 1;
$client->GetItemAt($slot); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
slot|int|
- name: GetItemIDAt
summary: gets a client item ida t.
example: |2-
```perl
my $slot_id = 1;
my $val = $client->GetItemIDAt($slot_id);
quest::say($val); # Returns int
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
slot_id||
- name: GetItemInInventory
summary: gets a client item in inventory.
example: |2-
```perl
my $slot_id = 1;
$client->GetItemInInventory($slot_id); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
slot_id||
- name: GetLDoNLosses
summary: gets a client l do n losses.
example: |2-
```perl
my $val = $client->GetLDoNLosses();
quest::say($val); # Returns uint
```
argument: ""
- name: GetLDoNLossesTheme
summary: gets a client l do n losses theme.
example: |2-
```perl
my $theme = 1;
my $val = $client->GetLDoNLossesTheme($theme);
quest::say($val); # Returns uint
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
theme||
- name: GetLDoNPointsTheme
summary: gets a client l do n points theme.
example: |2-
```perl
my $theme = 1;
my $val = $client->GetLDoNPointsTheme($theme);
quest::say($val); # Returns uint
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
theme||
- name: GetLDoNWins
summary: gets a client l do n wins.
example: |2-
```perl
my $val = $client->GetLDoNWins();
quest::say($val); # Returns uint
```
argument: ""
- name: GetLDoNWinsTheme
summary: gets a client l do n wins theme.
example: |2-
```perl
my $theme = 1;
my $val = $client->GetLDoNWinsTheme($theme);
quest::say($val); # Returns uint
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
theme||
- name: GetLanguageSkill
summary: gets a client language skill.
example: |2-
```perl
my $n = 1;
my $val = $client->GetLanguageSkill($n);
quest::say($val); # Returns uint
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
n||
- name: GetLastName
summary: gets a client last name.
example: |2-
```perl
my $val = $client->GetLastName();
quest::say($val); # Returns string
```
argument: ""
- name: GetMaxEndurance
summary: gets a client max endurance.
example: |2-
```perl
my $val = $client->GetMaxEndurance();
quest::say($val); # Returns uint
```
argument: ""
- name: GetModCharacterFactionLevel
summary: gets a client mod character faction level.
example: |2-
```perl
my $faction_id = 1;
my $val = $client->GetModCharacterFactionLevel($faction_id);
quest::say($val); # Returns int
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
faction_id||
- name: GetMoney
summary: gets a client money.
example: |2-
```perl
my $type = 1;
my $subtype = 1;
my $val = $client->GetMoney($type, $subtype);
quest::say($val); # Returns double
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
type|int|
subtype||
- name: GetPVP
summary: gets a client p v p.
example: |2-
```perl
my $val = $client->GetPVP();
quest::say($val); # Returns bool
```
argument: ""
- name: GetPVPPoints
summary: gets a client p v p points.
example: |2-
```perl
my $val = $client->GetPVPPoints();
quest::say($val); # Returns uint
```
argument: ""
- name: GetRadiantCrystals
summary: gets a client radiant crystals.
example: |2-
```perl
my $val = $client->GetRadiantCrystals();
quest::say($val); # Returns uint
```
argument: ""
- name: GetRaid
summary: gets a client raid.
example: |2-
```perl
$client->GetRaid(); # Returns void
```
argument: ""
- name: GetRaidPoints
summary: gets a client raid points.
example: |2-
```perl
my $val = $client->GetRaidPoints();
quest::say($val); # Returns uint
```
argument: ""
- name: GetRawItemAC
summary: gets a client raw item a c.
example: |2-
```perl
my $val = $client->GetRawItemAC();
quest::say($val); # Returns int
```
argument: ""
- name: GetRawSkill
summary: gets a client raw skill.
example: |2-
```perl
my $skill_id = 1;
my $val = $client->GetRawSkill($skill_id);
quest::say($val); # Returns uint
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
skill_id||
- name: GetSkill
summary: gets a client skill.
example: |2-
```perl
my $skill_id = 1;
my $val = $client->GetSkill($skill_id);
quest::say($val); # Returns uint
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
skill_id||
- name: GetSkillPoints
summary: gets a client skill points.
example: |2-
```perl
my $val = $client->GetSkillPoints();
quest::say($val); # Returns uint
```
argument: ""
- name: GetSpellBookSlotBySpellID
summary: gets a client spell book slot by spell i d.
example: |2-
```perl
my $spell_id = 1;
my $val = $client->GetSpellBookSlotBySpellID($spell_id);
quest::say($val); # Returns int
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
spell_id|int|
- name: GetSpentAA
summary: gets a client spent a a.
example: |2-
```perl
my $val = $client->GetSpentAA();
quest::say($val); # Returns uint
```
argument: ""
- name: GetStartZone
summary: gets a client start zone.
example: |2-
```perl
my $val = $client->GetStartZone();
quest::say($val); # Returns uint
```
argument: ""
- name: GetTargetRingX
summary: gets a client target ring x.
example: |2-
```perl
my $val = $client->GetTargetRingX();
quest::say($val); # Returns double
```
argument: ""
- name: GetTargetRingY
summary: gets a client target ring y.
example: |2-
```perl
my $val = $client->GetTargetRingY();
quest::say($val); # Returns double
```
argument: ""
- name: GetTargetRingZ
summary: gets a client target ring z.
example: |2-
```perl
my $val = $client->GetTargetRingZ();
quest::say($val); # Returns double
```
argument: ""
- name: GetTaskActivityDoneCount
summary: gets a client task activity done count.
example: |2-
```perl
my $TaskID = 1;
my $ActivityID = 1;
my $val = $client->GetTaskActivityDoneCount($TaskID, $ActivityID);
quest::say($val); # Returns int
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
TaskID||
ActivityID||
- name: GetThirst
summary: gets a client thirst.
example: |2-
```perl
my $val = $client->GetThirst();
quest::say($val); # Returns int
```
argument: ""
- name: GetTotalSecondsPlayed
summary: gets a client total seconds played.
example: |2-
```perl
my $val = $client->GetTotalSecondsPlayed();
quest::say($val); # Returns uint
```
argument: ""
- name: GetWeight
summary: gets a client weight.
example: |2-
```perl
my $val = $client->GetWeight();
quest::say($val); # Returns uint
```
argument: ""
- name: GoFish
summary: GoFish.
example: |2-
```perl
$client->GoFish(); # Returns void
```
argument: ""
- name: GrantAlternateAdvancementAbility
summary: GrantAlternateAdvancementAbility.
example: |2-
```perl
my $aa_id = 1;
my $points = 1;
my $ignore_cost = 1;
my $val = $client->GrantAlternateAdvancementAbility($aa_id, $points, $ignore_cost);
quest::say($val); # Returns bool
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
aa_id||
points||
ignore_cost||
- name: GuildID
summary: GuildID.
example: |2-
```perl
my $val = $client->GuildID();
quest::say($val); # Returns uint
```
argument: ""
- name: GuildRank
summary: GuildRank.
example: |2-
```perl
my $val = $client->GuildRank();
quest::say($val); # Returns uint
```
argument: ""
- name: HasSkill
summary: HasSkill.
example: |2-
```perl
my $skill_id = 1;
my $val = $client->HasSkill($skill_id);
quest::say($val); # Returns bool
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
skill_id||
- name: HasSpellScribed
summary: HasSpellScribed.
example: |2-
```perl
my $spell_id = 1;
my $val = $client->HasSpellScribed($spell_id);
quest::say($val); # Returns bool
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
spell_id|int|
- name: HasZoneFlag
summary: HasZoneFlag.
example: |2-
```perl
my $zone_id = 1;
my $val = $client->HasZoneFlag($zone_id);
quest::say($val); # Returns bool
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
zone_id|int|
- name: Hungry
summary: Hungry.
example: |2-
```perl
my $val = $client->Hungry();
quest::say($val); # Returns bool
```
argument: ""
- name: InZone
summary: InZone.
example: |2-
```perl
my $val = $client->InZone();
quest::say($val); # Returns bool
```
argument: ""
- name: IncStats
summary: IncStats.
example: |2-
```perl
my $type = 1;
my $increase_val = 1;
$client->IncStats($type, $increase_val); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
type|int|
increase_val||
- name: IncreaseLanguageSkill
summary: IncreaseLanguageSkill.
example: |2-
```perl
my $skill_id = 1;
my $value = 1;
$client->IncreaseLanguageSkill($skill_id, $value); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
skill_id||
value|int|
- name: IncreaseSkill
summary: IncreaseSkill.
example: |2-
```perl
my $skill_id = 1;
my $value = 1;
$client->IncreaseSkill($skill_id, $value); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
skill_id||
value|int|
- name: IncrementAA
summary: IncrementAA.
example: |2-
```perl
my $aaskillid = 1;
$client->IncrementAA($aaskillid); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
aaskillid||
- name: IsBecomeNPC
summary: is a client become n p c.
example: |2-
```perl
my $val = $client->IsBecomeNPC();
quest::say($val); # Returns bool
```
argument: ""
- name: IsDueling
summary: is a client dueling.
example: |2-
```perl
my $val = $client->IsDueling();
quest::say($val); # Returns bool
```
argument: ""
- name: IsGrouped
summary: is a client grouped.
example: |2-
```perl
my $val = $client->IsGrouped();
quest::say($val); # Returns bool
```
argument: ""
- name: IsLD
summary: is a client l d.
example: |2-
```perl
my $val = $client->IsLD();
quest::say($val); # Returns bool
```
argument: ""
- name: IsMedding
summary: is a client medding.
example: |2-
```perl
my $val = $client->IsMedding();
quest::say($val); # Returns bool
```
argument: ""
- name: IsRaidGrouped
summary: is a client raid grouped.
example: |2-
```perl
my $val = $client->IsRaidGrouped();
quest::say($val); # Returns bool
```
argument: ""
- name: IsSitting
summary: is a client sitting.
example: |2-
```perl
my $val = $client->IsSitting();
quest::say($val); # Returns bool
```
argument: ""
- name: IsTaskActive
summary: is a client task active.
example: |2-
```perl
my $TaskID = 1;
my $val = $client->IsTaskActive($TaskID);
quest::say($val); # Returns bool
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
TaskID||
- name: IsTaskActivityActive
summary: is a client task activity active.
example: |2-
```perl
my $TaskID = 1;
my $ActivityID = 1;
my $val = $client->IsTaskActivityActive($TaskID, $ActivityID);
quest::say($val); # Returns bool
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
TaskID||
ActivityID||
- name: IsTaskCompleted
summary: is a client task completed.
example: |2-
```perl
my $TaskID = 1;
my $val = $client->IsTaskCompleted($TaskID);
quest::say($val); # Returns bool
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
TaskID||
- name: KeyRingAdd
summary: KeyRingAdd.
example: |2-
```perl
my $item_id = 1;
$client->KeyRingAdd($item_id); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
item_id|int|
- name: KeyRingCheck
summary: KeyRingCheck.
example: |2-
```perl
my $item_id = 1;
my $val = $client->KeyRingCheck($item_id);
quest::say($val); # Returns bool
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
item_id|int|
- name: Kick
summary: Kick.
example: |2-
```perl
$client->Kick(); # Returns void
```
argument: ""
- name: LearnRecipe
summary: LearnRecipe.
example: |2-
```perl
my $recipe_id = 1;
$client->LearnRecipe($recipe_id); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
recipe_id||
- name: LeaveGroup
summary: LeaveGroup.
example: |2-
```perl
$client->LeaveGroup(); # Returns void
```
argument: ""
- name: LoadZoneFlags
summary: LoadZoneFlags.
example: |2-
```perl
$client->LoadZoneFlags(); # Returns void
```
argument: ""
- name: MarkCompassLoc
summary: MarkCompassLoc.
example: |2-
```perl
my $x = 1;
my $y = 1;
my $z = 1;
$client->MarkCompassLoc($x, $y, $z); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
x|float|
y|float|
z|float|
- name: MaxSkill
summary: MaxSkill.
example: |2-
```perl
my $skillid = 1;
my $class = 1;
my $level = 1;
my $val = $client->MaxSkill($skillid, $class, $level);
quest::say($val); # Returns uint
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
skillid||
class||
level|int|
- name: MemSpell
summary: MemSpell.
example: |2-
```perl
my $spell_id = 1;
my $slot = 1;
my $update_client = 1;
$client->MemSpell($spell_id, $slot, $update_client); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
spell_id|int|
slot|int|
update_client||
- name: MovePC
summary: MovePC.
example: |2-
```perl
my $zoneID = 1;
my $x = 1;
my $y = 1;
my $z = 1;
my $heading = 1;
$client->MovePC($zoneID, $x, $y, $z, $heading); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
zoneID||
x|float|
y|float|
z|float|
heading|float|
- name: MovePCInstance
summary: MovePCInstance.
example: |2-
```perl
my $zoneID = 1;
my $instanceID = 1;
my $x = 1;
my $y = 1;
my $z = 1;
my $heading = 1;
$client->MovePCInstance($zoneID, $instanceID, $x, $y, $z, $heading); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
zoneID||
instanceID||
x|float|
y|float|
z|float|
heading|float|
- name: NPCSpawn
summary: NPCSpawn.
example: |2-
```perl
my $target_npc = 1;
my $option = 1;
my $respawntime = 1;
$client->NPCSpawn($target_npc, $option, $respawntime); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
target_npc||
option||
respawntime||
- name: NukeItem
summary: NukeItem.
example: |2-
```perl
my $itemnum = 1;
my $where_to_check = 1;
my $val = $client->NukeItem($itemnum, $where_to_check);
quest::say($val); # Returns uint
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
itemnum||
where_to_check||
- name: OpenLFGuildWindow
summary: OpenLFGuildWindow.
example: |2-
```perl
$client->OpenLFGuildWindow(); # Returns void
```
argument: ""
- name: PlayMP3
summary: plays a client m p3.
example: |2-
```perl
my $fname = 1;
$client->PlayMP3($fname); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
fname||
- name: QuestReward
summary: QuestReward.
example: |2-
```perl
my $mob = 1;
my $copper = 1;
my $silver = 1;
my $gold = 1;
my $platinum = 1;
my $itemid = 1;
my $exp = 1;
my $faction = 1;
$client->QuestReward($mob, $copper, $silver, $gold, $platinum, $itemid, $exp, $faction); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
mob||
copper|int|
silver|int|
gold|int|
platinum|int|
itemid||
exp||
faction||
- name: ReadBook
summary: ReadBook.
example: |2-
```perl
my $Text = 1;
my $Type = 1;
$client->ReadBook($Text, $Type); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
Text||
Type||
- name: RefundAA
summary: RefundAA.
example: |2-
```perl
$client->RefundAA(); # Returns void
```
argument: ""
- name: RemoveFromInstance
summary: RemoveFromInstance.
example: |2-
```perl
my $instance_id = 1;
$client->RemoveFromInstance($instance_id); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
instance_id|int|
- name: RemoveNoRent
summary: RemoveNoRent.
example: |2-
```perl
$client->RemoveNoRent(); # Returns void
```
argument: ""
- name: ResetAA
summary: ResetAA.
example: |2-
```perl
$client->ResetAA(); # Returns void
```
argument: ""
- name: ResetTrade
summary: ResetTrade.
example: |2-
```perl
$client->ResetTrade(); # Returns void
```
argument: ""
- name: Save
summary: Save.
example: |2-
```perl
my $iCommitNow = 1;
my $val = $client->Save($iCommitNow);
quest::say($val); # Returns bool
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
iCommitNow||
- name: SaveBackup
summary: SaveBackup.
example: |2-
```perl
$client->SaveBackup(); # Returns void
```
argument: ""
- name: ScribeSpell
summary: ScribeSpell.
example: |2-
```perl
my $spell_id = 1;
my $slot = 1;
my $update_client = 1;
$client->ScribeSpell($spell_id, $slot, $update_client); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
spell_id|int|
slot|int|
update_client||
- name: SendColoredText
summary: sends a client colored text.
example: |2-
```perl
my $color = 1;
my $message = "test";
$client->SendColoredText($color, $message); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
color|int|
message|string|
- name: SendMarqueeMessage
summary: sends a client marquee message.
example: |2-
```perl
my $type = 1;
my $priority = 1;
my $fade_in = 1;
my $fade_out = 1;
my $duration = 1;
my $msg = 1;
$client->SendMarqueeMessage($type, $priority, $fade_in, $fade_out, $duration, $msg); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
type|int|
priority|int|
fade_in|int|
fade_out|int|
duration|int|
msg||
- name: SendOPTranslocateConfirm
summary: sends a client o p translocate confirm.
example: |2-
```perl
my $Caster = 1;
my $SpellID = 1;
$client->SendOPTranslocateConfirm($Caster, $SpellID); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
Caster||
SpellID||
- name: SendSound
summary: sends a client sound.
example: |2-
```perl
$client->SendSound(); # Returns void
```
argument: ""
- name: SendSpellAnim
summary: sends a client spell anim.
example: |2-
```perl
my $spell_id = 1;
my $seq = 1;
$client->SendSpellAnim($spell_id, $seq); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
spell_id||
seq||
- name: SendTargetCommand
summary: sends a client target command.
example: |2-
```perl
my $in_entid = 1;
$client->SendTargetCommand($in_entid); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
in_entid||
- name: SendWebLink
summary: sends a client web link.
example: |2-
```perl
my $website = 1;
$client->SendWebLink($website); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
website||
- name: SendZoneFlagInfo
summary: sends a client zone flag info.
example: |2-
```perl
my $to = 1;
$client->SendZoneFlagInfo($to); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
to||
- name: SetAAPoints
summary: sets a client a a points.
example: |2-
```perl
my $points = 1;
$client->SetAAPoints($points); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
points||
- name: SetAATitle
summary: sets a client a a title.
example: |2-
```perl
my $txt = 1;
my $save = 1;
$client->SetAATitle($txt, $save); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
txt||
save||
- name: SetAccountFlag
summary: sets a client account flag.
example: |2-
```perl
my $flag = 1;
my $value = 1;
$client->SetAccountFlag($flag, $value); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
flag||
value|int|
- name: SetBaseClass
summary: sets a client base class.
example: |2-
```perl
my $i = 1;
$client->SetBaseClass($i); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
i||
- name: SetBaseGender
summary: sets a client base gender.
example: |2-
```perl
my $i = 1;
$client->SetBaseGender($i); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
i||
- name: SetBaseRace
summary: sets a client base race.
example: |2-
```perl
my $i = 1;
$client->SetBaseRace($i); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
i||
- name: SetBecomeNPC
summary: sets a client become n p c.
example: |2-
```perl
my $flag = 1;
$client->SetBecomeNPC($flag); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
flag||
- name: SetBecomeNPCLevel
summary: sets a client become npcl evel.
example: |2-
```perl
my $level = 1;
$client->SetBecomeNPCLevel($level); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
level|int|
- name: SetBindPoint
summary: sets a client bind point.
example: |2-
```perl
my $to_zone = 1;
$client->SetBindPoint($to_zone); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
to_zone||
- name: SetCustomItemData
summary: sets a client custom item data.
example: |2-
```perl
my $slot_id = 1;
my $identifier = 1;
my $value = 1;
$client->SetCustomItemData($slot_id, $identifier, $value); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
slot_id||
identifier||
value|int|
- name: SetDeity
summary: sets a client deity.
example: |2-
```perl
my $i = 1;
$client->SetDeity($i); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
i||
- name: SetDuelTarget
summary: sets a client duel target.
example: |2-
```perl
my $set_id = 1;
$client->SetDuelTarget($set_id); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
set_id||
- name: SetDueling
summary: sets a client dueling.
example: |2-
```perl
my $duel = 1;
$client->SetDueling($duel); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
duel||
- name: SetEXP
summary: sets a client e x p.
example: |2-
```perl
my $set_exp = 1;
my $set_aaxp = 1;
my $resexp = 1;
$client->SetEXP($set_exp, $set_aaxp, $resexp); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
set_exp||
set_aaxp||
resexp||
- name: SetEndurance
summary: sets a client endurance.
example: |2-
```perl
my $Endurance = 1;
$client->SetEndurance($Endurance); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
Endurance||
- name: SetFactionLevel
summary: sets a client faction level.
example: |2-
```perl
my $char_id = 1;
my $npc_id = 1;
my $char_class = 1;
my $char_race = 1;
my $char_deity = 1;
$client->SetFactionLevel($char_id, $npc_id, $char_class, $char_race, $char_deity); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
char_id|int|
npc_id|int|
char_class||
char_race||
char_deity||
- name: SetFactionLevel2
summary: sets a client faction level2.
example: |2-
```perl
my $char_id = 1;
my $faction_id = 1;
my $char_class = 1;
my $char_race = 1;
my $char_deity = 1;
my $value = 1;
my $temp = 1;
$client->SetFactionLevel2($char_id, $faction_id, $char_class, $char_race, $char_deity, $value, $temp); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
char_id|int|
faction_id||
char_class||
char_race||
char_deity||
value|int|
temp|int|
- name: SetFeigned
summary: sets a client feigned.
example: |2-
```perl
my $in_feigned = 1;
$client->SetFeigned($in_feigned); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
in_feigned||
- name: SetGM
summary: sets a client g m.
example: |2-
```perl
my $toggle = 1;
$client->SetGM($toggle); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
toggle||
- name: SetHorseId
summary: sets a client horse id.
example: |2-
```perl
my $horseid_in = 1;
$client->SetHorseId($horseid_in); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
horseid_in||
- name: SetHunger
summary: sets a client hunger.
example: |2-
```perl
my $in_hunger = 1;
my $in_thirst = 1;
$client->SetHunger($in_hunger, $in_thirst); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
in_hunger||
in_thirst||
- name: SetLanguageSkill
summary: sets a client language skill.
example: |2-
```perl
my $langid = 1;
my $value = 1;
$client->SetLanguageSkill($langid, $value); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
langid||
value|int|
- name: SetMaterial
summary: sets a client material.
example: |2-
```perl
my $slot_id = 1;
my $item_id = 1;
$client->SetMaterial($slot_id, $item_id); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
slot_id||
item_id|int|
- name: SetPVP
summary: sets a client p v p.
example: |2-
```perl
my $toggle = 1;
$client->SetPVP($toggle); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
toggle||
- name: SetSkill
summary: sets a client skill.
example: |2-
```perl
my $skill_num = 1;
my $value = 1;
$client->SetSkill($skill_num, $value); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
skill_num||
value|int|
- name: SetSkillPoints
summary: sets a client skill points.
example: |2-
```perl
my $inp = 1;
$client->SetSkillPoints($inp); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
inp||
- name: SetStartZone
summary: sets a client start zone.
example: |2-
```perl
my $ = 1;
my $x = 1;
my $y = 1;
my $z = 1;
$client->SetStartZone($, $x, $y, $z); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
||
x|float|
y|float|
z|float|
- name: SetStats
summary: sets a client stats.
example: |2-
```perl
my $type = 1;
my $increase_val = 1;
$client->SetStats($type, $increase_val); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
type|int|
increase_val||
- name: SetThirst
summary: sets a client thirst.
example: |2-
```perl
my $in_thirst = 1;
$client->SetThirst($in_thirst); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
in_thirst||
- name: SetTint
summary: sets a client tint.
example: |2-
```perl
my $slot_id = 1;
my $color = 1;
$client->SetTint($slot_id, $color); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
slot_id||
color|int|
- name: SetTitleSuffix
summary: sets a client title suffix.
example: |2-
```perl
my $txt = 1;
my $save = 1;
$client->SetTitleSuffix($txt, $save); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
txt||
save||
- name: SetZoneFlag
summary: sets a client zone flag.
example: |2-
```perl
my $zone_id = 1;
$client->SetZoneFlag($zone_id); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
zone_id|int|
- name: SignalClient
summary: SignalClient.
example: |2-
```perl
my $data = 1;
$client->SignalClient($data); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
data||
- name: SilentMessage
summary: SilentMessage.
example: |2-
```perl
my $Message = 1;
$client->SilentMessage($Message); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
Message||
- name: SlotConvert2
summary: SlotConvert2.
example: |2-
```perl
my $slot = 1;
my $val = $client->SlotConvert2($slot);
quest::say($val); # Returns uint
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
slot|int|
- name: Stand
summary: Stand.
example: |2-
```perl
$client->Stand(); # Returns void
```
argument: ""
- name: SummonItem
summary: SummonItem.
example: |2-
```perl
my $item_id = 1;
my $charges = 1;
$client->SummonItem($item_id, $charges); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
item_id|int|
charges|int|
- name: TGB
summary: TGB.
example: |2-
```perl
my $val = $client->TGB();
quest::say($val); # Returns bool
```
argument: ""
- name: TakeMoneyFromPP
summary: TakeMoneyFromPP.
example: |2-
```perl
my $copper = 1;
my $updateclient = 1;
my $val = $client->TakeMoneyFromPP($copper, $updateclient);
quest::say($val); # Returns bool
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
copper|int|
updateclient||
- name: Thirsty
summary: Thirsty.
example: |2-
```perl
my $val = $client->Thirsty();
quest::say($val); # Returns bool
```
argument: ""
- name: TrainDiscBySpellID
summary: TrainDiscBySpellID.
example: |2-
```perl
my $spell_id = 1;
$client->TrainDiscBySpellID($spell_id); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
spell_id|int|
- name: UnFreeze
summary: UnFreeze.
example: |2-
```perl
$client->UnFreeze(); # Returns void
```
argument: ""
- name: Undye
summary: Undye.
example: |2-
```perl
$client->Undye(); # Returns void
```
argument: ""
- name: UnmemSpell
summary: UnmemSpell.
example: |2-
```perl
my $slot = 1;
my $update_client = 1;
$client->UnmemSpell($slot, $update_client); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
slot|int|
update_client||
- name: UnmemSpellAll
summary: UnmemSpellAll.
example: |2-
```perl
my $update_client = 1;
$client->UnmemSpellAll($update_client); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
update_client||
- name: UnmemSpellBySpellID
summary: UnmemSpellBySpellID.
example: |2-
```perl
my $spell_id = 1;
$client->UnmemSpellBySpellID($spell_id); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
spell_id|int|
- name: UnscribeSpell
summary: UnscribeSpell.
example: |2-
```perl
my $slot = 1;
my $update_client = 1;
$client->UnscribeSpell($slot, $update_client); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
slot|int|
update_client||
- name: UnscribeSpellAll
summary: UnscribeSpellAll.
example: |2-
```perl
my $update_client = 1;
$client->UnscribeSpellAll($update_client); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
update_client||
- name: UntrainDisc
summary: UntrainDisc.
example: |2-
```perl
my $slot = 1;
my $update_client = 1;
$client->UntrainDisc($slot, $update_client); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
slot|int|
update_client||
- name: UntrainDiscAll
summary: UntrainDiscAll.
example: |2-
```perl
my $update_client = 1;
$client->UntrainDiscAll($update_client); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
update_client||
- name: UpdateAdmin
summary: UpdateAdmin.
example: |2-
```perl
my $iFromDB = 1;
$client->UpdateAdmin($iFromDB); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
iFromDB|bool|
- name: UpdateGroupAAs
summary: UpdateGroupAAs.
example: |2-
```perl
my $points = 1;
my $type = 1;
$client->UpdateGroupAAs($points, $type); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
points||
type|int|
- name: UpdateLDoNPoints
summary: UpdateLDoNPoints.
example: |2-
```perl
my $points = 1;
my $theme = 1;
my $val = $client->UpdateLDoNPoints($points, $theme);
quest::say($val); # Returns bool
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
points||
theme||
- name: UpdateTaskActivity
summary: UpdateTaskActivity.
example: |2-
```perl
my $TaskID = 1;
my $ActivityID = 1;
my $Count = 1;
my $ignore_quest_update = 1;
$client->UpdateTaskActivity($TaskID, $ActivityID, $Count, $ignore_quest_update); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
TaskID||
ActivityID||
Count||
ignore_quest_update|bool|
- name: UpdateWho
summary: UpdateWho.
example: |2-
```perl
my $remove = 1;
$client->UpdateWho($remove); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
remove||
- name: UseDiscipline
summary: UseDiscipline.
example: |2-
```perl
my $spell_id = 1;
my $target = 1;
my $val = $client->UseDiscipline($spell_id, $target);
quest::say($val); # Returns bool
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
spell_id|int|
target||
- name: WorldKick
summary: WorldKick.
example: |2-
```perl
$client->WorldKick(); # Returns void
```
argument: ""
- name: Mob
functions:
- name: AddFeignMemory
summary: adds a mob feign memory.
example: |2-
```perl
my $attacker = 1;
$mob->AddFeignMemory($attacker); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
attacker||
- name: AddToHateList
summary: adds a mob to hate list.
example: |2-
```perl
my $other = 1;
my $hate = 1;
$mob->AddToHateList($other, $hate); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
other||
hate||
- name: Attack
summary: Attack.
example: |2-
```perl
my $other = 1;
my $Hand = 1;
my $val = $mob->Attack($other, $Hand);
quest::say($val); # Returns bool
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
other||
Hand||
- name: BehindMob
summary: BehindMob.
example: |2-
```perl
my $other = 1;
my $val = $mob->BehindMob($other);
quest::say($val); # Returns bool
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
other||
- name: BuffFadeAll
summary: BuffFadeAll.
example: |2-
```perl
$mob->BuffFadeAll(); # Returns void
```
argument: ""
- name: BuffFadeByEffect
summary: BuffFadeByEffect.
example: |2-
```perl
my $effectid = 1;
my $skipslot = 1;
$mob->BuffFadeByEffect($effectid, $skipslot); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
effectid||
skipslot||
- name: BuffFadeBySlot
summary: BuffFadeBySlot.
example: |2-
```perl
my $slot = 1;
my $iRecalcBonuses = 1;
$mob->BuffFadeBySlot($slot, $iRecalcBonuses); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
slot|int|
iRecalcBonuses||
- name: BuffFadeBySpellID
summary: BuffFadeBySpellID.
example: |2-
```perl
my $spell_id = 1;
$mob->BuffFadeBySpellID($spell_id); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
spell_id|int|
- name: CalculateDistance
summary: CalculateDistance.
example: |2-
```perl
my $x = 1;
my $y = 1;
my $z = 1;
my $val = $mob->CalculateDistance($x, $y, $z);
quest::say($val); # Returns double
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
x|float|
y|float|
z|float|
- name: CalculateHeadingToTarget
summary: CalculateHeadingToTarget.
example: |2-
```perl
my $in_x = 1;
my $in_y = 1;
my $val = $mob->CalculateHeadingToTarget($in_x, $in_y);
quest::say($val); # Returns int
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
in_x||
in_y||
- name: CalculateNewPosition
summary: CalculateNewPosition.
example: |2-
```perl
my $x = 1;
my $y = 1;
my $z = 1;
my $speed = 1;
my $checkZ = 1;
my $val = $mob->CalculateNewPosition($x, $y, $z, $speed, $checkZ);
quest::say($val); # Returns bool
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
x|float|
y|float|
z|float|
speed||
checkZ||
- name: CalculateNewPosition2
summary: CalculateNewPosition2.
example: |2-
```perl
my $x = 1;
my $y = 1;
my $z = 1;
my $speed = 1;
my $checkZ = 1;
my $val = $mob->CalculateNewPosition2($x, $y, $z, $speed, $checkZ);
quest::say($val); # Returns bool
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
x|float|
y|float|
z|float|
speed||
checkZ||
- name: CameraEffect
summary: CameraEffect.
example: |2-
```perl
my $duration = 1;
my $intensity = 1;
my $singleclient = 1;
my $global = 1;
$mob->CameraEffect($duration, $intensity, $singleclient, $global); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
duration|int|
intensity||
singleclient||
global||
- name: CanBuffStack
summary: CanBuffStack.
example: |2-
```perl
my $spellid = 1;
my $caster_level = 1;
my $iFailIfOverwrite = 1;
my $val = $mob->CanBuffStack($spellid, $caster_level, $iFailIfOverwrite);
quest::say($val); # Returns int
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
spellid||
caster_level||
iFailIfOverwrite||
- name: CanClassEquipItem
summary: CanClassEquipItem.
example: |2-
```perl
my $item_id = 1;
my $val = $mob->CanClassEquipItem($item_id);
quest::say($val); # Returns bool
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
item_id|int|
- name: CanThisClassDodge
summary: CanThisClassDodge.
example: |2-
```perl
my $val = $mob->CanThisClassDodge();
quest::say($val); # Returns bool
```
argument: ""
- name: CanThisClassDoubleAttack
summary: CanThisClassDoubleAttack.
example: |2-
```perl
my $val = $mob->CanThisClassDoubleAttack();
quest::say($val); # Returns bool
```
argument: ""
- name: CanThisClassDualWield
summary: CanThisClassDualWield.
example: |2-
```perl
my $val = $mob->CanThisClassDualWield();
quest::say($val); # Returns bool
```
argument: ""
- name: CanThisClassParry
summary: CanThisClassParry.
example: |2-
```perl
my $val = $mob->CanThisClassParry();
quest::say($val); # Returns bool
```
argument: ""
- name: CanThisClassRiposte
summary: CanThisClassRiposte.
example: |2-
```perl
my $val = $mob->CanThisClassRiposte();
quest::say($val); # Returns bool
```
argument: ""
- name: CastSpell
summary: CastSpell.
example: |2-
```perl
my $spell_id = 1;
my $target_id = 1;
my $slot = 1;
$mob->CastSpell($spell_id, $target_id, $slot); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
spell_id|int|
target_id|int|
slot|int|
- name: CastToClient
summary: CastToClient.
example: |2-
```perl
$mob->CastToClient(); # Returns void
```
argument: ""
- name: CastToCorpse
summary: CastToCorpse.
example: |2-
```perl
$mob->CastToCorpse(); # Returns void
```
argument: ""
- name: CastToMob
summary: CastToMob.
example: |2-
```perl
$mob->CastToMob(); # Returns void
```
argument: ""
- name: CastToNPC
summary: CastToNPC.
example: |2-
```perl
$mob->CastToNPC(); # Returns void
```
argument: ""
- name: CastingSpellID
summary: CastingSpellID.
example: |2-
```perl
my $val = $mob->CastingSpellID();
quest::say($val); # Returns uint
```
argument: ""
- name: ChangeLastName
summary: ChangeLastName.
example: |2-
```perl
my $name = "test";
$mob->ChangeLastName($name); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
name|string|
- name: ChangeSize
summary: ChangeSize.
example: |2-
```perl
my $in_size = 1;
my $bNoRestriction = 1;
$mob->ChangeSize($in_size, $bNoRestriction); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
in_size||
bNoRestriction||
- name: Charmed
summary: Charmed.
example: |2-
```perl
my $val = $mob->Charmed();
quest::say($val); # Returns bool
```
argument: ""
- name: CheckAggro
summary: CheckAggro.
example: |2-
```perl
my $other = 1;
my $val = $mob->CheckAggro($other);
quest::say($val); # Returns bool
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
other||
- name: CheckAggroAmount
summary: CheckAggroAmount.
example: |2-
```perl
my $spellid = 1;
my $val = $mob->CheckAggroAmount($spellid);
quest::say($val); # Returns uint
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
spellid||
- name: CheckHealAggroAmount
summary: CheckHealAggroAmount.
example: |2-
```perl
my $spellid = 1;
my $possible_heal_amt = 1;
my $val = $mob->CheckHealAggroAmount($spellid, $possible_heal_amt);
quest::say($val); # Returns uint
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
spellid||
possible_heal_amt||
- name: CheckLoS
summary: CheckLoS.
example: |2-
```perl
my $mob = 1;
my $val = $mob->CheckLoS($mob);
quest::say($val); # Returns bool
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
mob||
- name: CheckLoSToLoc
summary: CheckLoSToLoc.
example: |2-
```perl
my $loc_x = 1;
my $loc_y = 1;
my $loc_z = 1;
my $mob_size = 1;
my $val = $mob->CheckLoSToLoc($loc_x, $loc_y, $loc_z, $mob_size);
quest::say($val); # Returns bool
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
loc_x||
loc_y||
loc_z||
mob_size||
- name: ClearFeignMemory
summary: ClearFeignMemory.
example: |2-
```perl
$mob->ClearFeignMemory(); # Returns void
```
argument: ""
- name: ClearLastName
summary: ClearLastName.
example: |2-
```perl
$mob->ClearLastName(); # Returns void
```
argument: ""
- name: ClearSpecialAbilities
summary: ClearSpecialAbilities.
example: |2-
```perl
$mob->ClearSpecialAbilities(); # Returns void
```
argument: ""
- name: CombatRange
summary: CombatRange.
example: |2-
```perl
my $target = 1;
my $val = $mob->CombatRange($target);
quest::say($val); # Returns bool
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
target||
- name: Damage
summary: Damage.
example: |2-
```perl
my $from = "test";
my $damage = 1;
my $spell_id = 1;
my $attack_skill = 1;
my $avoidable = 1;
$mob->Damage($from, $damage, $spell_id, $attack_skill, $avoidable); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
from|string|
damage||
spell_id|int|
attack_skill||
avoidable||
- name: DelGlobal
summary: DelGlobal.
example: |2-
```perl
my $varname = 1;
$mob->DelGlobal($varname); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
varname||
- name: Depop
summary: Depop.
example: |2-
```perl
my $StartSpawnTimer = 1;
$mob->Depop($StartSpawnTimer); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
StartSpawnTimer||
- name: DivineAura
summary: DivineAura.
example: |2-
```perl
my $val = $mob->DivineAura();
quest::say($val); # Returns bool
```
argument: ""
- name: DoAnim
summary: DoAnim.
example: |2-
```perl
my $animnum = 1;
my $type = 1;
$mob->DoAnim($animnum, $type); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
animnum||
type|int|
- name: DoArcheryAttackDmg
summary: DoArcheryAttackDmg.
example: |2-
```perl
my $target = 1;
my $RangeWeapon = 1;
$mob->DoArcheryAttackDmg($target, $RangeWeapon); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
target||
RangeWeapon||
- name: DoKnockback
summary: DoKnockback.
example: |2-
```perl
my $caster = 1;
my $pushback = 1;
my $pushup = 1;
$mob->DoKnockback($caster, $pushback, $pushup); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
caster||
pushback||
pushup||
- name: DoMeleeSkillAttackDmg
summary: DoMeleeSkillAttackDmg.
example: |2-
```perl
my $target = 1;
my $weapon_damage = 1;
my $skill = 1;
my $chance_mod = 1;
my $focus = 1;
my $CanRiposte = 1;
$mob->DoMeleeSkillAttackDmg($target, $weapon_damage, $skill, $chance_mod, $focus, $CanRiposte); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
target||
weapon_damage||
skill||
chance_mod||
focus||
CanRiposte||
- name: DoSpecialAttackDamage
summary: DoSpecialAttackDamage.
example: |2-
```perl
my $target = 1;
my $skill = 1;
my $max_damage = 1;
my $min_damage = 1;
$mob->DoSpecialAttackDamage($target, $skill, $max_damage, $min_damage); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
target||
skill||
max_damage||
min_damage||
- name: DoThrowingAttackDmg
summary: DoThrowingAttackDmg.
example: |2-
```perl
my $target = 1;
my $RangeWeapon = 1;
$mob->DoThrowingAttackDmg($target, $RangeWeapon); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
target||
RangeWeapon||
- name: DontBuffMeBefore
summary: DontBuffMeBefore.
example: |2-
```perl
my $val = $mob->DontBuffMeBefore();
quest::say($val); # Returns uint
```
argument: ""
- name: DontDotMeBefore
summary: DontDotMeBefore.
example: |2-
```perl
my $val = $mob->DontDotMeBefore();
quest::say($val); # Returns uint
```
argument: ""
- name: DontHealMeBefore
summary: DontHealMeBefore.
example: |2-
```perl
my $val = $mob->DontHealMeBefore();
quest::say($val); # Returns uint
```
argument: ""
- name: DontRootMeBefore
summary: DontRootMeBefore.
example: |2-
```perl
my $val = $mob->DontRootMeBefore();
quest::say($val); # Returns uint
```
argument: ""
- name: DontSnareMeBefore
summary: DontSnareMeBefore.
example: |2-
```perl
my $val = $mob->DontSnareMeBefore();
quest::say($val); # Returns uint
```
argument: ""
- name: DoubleAggro
summary: DoubleAggro.
example: |2-
```perl
my $other = 1;
$mob->DoubleAggro($other); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
other||
- name: Emote
summary: Emote.
example: |2-
```perl
my $format = "test";
$mob->Emote($format, ...); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
format|string|
...||
- name: EntityVariableExists
summary: EntityVariableExists.
example: |2-
```perl
my $id = 1;
my $val = $mob->EntityVariableExists($id);
quest::say($val); # Returns bool
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
id||
- name: FaceTarget
summary: FaceTarget.
example: |2-
```perl
my $MobToFace = 1;
$mob->FaceTarget($MobToFace); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
MobToFace||
- name: FindBuff
summary: FindBuff.
example: |2-
```perl
my $spellid = 1;
my $val = $mob->FindBuff($spellid);
quest::say($val); # Returns bool
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
spellid||
- name: FindGroundZ
summary: FindGroundZ.
example: |2-
```perl
my $new_x = 1;
my $new_y = 1;
my $z_offset = 1;
my $val = $mob->FindGroundZ($new_x, $new_y, $z_offset);
quest::say($val); # Returns double
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
new_x||
new_y||
z_offset||
- name: FindType
summary: FindType.
example: |2-
```perl
my $type = 1;
my $bOffensive = 1;
my $val = $mob->FindType($type, $bOffensive);
quest::say($val); # Returns bool
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
type|int|
bOffensive||
- name: GMMove
summary: GMMove.
example: |2-
```perl
my $x = 1;
my $y = 1;
my $z = 1;
my $heading = 1;
$mob->GMMove($x, $y, $z, $heading); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
x|float|
y|float|
z|float|
heading|float|
- name: Gate
summary: Gate.
example: |2-
```perl
$mob->Gate(); # Returns void
```
argument: ""
- name: GetAA
summary: gets a mob a a.
example: |2-
```perl
my $rank_id = 1;
my $val = $mob->GetAA($rank_id);
quest::say($val); # Returns uint
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
rank_id||
- name: GetAAByAAID
summary: gets a mob a a by a a i d.
example: |2-
```perl
my $aa_id = 1;
my $val = $mob->GetAAByAAID($aa_id);
quest::say($val); # Returns uint
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
aa_id||
- name: GetAC
summary: gets a mob a c.
example: |2-
```perl
my $val = $mob->GetAC();
quest::say($val); # Returns uint
```
argument: ""
- name: GetAGI
summary: gets a mob a g i.
example: |2-
```perl
my $val = $mob->GetAGI();
quest::say($val); # Returns int
```
argument: ""
- name: GetATK
summary: gets a mob a t k.
example: |2-
```perl
my $val = $mob->GetATK();
quest::say($val); # Returns uint
```
argument: ""
- name: GetActSpellCasttime
summary: gets a mob act spell casttime.
example: |2-
```perl
my $spell_id = 1;
my $casttime = 1;
my $val = $mob->GetActSpellCasttime($spell_id, $casttime);
quest::say($val); # Returns int
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
spell_id|int|
casttime||
- name: GetActSpellCost
summary: gets a mob act spell cost.
example: |2-
```perl
my $spell_id = 1;
my $cost = 1;
my $val = $mob->GetActSpellCost($spell_id, $cost);
quest::say($val); # Returns int
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
spell_id|int|
cost|int|
- name: GetActSpellDamage
summary: gets a mob act spell damage.
example: |2-
```perl
my $spell_id = 1;
my $value = 1;
my $val = $mob->GetActSpellDamage($spell_id, $value);
quest::say($val); # Returns int
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
spell_id|int|
value|int|
- name: GetActSpellDuration
summary: gets a mob act spell duration.
example: |2-
```perl
my $spell_id = 1;
my $duration = 1;
my $val = $mob->GetActSpellDuration($spell_id, $duration);
quest::say($val); # Returns int
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
spell_id|int|
duration|int|
- name: GetActSpellHealing
summary: gets a mob act spell healing.
example: |2-
```perl
my $spell_id = 1;
my $value = 1;
my $val = $mob->GetActSpellHealing($spell_id, $value);
quest::say($val); # Returns int
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
spell_id|int|
value|int|
- name: GetActSpellRange
summary: gets a mob act spell range.
example: |2-
```perl
my $spell_id = 1;
my $range = 1;
my $val = $mob->GetActSpellRange($spell_id, $range);
quest::say($val); # Returns double
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
spell_id|int|
range||
- name: GetAggroRange
summary: gets a mob aggro range.
example: |2-
```perl
my $val = $mob->GetAggroRange();
quest::say($val); # Returns double
```
argument: ""
- name: GetAllowBeneficial
summary: gets a mob allow beneficial.
example: |2-
```perl
my $val = $mob->GetAllowBeneficial();
quest::say($val); # Returns bool
```
argument: ""
- name: GetAppearance
summary: gets a mob appearance.
example: |2-
```perl
my $val = $mob->GetAppearance();
quest::say($val); # Returns uint
```
argument: ""
- name: GetArmorTint
summary: gets a mob armor tint.
example: |2-
```perl
my $material_slot = 1;
my $val = $mob->GetArmorTint($material_slot);
quest::say($val); # Returns int
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
material_slot||
- name: GetAssistRange
summary: gets a mob assist range.
example: |2-
```perl
my $val = $mob->GetAssistRange();
quest::say($val); # Returns double
```
argument: ""
- name: GetBaseGender
summary: gets a mob base gender.
example: |2-
```perl
my $val = $mob->GetBaseGender();
quest::say($val); # Returns uint
```
argument: ""
- name: GetBaseRace
summary: gets a mob base race.
example: |2-
```perl
my $val = $mob->GetBaseRace();
quest::say($val); # Returns uint
```
argument: ""
- name: GetBaseSize
summary: gets a mob base size.
example: |2-
```perl
my $val = $mob->GetBaseSize();
quest::say($val); # Returns double
```
argument: ""
- name: GetBeard
summary: gets a mob beard.
example: |2-
```perl
my $val = $mob->GetBeard();
quest::say($val); # Returns uint
```
argument: ""
- name: GetBeardColor
summary: gets a mob beard color.
example: |2-
```perl
my $val = $mob->GetBeardColor();
quest::say($val); # Returns uint
```
argument: ""
- name: GetBodyType
summary: gets a mob body type.
example: |2-
```perl
my $val = $mob->GetBodyType();
quest::say($val); # Returns uint
```
argument: ""
- name: GetBuffSlotFromType
summary: gets a mob buff slot from type.
example: |2-
```perl
my $type = 1;
my $val = $mob->GetBuffSlotFromType($type);
quest::say($val); # Returns int
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
type|int|
- name: GetCHA
summary: gets a mob c h a.
example: |2-
```perl
my $val = $mob->GetCHA();
quest::say($val); # Returns int
```
argument: ""
- name: GetCR
summary: gets a mob c r.
example: |2-
```perl
my $val = $mob->GetCR();
quest::say($val); # Returns int
```
argument: ""
- name: GetCasterLevel
summary: gets a mob caster level.
example: |2-
```perl
my $spell_id = 1;
my $val = $mob->GetCasterLevel($spell_id);
quest::say($val); # Returns int
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
spell_id|int|
- name: GetClass
summary: gets a mob class.
example: |2-
```perl
my $val = $mob->GetClass();
quest::say($val); # Returns uint
```
argument: ""
- name: GetClassLevelFactor
summary: gets a mob class level factor.
example: |2-
```perl
my $val = $mob->GetClassLevelFactor();
quest::say($val); # Returns uint
```
argument: ""
- name: GetCleanName
summary: gets a mob clean name.
example: |2-
```perl
my $val = $mob->GetCleanName();
quest::say($val); # Returns string
```
argument: ""
- name: GetCorruption
summary: gets a mob corruption.
example: |2-
```perl
my $val = $mob->GetCorruption();
quest::say($val); # Returns int
```
argument: ""
- name: GetDEX
summary: gets a mob d e x.
example: |2-
```perl
my $val = $mob->GetDEX();
quest::say($val); # Returns int
```
argument: ""
- name: GetDR
summary: gets a mob d r.
example: |2-
```perl
my $val = $mob->GetDR();
quest::say($val); # Returns int
```
argument: ""
- name: GetDamageAmount
summary: gets a mob damage amount.
example: |2-
```perl
my $tmob = 1;
my $val = $mob->GetDamageAmount($tmob);
quest::say($val); # Returns uint
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
tmob||
- name: GetDeity
summary: gets a mob deity.
example: |2-
```perl
my $val = $mob->GetDeity();
quest::say($val); # Returns uint
```
argument: ""
- name: GetDrakkinDetails
summary: gets a mob drakkin details.
example: |2-
```perl
my $val = $mob->GetDrakkinDetails();
quest::say($val); # Returns uint
```
argument: ""
- name: GetDrakkinHeritage
summary: gets a mob drakkin heritage.
example: |2-
```perl
my $val = $mob->GetDrakkinHeritage();
quest::say($val); # Returns uint
```
argument: ""
- name: GetDrakkinTattoo
summary: gets a mob drakkin tattoo.
example: |2-
```perl
my $val = $mob->GetDrakkinTattoo();
quest::say($val); # Returns uint
```
argument: ""
- name: GetEntityVariable
summary: gets a mob entity variable.
example: |2-
```perl
my $id = 1;
my $val = $mob->GetEntityVariable($id);
quest::say($val); # Returns string
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
id||
- name: GetEquipment
summary: gets a mob equipment.
example: |2-
```perl
my $material_slot = 1;
my $val = $mob->GetEquipment($material_slot);
quest::say($val); # Returns int
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
material_slot||
- name: GetEquipmentColor
summary: gets a mob equipment color.
example: |2-
```perl
my $material_slot = 1;
my $val = $mob->GetEquipmentColor($material_slot);
quest::say($val); # Returns int
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
material_slot||
- name: GetEquipmentMaterial
summary: gets a mob equipment material.
example: |2-
```perl
my $material_slot = 1;
my $val = $mob->GetEquipmentMaterial($material_slot);
quest::say($val); # Returns int
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
material_slot||
- name: GetEyeColor1
summary: gets a mob eye color1.
example: |2-
```perl
my $val = $mob->GetEyeColor1();
quest::say($val); # Returns uint
```
argument: ""
- name: GetEyeColor2
summary: gets a mob eye color2.
example: |2-
```perl
my $val = $mob->GetEyeColor2();
quest::say($val); # Returns uint
```
argument: ""
- name: GetFR
summary: gets a mob f r.
example: |2-
```perl
my $val = $mob->GetFR();
quest::say($val); # Returns int
```
argument: ""
- name: GetFlurryChance
summary: gets a mob flurry chance.
example: |2-
```perl
my $val = $mob->GetFlurryChance();
quest::say($val); # Returns uint
```
argument: ""
- name: GetFollowID
summary: gets a mob follow i d.
example: |2-
```perl
my $val = $mob->GetFollowID();
quest::say($val); # Returns uint
```
argument: ""
- name: GetGender
summary: gets a mob gender.
example: |2-
```perl
my $val = $mob->GetGender();
quest::say($val); # Returns uint
```
argument: ""
- name: GetGlobal
summary: gets a mob global.
example: |2-
```perl
my $varname = 1;
my $val = $mob->GetGlobal($varname);
quest::say($val); # Returns string
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
varname||
- name: GetHP
summary: gets a mob h p.
example: |2-
```perl
my $val = $mob->GetHP();
quest::say($val); # Returns int
```
argument: ""
- name: GetHPRatio
summary: gets a mob h p ratio.
example: |2-
```perl
my $val = $mob->GetHPRatio();
quest::say($val); # Returns double
```
argument: ""
- name: GetHairColor
summary: gets a mob hair color.
example: |2-
```perl
my $val = $mob->GetHairColor();
quest::say($val); # Returns uint
```
argument: ""
- name: GetHairStyle
summary: gets a mob hair style.
example: |2-
```perl
my $val = $mob->GetHairStyle();
quest::say($val); # Returns uint
```
argument: ""
- name: GetHandToHandDamage
summary: gets a mob hand to hand damage.
example: |2-
```perl
my $val = $mob->GetHandToHandDamage();
quest::say($val); # Returns int
```
argument: ""
- name: GetHandToHandDelay
summary: gets a mob hand to hand delay.
example: |2-
```perl
my $val = $mob->GetHandToHandDelay();
quest::say($val); # Returns int
```
argument: ""
- name: GetHaste
summary: gets a mob haste.
example: |2-
```perl
my $val = $mob->GetHaste();
quest::say($val); # Returns int
```
argument: ""
- name: GetHateAmount
summary: gets a mob hate amount.
example: |2-
```perl
my $tmob = 1;
my $is_dam = 1;
my $val = $mob->GetHateAmount($tmob, $is_dam);
quest::say($val); # Returns uint
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
tmob||
is_dam||
- name: GetHateDamageTop
summary: gets a mob hate damage top.
example: |2-
```perl
my $other = 1;
$mob->GetHateDamageTop($other); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
other||
- name: GetHateList
summary: gets a mob hate list.
example: |2-
```perl
my $val = $mob->GetHateList();
quest::say($val); # Returns array
```
argument: ""
- name: GetHateRandom
summary: gets a mob hate random.
example: |2-
```perl
$mob->GetHateRandom(); # Returns void
```
argument: ""
- name: GetHateTop
summary: gets a mob hate top.
example: |2-
```perl
$mob->GetHateTop(); # Returns void
```
argument: ""
- name: GetHeading
summary: gets a mob heading.
example: |2-
```perl
my $val = $mob->GetHeading();
quest::say($val); # Returns double
```
argument: ""
- name: GetHelmTexture
summary: gets a mob helm texture.
example: |2-
```perl
my $val = $mob->GetHelmTexture();
quest::say($val); # Returns uint
```
argument: ""
- name: GetHerosForgeModel
summary: gets a mob heros forge model.
example: |2-
```perl
my $material_slot = 1;
my $val = $mob->GetHerosForgeModel($material_slot);
quest::say($val); # Returns int
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
material_slot||
- name: GetID
summary: gets a mob i d.
example: |2-
```perl
my $val = $mob->GetID();
quest::say($val); # Returns uint
```
argument: ""
- name: GetINT
summary: gets a mob i n t.
example: |2-
```perl
my $val = $mob->GetINT();
quest::say($val); # Returns int
```
argument: ""
- name: GetInvul
summary: gets a mob invul.
example: |2-
```perl
my $val = $mob->GetInvul();
quest::say($val); # Returns bool
```
argument: ""
- name: GetItemHPBonuses
summary: gets a mob item h p bonuses.
example: |2-
```perl
my $val = $mob->GetItemHPBonuses();
quest::say($val); # Returns int
```
argument: ""
- name: GetItemStat
summary: gets a mob item stat.
example: |2-
```perl
my $itemid = 1;
my $stat = 1;
my $val = $mob->GetItemStat($itemid, $stat);
quest::say($val); # Returns int
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
itemid||
stat||
- name: GetLevel
summary: gets a mob level.
example: |2-
```perl
my $val = $mob->GetLevel();
quest::say($val); # Returns uint
```
argument: ""
- name: GetLevelCon
summary: gets a mob level con.
example: |2-
```perl
my $iOtherLevel = 1;
my $val = $mob->GetLevelCon($iOtherLevel);
quest::say($val); # Returns uint
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
iOtherLevel||
- name: GetLevelHP
summary: gets a mob level h p.
example: |2-
```perl
my $tlevel = 1;
my $val = $mob->GetLevelHP($tlevel);
quest::say($val); # Returns uint
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
tlevel||
- name: GetLuclinFace
summary: gets a mob luclin face.
example: |2-
```perl
my $val = $mob->GetLuclinFace();
quest::say($val); # Returns uint
```
argument: ""
- name: GetMR
summary: gets a mob m r.
example: |2-
```perl
my $val = $mob->GetMR();
quest::say($val); # Returns int
```
argument: ""
- name: GetMana
summary: gets a mob mana.
example: |2-
```perl
my $val = $mob->GetMana();
quest::say($val); # Returns int
```
argument: ""
- name: GetManaRatio
summary: gets a mob mana ratio.
example: |2-
```perl
my $val = $mob->GetManaRatio();
quest::say($val); # Returns double
```
argument: ""
- name: GetMaxAGI
summary: gets a mob max a g i.
example: |2-
```perl
my $val = $mob->GetMaxAGI();
quest::say($val); # Returns int
```
argument: ""
- name: GetMaxCHA
summary: gets a mob max c h a.
example: |2-
```perl
my $val = $mob->GetMaxCHA();
quest::say($val); # Returns int
```
argument: ""
- name: GetMaxDEX
summary: gets a mob max d e x.
example: |2-
```perl
my $val = $mob->GetMaxDEX();
quest::say($val); # Returns int
```
argument: ""
- name: GetMaxHP
summary: gets a mob max h p.
example: |2-
```perl
my $val = $mob->GetMaxHP();
quest::say($val); # Returns int
```
argument: ""
- name: GetMaxINT
summary: gets a mob max i n t.
example: |2-
```perl
my $val = $mob->GetMaxINT();
quest::say($val); # Returns int
```
argument: ""
- name: GetMaxMana
summary: gets a mob max mana.
example: |2-
```perl
my $val = $mob->GetMaxMana();
quest::say($val); # Returns int
```
argument: ""
- name: GetMaxSTA
summary: gets a mob max s t a.
example: |2-
```perl
my $val = $mob->GetMaxSTA();
quest::say($val); # Returns int
```
argument: ""
- name: GetMaxSTR
summary: gets a mob max s t r.
example: |2-
```perl
my $val = $mob->GetMaxSTR();
quest::say($val); # Returns int
```
argument: ""
- name: GetMaxWIS
summary: gets a mob max w i s.
example: |2-
```perl
my $val = $mob->GetMaxWIS();
quest::say($val); # Returns int
```
argument: ""
- name: GetModSkillDmgTaken
summary: gets a mob mod skill dmg taken.
example: |2-
```perl
my $skill_num = 1;
my $val = $mob->GetModSkillDmgTaken($skill_num);
quest::say($val); # Returns int
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
skill_num||
- name: GetModVulnerability
summary: gets a mob mod vulnerability.
example: |2-
```perl
my $resist = 1;
my $val = $mob->GetModVulnerability($resist);
quest::say($val); # Returns int
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
resist||
- name: GetNPCTypeID
summary: gets a mob npct ype i d.
example: |2-
```perl
my $val = $mob->GetNPCTypeID();
quest::say($val); # Returns uint
```
argument: ""
- name: GetName
summary: gets a mob name.
example: |2-
```perl
my $val = $mob->GetName();
quest::say($val); # Returns string
```
argument: ""
- name: GetNimbusEffect1
summary: gets a mob nimbus effect1.
example: |2-
```perl
my $val = $mob->GetNimbusEffect1();
quest::say($val); # Returns uint
```
argument: ""
- name: GetNimbusEffect2
summary: gets a mob nimbus effect2.
example: |2-
```perl
my $val = $mob->GetNimbusEffect2();
quest::say($val); # Returns uint
```
argument: ""
- name: GetNimbusEffect3
summary: gets a mob nimbus effect3.
example: |2-
```perl
my $val = $mob->GetNimbusEffect3();
quest::say($val); # Returns uint
```
argument: ""
- name: GetOwnerID
summary: gets a mob owner i d.
example: |2-
```perl
my $val = $mob->GetOwnerID();
quest::say($val); # Returns uint
```
argument: ""
- name: GetPR
summary: gets a mob p r.
example: |2-
```perl
my $val = $mob->GetPR();
quest::say($val); # Returns int
```
argument: ""
- name: GetPetID
summary: gets a mob pet i d.
example: |2-
```perl
my $val = $mob->GetPetID();
quest::say($val); # Returns uint
```
argument: ""
- name: GetPetOrder
summary: gets a mob pet order.
example: |2-
```perl
my $val = $mob->GetPetOrder();
quest::say($val); # Returns int
```
argument: ""
- name: GetPetType
summary: gets a mob pet type.
example: |2-
```perl
my $val = $mob->GetPetType();
quest::say($val); # Returns uint
```
argument: ""
- name: GetPhR
summary: gets a mob ph r.
example: |2-
```perl
my $val = $mob->GetPhR();
quest::say($val); # Returns int
```
argument: ""
- name: GetRace
summary: gets a mob race.
example: |2-
```perl
my $val = $mob->GetRace();
quest::say($val); # Returns uint
```
argument: ""
- name: GetResist
summary: gets a mob resist.
example: |2-
```perl
my $type = 1;
my $val = $mob->GetResist($type);
quest::say($val); # Returns int
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
type|int|
- name: GetReverseFactionCon
summary: gets a mob reverse faction con.
example: |2-
```perl
my $iOther = 1;
my $val = $mob->GetReverseFactionCon($iOther);
quest::say($val); # Returns int
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
iOther||
- name: GetRunAnimSpeed
summary: gets a mob run anim speed.
example: |2-
```perl
my $val = $mob->GetRunAnimSpeed();
quest::say($val); # Returns uint
```
argument: ""
- name: GetRunspeed
summary: gets a mob runspeed.
example: |2-
```perl
my $val = $mob->GetRunspeed();
quest::say($val); # Returns double
```
argument: ""
- name: GetSTA
summary: gets a mob s t a.
example: |2-
```perl
my $val = $mob->GetSTA();
quest::say($val); # Returns int
```
argument: ""
- name: GetSTR
summary: gets a mob s t r.
example: |2-
```perl
my $val = $mob->GetSTR();
quest::say($val); # Returns int
```
argument: ""
- name: GetShieldTarget
summary: gets a mob shield target.
example: |2-
```perl
$mob->GetShieldTarget(); # Returns void
```
argument: ""
- name: GetSize
summary: gets a mob size.
example: |2-
```perl
my $val = $mob->GetSize();
quest::say($val); # Returns double
```
argument: ""
- name: GetSkill
summary: gets a mob skill.
example: |2-
```perl
my $skill_num = 1;
my $val = $mob->GetSkill($skill_num);
quest::say($val); # Returns uint
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
skill_num||
- name: GetSkillDmgTaken
summary: gets a mob skill dmg taken.
example: |2-
```perl
my $skill_num = 1;
my $val = $mob->GetSkillDmgTaken($skill_num);
quest::say($val); # Returns uint
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
skill_num||
- name: GetSpecialAbility
summary: gets a mob special ability.
example: |2-
```perl
my $special_ability = 1;
my $val = $mob->GetSpecialAbility($special_ability);
quest::say($val); # Returns int
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
special_ability||
- name: GetSpecialAbilityParam
summary: gets a mob special ability param.
example: |2-
```perl
my $special_ability = 1;
my $param = 1;
my $val = $mob->GetSpecialAbilityParam($special_ability, $param);
quest::say($val); # Returns int
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
special_ability||
param||
- name: GetSpecializeSkillValue
summary: gets a mob specialize skill value.
example: |2-
```perl
my $spell_id = 1;
my $val = $mob->GetSpecializeSkillValue($spell_id);
quest::say($val); # Returns uint
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
spell_id|int|
- name: GetSpellHPBonuses
summary: gets a mob spell h p bonuses.
example: |2-
```perl
my $val = $mob->GetSpellHPBonuses();
quest::say($val); # Returns int
```
argument: ""
- name: GetSpellIDFromSlot
summary: gets a mob spell idf rom slot.
example: |2-
```perl
my $slot = 1;
my $val = $mob->GetSpellIDFromSlot($slot);
quest::say($val); # Returns int
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
slot|int|
- name: GetSpellStat
summary: gets a mob spell stat.
example: |2-
```perl
my $itemid = 1;
my $stat = 1;
my $slot = 1;
my $val = $mob->GetSpellStat($itemid, $stat, $slot);
quest::say($val); # Returns int
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
itemid||
stat||
slot|int|
- name: GetTarget
summary: gets a mob target.
example: |2-
```perl
$mob->GetTarget(); # Returns void
```
argument: ""
- name: GetTexture
summary: gets a mob texture.
example: |2-
```perl
my $val = $mob->GetTexture();
quest::say($val); # Returns uint
```
argument: ""
- name: GetWIS
summary: gets a mob w i s.
example: |2-
```perl
my $val = $mob->GetWIS();
quest::say($val); # Returns int
```
argument: ""
- name: GetWalkspeed
summary: gets a mob walkspeed.
example: |2-
```perl
my $val = $mob->GetWalkspeed();
quest::say($val); # Returns double
```
argument: ""
- name: GetWaypointH
summary: gets a mob waypoint h.
example: |2-
```perl
my $val = $mob->GetWaypointH();
quest::say($val); # Returns double
```
argument: ""
- name: GetWaypointID
summary: gets a mob waypoint i d.
example: |2-
```perl
my $val = $mob->GetWaypointID();
quest::say($val); # Returns uint
```
argument: ""
- name: GetWaypointPause
summary: gets a mob waypoint pause.
example: |2-
```perl
my $val = $mob->GetWaypointPause();
quest::say($val); # Returns uint
```
argument: ""
- name: GetWaypointX
summary: gets a mob waypoint x.
example: |2-
```perl
my $val = $mob->GetWaypointX();
quest::say($val); # Returns double
```
argument: ""
- name: GetWaypointY
summary: gets a mob waypoint y.
example: |2-
```perl
my $val = $mob->GetWaypointY();
quest::say($val); # Returns double
```
argument: ""
- name: GetWaypointZ
summary: gets a mob waypoint z.
example: |2-
```perl
my $val = $mob->GetWaypointZ();
quest::say($val); # Returns double
```
argument: ""
- name: GetX
summary: gets a mob x.
example: |2-
```perl
my $val = $mob->GetX();
quest::say($val); # Returns double
```
argument: ""
- name: GetY
summary: gets a mob y.
example: |2-
```perl
my $val = $mob->GetY();
quest::say($val); # Returns double
```
argument: ""
- name: GetZ
summary: gets a mob z.
example: |2-
```perl
my $val = $mob->GetZ();
quest::say($val); # Returns double
```
argument: ""
- name: GetZoneID
summary: gets a mob zone i d.
example: |2-
```perl
my $val = $mob->GetZoneID();
quest::say($val); # Returns uint
```
argument: ""
- name: GoToBind
summary: GoToBind.
example: |2-
```perl
$mob->GoToBind(); # Returns void
```
argument: ""
- name: HalveAggro
summary: HalveAggro.
example: |2-
```perl
my $other = 1;
$mob->HalveAggro($other); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
other||
- name: HasNPCSpecialAtk
summary: HasNPCSpecialAtk.
example: |2-
```perl
my $parse = 1;
my $val = $mob->HasNPCSpecialAtk($parse);
quest::say($val); # Returns bool
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
parse||
- name: HasOwner
summary: HasOwner.
example: |2-
```perl
my $val = $mob->HasOwner();
quest::say($val); # Returns bool
```
argument: ""
- name: HasPet
summary: HasPet.
example: |2-
```perl
my $val = $mob->HasPet();
quest::say($val); # Returns bool
```
argument: ""
- name: HasProcs
summary: HasProcs.
example: |2-
```perl
my $val = $mob->HasProcs();
quest::say($val); # Returns bool
```
argument: ""
- name: HasShieldEquiped
summary: HasShieldEquiped.
example: |2-
```perl
my $val = $mob->HasShieldEquiped();
quest::say($val); # Returns bool
```
argument: ""
- name: HasTwoHandBluntEquiped
summary: HasTwoHandBluntEquiped.
example: |2-
```perl
my $val = $mob->HasTwoHandBluntEquiped();
quest::say($val); # Returns bool
```
argument: ""
- name: HasTwoHanderEquipped
summary: HasTwoHanderEquipped.
example: |2-
```perl
my $val = $mob->HasTwoHanderEquipped();
quest::say($val); # Returns bool
```
argument: ""
- name: HateSummon
summary: HateSummon.
example: |2-
```perl
my $val = $mob->HateSummon();
quest::say($val); # Returns bool
```
argument: ""
- name: Heal
summary: Heal.
example: |2-
```perl
$mob->Heal(); # Returns void
```
argument: ""
- name: HealDamage
summary: HealDamage.
example: |2-
```perl
my $amount = 1;
my $caster = 1;
$mob->HealDamage($amount, $caster); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
amount||
caster||
- name: InterruptSpell
summary: InterruptSpell.
example: |2-
```perl
my $spellid = 1;
$mob->InterruptSpell($spellid); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
spellid||
- name: IsAIControlled
summary: is a mob a i controlled.
example: |2-
```perl
my $val = $mob->IsAIControlled();
quest::say($val); # Returns bool
```
argument: ""
- name: IsAmnesiad
summary: is a mob amnesiad.
example: |2-
```perl
my $val = $mob->IsAmnesiad();
quest::say($val); # Returns bool
```
argument: ""
- name: IsBeacon
summary: is a mob beacon.
example: |2-
```perl
my $val = $mob->IsBeacon();
quest::say($val); # Returns bool
```
argument: ""
- name: IsBeneficialAllowed
summary: is a mob beneficial allowed.
example: |2-
```perl
my $target = 1;
my $val = $mob->IsBeneficialAllowed($target);
quest::say($val); # Returns bool
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
target||
- name: IsBlind
summary: is a mob blind.
example: |2-
```perl
my $val = $mob->IsBlind();
quest::say($val); # Returns bool
```
argument: ""
- name: IsCasting
summary: is a mob casting.
example: |2-
```perl
my $val = $mob->IsCasting();
quest::say($val); # Returns bool
```
argument: ""
- name: IsClient
summary: is a mob client.
example: |2-
```perl
my $val = $mob->IsClient();
quest::say($val); # Returns bool
```
argument: ""
- name: IsCorpse
summary: is a mob corpse.
example: |2-
```perl
my $val = $mob->IsCorpse();
quest::say($val); # Returns bool
```
argument: ""
- name: IsDoor
summary: is a mob door.
example: |2-
```perl
my $val = $mob->IsDoor();
quest::say($val); # Returns bool
```
argument: ""
- name: IsEliteMaterialItem
summary: is a mob elite material item.
example: |2-
```perl
my $material_slot = 1;
my $val = $mob->IsEliteMaterialItem($material_slot);
quest::say($val); # Returns uint
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
material_slot||
- name: IsEngaged
summary: is a mob engaged.
example: |2-
```perl
my $val = $mob->IsEngaged();
quest::say($val); # Returns bool
```
argument: ""
- name: IsEnraged
summary: is a mob enraged.
example: |2-
```perl
my $val = $mob->IsEnraged();
quest::say($val); # Returns bool
```
argument: ""
- name: IsFeared
summary: is a mob feared.
example: |2-
```perl
my $val = $mob->IsFeared();
quest::say($val); # Returns bool
```
argument: ""
- name: IsImmuneToSpell
summary: is a mob immune to spell.
example: |2-
```perl
my $spell_id = 1;
my $caster = 1;
my $val = $mob->IsImmuneToSpell($spell_id, $caster);
quest::say($val); # Returns bool
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
spell_id|int|
caster||
- name: IsInvisible
summary: is a mob invisible.
example: |2-
```perl
my $other = 1;
my $val = $mob->IsInvisible($other);
quest::say($val); # Returns bool
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
other||
- name: IsMeleeDisabled
summary: is a mob melee disabled.
example: |2-
```perl
my $val = $mob->IsMeleeDisabled();
quest::say($val); # Returns bool
```
argument: ""
- name: IsMezzed
summary: is a mob mezzed.
example: |2-
```perl
my $val = $mob->IsMezzed();
quest::say($val); # Returns bool
```
argument: ""
- name: IsMob
summary: is a mob mob.
example: |2-
```perl
my $val = $mob->IsMob();
quest::say($val); # Returns bool
```
argument: ""
- name: IsMoving
summary: is a mob moving.
example: |2-
```perl
my $val = $mob->IsMoving();
quest::say($val); # Returns bool
```
argument: ""
- name: IsNPC
summary: is a mob n p c.
example: |2-
```perl
my $val = $mob->IsNPC();
quest::say($val); # Returns bool
```
argument: ""
- name: IsNPCCorpse
summary: is a mob npcc orpse.
example: |2-
```perl
my $val = $mob->IsNPCCorpse();
quest::say($val); # Returns bool
```
argument: ""
- name: IsObject
summary: is a mob object.
example: |2-
```perl
my $val = $mob->IsObject();
quest::say($val); # Returns bool
```
argument: ""
- name: IsPet
summary: is a mob pet.
example: |2-
```perl
my $val = $mob->IsPet();
quest::say($val); # Returns bool
```
argument: ""
- name: IsPlayerCorpse
summary: is a mob er corpse.
example: |2-
```perl
my $val = $mob->IsPlayerCorpse();
quest::say($val); # Returns bool
```
argument: ""
- name: IsRoamer
summary: is a mob roamer.
example: |2-
```perl
my $val = $mob->IsRoamer();
quest::say($val); # Returns bool
```
argument: ""
- name: IsRooted
summary: is a mob rooted.
example: |2-
```perl
my $val = $mob->IsRooted();
quest::say($val); # Returns bool
```
argument: ""
- name: IsRunning
summary: is a mob running.
example: |2-
```perl
my $val = $mob->IsRunning();
quest::say($val); # Returns bool
```
argument: ""
- name: IsSilenced
summary: is a mob silenced.
example: |2-
```perl
my $val = $mob->IsSilenced();
quest::say($val); # Returns bool
```
argument: ""
- name: IsStunned
summary: is a mob stunned.
example: |2-
```perl
my $val = $mob->IsStunned();
quest::say($val); # Returns bool
```
argument: ""
- name: IsTargetable
summary: is a mob targetable.
example: |2-
```perl
my $val = $mob->IsTargetable();
quest::say($val); # Returns bool
```
argument: ""
- name: IsTargeted
summary: is a mob targeted.
example: |2-
```perl
my $val = $mob->IsTargeted();
quest::say($val); # Returns bool
```
argument: ""
- name: IsTrap
summary: is a mob trap.
example: |2-
```perl
my $val = $mob->IsTrap();
quest::say($val); # Returns bool
```
argument: ""
- name: IsWarriorClass
summary: is a mob warrior class.
example: |2-
```perl
my $val = $mob->IsWarriorClass();
quest::say($val); # Returns bool
```
argument: ""
- name: Kill
summary: Kill.
example: |2-
```perl
$mob->Kill(); # Returns void
```
argument: ""
- name: MakePet
summary: MakePet.
example: |2-
```perl
my $spell_id = 1;
my $pettype = 1;
my $name = "test";
$mob->MakePet($spell_id, $pettype, $name); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
spell_id|int|
pettype||
name|string|
- name: MakeTempPet
summary: MakeTempPet.
example: |2-
```perl
my $spell_id = 1;
my $name = "test";
$mob->MakeTempPet($spell_id, $name); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
spell_id|int|
name|string|
- name: Mesmerize
summary: Mesmerize.
example: |2-
```perl
$mob->Mesmerize(); # Returns void
```
argument: ""
- name: Message
summary: Message.
example: |2-
```perl
my $type = 1;
my $message = "test";
$mob->Message($type, $message, ...); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
type|int|
message|string|
...||
- name: Message_StringID
summary: Message_StringID.
example: |2-
```perl
my $type = 1;
my $string_id = 1;
my $distance = 1;
$mob->Message_StringID($type, $string_id, $distance); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
type|int|
string_id||
distance|int|
- name: ModSkillDmgTaken
summary: ModSkillDmgTaken.
example: |2-
```perl
my $skill = 1;
my $value = 1;
$mob->ModSkillDmgTaken($skill, $value); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
skill||
value|int|
- name: ModVulnerability
summary: ModVulnerability.
example: |2-
```perl
my $resist = 1;
my $value = 1;
$mob->ModVulnerability($resist, $value); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
resist||
value|int|
- name: NPCSpecialAttacks
summary: NPCSpecialAttacks.
example: |2-
```perl
my $parse = 1;
my $permtag = 1;
my $reset = 1;
my $remove = 1;
$mob->NPCSpecialAttacks($parse, $permtag, $reset, $remove); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
parse||
permtag||
reset||
remove||
- name: ProcessSpecialAbilities
summary: ProcessSpecialAbilities.
example: |2-
```perl
my $str = 1;
$mob->ProcessSpecialAbilities($str); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
str||
- name: ProjectileAnim
summary: ProjectileAnim.
example: |2-
```perl
my $mob = 1;
my $item_id = 1;
my $IsArrow = 1;
my $speed = 1;
my $angle = 1;
my $tilt = 1;
my $arc = 1;
$mob->ProjectileAnim($mob, $item_id, $IsArrow, $speed, $angle, $tilt, $arc); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
mob||
item_id|int|
IsArrow||
speed||
angle||
tilt||
arc||
- name: RangedAttack
summary: RangedAttack.
example: |2-
```perl
my $other = 1;
$mob->RangedAttack($other); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
other||
- name: RemoveFromFeignMemory
summary: RemoveFromFeignMemory.
example: |2-
```perl
my $attacker = 1;
$mob->RemoveFromFeignMemory($attacker); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
attacker||
- name: RemoveNimbusEffect
summary: RemoveNimbusEffect.
example: |2-
```perl
my $effectid = 1;
$mob->RemoveNimbusEffect($effectid); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
effectid||
- name: ResistSpell
summary: ResistSpell.
example: |2-
```perl
my $ressit_type = 1;
my $spell_id = 1;
my $caster = 1;
my $val = $mob->ResistSpell($ressit_type, $spell_id, $caster);
quest::say($val); # Returns double
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
ressit_type||
spell_id|int|
caster||
- name: RogueAssassinate
summary: RogueAssassinate.
example: |2-
```perl
my $other = 1;
$mob->RogueAssassinate($other); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
other||
- name: Say
summary: Say.
example: |2-
```perl
my $format = "test";
$mob->Say($format, ...); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
format|string|
...||
- name: SeeHide
summary: SeeHide.
example: |2-
```perl
my $val = $mob->SeeHide();
quest::say($val); # Returns bool
```
argument: ""
- name: SeeImprovedHide
summary: SeeImprovedHide.
example: |2-
```perl
my $val = $mob->SeeImprovedHide();
quest::say($val); # Returns bool
```
argument: ""
- name: SeeInvisible
summary: SeeInvisible.
example: |2-
```perl
my $val = $mob->SeeInvisible();
quest::say($val); # Returns uint
```
argument: ""
- name: SeeInvisibleUndead
summary: SeeInvisibleUndead.
example: |2-
```perl
my $val = $mob->SeeInvisibleUndead();
quest::say($val); # Returns bool
```
argument: ""
- name: SendAppearanceEffect
summary: sends a mob appearance effect.
example: |2-
```perl
my $parm1 = 1;
my $parm2 = 1;
my $parm3 = 1;
my $parm4 = 1;
my $parm5 = 1;
my $singleclient = 1;
$mob->SendAppearanceEffect($parm1, $parm2, $parm3, $parm4, $parm5, $singleclient); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
parm1||
parm2||
parm3||
parm4||
parm5||
singleclient||
- name: SendIllusion
summary: sends a mob illusion.
example: |2-
```perl
my $race = 1;
my $gender = 1;
my $texture = 1;
my $helmtexture = 1;
my $face = 1;
my $hairstyle = 1;
my $haircolor = 1;
my $beard = 1;
my $beardcolor = 1;
my $drakkin_heritage = 1;
my $drakkin_tattoo = 1;
my $drakkin_details = 1;
my $size = 1;
$mob->SendIllusion($race, $gender, $texture, $helmtexture, $face, $hairstyle, $haircolor, $beard, $beardcolor, $drakkin_heritage, $drakkin_tattoo, $drakkin_details, $size); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
race||
gender||
texture||
helmtexture||
face||
hairstyle||
haircolor||
beard||
beardcolor||
drakkin_heritage||
drakkin_tattoo||
drakkin_details||
size|int|
- name: SendPosUpdate
summary: sends a mob pos update.
example: |2-
```perl
my $iSendToSelf = 1;
$mob->SendPosUpdate($iSendToSelf); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
iSendToSelf|int|
- name: SendPosition
summary: sends a mob position.
example: |2-
```perl
$mob->SendPosition(); # Returns void
```
argument: ""
- name: SendTo
summary: sends a mob to.
example: |2-
```perl
my $new_x = 1;
my $new_y = 1;
my $new_z = 1;
$mob->SendTo($new_x, $new_y, $new_z); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
new_x||
new_y||
new_z||
- name: SendToFixZ
summary: sends a mob to fix z.
example: |2-
```perl
my $new_x = 1;
my $new_y = 1;
my $new_z = 1;
$mob->SendToFixZ($new_x, $new_y, $new_z); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
new_x||
new_y||
new_z||
- name: SendWearChange
summary: sends a mob wear change.
example: |2-
```perl
my $material_slot = 1;
$mob->SendWearChange($material_slot); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
material_slot||
- name: SetAA
summary: sets a mob a a.
example: |2-
```perl
my $aa_id = 1;
my $points = 1;
my $charges = 1;
my $val = $mob->SetAA($aa_id, $points, $charges);
quest::say($val); # Returns bool
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
aa_id||
points||
charges|int|
- name: SetAllowBeneficial
summary: sets a mob allow beneficial.
example: |2-
```perl
my $value = 1;
$mob->SetAllowBeneficial($value); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
value|int|
- name: SetAppearance
summary: sets a mob appearance.
example: |2-
```perl
my $app = 1;
my $iIgnoreSelf = 1;
$mob->SetAppearance($app, $iIgnoreSelf); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
app||
iIgnoreSelf||
- name: SetBodyType
summary: sets a mob body type.
example: |2-
```perl
my $type = 1;
my $overwrite_orig = 1;
$mob->SetBodyType($type, $overwrite_orig); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
type|int|
overwrite_orig||
- name: SetCurrentWP
summary: sets a mob current w p.
example: |2-
```perl
my $waypoint = 1;
$mob->SetCurrentWP($waypoint); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
waypoint||
- name: SetDeltas
summary: sets a mob deltas.
example: |2-
```perl
my $delta_x = 1;
my $delta_y = 1;
my $delta_z = 1;
my $delta_h = 1;
$mob->SetDeltas($delta_x, $delta_y, $delta_z, $delta_h); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
delta_x||
delta_y||
delta_z||
delta_h||
- name: SetDisableMelee
summary: sets a mob disable melee.
example: |2-
```perl
my $value = 1;
$mob->SetDisableMelee($value); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
value|int|
- name: SetEntityVariable
summary: sets a mob entity variable.
example: |2-
```perl
my $id = 1;
my $var = 1;
$mob->SetEntityVariable($id, $var); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
id||
var||
- name: SetExtraHaste
summary: sets a mob extra haste.
example: |2-
```perl
my $Haste = 1;
$mob->SetExtraHaste($Haste); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
Haste||
- name: SetFlurryChance
summary: sets a mob flurry chance.
example: |2-
```perl
my $value = 1;
$mob->SetFlurryChance($value); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
value|int|
- name: SetFlyMode
summary: sets a mob fly mode.
example: |2-
```perl
my $0|1|2|3 = 1;
$mob->SetFlyMode($0|1|2|3); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
0|1|2|3||
- name: SetFollowID
summary: sets a mob follow i d.
example: |2-
```perl
my $id = 1;
$mob->SetFollowID($id); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
id||
- name: SetGender
summary: sets a mob gender.
example: |2-
```perl
my $gender = 1;
$mob->SetGender($gender); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
gender||
- name: SetGlobal
summary: sets a mob global.
example: |2-
```perl
my $varname = 1;
my $newvalue = 1;
my $options = 1;
my $duration = 1;
my $other = 1;
$mob->SetGlobal($varname, $newvalue, $options, $duration, $other); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
varname||
newvalue||
options|int|
duration|int|
other||
- name: SetHP
summary: sets a mob h p.
example: |2-
```perl
my $hp = 1;
$mob->SetHP($hp); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
hp||
- name: SetHate
summary: sets a mob hate.
example: |2-
```perl
my $other = 1;
my $hate = 1;
$mob->SetHate($other, $hate); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
other||
hate||
- name: SetHeading
summary: sets a mob heading.
example: |2-
```perl
my $iHeading = 1;
$mob->SetHeading($iHeading); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
iHeading||
- name: SetInvisible
summary: sets a mob invisible.
example: |2-
```perl
my $state = 1;
$mob->SetInvisible($state); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
state||
- name: SetInvul
summary: sets a mob invul.
example: |2-
```perl
my $invul = 1;
$mob->SetInvul($invul); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
invul||
- name: SetLD
summary: sets a mob l d.
example: |2-
```perl
my $value = 1;
$mob->SetLD($value); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
value|int|
- name: SetLevel
summary: sets a mob level.
example: |2-
```perl
my $in_level = 1;
my $command = 1;
$mob->SetLevel($in_level, $command); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
in_level||
command||
- name: SetMana
summary: sets a mob mana.
example: |2-
```perl
my $amount = 1;
$mob->SetMana($amount); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
amount||
- name: SetMaxHP
summary: sets a mob max h p.
example: |2-
```perl
$mob->SetMaxHP(); # Returns void
```
argument: ""
- name: SetOOCRegen
summary: sets a mob o o c regen.
example: |2-
```perl
my $newoocregen = 1;
$mob->SetOOCRegen($newoocregen); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
newoocregen||
- name: SetOwnerID
summary: sets a mob owner i d.
example: |2-
```perl
my $NewOwnerID = 1;
$mob->SetOwnerID($NewOwnerID); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
NewOwnerID||
- name: SetPetID
summary: sets a mob pet i d.
example: |2-
```perl
my $NewPetID = 1;
$mob->SetPetID($NewPetID); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
NewPetID||
- name: SetPetOrder
summary: sets a mob pet order.
example: |2-
```perl
my $i = 1;
$mob->SetPetOrder($i); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
i||
- name: SetRace
summary: sets a mob race.
example: |2-
```perl
my $race = 1;
$mob->SetRace($race); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
race||
- name: SetRunAnimSpeed
summary: sets a mob run anim speed.
example: |2-
```perl
my $in = 1;
$mob->SetRunAnimSpeed($in); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
in||
- name: SetRunning
summary: sets a mob running.
example: |2-
```perl
my $value = 1;
$mob->SetRunning($value); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
value|int|
- name: SetShieldTarget
summary: sets a mob shield target.
example: |2-
```perl
my $mob = 1;
$mob->SetShieldTarget($mob); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
mob||
- name: SetSlotTint
summary: sets a mob slot tint.
example: |2-
```perl
my $material_slot = 1;
my $red_tint = 1;
my $green_tint = 1;
my $blue_tint = 1;
$mob->SetSlotTint($material_slot, $red_tint, $green_tint, $blue_tint); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
material_slot||
red_tint||
green_tint||
blue_tint||
- name: SetSpecialAbility
summary: sets a mob special ability.
example: |2-
```perl
my $ability = 1;
my $value = 1;
$mob->SetSpecialAbility($ability, $value); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
ability||
value|int|
- name: SetSpecialAbilityParam
summary: sets a mob special ability param.
example: |2-
```perl
my $ability = 1;
my $param = 1;
my $value = 1;
$mob->SetSpecialAbilityParam($ability, $param, $value); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
ability||
param||
value|int|
- name: SetTarget
summary: sets a mob target.
example: |2-
```perl
my $mob = 1;
$mob->SetTarget($mob); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
mob||
- name: SetTargetDestSteps
summary: sets a mob target dest steps.
example: |2-
```perl
my $target_steps = 1;
$mob->SetTargetDestSteps($target_steps); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
target_steps||
- name: SetTargetable
summary: sets a mob targetable.
example: |2-
```perl
my $on = 1;
$mob->SetTargetable($on); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
on||
- name: SetTexture
summary: sets a mob texture.
example: |2-
```perl
my $texture = 1;
$mob->SetTexture($texture); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
texture||
- name: Shout
summary: Shout.
example: |2-
```perl
my $format = "test";
$mob->Shout($format, ...); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
format|string|
...||
- name: SignalClient
summary: SignalClient.
example: |2-
```perl
my $client = 1;
my $data = 1;
$mob->SignalClient($client, $data); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
client||
data||
- name: SpellEffect
summary: SpellEffect.
example: |2-
```perl
my $effect = 1;
my $duration = 1;
my $finish_delay = 1;
my $zone_wide = 1;
my $unk20 = 1;
my $perm_effect = 1;
my $client = 1;
$mob->SpellEffect($effect, $duration, $finish_delay, $zone_wide, $unk20, $perm_effect, $client); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
effect||
duration|int|
finish_delay||
zone_wide||
unk20||
perm_effect||
client||
- name: SpellFinished
summary: SpellFinished.
example: |2-
```perl
my $spell_id = 1;
my $spell_target = 1;
$mob->SpellFinished($spell_id, $spell_target); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
spell_id|int|
spell_target||
- name: Spin
summary: Spin.
example: |2-
```perl
$mob->Spin(); # Returns void
```
argument: ""
- name: StartEnrage
summary: StartEnrage.
example: |2-
```perl
$mob->StartEnrage(); # Returns void
```
argument: ""
- name: Stun
summary: Stun.
example: |2-
```perl
my $duration = 1;
$mob->Stun($duration); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
duration|int|
- name: TarGlobal
summary: TarGlobal.
example: |2-
```perl
my $varname = 1;
my $value = 1;
my $duration = 1;
my $npcid = 1;
my $charid = 1;
my $zoneid = 1;
$mob->TarGlobal($varname, $value, $duration, $npcid, $charid, $zoneid); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
varname||
value|int|
duration|int|
npcid||
charid||
zoneid||
- name: TempName
summary: TempName.
example: |2-
```perl
my $name = "test";
$mob->TempName($name); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
name|string|
- name: ThrowingAttack
summary: ThrowingAttack.
example: |2-
```perl
my $other = 1;
$mob->ThrowingAttack($other); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
other||
- name: TypesTempPet
summary: TypesTempPet.
example: |2-
```perl
my $typesid = 1;
my $name = "test";
$mob->TypesTempPet($typesid, $name); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
typesid||
name|string|
- name: WearChange
summary: WearChange.
example: |2-
```perl
my $material_slot = 1;
my $texture = 1;
my $color = 1;
my $hero_forge_model = 1;
$mob->WearChange($material_slot, $texture, $color, $hero_forge_model); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
material_slot||
texture||
color|int|
hero_forge_model||
- name: WipeHateList
summary: WipeHateList.
example: |2-
```perl
$mob->WipeHateList(); # Returns void
```
argument: ""
- name: Corpse
functions:
- name: AddItem
summary: adds a corpse item.
example: |2-
```perl
my $itemnum = 1;
my $charges = 1;
my $slot = 1;
$corpse->AddItem($itemnum, $charges, $slot); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
itemnum||
charges|int|
slot|int|
- name: AddLooter
summary: adds a corpse looter.
example: |2-
```perl
my $who = 1;
$corpse->AddLooter($who); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
who||
- name: AllowMobLoot
summary: AllowMobLoot.
example: |2-
```perl
my $them = 1;
my $slot = 1;
$corpse->AllowMobLoot($them, $slot); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
them||
slot|int|
- name: CanMobLoot
summary: CanMobLoot.
example: |2-
```perl
my $charid = 1;
my $val = $corpse->CanMobLoot($charid);
quest::say($val); # Returns bool
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
charid||
- name: CastRezz
summary: CastRezz.
example: |2-
```perl
my $spellid = 1;
my $Caster = 1;
$corpse->CastRezz($spellid, $Caster); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
spellid||
Caster||
- name: CompleteRezz
summary: CompleteRezz.
example: |2-
```perl
$corpse->CompleteRezz(); # Returns void
```
argument: ""
- name: CountItems
summary: CountItems.
example: |2-
```perl
my $val = $corpse->CountItems();
quest::say($val); # Returns uint
```
argument: ""
- name: Delete
summary: Delete.
example: |2-
```perl
$corpse->Delete(); # Returns void
```
argument: ""
- name: GetCharID
summary: gets a corpse char i d.
example: |2-
```perl
my $val = $corpse->GetCharID();
quest::say($val); # Returns uint
```
argument: ""
- name: GetCopper
summary: gets a corpse copper.
example: |2-
```perl
my $val = $corpse->GetCopper();
quest::say($val); # Returns uint
```
argument: ""
- name: GetDBID
summary: gets a corpse d b i d.
example: |2-
```perl
my $val = $corpse->GetDBID();
quest::say($val); # Returns uint
```
argument: ""
- name: GetDecayTime
summary: gets a corpse decay time.
example: |2-
```perl
my $val = $corpse->GetDecayTime();
quest::say($val); # Returns uint
```
argument: ""
- name: GetGold
summary: gets a corpse gold.
example: |2-
```perl
my $val = $corpse->GetGold();
quest::say($val); # Returns uint
```
argument: ""
- name: GetOwnerName
summary: gets a corpse owner name.
example: |2-
```perl
my $val = $corpse->GetOwnerName();
quest::say($val); # Returns string
```
argument: ""
- name: GetPlatinum
summary: gets a corpse platinum.
example: |2-
```perl
my $val = $corpse->GetPlatinum();
quest::say($val); # Returns uint
```
argument: ""
- name: GetSilver
summary: gets a corpse silver.
example: |2-
```perl
my $val = $corpse->GetSilver();
quest::say($val); # Returns uint
```
argument: ""
- name: GetWornItem
summary: gets a corpse worn item.
example: |2-
```perl
my $equipSlot = 1;
my $val = $corpse->GetWornItem($equipSlot);
quest::say($val); # Returns uint
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
equipSlot||
- name: IsEmpty
summary: is a corpse empty.
example: |2-
```perl
my $val = $corpse->IsEmpty();
quest::say($val); # Returns bool
```
argument: ""
- name: IsLocked
summary: is a corpse locked.
example: |2-
```perl
my $val = $corpse->IsLocked();
quest::say($val); # Returns bool
```
argument: ""
- name: Lock
summary: Lock.
example: |2-
```perl
$corpse->Lock(); # Returns void
```
argument: ""
- name: RemoveCash
summary: RemoveCash.
example: |2-
```perl
$corpse->RemoveCash(); # Returns void
```
argument: ""
- name: RemoveItem
summary: RemoveItem.
example: |2-
```perl
my $lootslot = 1;
$corpse->RemoveItem($lootslot); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
lootslot||
- name: ResetLooter
summary: ResetLooter.
example: |2-
```perl
$corpse->ResetLooter(); # Returns void
```
argument: ""
- name: SetCash
summary: sets a corpse cash.
example: |2-
```perl
my $in_copper = 1;
my $in_silver = 1;
my $in_gold = 1;
my $in_platinum = 1;
$corpse->SetCash($in_copper, $in_silver, $in_gold, $in_platinum); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
in_copper||
in_silver||
in_gold||
in_platinum||
- name: SetDecayTimer
summary: sets a corpse decay timer.
example: |2-
```perl
my $decaytime = 1;
$corpse->SetDecayTimer($decaytime); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
decaytime||
- name: Summon
summary: Summon.
example: |2-
```perl
my $client = 1;
my $spell = 1;
$corpse->Summon($client, $spell); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
client||
spell||
- name: UnLock
summary: UnLock.
example: |2-
```perl
$corpse->UnLock(); # Returns void
```
argument: ""
- name: Quest
functions:
- name: AddNode
summary: adds a quest node.
example: |2-
```perl
my $x = 1;
my $y = 1;
my $z = 1;
my $best_z = 1;
my $requested_id = 1;
quest::AddNode($x, $y, $z, $best_z, $requested_id); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
x|float|
y|float|
z|float|
best_z|float|
requested_id|int|
- name: AssignGroupToInstance
summary: AssignGroupToInstance.
example: |2-
```perl
my $instance_id = 1;
quest::AssignGroupToInstance($instance_id); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
instance_id|int|
- name: AssignRaidToInstance
summary: AssignRaidToInstance.
example: |2-
```perl
my $instance_id = 1;
quest::AssignRaidToInstance($instance_id); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
instance_id|int|
- name: AssignToInstance
summary: AssignToInstance.
example: |2-
```perl
my $instance_id = 1;
quest::AssignToInstance($instance_id); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
instance_id|int|
- name: ChooseRandom
summary: ChooseRandom.
example: |2-
```perl
my $list ... = 1;
quest::ChooseRandom($list ...); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
list ...||
- name: ConnectNodeToNode
summary: ConnectNodeToNode.
example: |2-
```perl
my $node1 = 1;
my $node2 = 1;
my $teleport = 1;
my $doorid = 1;
quest::ConnectNodeToNode($node1, $node2, $teleport, $doorid); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
node1|int|
node2|int|
teleport|int|
doorid||
- name: CreateInstance
summary: CreateInstance.
example: |2-
```perl
my $zone_name = "test";
my $version = 1;
my $duration = 1;
quest::CreateInstance($zone_name, $version, $duration); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
zone_name|string|
version|int|
duration|int|
- name: DestroyInstance
summary: DestroyInstance.
example: |2-
```perl
my $id = 1;
quest::DestroyInstance($id); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
id|uint|
- name: FlagInstanceByGroupLeader
summary: FlagInstanceByGroupLeader.
example: |2-
```perl
my $zone = 1;
my $version = 1;
quest::FlagInstanceByGroupLeader($zone, $version); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
zone|uint|
version|int|
- name: FlagInstanceByRaidLeader
summary: FlagInstanceByRaidLeader.
example: |2-
```perl
my $zone = 1;
my $version = 1;
quest::FlagInstanceByRaidLeader($zone, $version); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
zone|uint|
version|int|
- name: FlyMode
summary: FlyMode.
example: |2-
```perl
my $0/1/2 = 1;
quest::FlyMode($0/1/2); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
0/1/2|uint|
- name: GetCharactersInInstance
summary: gets a quest characters in instance.
example: |2-
```perl
my $instance_id = 1;
my $val = quest::GetCharactersInInstance($instance_id);
quest::say($val); # Returns string
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
instance_id|int|
- name: GetInstanceID
summary: gets a quest instance i d.
example: |2-
```perl
my $zone_name = "test";
my $version = 1;
quest::GetInstanceID($zone_name, $version); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
zone_name|string|
version|int|
- name: GetInstanceTimer
summary: gets a quest instance timer.
example: |2-
```perl
quest::GetInstanceTimer(); # Returns void
```
argument: ""
- name: GetInstanceTimerByID
summary: gets a quest instance timer by i d.
example: |2-
```perl
my $instance_id = 1;
quest::GetInstanceTimerByID($instance_id); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
instance_id|int|
- name: GetSpellResistType
summary: gets a quest spell resist type.
example: |2-
```perl
my $spell_id = 1;
quest::GetSpellResistType($spell_id); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
spell_id|int|
- name: GetSpellTargetType
summary: gets a quest spell target type.
example: |2-
```perl
my $spell_id = 1;
quest::GetSpellTargetType($spell_id); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
spell_id|int|
- name: GetTimeSeconds
summary: gets a quest time seconds.
example: |2-
```perl
quest::GetTimeSeconds(); # Returns void
```
argument: ""
- name: GetZoneID
summary: gets a quest zone i d.
example: |2-
```perl
my $zone = "test";
quest::GetZoneID($zone); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
zone|string|
- name: GetZoneLongName
summary: gets a quest zone long name.
example: |2-
```perl
my $zone = 1;
my $val = quest::GetZoneLongName($zone);
quest::say($val); # Returns string
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
zone||
- name: IsBeneficialSpell
summary: is a quest beneficial spell.
example: |2-
```perl
my $spell_id = 1;
my $val = quest::IsBeneficialSpell($spell_id);
quest::say($val); # Returns uint
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
spell_id|int|
- name: IsEffectInSpell
summary: is a quest effect in spell.
example: |2-
```perl
my $spell_id = 1;
my $effect_id = 1;
my $val = quest::IsEffectInSpell($spell_id, $effect_id);
quest::say($val); # Returns uint
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
spell_id|int|
effect_id|int|
- name: IsRunning
summary: is a quest running.
example: |2-
```perl
my $val = quest::IsRunning();
quest::say($val); # Returns uint
```
argument: ""
- name: LearnRecipe
summary: LearnRecipe.
example: |2-
```perl
my $recipe_id = 1;
quest::LearnRecipe($recipe_id); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
recipe_id|uint|
- name: MerchantCountItem
summary: MerchantCountItem.
example: |2-
```perl
my $npc_id = 1;
my $item_id = 1;
quest::MerchantCountItem($npc_id, $item_id); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
npc_id|int|
item_id|int|
- name: MerchantSetItem
summary: MerchantSetItem.
example: |2-
```perl
my $npc_id = 1;
my $ = 1;
my $quantity = 1;
quest::MerchantSetItem($npc_id, $, $quantity); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
npc_id|int|
||
quantity|int|
- name: ModifyNPCStat
summary: ModifyNPCStat.
example: |2-
```perl
my $stat_id = 1;
my $str_value = "test";
quest::ModifyNPCStat($stat_id, $str_value); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
stat_id|int|
str_value|string|
- name: MovePCInstance
summary: MovePCInstance.
example: |2-
```perl
my $zone_id = 1;
my $instance_id = 1;
my $x = 1;
my $y = 1;
my $ = 1;
my $heading = 1;
quest::MovePCInstance($zone_id, $instance_id, $x, $y, $, $heading); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
zone_id|int|
instance_id|int|
x|float|
y|float|
||
heading|float|
- name: RemoveAllFromInstance
summary: RemoveAllFromInstance.
example: |2-
```perl
my $instance_id = 1;
quest::RemoveAllFromInstance($instance_id); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
instance_id|int|
- name: RemoveFromInstance
summary: RemoveFromInstance.
example: |2-
```perl
my $instance_id = 1;
quest::RemoveFromInstance($instance_id); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
instance_id|int|
- name: SendMail
summary: sends a quest mail.
example: |2-
```perl
my $to = "test";
my $from = "test";
my $subject = "test";
my $message = "test";
quest::SendMail($to, $from, $subject, $message); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
to|string|
from|string|
subject|string|
message|string|
- name: SetRunning
summary: sets a quest running.
example: |2-
```perl
my $val = 1;
quest::SetRunning($val); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
val|bool|
- name: UpdateInstanceTimer
summary: UpdateInstanceTimer.
example: |2-
```perl
my $instance_id = 1;
my $duration = 1;
quest::UpdateInstanceTimer($instance_id, $duration); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
instance_id|int|
duration|int|
- name: UpdateSpawnTimer
summary: UpdateSpawnTimer.
example: |2-
```perl
my $spawn2_id = 1;
my $updated_time_till_repop = 1;
quest::UpdateSpawnTimer($spawn2_id, $updated_time_till_repop); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
spawn2_id|uint|
updated_time_till_repop|uint|
- name: activespeakactivity
summary: activespeakactivity.
example: |2-
```perl
my $task_id = 1;
my $val = quest::activespeakactivity($task_id);
quest::say($val); # Returns int
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
task_id|uint|
- name: activespeaktask
summary: activespeaktask.
example: |2-
```perl
my $val = quest::activespeaktask();
quest::say($val); # Returns int
```
argument: ""
- name: activetasksinset
summary: activetasksinset.
example: |2-
```perl
my $task_set = 1;
my $val = quest::activetasksinset($task_set);
quest::say($val); # Returns int
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
task_set|int|
- name: addldonloss
summary: adds a quest ldonloss.
example: |2-
```perl
my $losses = 1;
my $theme_id = 1;
quest::addldonloss($losses, $theme_id); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
losses|long|
theme_id|int|
- name: addldonpoints
summary: adds a quest ldonpoints.
example: |2-
```perl
my $points = 1;
my $theme_id = 1;
quest::addldonpoints($points, $theme_id); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
points|long|
theme_id|int|
- name: addldonwin
summary: adds a quest ldonwin.
example: |2-
```perl
my $wins = 1;
my $theme_id = 1;
quest::addldonwin($wins, $theme_id); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
wins|long|
theme_id|int|
- name: addloot
summary: adds a quest loot.
example: |2-
```perl
my $item_id = 1;
my $charges = 1;
quest::addloot($item_id, $charges); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
item_id|int|
charges|int|
- name: addskill
summary: adds a quest skill.
example: |2-
```perl
my $skill_id = 1;
my $int_value = 1;
quest::addskill($skill_id, $int_value); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
skill_id|int|
int_value|int|
- name: assigntask
summary: assigntask.
example: |2-
```perl
my $task_id = 1;
my $enforce_level_requirement = 1;
quest::assigntask($task_id, $enforce_level_requirement); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
task_id|uint|
enforce_level_requirement|bool|
- name: attack
summary: attack.
example: |2-
```perl
my $client_name = "test";
quest::attack($client_name); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
client_name|string|
- name: attacknpc
summary: attacknpc.
example: |2-
```perl
my $npc_entity_id = 1;
quest::attacknpc($npc_entity_id); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
npc_entity_id|int|
- name: attacknpctype
summary: attacknpctype.
example: |2-
```perl
my $npc_type_id = 1;
quest::attacknpctype($npc_type_id); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
npc_type_id|int|
- name: buryplayercorpse
summary: buryplayercorpse.
example: |2-
```perl
my $char_id = 1;
my $val = quest::buryplayercorpse($char_id);
quest::say($val); # Returns uint
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
char_id|int|
- name: castspell
summary: castspell.
example: |2-
```perl
my $spell_id = 1;
my $target_id = 1;
quest::castspell($spell_id, $target_id); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
spell_id|int|
target_id|int|
- name: changedeity
summary: changedeity.
example: |2-
```perl
my $diety_id = 1;
quest::changedeity($diety_id); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
diety_id|int|
- name: checktitle
summary: checktitle.
example: |2-
```perl
my $titleset = 1;
my $val = quest::checktitle($titleset);
quest::say($val); # Returns bool
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
titleset||
- name: clear_npctype_cache
summary: clear_npctype_cache.
example: |2-
```perl
my $npc_type_id = 1;
quest::clear_npctype_cache($npc_type_id); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
npc_type_id|int|
- name: clear_proximity
summary: clear_proximity.
example: |2-
```perl
quest::clear_proximity(); # Returns void
```
argument: ""
- name: clear_zone_flag
summary: clear_zone_flag.
example: |2-
```perl
my $zone_id = 1;
quest::clear_zone_flag($zone_id); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
zone_id|int|
- name: clearspawntimers
summary: clearspawntimers.
example: |2-
```perl
quest::clearspawntimers(); # Returns void
```
argument: ""
- name: collectitems
summary: collectitems.
example: |2-
```perl
my $item_id = 1;
my $remove_item = 1;
quest::collectitems($item_id, $remove_item); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
item_id|int|
remove_item|bool|
- name: completedtasksinset
summary: completedtasksinset.
example: |2-
```perl
my $task_set = 1;
my $val = quest::completedtasksinset($task_set);
quest::say($val); # Returns int
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
task_set|int|
- name: createBot
summary: createBot.
example: |2-
```perl
my $firstname = "test";
my $lastname = "test";
my $level = 1;
my $race_id = 1;
my $class_id = 1;
my $gender_id = 1;
my $val = quest::createBot($firstname, $lastname, $level, $race_id, $class_id, $gender_id);
quest::say($val); # Returns uint
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
firstname|string|
lastname|string|
level|int|
race_id|int|
class_id|int|
gender_id|int|
- name: createdoor
summary: createdoor.
example: |2-
```perl
my $modelname = "test";
my $x = 1;
my $y = 1;
my $z = 1;
my $heading = 1;
my $object_type = 1;
my $size = 1;
quest::createdoor($modelname, $x, $y, $z, $heading, $object_type, $size); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
modelname|string|
x|float|
y|float|
z|float|
heading|float|
object_type|int|
size|int|
- name: creategroundobject
summary: creategroundobject.
example: |2-
```perl
my $item_id = 1;
my $x = 1;
my $y = 1;
my $z = 1;
my $heading = 1;
my $decay_time = 1;
quest::creategroundobject($item_id, $x, $y, $z, $heading, $decay_time); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
item_id|int|
x|float|
y|float|
z|float|
heading|float|
decay_time|int|
- name: creategroundobjectfrommodel
summary: creategroundobjectfrommodel.
example: |2-
```perl
my $modelname = "test";
my $x = 1;
my $y = 1;
my $z = 1;
my $heading = 1;
my $object_type = 1;
my $decay_time = 1;
quest::creategroundobjectfrommodel($modelname, $x, $y, $z, $heading, $object_type, $decay_time); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
modelname|string|
x|float|
y|float|
z|float|
heading|float|
object_type|int|
decay_time|int|
- name: createguild
summary: createguild.
example: |2-
```perl
my $guild_name = "test";
my $leader_name = "test";
quest::createguild($guild_name, $leader_name); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
guild_name|string|
leader_name|string|
- name: crosszonemessageplayerbyname
summary: crosszonemessageplayerbyname.
example: |2-
```perl
my $channel_id = 1;
my $name = "test";
my $message = "test";
quest::crosszonemessageplayerbyname($channel_id, $name, $message); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
channel_id|int|
name|string|
message|string|
- name: crosszonesetentityvariablebyclient_name
summary: crosszonesetentityvariablebyclient_name.
example: |2-
```perl
my $client_name = "test";
my $key = "test";
my $str_value = "test";
quest::crosszonesetentityvariablebyclient_name($client_name, $key, $str_value); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
client_name|string|
key|string|
str_value|string|
- name: crosszonesetentityvariablebynpctypeid
summary: crosszonesetentityvariablebynpctypeid.
example: |2-
```perl
my $npc_type_id = 1;
my $key = "test";
my $str_value = "test";
quest::crosszonesetentityvariablebynpctypeid($npc_type_id, $key, $str_value); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
npc_type_id|int|
key|string|
str_value|string|
- name: crosszonesignalclientbychar_id
summary: crosszonesignalclientbychar_id.
example: |2-
```perl
my $name = "test";
my $int_value = 1;
quest::crosszonesignalclientbychar_id($name, $int_value); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
name|string|
int_value|int|
- name: crosszonesignalnpcbynpctypeid
summary: crosszonesignalnpcbynpctypeid.
example: |2-
```perl
my $npc_type_id = 1;
my $int_value = 1;
quest::crosszonesignalnpcbynpctypeid($npc_type_id, $int_value); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
npc_type_id|int|
int_value|int|
- name: debug
summary: debug.
example: |2-
```perl
my $message = "test";
my $debug_level = 1;
quest::debug($message, $debug_level); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
message|string|
debug_level|int|
- name: delglobal
summary: delglobal.
example: |2-
```perl
my $key = "test";
quest::delglobal($key); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
key|string|
- name: depop
summary: depop.
example: |2-
```perl
my $npc_type_id = 1;
quest::depop($npc_type_id); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
npc_type_id|int|
- name: depop_withtimer
summary: depop_withtimer.
example: |2-
```perl
my $npc_type_id = 1;
quest::depop_withtimer($npc_type_id); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
npc_type_id|int|
- name: depopall
summary: depopall.
example: |2-
```perl
my $npc_type_id = 1;
quest::depopall($npc_type_id); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
npc_type_id|int|
- name: depopzone
summary: depopzone.
example: |2-
```perl
my $StartSpawnStatus = 1;
quest::depopzone($StartSpawnStatus); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
StartSpawnStatus|bool|
- name: ding
summary: ding.
example: |2-
```perl
quest::ding(); # Returns void
```
argument: ""
- name: disable_proximity_say
summary: disable_proximity_say.
example: |2-
```perl
quest::disable_proximity_say(); # Returns void
```
argument: ""
- name: disable_spawn2
summary: disable_spawn2.
example: |2-
```perl
my $spawn2_id = 1;
quest::disable_spawn2($spawn2_id); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
spawn2_id|int|
- name: disablerecipe
summary: disablerecipe.
example: |2-
```perl
my $recipe_id = 1;
quest::disablerecipe($recipe_id); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
recipe_id||
- name: disabletask
summary: disabletask.
example: |2-
```perl
my $task_id1 = 1;
my $task_id2 = 1;
my $task_id10 = 1;
quest::disabletask($task_id1, $task_id2, ..., $task_id10); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
task_id1|int|
task_id2|int|
...||
task_id10|int|
- name: doanim
summary: doanim.
example: |2-
```perl
my $anim_id = 1;
quest::doanim($anim_id); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
anim_id|int|
- name: echo
summary: echo.
example: |2-
```perl
my $color_id = 1;
my $message = "test";
quest::echo($color_id, $message); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
color_id|int|
message|string|
- name: emote
summary: emote.
example: |2-
```perl
my $message = "test";
quest::emote($message); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
message|string|
- name: enable_proximity_say
summary: enable_proximity_say.
example: |2-
```perl
quest::enable_proximity_say(); # Returns void
```
argument: ""
- name: enable_spawn2
summary: enable_spawn2.
example: |2-
```perl
my $spawn2_id = 1;
quest::enable_spawn2($spawn2_id); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
spawn2_id|int|
- name: enabledtaskcount
summary: enabledtaskcount.
example: |2-
```perl
my $task_set = 1;
my $val = quest::enabledtaskcount($task_set);
quest::say($val); # Returns int
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
task_set|int|
- name: enablerecipe
summary: enablerecipe.
example: |2-
```perl
my $recipe_id = 1;
quest::enablerecipe($recipe_id); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
recipe_id||
- name: enabletask
summary: enabletask.
example: |2-
```perl
my $task_id1 = 1;
my $task_id2 = 1;
my $task_id10 = 1;
quest::enabletask($task_id1, $task_id2, ..., $task_id10); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
task_id1|int|
task_id2|int|
...||
task_id10|int|
- name: enabletitle
summary: enabletitle.
example: |2-
```perl
my $titleset = 1;
quest::enabletitle($titleset); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
titleset|int|
- name: exp
summary: exp.
example: |2-
```perl
my $amt = 1;
quest::exp($amt); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
amt|int|
- name: faction
summary: faction.
example: |2-
```perl
my $faction_id = 1;
my $int_value = 1;
my $temp = 1;
quest::faction($faction_id, $int_value, $temp); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
faction_id|int|
int_value|int|
temp|int|
- name: factionvalue
summary: factionvalue.
example: |2-
```perl
quest::factionvalue(); # Returns void
```
argument: ""
- name: failtask
summary: failtask.
example: |2-
```perl
my $task_id = 1;
quest::failtask($task_id); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
task_id|uint|
- name: firsttaskinset
summary: firsttaskinset.
example: |2-
```perl
my $task_set = 1;
my $val = quest::firsttaskinset($task_set);
quest::say($val); # Returns int
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
task_set|int|
- name: follow
summary: follow.
example: |2-
```perl
my $entity_id = 1;
my $distance = 1;
quest::follow($entity_id, $distance); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
entity_id|int|
distance|int|
- name: forcedoorclose
summary: forcedoorclose.
example: |2-
```perl
my $door_id = 1;
my $alt_mode = 1;
quest::forcedoorclose($door_id, $alt_mode); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
door_id|int|
alt_mode|bool|
- name: forcedooropen
summary: forcedooropen.
example: |2-
```perl
my $door_id = 1;
my $alt_mode = 1;
quest::forcedooropen($door_id, $alt_mode); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
door_id|int|
alt_mode|bool|
- name: get_spawn_condition
summary: gets a quest spawn condition.
example: |2-
```perl
my $zone_short = "test";
my $instance_id = 1;
my $condition_id = 1;
my $val = quest::get_spawn_condition($zone_short, $instance_id, $condition_id);
quest::say($val); # Returns uint
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
zone_short|string|
instance_id|int|
condition_id|int|
- name: getguildnamebyid
summary: gets a quest guildnamebyid.
example: |2-
```perl
my $guild_id = 1;
my $val = quest::getguildnamebyid($guild_id);
quest::say($val); # Returns string
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
guild_id||
- name: getlevel
summary: gets a quest level.
example: |2-
```perl
my $type = 1;
my $val = quest::getlevel($type);
quest::say($val); # Returns uint
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
type|int|
- name: getplayerburiedcorpsecount
summary: gets a quest playerburiedcorpsecount.
example: |2-
```perl
my $char_id = 1;
my $val = quest::getplayerburiedcorpsecount($char_id);
quest::say($val); # Returns uint
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
char_id|int|
- name: gettaskactivitydonecount
summary: gets a quest taskactivitydonecount.
example: |2-
```perl
my $task_id = 1;
my $activity_id = 1;
quest::gettaskactivitydonecount($task_id, $activity_id); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
task_id|uint|
activity_id|uint|
- name: givecash
summary: givecash.
example: |2-
```perl
my $copper = 1;
my $silver = 1;
my $gold = 1;
my $platinum = 1;
quest::givecash($copper, $silver, $gold, $platinum); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
copper|int|
silver|int|
gold|int|
platinum|int|
- name: gmmove
summary: gmmove.
example: |2-
```perl
my $x = 1;
my $y = 1;
my $z = 1;
quest::gmmove($x, $y, $z); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
x|float|
y|float|
z|float|
- name: gmsay
summary: gmsay.
example: |2-
```perl
my $message = "test";
my $color_id = 1;
my $send_to_world = 1;
quest::gmsay($message, $color_id, $send_to_world); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
message|string|
color_id|int|
send_to_world|bool|
- name: has_zone_flag
summary: has_zone_flag.
example: |2-
```perl
my $zone_id = 1;
my $val = quest::has_zone_flag($zone_id);
quest::say($val); # Returns uint
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
zone_id|int|
- name: incstat
summary: incstat.
example: |2-
```perl
my $stat_id = 1;
my $int_value = 1;
quest::incstat($stat_id, $int_value); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
stat_id|int|
int_value|int|
- name: isdisctome
summary: is a quest disctome.
example: |2-
```perl
my $item_id = 1;
my $val = quest::isdisctome($item_id);
quest::say($val); # Returns bool
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
item_id|int|
- name: isdooropen
summary: is a quest dooropen.
example: |2-
```perl
my $door_id = 1;
my $val = quest::isdooropen($door_id);
quest::say($val); # Returns uint
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
door_id|int|
- name: istaskaappropriate
summary: is a quest taskaappropriate.
example: |2-
```perl
my $task = 1;
my $val = quest::istaskaappropriate($task);
quest::say($val); # Returns uint
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
task|int|
- name: istaskactive
summary: is a quest taskactive.
example: |2-
```perl
my $task_id = 1;
my $val = quest::istaskactive($task_id);
quest::say($val); # Returns uint
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
task_id|uint|
- name: istaskactivityactive
summary: is a quest taskactivityactive.
example: |2-
```perl
my $task_id = 1;
my $activity_id = 1;
my $val = quest::istaskactivityactive($task_id, $activity_id);
quest::say($val); # Returns uint
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
task_id|uint|
activity_id|uint|
- name: istaskcompleted
summary: is a quest taskcompleted.
example: |2-
```perl
my $task_id = 1;
my $val = quest::istaskcompleted($task_id);
quest::say($val); # Returns int
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
task_id|uint|
- name: istaskenabled
summary: is a quest taskenabled.
example: |2-
```perl
my $task_id = 1;
my $val = quest::istaskenabled($task_id);
quest::say($val); # Returns uint
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
task_id|uint|
- name: itemlink
summary: itemlink.
example: |2-
```perl
my $item_id = 1;
quest::itemlink($item_id); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
item_id|int|
- name: lasttaskinset
summary: lasttaskinset.
example: |2-
```perl
my $task_set = 1;
my $val = quest::lasttaskinset($task_set);
quest::say($val); # Returns int
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
task_set|int|
- name: level
summary: level.
example: |2-
```perl
my $newlevel = 1;
quest::level($newlevel); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
newlevel|int|
- name: movegrp
summary: movegrp.
example: |2-
```perl
my $zone_id = 1;
my $x = 1;
my $y = 1;
my $z = 1;
quest::movegrp($zone_id, $x, $y, $z); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
zone_id|int|
x|float|
y|float|
z|float|
- name: movepc
summary: movepc.
example: |2-
```perl
my $zone_id = 1;
my $x = 1;
my $y = 1;
my $ = 1;
my $heading = 1;
quest::movepc($zone_id, $x, $y, $, $heading); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
zone_id|int|
x|float|
y|float|
||
heading|float|
- name: moveto
summary: moveto.
example: |2-
```perl
my $x = 1;
my $y = 1;
my $z = 1;
my $heading = 1;
my $saveguard = 1;
quest::moveto($x, $y, $z, $heading, $saveguard); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
x|float|
y|float|
z|float|
heading|float|
saveguard|bool|
- name: new
summary: new.
example: |2-
```perl
quest::new(); # Returns void
```
argument: ""
- name: nexttaskinset
summary: nexttaskinset.
example: |2-
```perl
my $task_set = 1;
my $task_id = 1;
my $val = quest::nexttaskinset($task_set, $task_id);
quest::say($val); # Returns int
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
task_set|int|
task_id|uint|
- name: npcfeature
summary: npcfeature.
example: |2-
```perl
my $str_value = "test";
my $int_value = 1;
my $val = quest::npcfeature($str_value, $int_value);
quest::say($val); # Returns uint
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
str_value|string|
int_value|int|
- name: npcgender
summary: npcgender.
example: |2-
```perl
my $gender_id = 1;
quest::npcgender($gender_id); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
gender_id|int|
- name: npcrace
summary: npcrace.
example: |2-
```perl
my $race_id = 1;
quest::npcrace($race_id); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
race_id|int|
- name: npcsize
summary: npcsize.
example: |2-
```perl
my $size = 1;
quest::npcsize($size); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
size|int|
- name: npctexture
summary: npctexture.
example: |2-
```perl
my $texture_id = 1;
quest::npctexture($texture_id); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
texture_id|int|
- name: pause
summary: pause.
example: |2-
```perl
my $duration = 1;
quest::pause($duration); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
duration|int|
- name: permaclass
summary: permaclass.
example: |2-
```perl
my $class_id = 1;
quest::permaclass($class_id); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
class_id|int|
- name: permagender
summary: permagender.
example: |2-
```perl
my $gender_id = 1;
quest::permagender($gender_id); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
gender_id|int|
- name: permarace
summary: permarace.
example: |2-
```perl
my $race_id = 1;
quest::permarace($race_id); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
race_id|int|
- name: playerfeature
summary: plays a quest erfeature.
example: |2-
```perl
my $str_value = "test";
my $int_value = 1;
quest::playerfeature($str_value, $int_value); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
str_value|string|
int_value|int|
- name: playergender
summary: plays a quest ergender.
example: |2-
```perl
my $gender_id = 1;
quest::playergender($gender_id); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
gender_id|int|
- name: playerrace
summary: plays a quest errace.
example: |2-
```perl
my $race_id = 1;
quest::playerrace($race_id); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
race_id|int|
- name: playersize
summary: plays a quest ersize.
example: |2-
```perl
my $newsize = 1;
quest::playersize($newsize); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
newsize|int|
- name: playertexture
summary: plays a quest ertexture.
example: |2-
```perl
my $texture_id = 1;
quest::playertexture($texture_id); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
texture_id|int|
- name: popup
summary: popup.
example: |2-
```perl
my $window_title = "test";
my $message = "test";
my $popup_id = 1;
my $buttons = 1;
my $duration = 1;
quest::popup($window_title, $message, $popup_id, $buttons, $duration); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
window_title|string|
message|string|
popup_id|int|
buttons|int|
duration|int|
- name: pvp
summary: pvp.
example: |2-
```perl
my $mode = "test";
quest::pvp($mode); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
mode|string|
- name: qs_player_event
summary: qs_player_event.
example: |2-
```perl
my $char_id = 1;
my $message = "test";
quest::qs_player_event($char_id, $message); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
char_id|int|
message|string|
- name: qs_send_query
summary: qs_send_query.
example: |2-
```perl
my $query = 1;
quest::qs_send_query($query); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
query||
- name: rain
summary: rain.
example: |2-
```perl
my $weather = 1;
quest::rain($weather); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
weather|int|
- name: rebind
summary: rebind.
example: |2-
```perl
my $zone_id = 1;
my $x = 1;
my $y = 1;
my $z = 1;
quest::rebind($zone_id, $x, $y, $z); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
zone_id|int|
x|float|
y|float|
z|float|
- name: removetitle
summary: removetitle.
example: |2-
```perl
my $titleset = 1;
quest::removetitle($titleset); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
titleset|int|
- name: repopzone
summary: repopzone.
example: |2-
```perl
quest::repopzone(); # Returns void
```
argument: ""
- name: resettaskactivity
summary: resettaskactivity.
example: |2-
```perl
my $task_id = 1;
my $activity_id = 1;
quest::resettaskactivity($task_id, $activity_id); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
task_id|uint|
activity_id|uint|
- name: respawn
summary: respawn.
example: |2-
```perl
my $npc_type_id = 1;
my $grid_id = 1;
quest::respawn($npc_type_id, $grid_id); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
npc_type_id|int|
grid_id|int|
- name: resume
summary: resume.
example: |2-
```perl
quest::resume(); # Returns void
```
argument: ""
- name: safemove
summary: safemove.
example: |2-
```perl
quest::safemove(); # Returns void
```
argument: ""
- name: save
summary: save.
example: |2-
```perl
quest::save(); # Returns void
```
argument: ""
- name: say
summary: say.
example: |2-
```perl
my $ = 1;
my $language_id = 1;
quest::say($, $language_id); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
||
language_id|int|
- name: saylink
summary: saylink.
example: |2-
```perl
my $message = "test";
my $silent = 1;
my $link_name = "test";
my $val = quest::saylink($message, $silent, $link_name);
quest::say($val); # Returns string
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
message|string|
silent|bool|
link_name|string|
- name: scribespells
summary: scribespells.
example: |2-
```perl
my $max_level = 1;
my $min_level = 1;
my $val = quest::scribespells($max_level, $min_level);
quest::say($val); # Returns uint
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
max_level|int|
min_level|int|
- name: selfcast
summary: selfcast.
example: |2-
```perl
my $spell_id = 1;
quest::selfcast($spell_id); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
spell_id|int|
- name: set_proximity
summary: sets a quest proximity.
example: |2-
```perl
my $min_x = 1;
my $max_x = 1;
my $min_y = 1;
my $ = 1;
my $min_z = 1;
my $max_z = 1;
quest::set_proximity($min_x, $max_x, $min_y, $, $min_z, $max_z); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
min_x|float|
max_x|float|
min_y|float|
||
min_z|float|
max_z|float|
- name: set_zone_flag
summary: sets a quest zone flag.
example: |2-
```perl
my $zone_id = 1;
quest::set_zone_flag($zone_id); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
zone_id|int|
- name: setallskill
summary: sets a quest allskill.
example: |2-
```perl
my $int_value = 1;
quest::setallskill($int_value); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
int_value|int|
- name: setanim
summary: sets a quest anim.
example: |2-
```perl
my $npc_type_id = 1;
my $anim_num = 1;
quest::setanim($npc_type_id, $anim_num); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
npc_type_id|int|
anim_num|int|
- name: setglobal
summary: sets a quest global.
example: |2-
```perl
my $key = "test";
my $str_value = "test";
my $options = 1;
my $duration = 1;
quest::setglobal($key, $str_value, $options, $duration); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
key|string|
str_value|string|
options|int|
duration|int|
- name: setguild
summary: sets a quest guild.
example: |2-
```perl
my $new_guild_id = 1;
my $guild_rank_id = 1;
quest::setguild($new_guild_id, $guild_rank_id); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
new_guild_id|unsigned long|
guild_rank_id|int|
- name: sethp
summary: sets a quest hp.
example: |2-
```perl
my $percentage = 1;
quest::sethp($percentage); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
percentage|int|
- name: setlanguage
summary: sets a quest language.
example: |2-
```perl
my $skill_id = 1;
my $int_value = 1;
quest::setlanguage($skill_id, $int_value); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
skill_id|int|
int_value|int|
- name: setnexthpevent
summary: sets a quest nexthpevent.
example: |2-
```perl
my $at = 1;
quest::setnexthpevent($at); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
at|int|
- name: setnextinchpevent
summary: sets a quest nextinchpevent.
example: |2-
```perl
my $at = 1;
quest::setnextinchpevent($at); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
at|int|
- name: setskill
summary: sets a quest skill.
example: |2-
```perl
my $skill_id = 1;
my $int_value = 1;
quest::setskill($skill_id, $int_value); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
skill_id|int|
int_value|int|
- name: setsky
summary: sets a quest sky.
example: |2-
```perl
my $new_sky = 1;
quest::setsky($new_sky); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
new_sky||
- name: setstat
summary: sets a quest stat.
example: |2-
```perl
my $stat_id = 1;
my $int_value = 1;
quest::setstat($stat_id, $int_value); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
stat_id|int|
int_value|int|
- name: settarget
summary: sets a quest target.
example: |2-
```perl
my $target_enum = "test";
my $target_id = 1;
quest::settarget($target_enum, $target_id); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
target_enum|string|
target_id|int|
- name: settime
summary: sets a quest time.
example: |2-
```perl
my $new_hour = 1;
my $new_min = 1;
my $update_world = 1;
quest::settime($new_hour, $new_min, $update_world); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
new_hour|int|
new_min|int|
update_world|int|
- name: settimer
summary: sets a quest timer.
example: |2-
```perl
my $timer_name = "test";
my $seconds = 1;
quest::settimer($timer_name, $seconds); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
timer_name|string|
seconds|int|
- name: settimerMS
summary: sets a quest timer m s.
example: |2-
```perl
my $timer_name = "test";
my $milliseconds = 1;
quest::settimerMS($timer_name, $milliseconds); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
timer_name|string|
milliseconds|int|
- name: sfollow
summary: sfollow.
example: |2-
```perl
quest::sfollow(); # Returns void
```
argument: ""
- name: shout
summary: shout.
example: |2-
```perl
my $message = "test";
quest::shout($message); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
message|string|
- name: shout2
summary: shout2.
example: |2-
```perl
my $message = "test";
quest::shout2($message); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
message|string|
- name: showgrid
summary: showgrid.
example: |2-
```perl
my $grid_id = 1;
quest::showgrid($grid_id); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
grid_id|int|
- name: signal
summary: signal.
example: |2-
```perl
my $npc_id = 1;
my $wait_ms = 1;
quest::signal($npc_id, $wait_ms); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
npc_id|int|
wait_ms|int|
- name: signalwith
summary: signalwith.
example: |2-
```perl
my $npc_id = 1;
my $signal_id = 1;
my $wait_ms = 1;
quest::signalwith($npc_id, $signal_id, $wait_ms); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
npc_id|int|
signal_id|int|
wait_ms|int|
- name: snow
summary: snow.
example: |2-
```perl
my $weather = 1;
quest::snow($weather); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
weather|int|
- name: spawn
summary: spawn.
example: |2-
```perl
my $npc_type_id = 1;
my $grid_id = 1;
my $int_unused = 1;
my $x = 1;
my $y = 1;
my $z = 1;
my $val = quest::spawn($npc_type_id, $grid_id, $int_unused, $x, $y, $z);
quest::say($val); # Returns uint
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
npc_type_id|int|
grid_id|int|
int_unused|int|
x|float|
y|float|
z|float|
- name: spawn2
summary: spawn2.
example: |2-
```perl
my $npc_type_id = 1;
my $grid_id = 1;
my $int_unused = 1;
my $x = 1;
my $y = 1;
my $z = 1;
my $heading = 1;
my $val = quest::spawn2($npc_type_id, $grid_id, $int_unused, $x, $y, $z, $heading);
quest::say($val); # Returns uint
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
npc_type_id|int|
grid_id|int|
int_unused|int|
x|float|
y|float|
z|float|
heading|float|
- name: spawn_condition
summary: spawn_condition.
example: |2-
```perl
my $zone_short = "test";
my $instance_id = 1;
my $condition_id = 1;
my $int_value = 1;
quest::spawn_condition($zone_short, $instance_id, $condition_id, $int_value); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
zone_short|string|
instance_id|int|
condition_id|int|
int_value|int|
- name: spawn_from_spawn2
summary: spawn_from_spawn2.
example: |2-
```perl
my $spawn2_id = 1;
my $val = quest::spawn_from_spawn2($spawn2_id);
quest::say($val); # Returns uint
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
spawn2_id||
- name: start
summary: start.
example: |2-
```perl
my $wp = 1;
quest::start($wp); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
wp|int|
- name: stop
summary: stop.
example: |2-
```perl
quest::stop(); # Returns void
```
argument: ""
- name: stopalltimers
summary: stopalltimers.
example: |2-
```perl
quest::stopalltimers(); # Returns void
```
argument: ""
- name: stoptimer
summary: stoptimer.
example: |2-
```perl
my $timer_name = "test";
quest::stoptimer($timer_name); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
timer_name|string|
- name: summonallplayercorpses
summary: summonallplayercorpses.
example: |2-
```perl
my $char_id = 1;
my $dest_x = 1;
my $dest_y = 1;
my $dest_z = 1;
my $dest_heading = 1;
my $val = quest::summonallplayercorpses($char_id, $dest_x, $dest_y, $dest_z, $dest_heading);
quest::say($val); # Returns bool
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
char_id|int|
dest_x|float|
dest_y|float|
dest_z|float|
dest_heading|float|
- name: summonburiedplayercorpse
summary: summonburiedplayercorpse.
example: |2-
```perl
my $char_id = 1;
my $dest_x = 1;
my $dest_y = 1;
my $dest_z = 1;
my $dest_heading = 1;
my $val = quest::summonburiedplayercorpse($char_id, $dest_x, $dest_y, $dest_z, $dest_heading);
quest::say($val); # Returns bool
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
char_id|int|
dest_x|float|
dest_y|float|
dest_z|float|
dest_heading|float|
- name: summonitem
summary: summonitem.
example: |2-
```perl
my $item_id = 1;
my $charges = 1;
quest::summonitem($item_id, $charges); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
item_id|int|
charges|int|
- name: surname
summary: surname.
example: |2-
```perl
my $name = "test";
quest::surname($name); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
name|string|
- name: targlobal
summary: targlobal.
example: |2-
```perl
my $key = "test";
my $str_value = "test";
my $duration = 1;
my $npc_id = 1;
my $char_id = 1;
my $zone_id = 1;
quest::targlobal($key, $str_value, $duration, $npc_id, $char_id, $zone_id); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
key|string|
str_value|string|
duration|int|
npc_id|int|
char_id|int|
zone_id|int|
- name: task_setselector
summary: task_setselector.
example: |2-
```perl
my $task_setid = 1;
quest::task_setselector($task_setid); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
task_setid||
- name: taskexplorearea
summary: taskexplorearea.
example: |2-
```perl
my $explore_id = 1;
quest::taskexplorearea($explore_id); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
explore_id|uint|
- name: taskselector
summary: taskselector.
example: |2-
```perl
my $task_id1 = 1;
my $task_id2 = 1;
my $task_id%i = 1;
quest::taskselector($task_id1, $task_id2, ..., $task_id%i); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
task_id1|int|
task_id2|int|
...||
task_id%i|int|
- name: tasktimeleft
summary: tasktimeleft.
example: |2-
```perl
my $task_id = 1;
my $val = quest::tasktimeleft($task_id);
quest::say($val); # Returns int
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
task_id|uint|
- name: toggle_spawn_event
summary: toggle_spawn_event.
example: |2-
```perl
my $event_id = 1;
my $is_enabled = 1;
my $is_strict = 1;
my $reset_base = 1;
quest::toggle_spawn_event($event_id, $is_enabled, $is_strict, $reset_base); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
event_id|uint|
is_enabled|bool|
is_strict|bool|
reset_base|bool|
- name: toggledoorstate
summary: toggledoorstate.
example: |2-
```perl
my $door_id = 1;
quest::toggledoorstate($door_id); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
door_id|int|
- name: traindisc
summary: traindisc.
example: |2-
```perl
my $discipline_tome_item_id = 1;
quest::traindisc($discipline_tome_item_id); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
discipline_tome_item_id|int|
- name: traindiscs
summary: traindiscs.
example: |2-
```perl
my $max_level = 1;
my $min_level = 1;
my $val = quest::traindiscs($max_level, $min_level);
quest::say($val); # Returns uint
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
max_level|int|
min_level|int|
- name: unique_spawn
summary: unique_spawn.
example: |2-
```perl
my $npc_type_id = 1;
my $grid_id = 1;
my $int_unused = 1;
my $x = 1;
my $y = 1;
my $z = 1;
my $heading = 1;
my $val = quest::unique_spawn($npc_type_id, $grid_id, $int_unused, $x, $y, $z, $heading);
quest::say($val); # Returns uint
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
npc_type_id|int|
grid_id|int|
int_unused|int|
x|float|
y|float|
z|float|
heading|float|
- name: unscribespells
summary: unscribespells.
example: |2-
```perl
quest::unscribespells(); # Returns void
```
argument: ""
- name: untraindiscs
summary: untraindiscs.
example: |2-
```perl
quest::untraindiscs(); # Returns void
```
argument: ""
- name: updatetaskactivity
summary: updatetaskactivity.
example: |2-
```perl
my $task_id = 1;
my $activity_id = 1;
my $count = 1;
my $ignore_quest_update = 1;
quest::updatetaskactivity($task_id, $activity_id, $count, $ignore_quest_update); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
task_id|uint|
activity_id|uint|
count|int|
ignore_quest_update|bool|
- name: varlink
summary: varlink.
example: |2-
```perl
my $item_id = 1;
my $val = quest::varlink($item_id);
quest::say($val); # Returns string
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
item_id|int|
- name: voicetell
summary: voicetell.
example: |2-
```perl
my $client_name = "test";
my $macro_id = 1;
my $race_id = 1;
my $gender_id = 1;
quest::voicetell($client_name, $macro_id, $race_id, $gender_id); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
client_name|string|
macro_id|int|
race_id|int|
gender_id|int|
- name: we
summary: we.
example: |2-
```perl
my $channel_id = 1;
my $message = "test";
quest::we($channel_id, $message); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
channel_id|int|
message|string|
- name: wearchange
summary: wearchange.
example: |2-
```perl
my $slot = 1;
my $texture_id = 1;
my $hero_forge_model_id = 1;
my $elite_material_id = 1;
quest::wearchange($slot, $texture_id, $hero_forge_model_id, $elite_material_id); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
slot|int|
texture_id|int|
hero_forge_model_id|int|
elite_material_id|int|
- name: worldwidemarquee
summary: worldwidemarquee.
example: |2-
```perl
my $color_id = 1;
my $priority = 1;
my $fade_in = 1;
my $fade_out = 1;
my $duration = 1;
my $message = "test";
quest::worldwidemarquee($color_id, $priority, $fade_in, $fade_out, $duration, $message); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
color_id|int|
priority|int|
fade_in|int|
fade_out|int|
duration|int|
message|string|
- name: write
summary: write.
example: |2-
```perl
my $file = "test";
my $message = "test";
quest::write($file, $message); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
file|string|
message|string|
- name: ze
summary: ze.
example: |2-
```perl
my $channel_id = 1;
my $message = "test";
quest::ze($channel_id, $message); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
channel_id|int|
message|string|
- name: zone
summary: zone.
example: |2-
```perl
my $zone_name = "test";
quest::zone($zone_name); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
zone_name|string|
- name: Raid
functions:
- name: BalanceHP
summary: BalanceHP.
example: |2-
```perl
my $penalty = 1;
my $gid = 1;
$raid->BalanceHP($penalty, $gid); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
penalty||
gid||
- name: CastGroupSpell
summary: CastGroupSpell.
example: |2-
```perl
my $caster = 1;
my $spellid = 1;
my $gid = 1;
$raid->CastGroupSpell($caster, $spellid, $gid); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
caster||
spellid||
gid||
- name: GetClientByIndex
summary: gets a raid client by index.
example: |2-
```perl
my $index = 1;
$raid->GetClientByIndex($index); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
index||
- name: GetGroup
summary: gets a raid group.
example: |2-
```perl
my $name = "test";
my $val = $raid->GetGroup($name);
quest::say($val); # Returns uint
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
name|string|
- name: GetHighestLevel
summary: gets a raid highest level.
example: |2-
```perl
my $val = $raid->GetHighestLevel();
quest::say($val); # Returns uint
```
argument: ""
- name: GetID
summary: gets a raid i d.
example: |2-
```perl
my $val = $raid->GetID();
quest::say($val); # Returns uint
```
argument: ""
- name: GetLowestLevel
summary: gets a raid lowest level.
example: |2-
```perl
my $val = $raid->GetLowestLevel();
quest::say($val); # Returns uint
```
argument: ""
- name: GetTotalRaidDamage
summary: gets a raid total raid damage.
example: |2-
```perl
my $other = 1;
my $val = $raid->GetTotalRaidDamage($other);
quest::say($val); # Returns uint
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
other||
- name: GroupCount
summary: GroupCount.
example: |2-
```perl
my $gid = 1;
my $val = $raid->GroupCount($gid);
quest::say($val); # Returns uint
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
gid||
- name: IsGroupLeader
summary: is a raid group leader.
example: |2-
```perl
my $who = 1;
my $val = $raid->IsGroupLeader($who);
quest::say($val); # Returns bool
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
who||
- name: IsLeader
summary: is a raid leader.
example: |2-
```perl
my $name = "test";
my $val = $raid->IsLeader($name);
quest::say($val); # Returns bool
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
name|string|
- name: IsRaidMember
summary: is a raid raid member.
example: |2-
```perl
my $name = "test";
my $val = $raid->IsRaidMember($name);
quest::say($val); # Returns bool
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
name|string|
- name: RaidCount
summary: RaidCount.
example: |2-
```perl
my $val = $raid->RaidCount();
quest::say($val); # Returns uint
```
argument: ""
- name: SplitExp
summary: SplitExp.
example: |2-
```perl
my $exp = 1;
my $other = 1;
$raid->SplitExp($exp, $other); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
exp||
other||
- name: SplitMoney
summary: SplitMoney.
example: |2-
```perl
my $copper = 1;
my $silver = 1;
my $gold = 1;
my $platinum = 1;
$raid->SplitMoney($copper, $silver, $gold, $platinum); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
copper|int|
silver|int|
gold|int|
platinum|int|
- name: TeleportGroup
summary: teleports a raid group.
example: |2-
```perl
my $sender = 1;
my $zoneID = 1;
my $x = 1;
my $y = 1;
my $z = 1;
my $heading = 1;
my $gid = 1;
$raid->TeleportGroup($sender, $zoneID, $x, $y, $z, $heading, $gid); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
sender||
zoneID||
x|float|
y|float|
z|float|
heading|float|
gid||
- name: TeleportRaid
summary: teleports a raid raid.
example: |2-
```perl
my $sender = 1;
my $zoneID = 1;
my $x = 1;
my $y = 1;
my $z = 1;
my $heading = 1;
$raid->TeleportRaid($sender, $zoneID, $x, $y, $z, $heading); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
sender||
zoneID||
x|float|
y|float|
z|float|
heading|float|
- name: EntityList
functions:
- name: CanAddHateForMob
summary: CanAddHateForMob.
example: |2-
```perl
my $p = 1;
my $val = $entity_list->CanAddHateForMob($p);
quest::say($val); # Returns bool
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
p||
- name: Clear
summary: Clear.
example: |2-
```perl
$entity_list->Clear(); # Returns void
```
argument: ""
- name: ClearClientPetitionQueue
summary: ClearClientPetitionQueue.
example: |2-
```perl
$entity_list->ClearClientPetitionQueue(); # Returns void
```
argument: ""
- name: ClearFeignAggro
summary: ClearFeignAggro.
example: |2-
```perl
my $targ = 1;
$entity_list->ClearFeignAggro($targ); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
targ||
- name: DeleteNPCCorpses
summary: DeleteNPCCorpses.
example: |2-
```perl
my $val = $entity_list->DeleteNPCCorpses();
quest::say($val); # Returns int
```
argument: ""
- name: DeletePlayerCorpses
summary: DeletePlayerCorpses.
example: |2-
```perl
my $val = $entity_list->DeletePlayerCorpses();
quest::say($val); # Returns int
```
argument: ""
- name: DoubleAggro
summary: DoubleAggro.
example: |2-
```perl
my $who = 1;
$entity_list->DoubleAggro($who); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
who||
- name: Fighting
summary: Fighting.
example: |2-
```perl
my $targ = 1;
my $val = $entity_list->Fighting($targ);
quest::say($val); # Returns bool
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
targ||
- name: FindDoor
summary: FindDoor.
example: |2-
```perl
my $id = 1;
$entity_list->FindDoor($id); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
id||
- name: GetClientByAccID
summary: gets a entitylist client by acc i d.
example: |2-
```perl
my $accid = 1;
$entity_list->GetClientByAccID($accid); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
accid||
- name: GetClientByCharID
summary: gets a entitylist client by char i d.
example: |2-
```perl
my $iCharID = 1;
$entity_list->GetClientByCharID($iCharID); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
iCharID||
- name: GetClientByID
summary: gets a entitylist client by i d.
example: |2-
```perl
my $id = 1;
$entity_list->GetClientByID($id); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
id||
- name: GetClientByName
summary: gets a entitylist client by name.
example: |2-
```perl
my $name = "test";
$entity_list->GetClientByName($name); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
name|string|
- name: GetClientByWID
summary: gets a entitylist client by w i d.
example: |2-
```perl
my $iWID = 1;
$entity_list->GetClientByWID($iWID); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
iWID||
- name: GetClientList
summary: gets a entitylist client list.
example: |2-
```perl
my $val = $entity_list->GetClientList();
quest::say($val); # Returns array
```
argument: ""
- name: GetCorpseByID
summary: gets a entitylist corpse by i d.
example: |2-
```perl
my $id = 1;
$entity_list->GetCorpseByID($id); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
id||
- name: GetCorpseByName
summary: gets a entitylist corpse by name.
example: |2-
```perl
my $name = "test";
$entity_list->GetCorpseByName($name); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
name|string|
- name: GetCorpseByOwner
summary: gets a entitylist corpse by owner.
example: |2-
```perl
my $client = 1;
$entity_list->GetCorpseByOwner($client); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
client||
- name: GetCorpseList
summary: gets a entitylist corpse list.
example: |2-
```perl
my $val = $entity_list->GetCorpseList();
quest::say($val); # Returns array
```
argument: ""
- name: GetDoorsByDBID
summary: gets a entitylist doors by d b i d.
example: |2-
```perl
my $id = 1;
$entity_list->GetDoorsByDBID($id); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
id||
- name: GetDoorsByDoorID
summary: gets a entitylist doors by door i d.
example: |2-
```perl
my $id = 1;
$entity_list->GetDoorsByDoorID($id); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
id||
- name: GetDoorsByID
summary: gets a entitylist doors by i d.
example: |2-
```perl
my $id = 1;
$entity_list->GetDoorsByID($id); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
id||
- name: GetDoorsList
summary: gets a entitylist doors list.
example: |2-
```perl
my $val = $entity_list->GetDoorsList();
quest::say($val); # Returns array
```
argument: ""
- name: GetGroupByClient
summary: gets a entitylist group by client.
example: |2-
```perl
my $client = 1;
$entity_list->GetGroupByClient($client); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
client||
- name: GetGroupByID
summary: gets a entitylist group by i d.
example: |2-
```perl
my $id = 1;
$entity_list->GetGroupByID($id); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
id||
- name: GetGroupByLeaderName
summary: gets a entitylist group by leader name.
example: |2-
```perl
my $leader = 1;
$entity_list->GetGroupByLeaderName($leader); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
leader||
- name: GetGroupByMob
summary: gets a entitylist group by mob.
example: |2-
```perl
my $mob = 1;
$entity_list->GetGroupByMob($mob); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
mob||
- name: GetMob
summary: gets a entitylist mob.
example: |2-
```perl
my $name = "test";
$entity_list->GetMob($name); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
name|string|
- name: GetMobByID
summary: gets a entitylist mob by i d.
example: |2-
```perl
my $id = 1;
$entity_list->GetMobByID($id); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
id||
- name: GetMobByNpcTypeID
summary: gets a entitylist mob by npc type i d.
example: |2-
```perl
my $get_id = 1;
$entity_list->GetMobByNpcTypeID($get_id); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
get_id||
- name: GetMobID
summary: gets a entitylist mob i d.
example: |2-
```perl
my $id = 1;
$entity_list->GetMobID($id); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
id||
- name: GetMobList
summary: gets a entitylist mob list.
example: |2-
```perl
my $val = $entity_list->GetMobList();
quest::say($val); # Returns array
```
argument: ""
- name: GetNPCByID
summary: gets a entitylist npcb y i d.
example: |2-
```perl
my $id = 1;
$entity_list->GetNPCByID($id); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
id||
- name: GetNPCByNPCTypeID
summary: gets a entitylist npcb y npct ype i d.
example: |2-
```perl
my $npc_id = 1;
$entity_list->GetNPCByNPCTypeID($npc_id); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
npc_id|int|
- name: GetNPCList
summary: gets a entitylist npcl ist.
example: |2-
```perl
my $val = $entity_list->GetNPCList();
quest::say($val); # Returns array
```
argument: ""
- name: GetObjectByDBID
summary: gets a entitylist object by d b i d.
example: |2-
```perl
my $id = 1;
$entity_list->GetObjectByDBID($id); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
id||
- name: GetObjectByID
summary: gets a entitylist object by i d.
example: |2-
```perl
my $id = 1;
$entity_list->GetObjectByID($id); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
id||
- name: GetObjectList
summary: gets a entitylist object list.
example: |2-
```perl
my $val = $entity_list->GetObjectList();
quest::say($val); # Returns array
```
argument: ""
- name: GetRaidByClient
summary: gets a entitylist raid by client.
example: |2-
```perl
my $client = 1;
$entity_list->GetRaidByClient($client); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
client||
- name: GetRaidByID
summary: gets a entitylist raid by i d.
example: |2-
```perl
my $id = 1;
$entity_list->GetRaidByID($id); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
id||
- name: GetRandomClient
summary: gets a entitylist random client.
example: |2-
```perl
my $x = 1;
my $y = 1;
my $z = 1;
my $distance = 1;
my $excludeclient = 1;
$entity_list->GetRandomClient($x, $y, $z, $distance, $excludeclient); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
x|float|
y|float|
z|float|
distance|int|
excludeclient||
- name: HalveAggro
summary: HalveAggro.
example: |2-
```perl
my $who = 1;
$entity_list->HalveAggro($who); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
who||
- name: MakeNameUnique
summary: MakeNameUnique.
example: |2-
```perl
my $name = "test";
my $val = $entity_list->MakeNameUnique($name);
quest::say($val); # Returns string
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
name|string|
- name: Message
summary: Message.
example: |2-
```perl
my $to_guilddbid = 1;
my $type = 1;
my $message = "test";
$entity_list->Message($to_guilddbid, $type, $message, ...); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
to_guilddbid||
type|int|
message|string|
...||
- name: MessageClose
summary: MessageClose.
example: |2-
```perl
my $sender = 1;
my $skipsender = 1;
my $dist = 1;
my $type = 1;
my $message = "test";
$entity_list->MessageClose($sender, $skipsender, $dist, $type, $message, ...); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
sender||
skipsender||
dist||
type|int|
message|string|
...||
- name: MessageGroup
summary: MessageGroup.
example: |2-
```perl
my $sender = 1;
my $skipclose = 1;
my $type = 1;
my $message = "test";
$entity_list->MessageGroup($sender, $skipclose, $type, $message, ...); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
sender||
skipclose||
type|int|
message|string|
...||
- name: MessageStatus
summary: MessageStatus.
example: |2-
```perl
my $to_guilddbid = 1;
my $to_minstatus = 1;
my $type = 1;
my $message = "test";
$entity_list->MessageStatus($to_guilddbid, $to_minstatus, $type, $message, ...); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
to_guilddbid||
to_minstatus||
type|int|
message|string|
...||
- name: OpenDoorsNear
summary: OpenDoorsNear.
example: |2-
```perl
my $opener = 1;
$entity_list->OpenDoorsNear($opener); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
opener||
- name: RemoveAllClients
summary: RemoveAllClients.
example: |2-
```perl
$entity_list->RemoveAllClients(); # Returns void
```
argument: ""
- name: RemoveAllCorpses
summary: RemoveAllCorpses.
example: |2-
```perl
$entity_list->RemoveAllCorpses(); # Returns void
```
argument: ""
- name: RemoveAllDoors
summary: RemoveAllDoors.
example: |2-
```perl
$entity_list->RemoveAllDoors(); # Returns void
```
argument: ""
- name: RemoveAllGroups
summary: RemoveAllGroups.
example: |2-
```perl
$entity_list->RemoveAllGroups(); # Returns void
```
argument: ""
- name: RemoveAllMobs
summary: RemoveAllMobs.
example: |2-
```perl
$entity_list->RemoveAllMobs(); # Returns void
```
argument: ""
- name: RemoveAllNPCs
summary: RemoveAllNPCs.
example: |2-
```perl
$entity_list->RemoveAllNPCs(); # Returns void
```
argument: ""
- name: RemoveAllObjects
summary: RemoveAllObjects.
example: |2-
```perl
$entity_list->RemoveAllObjects(); # Returns void
```
argument: ""
- name: RemoveAllTraps
summary: RemoveAllTraps.
example: |2-
```perl
$entity_list->RemoveAllTraps(); # Returns void
```
argument: ""
- name: RemoveClient
summary: RemoveClient.
example: |2-
```perl
my $delete_id = 1;
my $val = $entity_list->RemoveClient($delete_id);
quest::say($val); # Returns bool
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
delete_id||
- name: RemoveCorpse
summary: RemoveCorpse.
example: |2-
```perl
my $delete_id = 1;
my $val = $entity_list->RemoveCorpse($delete_id);
quest::say($val); # Returns bool
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
delete_id||
- name: RemoveDoor
summary: RemoveDoor.
example: |2-
```perl
my $delete_id = 1;
my $val = $entity_list->RemoveDoor($delete_id);
quest::say($val); # Returns bool
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
delete_id||
- name: RemoveEntity
summary: RemoveEntity.
example: |2-
```perl
my $id = 1;
$entity_list->RemoveEntity($id); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
id||
- name: RemoveFromHateLists
summary: RemoveFromHateLists.
example: |2-
```perl
my $mob = 1;
my $settoone = 1;
$entity_list->RemoveFromHateLists($mob, $settoone); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
mob||
settoone||
- name: RemoveFromTargets
summary: RemoveFromTargets.
example: |2-
```perl
my $mob = 1;
$entity_list->RemoveFromTargets($mob); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
mob||
- name: RemoveGroup
summary: RemoveGroup.
example: |2-
```perl
my $delete_id = 1;
my $val = $entity_list->RemoveGroup($delete_id);
quest::say($val); # Returns bool
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
delete_id||
- name: RemoveMob
summary: RemoveMob.
example: |2-
```perl
my $delete_id = 1;
my $val = $entity_list->RemoveMob($delete_id);
quest::say($val); # Returns bool
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
delete_id||
- name: RemoveNPC
summary: RemoveNPC.
example: |2-
```perl
my $delete_id = 1;
my $val = $entity_list->RemoveNPC($delete_id);
quest::say($val); # Returns bool
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
delete_id||
- name: RemoveNumbers
summary: RemoveNumbers.
example: |2-
```perl
my $CLASS = 1;
my $name = "test";
my $val = $entity_list->RemoveNumbers($CLASS, $name);
quest::say($val); # Returns string
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
CLASS||
name|string|
- name: RemoveObject
summary: RemoveObject.
example: |2-
```perl
my $delete_id = 1;
my $val = $entity_list->RemoveObject($delete_id);
quest::say($val); # Returns bool
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
delete_id||
- name: RemoveTrap
summary: RemoveTrap.
example: |2-
```perl
my $delete_id = 1;
my $val = $entity_list->RemoveTrap($delete_id);
quest::say($val); # Returns bool
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
delete_id||
- name: ReplaceWithTarget
summary: ReplaceWithTarget.
example: |2-
```perl
my $pOldMob = 1;
my $pNewTarget = 1;
$entity_list->ReplaceWithTarget($pOldMob, $pNewTarget); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
pOldMob||
pNewTarget||
- name: SignalMobsByNPCID
summary: SignalMobsByNPCID.
example: |2-
```perl
my $npc_type = 1;
my $signal_id = 1;
$entity_list->SignalMobsByNPCID($npc_type, $signal_id); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
npc_type||
signal_id|int|
- name: ValidMobByNpcTypeID
summary: ValidMobByNpcTypeID.
example: |2-
```perl
my $get_id = 1;
my $val = $entity_list->ValidMobByNpcTypeID($get_id);
quest::say($val); # Returns bool
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
get_id||
- name: Group
functions:
- name: CastGroupSpell
summary: CastGroupSpell.
example: |2-
```perl
my $caster = 1;
my $spellid = 1;
$group->CastGroupSpell($caster, $spellid); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
caster||
spellid||
- name: DisbandGroup
summary: DisbandGroup.
example: |2-
```perl
$group->DisbandGroup(); # Returns void
```
argument: ""
- name: GetHighestLevel
summary: gets a group highest level.
example: |2-
```perl
my $val = $group->GetHighestLevel();
quest::say($val); # Returns uint
```
argument: ""
- name: GetID
summary: gets a group i d.
example: |2-
```perl
my $val = $group->GetID();
quest::say($val); # Returns uint
```
argument: ""
- name: GetLeader
summary: gets a group leader.
example: |2-
```perl
$group->GetLeader(); # Returns void
```
argument: ""
- name: GetLeaderName
summary: gets a group leader name.
example: |2-
```perl
my $val = $group->GetLeaderName();
quest::say($val); # Returns string
```
argument: ""
- name: GetTotalGroupDamage
summary: gets a group total group damage.
example: |2-
```perl
my $other = 1;
my $val = $group->GetTotalGroupDamage($other);
quest::say($val); # Returns uint
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
other||
- name: GroupCount
summary: GroupCount.
example: |2-
```perl
my $val = $group->GroupCount();
quest::say($val); # Returns uint
```
argument: ""
- name: GroupMessage
summary: GroupMessage.
example: |2-
```perl
my $sender = 1;
my $language = 1;
my $message = "test";
$group->GroupMessage($sender, $language, $message); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
sender||
language||
message|string|
- name: IsGroupMember
summary: is a group group member.
example: |2-
```perl
my $client = 1;
my $val = $group->IsGroupMember($client);
quest::say($val); # Returns bool
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
client||
- name: IsLeader
summary: is a group leader.
example: |2-
```perl
my $leadertest = 1;
my $val = $group->IsLeader($leadertest);
quest::say($val); # Returns bool
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
leadertest||
- name: SendHPPacketsFrom
summary: sends a group h p packets from.
example: |2-
```perl
my $newmember = 1;
$group->SendHPPacketsFrom($newmember); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
newmember||
- name: SendHPPacketsTo
summary: sends a group h p packets to.
example: |2-
```perl
my $newmember = 1;
$group->SendHPPacketsTo($newmember); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
newmember||
- name: SetLeader
summary: sets a group leader.
example: |2-
```perl
my $newleader = 1;
$group->SetLeader($newleader); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
newleader||
- name: SplitExp
summary: SplitExp.
example: |2-
```perl
my $exp = 1;
my $other = 1;
$group->SplitExp($exp, $other); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
exp||
other||
- name: SplitMoney
summary: SplitMoney.
example: |2-
```perl
my $copper = 1;
my $silver = 1;
my $gold = 1;
my $platinum = 1;
$group->SplitMoney($copper, $silver, $gold, $platinum); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
copper|int|
silver|int|
gold|int|
platinum|int|
- name: TeleportGroup
summary: teleports a group group.
example: |2-
```perl
my $sender = 1;
my $zoneID = 1;
my $x = 1;
my $y = 1;
my $z = 1;
my $heading = 1;
$group->TeleportGroup($sender, $zoneID, $x, $y, $z, $heading); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
sender||
zoneID||
x|float|
y|float|
z|float|
heading|float|
- name: Object
functions:
- name: ClearUser
summary: ClearUser.
example: |2-
```perl
$object->ClearUser(); # Returns void
```
argument: ""
- name: Close
summary: Close.
example: |2-
```perl
$object->Close(); # Returns void
```
argument: ""
- name: Delete
summary: Delete.
example: |2-
```perl
my $reset_state = 1;
$object->Delete($reset_state); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
reset_state||
- name: DeleteItem
summary: DeleteItem.
example: |2-
```perl
my $index = 1;
$object->DeleteItem($index); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
index||
- name: Depop
summary: Depop.
example: |2-
```perl
$object->Depop(); # Returns void
```
argument: ""
- name: EntityVariableExists
summary: EntityVariableExists.
example: |2-
```perl
my $id = 1;
my $val = $object->EntityVariableExists($id);
quest::say($val); # Returns bool
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
id||
- name: GetDBID
summary: gets a object d b i d.
example: |2-
```perl
my $val = $object->GetDBID();
quest::say($val); # Returns uint
```
argument: ""
- name: GetEntityVariable
summary: gets a object entity variable.
example: |2-
```perl
my $id = 1;
my $val = $object->GetEntityVariable($id);
quest::say($val); # Returns string
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
id||
- name: GetHeading
summary: gets a object heading.
example: |2-
```perl
my $val = $object->GetHeading();
quest::say($val); # Returns double
```
argument: ""
- name: GetID
summary: gets a object i d.
example: |2-
```perl
my $val = $object->GetID();
quest::say($val); # Returns uint
```
argument: ""
- name: GetIcon
summary: gets a object icon.
example: |2-
```perl
my $val = $object->GetIcon();
quest::say($val); # Returns uint
```
argument: ""
- name: GetItemID
summary: gets a object item i d.
example: |2-
```perl
my $val = $object->GetItemID();
quest::say($val); # Returns uint
```
argument: ""
- name: GetModelName
summary: gets a object model name.
example: |2-
```perl
my $val = $object->GetModelName();
quest::say($val); # Returns string
```
argument: ""
- name: GetSize
summary: gets a object size.
example: |2-
```perl
my $val = $object->GetSize();
quest::say($val); # Returns double
```
argument: ""
- name: GetSolidType
summary: gets a object solid type.
example: |2-
```perl
my $val = $object->GetSolidType();
quest::say($val); # Returns uint
```
argument: ""
- name: GetType
summary: gets a object type.
example: |2-
```perl
my $val = $object->GetType();
quest::say($val); # Returns uint
```
argument: ""
- name: GetX
summary: gets a object x.
example: |2-
```perl
my $val = $object->GetX();
quest::say($val); # Returns double
```
argument: ""
- name: GetY
summary: gets a object y.
example: |2-
```perl
my $val = $object->GetY();
quest::say($val); # Returns double
```
argument: ""
- name: GetZ
summary: gets a object z.
example: |2-
```perl
my $val = $object->GetZ();
quest::say($val); # Returns double
```
argument: ""
- name: IsGroundSpawn
summary: is a object ground spawn.
example: |2-
```perl
my $val = $object->IsGroundSpawn();
quest::say($val); # Returns bool
```
argument: ""
- name: IsObject
summary: is a object object.
example: |2-
```perl
my $val = $object->IsObject();
quest::say($val); # Returns bool
```
argument: ""
- name: Repop
summary: Repop.
example: |2-
```perl
$object->Repop(); # Returns void
```
argument: ""
- name: Save
summary: Save.
example: |2-
```perl
my $val = $object->Save();
quest::say($val); # Returns bool
```
argument: ""
- name: SetEntityVariable
summary: sets a object entity variable.
example: |2-
```perl
my $id = 1;
my $var = 1;
$object->SetEntityVariable($id, $var); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
id||
var||
- name: SetHeading
summary: sets a object heading.
example: |2-
```perl
my $heading = 1;
$object->SetHeading($heading); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
heading|float|
- name: SetID
summary: sets a object i d.
example: |2-
```perl
my $set_id = 1;
$object->SetID($set_id); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
set_id||
- name: SetIcon
summary: sets a object icon.
example: |2-
```perl
my $icon = 1;
$object->SetIcon($icon); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
icon||
- name: SetItemID
summary: sets a object item i d.
example: |2-
```perl
my $itemid = 1;
$object->SetItemID($itemid); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
itemid||
- name: SetLocation
summary: sets a object location.
example: |2-
```perl
my $x = 1;
my $y = 1;
my $z = 1;
$object->SetLocation($x, $y, $z); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
x|float|
y|float|
z|float|
- name: SetModelName
summary: sets a object model name.
example: |2-
```perl
my $name = "test";
$object->SetModelName($name); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
name|string|
- name: SetSize
summary: sets a object size.
example: |2-
```perl
my $type = 1;
$object->SetSize($type); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
type|int|
- name: SetSolidType
summary: sets a object solid type.
example: |2-
```perl
my $type = 1;
$object->SetSolidType($type); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
type|int|
- name: SetTiltX
summary: sets a object tilt x.
example: |2-
```perl
my $pos = 1;
$object->SetTiltX($pos); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
pos||
- name: SetTiltY
summary: sets a object tilt y.
example: |2-
```perl
my $pos = 1;
$object->SetTiltY($pos); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
pos||
- name: SetType
summary: sets a object type.
example: |2-
```perl
my $type = 1;
$object->SetType($type); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
type|int|
- name: SetX
summary: sets a object x.
example: |2-
```perl
my $XPos = 1;
$object->SetX($XPos); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
XPos||
- name: SetY
summary: sets a object y.
example: |2-
```perl
my $YPos = 1;
$object->SetY($YPos); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
YPos||
- name: SetZ
summary: sets a object z.
example: |2-
```perl
my $ZPos = 1;
$object->SetZ($ZPos); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
ZPos||
- name: StartDecay
summary: StartDecay.
example: |2-
```perl
$object->StartDecay(); # Returns void
```
argument: ""
- name: VarSave
summary: VarSave.
example: |2-
```perl
my $val = $object->VarSave();
quest::say($val); # Returns uint
```
argument: ""
- name: Perlpacket
functions:
- name: DESTROY
summary: DESTROY.
example: |2-
```perl
$perlpacket->DESTROY(); # Returns void
```
argument: ""
- name: FromArray
summary: FromArray.
example: |2-
```perl
my $numbers = 1;
my $length = 1;
$perlpacket->FromArray($numbers, $length); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
numbers||
length||
- name: GetByte
summary: gets a perlpacket byte.
example: |2-
```perl
my $pos = 1;
my $val = $perlpacket->GetByte($pos);
quest::say($val); # Returns uint
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
pos||
- name: GetLong
summary: gets a perlpacket long.
example: |2-
```perl
my $pos = 1;
my $val = $perlpacket->GetLong($pos);
quest::say($val); # Returns uint
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
pos||
- name: GetShort
summary: gets a perlpacket short.
example: |2-
```perl
my $pos = 1;
my $val = $perlpacket->GetShort($pos);
quest::say($val); # Returns uint
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
pos||
- name: Resize
summary: Resize.
example: |2-
```perl
my $len = 1;
$perlpacket->Resize($len); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
len||
- name: SendTo
summary: sends a perlpacket to.
example: |2-
```perl
my $who = 1;
$perlpacket->SendTo($who); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
who||
- name: SendToAll
summary: sends a perlpacket to all.
example: |2-
```perl
$perlpacket->SendToAll(); # Returns void
```
argument: ""
- name: SetByte
summary: sets a perlpacket byte.
example: |2-
```perl
my $pos = 1;
my $val = 1;
$perlpacket->SetByte($pos, $val); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
pos||
val||
- name: SetEQ1319
summary: sets a perlpacket e q1319.
example: |2-
```perl
my $pos = 1;
my $part13 = 1;
my $part19 = 1;
$perlpacket->SetEQ1319($pos, $part13, $part19); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
pos||
part13||
part19||
- name: SetEQ1913
summary: sets a perlpacket e q1913.
example: |2-
```perl
my $pos = 1;
my $part19 = 1;
my $part13 = 1;
$perlpacket->SetEQ1913($pos, $part19, $part13); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
pos||
part19||
part13||
- name: SetFloat
summary: sets a perlpacket float.
example: |2-
```perl
my $pos = 1;
my $val = 1;
$perlpacket->SetFloat($pos, $val); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
pos||
val||
- name: SetLong
summary: sets a perlpacket long.
example: |2-
```perl
my $pos = 1;
my $val = 1;
$perlpacket->SetLong($pos, $val); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
pos||
val||
- name: SetOpcode
summary: sets a perlpacket opcode.
example: |2-
```perl
my $opcode = 1;
my $val = $perlpacket->SetOpcode($opcode);
quest::say($val); # Returns bool
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
opcode||
- name: SetShort
summary: sets a perlpacket short.
example: |2-
```perl
my $pos = 1;
my $val = 1;
$perlpacket->SetShort($pos, $val); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
pos||
val||
- name: SetString
summary: sets a perlpacket string.
example: |2-
```perl
my $pos = 1;
my $str = 1;
$perlpacket->SetString($pos, $str); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
pos||
str||
- name: Zero
summary: Zero.
example: |2-
```perl
$perlpacket->Zero(); # Returns void
```
argument: ""
- name: new
summary: new.
example: |2-
```perl
my $CLASS = 1;
my $opcode = 1;
$perlpacket->new($CLASS, $opcode); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
CLASS||
opcode||
- name: Questitem
functions:
- name: GetAugment
summary: gets a questitem augment.
example: |2-
```perl
my $augment_id = 1;
$questitem->GetAugment($augment_id); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
augment_id||
- name: GetCharges
summary: gets a questitem charges.
example: |2-
```perl
my $val = $questitem->GetCharges();
quest::say($val); # Returns int
```
argument: ""
- name: GetName
summary: gets a questitem name.
example: |2-
```perl
my $val = $questitem->GetName();
quest::say($val); # Returns string
```
argument: ""
- name: IsAttuned
summary: is a questitem attuned.
example: |2-
```perl
my $val = $questitem->IsAttuned();
quest::say($val); # Returns bool
```
argument: ""
- name: IsType
summary: is a questitem type.
example: |2-
```perl
my $type = 1;
my $val = $questitem->IsType($type);
quest::say($val); # Returns bool
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
type|int|
- name: ItemSay
summary: ItemSay.
example: |2-
```perl
my $ = 1;
my $language = 1;
$questitem->ItemSay($, $language); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
||
language||
- name: SetScale
summary: sets a questitem scale.
example: |2-
```perl
my $factor = 1;
$questitem->SetScale($factor); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
factor||
- name: HateEntry
functions:
- name: GetData
summary: gets a hateentry data.
example: |2-
```perl
$hate_entry->GetData(); # Returns void
```
argument: ""
- name: GetHate
summary: gets a hateentry hate.
example: |2-
```perl
my $val = $hate_entry->GetHate();
quest::say($val); # Returns int
```
argument: ""
- name: Doors
functions:
- name: GetDoorDBID
summary: gets a doors door d b i d.
example: |2-
```perl
my $val = $doors->GetDoorDBID();
quest::say($val); # Returns uint
```
argument: ""
- name: GetDoorID
summary: gets a doors door i d.
example: |2-
```perl
my $val = $doors->GetDoorID();
quest::say($val); # Returns uint
```
argument: ""
- name: GetHeading
summary: gets a doors heading.
example: |2-
```perl
my $val = $doors->GetHeading();
quest::say($val); # Returns double
```
argument: ""
- name: GetID
summary: gets a doors i d.
example: |2-
```perl
my $val = $doors->GetID();
quest::say($val); # Returns uint
```
argument: ""
- name: GetIncline
summary: gets a doors incline.
example: |2-
```perl
my $val = $doors->GetIncline();
quest::say($val); # Returns uint
```
argument: ""
- name: GetKeyItem
summary: gets a doors key item.
example: |2-
```perl
my $val = $doors->GetKeyItem();
quest::say($val); # Returns uint
```
argument: ""
- name: GetLockpick
summary: gets a doors lockpick.
example: |2-
```perl
my $val = $doors->GetLockpick();
quest::say($val); # Returns uint
```
argument: ""
- name: GetModelName
summary: gets a doors model name.
example: |2-
```perl
my $val = $doors->GetModelName();
quest::say($val); # Returns string
```
argument: ""
- name: GetNoKeyring
summary: gets a doors no keyring.
example: |2-
```perl
my $type = 1;
$doors->GetNoKeyring($type); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
type|int|
- name: GetOpenType
summary: gets a doors open type.
example: |2-
```perl
my $val = $doors->GetOpenType();
quest::say($val); # Returns uint
```
argument: ""
- name: GetX
summary: gets a doors x.
example: |2-
```perl
my $val = $doors->GetX();
quest::say($val); # Returns double
```
argument: ""
- name: GetY
summary: gets a doors y.
example: |2-
```perl
my $val = $doors->GetY();
quest::say($val); # Returns double
```
argument: ""
- name: GetZ
summary: gets a doors z.
example: |2-
```perl
my $val = $doors->GetZ();
quest::say($val); # Returns double
```
argument: ""
- name: SetHeading
summary: sets a doors heading.
example: |2-
```perl
my $heading = 1;
$doors->SetHeading($heading); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
heading|float|
- name: SetIncline
summary: sets a doors incline.
example: |2-
```perl
my $type = 1;
$doors->SetIncline($type); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
type|int|
- name: SetKeyItem
summary: sets a doors key item.
example: |2-
```perl
my $type = 1;
$doors->SetKeyItem($type); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
type|int|
- name: SetLocation
summary: sets a doors location.
example: |2-
```perl
my $x = 1;
my $y = 1;
my $z = 1;
$doors->SetLocation($x, $y, $z); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
x|float|
y|float|
z|float|
- name: SetLockpick
summary: sets a doors lockpick.
example: |2-
```perl
my $type = 1;
$doors->SetLockpick($type); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
type|int|
- name: SetModelName
summary: sets a doors model name.
example: |2-
```perl
my $name = "test";
$doors->SetModelName($name); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
name|string|
- name: SetNoKeyring
summary: sets a doors no keyring.
example: |2-
```perl
my $type = 1;
$doors->SetNoKeyring($type); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
type|int|
- name: SetOpenType
summary: sets a doors open type.
example: |2-
```perl
my $type = 1;
$doors->SetOpenType($type); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
type|int|
- name: SetSize
summary: sets a doors size.
example: |2-
```perl
my $size = 1;
$doors->SetSize($size); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
size|int|
- name: SetX
summary: sets a doors x.
example: |2-
```perl
my $XPos = 1;
$doors->SetX($XPos); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
XPos||
- name: SetY
summary: sets a doors y.
example: |2-
```perl
my $YPos = 1;
$doors->SetY($YPos); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
YPos||
- name: SetZ
summary: sets a doors z.
example: |2-
```perl
my $ZPos = 1;
$doors->SetZ($ZPos); # Returns void
```
argument: |
**Name**|**Type**|**Description**
:---|:---|:---
ZPos||
Reference in a new issue View git blame Copy permalink