Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/ClassicUO/classicuo-web/llms.txt

Use this file to discover all available pages before exploring further.

The enums namespace provides named numeric constants that make your scripts readable and maintainable. Rather than remembering that spell ID 29 is Greater Heal or that layer 6 is the helmet slot, you can write Spells.GreaterHeal and Layers.Helmet directly. The constants below are the same values the game engine uses internally, so they are safe to pass to any API that accepts a numeric ID.

Abilities

Combat special move identifiers. Pass these values to the relevant client API to activate a special move.
MemberValue
None0
ArmorIgnore1
BleedAttack2
ConcussionBlow3
CrushingBlow4
Disarm5
Dismount6
DoubleStrike7
InfectiousStrike8
MortalStrike9
MovingShot10
ParalyzingBlow11
ShadowStrike12
WhirlwindAttack13
RidingSwipe14
FrenziedWhirlwind15
Block16
DefenseMastery17
NerveStrike18
TalonStrike19
Feint20
DualWield21
DoubleShot22
ArmorPierce23
Bladeweave24
ForceArrow25
LightningArrow26
PsychicAttack27
SerpentArrow28
ForceOfNature29
InfusedThrow30
MysticArc31
Invalid255

Directions

Direction values used when comparing entity.direction. North (0) is up on the map, and values increase clockwise.
MemberValue
North0
Right1
East2
Down3
South4
Left5
West6
Up7

Example

if (player.direction === Directions.North) {
  log('Facing north');
}

Layers

Equipment slot identifiers. Use these with client.findItemOnLayer() to inspect or interact with items in a specific equipment slot.
MemberValue
Invalid0
OneHanded1
TwoHanded2
Shoes3
Pants4
Shirt5
Helmet6
Gloves7
Ring8
Talisman9
Necklace10
Hair11
Waist12
Torso13
Bracelet14
Face15
Beard16
Tunic17
Earrings18
Arms19
Cloak20
Backpack21
Robe22
Skirt23
Legs24
Mount25
ShopBuyRestock26
ShopBuy27
ShopSell28
Bank29

Example

const helmet = client.findItemOnLayer(Layers.Helmet);
if (helmet) {
  log('Wearing helmet with serial:', helmet.serial);
}

Spells

Spell identifiers to use with client.castSpell(). Magery spells start at 1, Necromancy spells at 101, Chivalry at 201, Bushido at 401, Ninjitsu at 501, Spellweaving at 601, Mysticism at 678, and Mastery spells at 701.
MemberValue
Clumsy1
CreateFood2
Feeblemind3
Heal4
MagicArrow5
NightSight6
ReactiveArmor7
Weaken8
Agility9
Cunning10
Cure11
Harm12
MagicTrap13
RemoveTrap14
Protection15
Strength16
Bless17
Fireball18
MagicLock19
Poison20
Telekinesis21
Teleport22
Unlock23
WallOfStone24
ArchCure25
ArchProtection26
Curse27
FireField28
GreaterHeal29
Lightning30
ManaDrain31
Recall32
BladeSpirits33
DispelField34
Incognito35
MagicReflect36
MindBlast37
Paralyze38
PoisonField39
SummonCreature40
Dispel41
EnergyBolt42
Explosion43
Invisibility44
Mark45
MassCurse46
ParalyzeField47
Reveal48
ChainLightning49
EnergyField50
FlameStrike51
GateTravel52
ManaVampire53
MassDispel54
MeteorSwarm55
Polymorph56
Earthquake57
EnergyVortex58
Resurrection59
AirElemental60
SummonDaemon61
EarthElemental62
FireElemental63
WaterElemental64
AnimateDead101
BloodOath102
CorpseSkin103
CurseWeapon104
EvilOmen105
HorrificBeast106
LichForm107
MindRot108
PainSpike109
PoisonStrike110
Strangle111
SummonFamiliar112
VampiricEmbrace113
VengefulSpirit114
Wither115
WraithForm116
Exorcism117
CleanseByFire201
CloseWounds202
ConsecrateWeapon203
DispelEvil204
DivineFury205
EnemyOfOne206
HolyLight207
NobleSacrifice208
RemoveCurse209
SacredJourney210
HonorableExecution401
Confidence402
Evasion403
CounterAttack404
LightningStrike405
MomentumStrike406
FocusAttack501
DeathStrike502
AnimalForm503
KiAttack504
SurpriseAttack505
Backstab506
Shadowjump507
MirrorImage508
ArcaneCircle601
GiftOfRenewal602
ImmolatingWeapon603
Attunement604
Thunderstorm605
NaturesFury606
SummonFey607
SummonFiend608
ReaperForm609
Wildfire610
EssenceOfWind611
DryadAllure612
EtherealVoyage613
WordOfDeath614
GiftOfLife615
ArcaneEmpowerment616
NetherBolt678
HealingStone679
PurgeMagic680
Enchant681
Sleep682
EagleStrike683
AnimatedWeapon684
StoneForm685
SpellTrigger686
MassSleep687
CleansingWinds688
Bombard689
SpellPlague690
HailStorm691
NetherCyclone692
RisingColossus693
Inspire701
Invigorate702
Resilience703
Perseverance704
Tribulation705
Despair706
DeathRay707
EtherealBurst708
NetherBlast709
MysticWeapon710
CommandUndead711
Conduit712
ManaShield713
SummonReaper714
EnchantedSummoning715
AnticipateHit716
Warcry717
Intuition718
Rejuvenate719
HolyFist720
Shadow721
WhiteTigerForm722
FlamingShot723
PlayingTheOdds724
Thrust725
Pierce726
Stagger727
Toughness728
Onslaught729
FocusedEye730
ElementalFury731
CalledShot732
WarriorsGifts733
ShieldBash734
Bodyguard735
HeightenSenses736
Tolerance737
InjectedStrike738
Potency739
Rampage740
FistsOfFury741
Knockout742
Whispering743
CombatTraining744
Boarding745

