File: Storage.em

Description: Functions for working with internal storage areas.
Last Modified: 10/27/2007

Functions:

CreateRootItemInStorageArea
CreateStorageArea
DestroyRootItemInStorageArea
FindRootItemInStorageArea
FindStorageArea
StorageAreas

Modules:

[+] Attribute
- AlterAttributeTemporaryMod
- BaseSkillToRawSkill
- CheckSkill
- GetAttribute
- GetAttributeBaseValue
- GetAttributeCap
- GetAttributeDefaultCap
- GetAttributeIntrinsicMod
- GetAttributeLock
- GetAttributeName
- GetAttributeTemporaryMod
- RawSkillToBaseSkill
- SetAttributeBaseValue
- SetAttributeCap
- SetAttributeLock
- SetAttributeTemporaryMod
[+] Basic
- Bin
- Boolean
- CAsc
- CAscZ
- CChr
- CChrZ
- CDbl
- CInt
- CStr
- Compare
- DecodeBase64
- EncodeBase64
- Find
- Hex
- Len
- Lower
- Pack
- PackJSON
- SizeOf
- SplitWords
- StrReplace
- SubStr
- SubStrReplace
- Trim
- TypeOf
- TypeOfInt
- Unpack
- UnpackJSON
- Upper
[+] BasicIO
- Print
[+] Boat
- BoatFromItem
- MoveBoat
- MoveBoatRelative
- MoveBoatXY
- RegisterItemWithBoat
- SystemFindBoatBySerial
- TurnBoat
[+] CfgFile
- AppendConfigFileElem
- FindConfigElem
- GetConfigInt
- GetConfigIntArray
- GetConfigIntKeys
- GetConfigMaxIntKey
- GetConfigReal
- GetConfigString
- GetConfigStringArray
- GetConfigStringDictionary
- GetConfigStringKeys
- ListConfigElemProps
- LoadTusScpFile
- ReadConfigFile
- UnloadConfigFile
[+] CliLoc
- PrintTextAboveCL
- PrintTextAbovePrivateCL
- SendSysMessageCL
[+] DataFile
- CreateDataFile
- ListDataFiles
- OpenDataFile
- UnloadDataFile
[+] File
- AppendToFile
- CreateDirectory
- CreateXmlFile
- FileExists
- ListDirectory
- LogToFile
- OpenBinaryFile
- OpenXmlFile
- ReadFile
- WriteFile
[+] Guild
- CreateGuild
- DestroyGuild
- FindGuild
- ListGuilds
[+] Http
- QueryIP
- QueryParam
- WriteHeader
- WriteHtml
- WriteHtmlRaw
- WriteStatus
[+] Math
- ACos
- ASin
- ATan
- Abs
- Ceil
- ConstE
- ConstPi
- Cos
- DegToRad
- Floor
- FormatRealToString
- Log10
- LogE
- Max
- Min
- Pow
- RadToDeg
- Root
- Sin
- Sqrt
- Tan
[+] Npc
- 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
- 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
- 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
- CreateParty
- DisbandParty
- SendPartyMsg
- SendPrivatePartyMsg
[+] PolSys
- AddRealm
- CreatePacket
- DeleteRealm
- FormatItemDescription
- GetCmdLevelName
- GetCmdLevelNumber
- GetItemDescriptor
- GetPackageByName
- GetRealmDecay
- IncRevision
- ListTextCommands
- ListenPoints
- LogCPropProfile
- MD5Encrypt
- Packages
- ReadMillisecondClock
- Realms
- ReloadConfiguration
- SetRealmDecay
- SetSysTrayPopupText
[+] Storage
- CreateRootItemInStorageArea
- CreateStorageArea
- DestroyRootItemInStorageArea
- FindRootItemInStorageArea
- FindStorageArea
- StorageAreas
[+] MySQL
- mysql_affected_rows
- mysql_close
- mysql_connect
- mysql_escape_string
- mysql_fetch_row
- mysql_field_name
- mysql_num_fields
- mysql_num_rows
- mysql_query
- mysql_select_db
[+] Unicode
- BroadcastUC
- PrintTextAbovePrivateUC
- PrintTextAboveUC
- RequestInputUC
- SendSysMessageUC
[+] UO
- 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
- 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
[+] Util
- RandomDiceRoll
- RandomFloat
- RandomInt
- RandomIntMinMax
- StrFormatTime
[+] Vitals
- ApplyDamage
- ApplyRawDamage
- ConsumeMana
- ConsumeVital
- GetVital
- GetVitalMaximumValue
- GetVitalName
- GetVitalRegenRate
- HealDamage
- RecalcVitals
- SetVital

CreateRootItemInStorageArea( area, itemname, objtype )
Parameters:
Name	Type
`area`	Storage Area Reference
`itemname`	String
`objtype`	Integer objtype, OR String ObjtypeName, OR GetItemDescriptor struct.
Explanation
Creates the "root" (top-level) item in the storage area provided. "itemname" is the name of this item, and "objtype" is its type.
Notes: The item is normally a container. For example, a bankbox is a storage area and the root item is the chest container. Normal items are then placed in this container.
Return values
Item Reference on success
Errors
"Invalid parameter type"
"Unable to create item"
Related
Item

[^]

CreateStorageArea( areaname )
Parameters:
Name	Type
`areaname`	String
Explanation
Create a new storage area with name "areaname".
Return values
Storage Area reference on success
Errors
Errors: none (returns 0 on invalid parameter)

[^]

DestroyRootItemInStorageArea( area, itemname )
Parameters:
Name	Type
`area`	Storage Area Reference
`itemname`	String
Explanation
Destroys the root item named "itemname" in storage area "area"
Return values
1 on delete success
0 on item not found
Errors
"Invalid parameter type"

[^]

FindRootItemInStorageArea( area, itemname )
Parameters:
Name	Type
`area`	Storage Area Reference
`itemname`	String
Explanation
Finds the root item named "itemname" in the storage area named "area".
Return values
Item Reference on success
Errors
"Invalid parameter type"
"Root item not found."

[^]

FindStorageArea( areaname )
Parameters:
Name	Type
`areaname`	String
Explanation
Gets a reference to the storage area named "areaname"
Return values
Storage Area reference on success
Errors
none (returns 0 on invalid parameter or area not found)
Related
StorageArea

[^]

StorageAreas()
Explanation
Returns a StorageAreas object, see object reference for details
Return values
StorageAreas object
Related
StorageAreas