Resource handlers

Except database resources, in OTServ you have another source of data - data/ directory. It contains all files essential for world content like map, spells, items definitions etc. which are stored in physical disk files (usualy XML, but sometimes also in binary format). POT provides classes to handle also those resources. Each kind of resource has it's list classes. Many of them also has single object classes but not every.

Note that unlike database resources, data/ directory resources lists doesnt contain underline (_) before "List" part of class name.

Interfaces

All list classes (except OTS_SpellsList) are simple aggregators for single items. All of those lists implements Iterator, Countable and ArrayAccess interfaces. It means that they can be used nearly as pure arrays - you can use then in foreach loop, count items within them using simple count() call and access items by using array acces operators (square brackets).

Vocations

Vocations list is the most simple resource - vocations file contains just IDs-names pairs assignments. Vocations list only translates vocation ID into it's name and vice-versa:

1. <?php
2.  
3. // to not repeat all that stuff
4. include('quickstart.php');
5.  
6. // loads vocations
7. $vocations = new OTS_VocationsList('/home/wrzasq/.otserv/data/vocations.xml');
8.  
9. // translates ID to vocation name
10. echo $vocations->getVocationName(1);
11.  
12. // translates vocations name to it's ID
13. echo $vocations->getVocationID('Knight');
14.  
15. ?>

Vocations are simple string names, there is no objective wrapper for it.

Monsters

Monsters list class is also not very complicated - only differences are that you put monsters directory path, not any particular file name; also monsters are represented by objects not by simple strings.

Items

Next resource is items list. To load it you have to create instance of OTS_ItemsList class and pass items directory path as constructor's parameter. It will load both items.xml file (definitions of item types) and items.otb (additional info and IDs mapping).

Warning - items are stored in both XML (items.xml) and binary (items.otb) files. Loading binary files in PHP is extremly slow as well as items.xml file is quite big usualy so loading it also takes much time. To speed it up you should use cache drivers.

Spells

A bit different then other resource lists is spells list - it does not implement any of interfaces mentiones in previous paragraph. It contains 3 sub-arrays which are groups of spells: conjures, instants and runes. Every spell is represented by OTS_Spell class object.

Map (towns list)

POT can parse binary map format - OTBM (this is the only map format supported by POT as it is the only currently supported map format by OTServ). OTBM format is extended case of general OTB format. Map file can be loaded with OTS_OTBMFile class. Loaded map acts also as towns list:

1. <?php
2.  
3. // to not repeat all that stuff
4. include('quickstart.php');
5.  
6. // loads map file
7. $towns = new OTS_OTBMFile('/home/wrzasq/.otserv/data/world/map.otbm');
8.  
9. // lists towns
10. foreach($towns as $id => $name)
11. {
12.     echo 'Town ID: ', $id, ', name: ', $name, "\n";
13. }
14.  
15. ?>

Warning - loading binary OTBM files in PHP is extremly slow as well as map files are usualy quite big. To speed it up you should use cache drivers.

Houses

When map is loaded it can also contain reference to external houses list - if so, then you can fetch this list by calling OTS_OTBMFile::getHousesList.

Houses list is usualy connected with map file, but you can also load it directly by creating instance of OTS_HousesList class.

Global resources

All those resources are parts of entire POT enviroment. They are necessary for some routines - for example player's items managing requires items list to be loaded. But created instances of those resources are only local. You can create them freely but they doesn't affect other parts of POT. In order to load those resources globaly into POT instance you will have to read about global resources.