Example

client.castSpell(Spells.GreaterHeal);
sleep(1000);
client.castSpell(Spells.Recall);

SearchEntityOptions

Notoriety-based filter flags for client.selectEntity(). These values can be combined using the bitwise OR operator (|) to match multiple notoriety types at once.
MemberValue
Any1
Enemy2
Murderer4
Criminal8
Gray16
Innocent32
Unfriendly64
Friend128
Invulnerable256

Example

// Select the nearest enemy or murderer
const target = client.selectEntity(
  SearchEntityOptions.Enemy | SearchEntityOptions.Murderer,
  SearchEntityRangeOptions.Nearest,
  SearchEntityTypeOptions.Any
);

SearchEntityRangeOptions

Controls iteration order when selecting entities with client.selectEntity().
MemberValue
Next0
Previous1
Nearest2
Closest3

SearchEntityTypeOptions

Filters entity searches by creature type.
MemberValue
Any0
Human1
NonHuman2

Example

// Tab through the nearest human enemies only
const humanEnemy = client.selectEntity(
  SearchEntityOptions.Enemy,
  SearchEntityRangeOptions.Nearest,
  SearchEntityTypeOptions.Human
);
if (humanEnemy) {
  log('Found human enemy:', humanEnemy.name);
}

BuffDebuffs

