POL Documentation Site
Note everything on these pages is considered to be IN PROGRESS. Data may and will change, and not all data has been verified (though the best effort was made to produce correct documentation). If you are viewing the downloadable local version of these docs, note the online version may contain more up-to-date information.
POL Core Documentation
Object Class ReferenceMembers and methods of every object type
Configuration FilesEvery .cfg file and its settings
Script TypesThe scripts the core runs, and when
System EventsEvents the core sends to scripts
Built-In Text CommandsCommands handled by the core itself
Character PrivilegesPrivilege names and what they allow
Combat PseudocodeHow the core resolves an attack
Latest Core ChangesWhat changed in recent core versions
Tutorials and Guides
eScript Modules
Attribute.em16 functionsFunctions for working with mobile's attributes/skills.
- AlterAttributeTemporaryMod
- BaseSkillToRawSkill
- CheckSkill
- GetAttribute
- GetAttributeBaseValue
- GetAttributeCap
- GetAttributeDefaultCap
- GetAttributeIntrinsicMod
- GetAttributeLock
- GetAttributeName
- GetAttributeTemporaryMod
- RawSkillToBaseSkill
- SetAttributeBaseValue
- SetAttributeCap
- SetAttributeLock
- SetAttributeTemporaryMod
Basic.em30 functionsFunctions for converting and manipulating number, character, and string values.
BasicIO.em1 functionBasic I/O functions.
Boat.em7 functionsFunctions for manipulating Multi Boat objects.
CfgFile.em15 functionsFunctions for accessing configuration files.
CliLoc.em3 functionsFunctions for sending Cliloc (Client Localized) messages to the Client.
DataFile.em4 functionsFunctions to access generic data files.
File.em10 functionsFile Access functions
Guild.em4 functionsFunctions for working with guilds in eScript.
Http.em6 functionsFunctions to send and receive data over an HTTP connection using POL's internal webserver.
Math.em21 functionsMathematic functions for your enjoyment
Npc.em26 functionsFunctions for manipulating non-player character mobiles.
- CanMove
- Face
- GetProperty
- IsLegalMove
- MakeBoundingBox
- Move
- RunAwayFrom
- RunAwayFromLocation
- RunToward
- RunTowardLocation
- Say
- SayUC
- Self
- SetAnchor
- SetOpponent
- SetProperty
- SetWarMode
- TurnAwayFrom
- TurnAwayFromLocation
- TurnToward
- TurnTowardLocation
- WalkAwayFrom
- WalkAwayFromLocation
- WalkToward
- WalkTowardLocation
- Wander
OS.em28 functionsPOL System Environment Functions
- Clear_Event_Queue
- Create_Debug_Context
- Debugger
- Events_Waiting
- GetEnvironmentVariable
- GetPid
- GetProcess
- HTTPRequest
- Is_Critical
- LoadExportedScript
- OpenConnection
- OpenURL
- PerformanceMeasure
- Run_Script
- Run_Script_To_Completion
- SendEmail
- Set_Critical
- Set_Debug
- Set_Event_Queue_Size
- Set_Priority
- Set_Script_Option
- Sleep
- Sleepms
- Start_Script
- Start_Skill_Script
- SysLog
- Unload_Scripts
- Wait_For_Event
Party.em5 functionsFunctions for working with parties in eScript.
PolSys.em21 functionsFunctions to access POL system data.
- AddRealm
- CheckItemIntegrity
- CreatePacket
- DeleteRealm
- FormatItemDescription
- GetCmdLevelName
- GetCmdLevelNumber
- GetItemDescriptor
- GetPackageByName
- GetRealmDecay
- IncRevision
- ListTextCommands
- ListenPoints
- LogCPropProfile
- MD5Encrypt
- Packages
- ReadMillisecondClock
- Realms
- ReloadConfiguration
- SetRealmDecay
- SetSysTrayPopupText
Storage.em6 functionsFunctions for working with internal storage areas.
MySQL.em10 functionsFunctions for interacting with a MySQL DBMS.
Unicode.em5 functionsFunctions that allow messages to be sent to clients in any unicode language UO supports.
UO.em168 functionsFunctions that interact with and alter UO game world data, including server-client messages.
- Accessible
- AddAmount
- AddMenuItem
- ApplyConstraint
- AssignRectToWeatherRegion
- Attach
- Broadcast
- CanWalk
- CancelTarget
- CheckLineOfSight
- CheckLosAt
- CheckLosBetween
- CloseGump
- CloseTradeWindow
- CloseWindow
- ConsumeReagents
- ConsumeSubstance
- CoordinateDistance
- CoordinateDistanceEuclidean
- CreateAccount
- CreateItemAtLocation
- CreateItemCopyAtLocation
- CreateItemInBackpack
- CreateItemInContainer
- CreateItemInInventory
- CreateMenu
- CreateMultiAtLocation
- CreateNpcFromTemplate
- DestroyItem
- DestroyMulti
- Detach
- DisableEvents
- DisconnectClient
- DisplayDialogGump
- Distance
- DistanceEuclidean
- EnableEvents
- EnumerateItemsInContainer
- EnumerateOnlineCharacters
- EquipFromTemplate
- EquipItem
- EraseGlobalProperty
- EraseObjProperty
- FindAccount
- FindObjtypeInContainer
- FindPath
- FindSubstance
- GetAmount
- GetCommandHelp
- GetCoordsInLine
- GetEquipmentByLayer
- GetFacing
- GetGlobalProperty
- GetGlobalPropertyNames
- GetHarvestDifficulty
- GetMapInfo
- GetMenuObjTypes
- GetMidpointCircleCoords
- GetMultiDimensions
- GetObjProperty
- GetObjPropertyNames
- GetObjType
- GetObjTypeByName
- GetRegionLightLevelAtLocation
- GetRegionName
- GetRegionNameAtLocation
- GetRegionString
- GetSpellDifficulty
- GetStandingCoordinates
- GetStandingHeight
- GetStandingLayers
- GetWorldHeight
- GrantPrivilege
- HarvestResource
- IsStackable
- ListAccounts
- ListEquippedItems
- ListGhostsNearLocation
- ListHostiles
- ListItemsAtLocation
- ListItemsInBoxOfObjType
- ListItemsNearLocation
- ListItemsNearLocationOfType
- ListItemsNearLocationWithFlag
- ListMobilesInBox
- ListMobilesInLineOfSight
- ListMobilesNearLocation
- ListMobilesNearLocationEx
- ListMultisInBox
- ListObjectsInBox
- ListObjectsInBoxOfClass
- ListOfflineMobilesInRealm
- ListStaticsAtLocation
- ListStaticsInBox
- ListStaticsNearLocation
- ListStaticsNearLocationOfType
- ListStaticsNearLocationWithFlag
- MoveItemToContainer
- MoveItemToSecureTradeWin
- MoveObjectToLocation
- OpenPaperdoll
- POLCore
- PerformAction
- PlayLightningBoltEffect
- PlayMovingEffect
- PlayMovingEffectEx
- PlayMovingEffectXYZ
- PlayMovingEffectXYZEx
- PlayMusic
- PlayObjectCenteredEffect
- PlayObjectCenteredEffectEx
- PlaySoundEffect
- PlaySoundEffectPrivate
- PlaySoundEffectXYZ
- PlayStationaryEffect
- PlayStationaryEffectEx
- PrintTextAbove
- PrintTextAbovePrivate
- ReadGameClock
- RegisterForSpeechEvents
- ReleaseItem
- RequestInput
- ReserveItem
- RestartScript
- Resurrect
- RevokePrivilege
- SaveWorldState
- SecureTradeWin
- SelectColor
- SelectMenuItem2
- SendBuyWindow
- SendCharProfile
- SendCharacterRaceChanger
- SendDialogGump
- SendEvent
- SendHousingTool
- SendInstaResDialog
- SendOpenBook
- SendOpenSpecialContainer
- SendOverallSeason
- SendPacket
- SendPopUpMenu
- SendQuestArrow
- SendSellWindow
- SendSkillWindow
- SendStatus
- SendStringAsTipWindow
- SendSysMessage
- SendTextEntryGump
- SendViewContainer
- SetGlobalProperty
- SetName
- SetObjProperty
- SetRegionLightLevel
- SetRegionWeatherLevel
- SetScriptController
- Shutdown
- SingleClick
- SpeakPowerWords
- StartSpellEffect
- SubtractAmount
- SystemFindObjectBySerial
- Target
- TargetCoordinates
- TargetMultiPlacement
- UpdateItem
- UpdateMobile
- UseItem