Identifiers for active buffs and debuffs. Use these to check whether a specific buff or debuff is currently applied via the player namespace.
MemberValue
DismountPrevention1001
NoRearm1002
NightSight1005
DeathStrike1006
EvilOmen1007
HonoredDebuff1008
AchievePerfection1009
DivineFury1010
EnemyOfOne1011
HidingAndOrStealth1012
ActiveMeditation1013
BloodOathCaster1014
BloodOathCurse1015
CorpseSkin1016
Mindrot1017
PainSpike1018
Strangle1019
GiftOfRenewal1020
AttuneWeapon1021
Thunderstorm1022
EssenceOfWind1023
EtherealVoyage1024
GiftOfLife1025
ArcaneEmpowerment1026
MortalStrike1027
ReactiveArmor1028
Protection1029
ArchProtection1030
MagicReflection1031
Incognito1032
Disguised1033
AnimalForm1034
Polymorph1035
Invisibility1036
Paralyze1037
Poison1038
Bleed1039
Clumsy1040
FeebleMind1041
Weaken1042
Curse1043
MassCurse1044
Agility1045
Cunning1046
Strength1047
Bless1048
Sleep1049
StoneForm1050
SpellPlague1051
Berserk1052
MassSleep1053
Fly1054
Inspire1055
Invigorate1056
Resilience1057
Perseverance1058
TribulationTarget1059
DespairTarget1060
FishPie1062
HitLowerAttack1063
HitLowerDefense1064
DualWield1065
Block1066
DefenseMastery1067
DespairCaster1068
Healing1069
SpellFocusingBuff1070
SpellFocusingDebuff1071
RageFocusingDebuff1072
RageFocusingBuff1073
Warding1074
TribulationCaster1075
ForceArrow1076
Disarm1077
Surge1078
Feint1079
TalonStrike1080
PsychicAttack1081
ConsecrateWeapon1082
GrapesOfWrath1083
EnemyOfOneDebuff1084
HorrificBeast1085
LichForm1086
VampiricEmbrace1087
CurseWeapon1088
ReaperForm1089
ImmolatingWeapon1090
Enchant1091
HonorableExecution1092
Confidence1093
Evasion1094
CounterAttack1095
LightningStrike1096
MomentumStrike1097
OrangePetals1098
RoseOfTrinsic1099
PoisonImmunity1100
Veterinary1101
Perfection1102
Honored1103
ManaPhase1104
FanDancerFanFire1105
Rage1106
Webbing1107
MedusaStone1108
TrueFear1109
AuraOfNausea1110
HowlOfCacophony1111
GazeDespair1112
HiryuPhysicalResistance1113
RuneBeetleCorruption1114
BloodwormAnemia1115
RotwormBloodDisease1116
SkillUseDelay1117
FactionStatLoss1118
HeatOfBattleStatus1119
CriminalStatus1120
ArmorPierce1121
SplinteringEffect1122
SwingSpeedDebuff1123
WraithForm1124
Humility1129
Rampage1130
Stagger1131
Toughness1132
Thrust1133
Pierce1134
PlayingTheOdds1135
FocusedEye1136
Onslaught1137
ElementalFury1138
ElementalFuryDebuff1139
CalledShot1140
Knockout1141
SavingThrow1142
Conduit1143
EtherealBurst1144
MysticWeapon1145
ManaShield1146
AnticipateHit1147
Warcry1148
Shadow1149
WhiteTigerForm1150
Bodyguard1151
HeightenedSenses1152
Tolerance1153
DeathRay1154
DeathRayDebuff1155
Intuition1156
EnchantedSummoning1157
ShieldBash1158
Whispering1159
CombatTraining1160
InjectedStrikeDebuff1161
InjectedStrike1162
UnknownTomato1163
PlayingTheOddsDebuff1164
DragonTurtleDebuff1165
Boarding1166
Potency1167
ThrustDebuff1168
FistsOfFury1169
BarrabHemolymphConcentrate1170
JukariBurnPoiltice1171
KurakAmbushersEssence1172
BarakoDraftOfMight1173
UraliTranceTonic1174
SakkhraProphylaxis1175
Sparks1176
Swarm1177
BoneBreaker1178
Unknown21179
SwarmImmune1180
BoneBreakerImmune1181
UnknownGoblin1182
UnknownRedDrop1183
UnknownStar1184
FeintDebuff1185
CaddelliteInfused1186
PotionGloriousFortune1187
MysticalPolymorphTotem1188
UnknownDebuff1189

Skills

Skill index values used with player.useSkill() and related APIs.
MemberValue
Alchemy0
Anatomy1
AnimalLore2
ItemID3
ArmsLore4
Parry5
Begging6
Blacksmith7
Fletching8
Peacemaking9
Camping10
Carpentry11
Cartography12
Cooking13
DetectHidden14
Discordance15
EvalInt16
Healing17
Fishing18
Forensics19
Herding20
Hiding21
Provocation22
Inscribe23
Lockpicking24
Magery25
MagicResist26
Tactics27
Snooping28
Musicianship29
Poisoning30
Archery31
SpiritSpeak32
Stealing33
Tailoring34
AnimalTaming35
TasteID36
Tinkering37
Tracking38
Veterinary39
Swords40
Macing41
Fencing42
Wrestling43
Lumberjacking44
Mining45
Meditation46
Stealth47
RemoveTrap48
Necromancy49
Focus50
Chivalry51
Bushido52
Ninjitsu53
Spellweaving54
Mysticism55
Imbuing56
Throwing57

Example

player.useSkill(Skills.Meditation);
sleep(10000);
player.useSkill(Skills.Anatomy);

Notorieties

Notoriety (karma/status) values that reflect how the game classifies a character or creature. These can be compared against entity.notoriety.
MemberValue
Unknown0
Innocent1
Ally2
Gray3
Criminal4
Enemy5
Murderer6
Invulnerable7

SkillLock

Represents the lock state of a skill, controlling whether it is set to rise, fall, or stay fixed.
MemberValue
Up0
Down1
Locked2

MessageType

Message type identifiers used to categorise in-game speech and system messages.
MemberValue
Regular0
System1
Emote2
Limit3Spell3
Label6
Focus7
Whisper8
Yell9
Spell10
Guild13
Alliance14
Command15
Encoded192
UOChat254
Party255

Virtues

Identifiers for the three Virtues that can be invoked in-game.
MemberValue
Honor1
Sacrifice2
Valor3

Functions

sleep, log, and exit — the built-in global functions

Client Namespace

Cast spells, find items, and interact with the world

Player Namespace

Read and act on player stats, skills, and equipment

Introduction

Get started with scripting in ClassicUO Web

Build docs developers (and LLMs) love