Returns amount of towns loaded.
Returns amount of towns loaded.
API Tags:
| Return: | Count of towns. |
| Access: | public |
Information Tags:
| Version: | 0.0.8 |
| Version: | 0.0.6 |
| Since: | 0.0.6 |
| Since: | 0.0.8 |
Implementation of:
- Countable::count
API Tags:
| Return: | Town name. |
| Deprecated: | 0.1.0 Use getIterator(). |
| Access: | public |
Information Tags:
| Version: | 0.0.8 |
| Version: | 0.0.6 |
| Since: | 0.0.8 |
| Since: | 0.0.6 |
Returns map description.
Returns map description.
API Tags:
| Return: | Map description. |
| Access: | public |
Information Tags:
| Version: | 0.0.6 |
| Since: | 0.0.6 |
Returns map height.
Returns map height.
API Tags:
| Return: | Map height. |
| Access: | public |
Information Tags:
| Version: | 0.0.6 |
| Since: | 0.0.6 |
Loads map's houses list.
Loads map's houses list.
API Tags:
| Return: | Houses from external file. |
| Access: | public |
Information Tags:
| Version: | 0.1.0 |
| Version: | 0.0.6 |
| Since: | 0.0.6 |
| Since: | 0.1.0 |
ArrayIterator getIterator(
)
|
|
Returns iterator handle for loops.
Returns iterator handle for loops.
API Tags:
| Return: | Towns list iterator. |
| Access: | public |
Information Tags:
| Version: | 0.1.0 |
| Version: | 0.0.6 |
| Since: | 0.0.6 |
| Since: | 0.1.0 |
Implementation of:
- IteratorAggregate::getIterator
int getTownID(
string
$name
)
|
|
Returns town's ID.
Returns town's ID.
Parameters:
API Tags:
| Return: | ID. |
| Access: | public |
Information Tags:
| Version: | 0.1.3 |
| Version: | 0.0.6 |
| Throws: | OutOfBoundsException If not found. |
| Since: | 0.0.6 |
string getTownName(
int
$id
)
|
|
Returns name of given town's ID.
Returns name of given town's ID.
Parameters:
API Tags:
| Return: | Name. |
| Access: | public |
Information Tags:
| Version: | 0.1.3 |
| Version: | 0.0.6 |
| Throws: | OutOfBoundsException If not found. |
| Since: | 0.0.6 |
API Tags:
| Return: | List of towns. |
| Deprecated: | 0.1.0 Use this class object as array for iterations, counting and methods for field fetching. |
| Access: | public |
Information Tags:
| Version: | 0.0.6 |
| Since: | 0.0.6 |
Returns town's temple position.
Returns town's temple position.
Parameters:
API Tags:
| Return: | Point on map (false if not found). |
| Access: | public |
Information Tags:
| Version: | 0.0.6 |
| Since: | 0.0.6 |
array getWaypointsList(
)
|
|
Returns map waypoints list.
Returns map waypoints list.
Each item of returned array is sub-array with list of waypoints.
API Tags:
| Return: | List of tracks. |
| Access: | public |
Information Tags:
| Version: | 0.1.6 |
| Version: | 0.0.6 |
| Since: | 0.0.6 |
| Since: | 0.1.6 |
Returns map width.
Returns map width.
API Tags:
| Return: | Map width. |
| Access: | public |
Information Tags:
| Version: | 0.0.6 |
| Since: | 0.0.6 |
bool hasTownId(
int
$id
)
|
|
Checks if given town ID exists on list.
Checks if given town ID exists on list.
Parameters:
API Tags:
| Return: | If town is set then true. |
| Access: | public |
Information Tags:
| Version: | 0.1.3 |
| Version: | 0.0.6 |
| Since: | 0.0.6 |
| Since: | 0.1.3 |
bool hasTownName(
string
$name
)
|
|
Checks if given town name exists on list.
Checks if given town name exists on list.
Parameters:
API Tags:
| Return: | If town is set then true. |
| Access: | public |
Information Tags:
| Version: | 0.1.3 |
| Version: | 0.0.6 |
| Since: | 0.0.6 |
| Since: | 0.1.3 |
API Tags:
| Return: | Current position key. |
| Deprecated: | 0.1.0 Use getIterator(). |
| Access: | public |
Information Tags:
| Version: | 0.0.8 |
| Version: | 0.0.6 |
| Since: | 0.0.8 |
| Since: | 0.0.6 |
void loadFile(
string
$file
)
|
|
Loads OTBM file content.
Loads OTBM file content.
Parameters:
API Tags:
Information Tags:
| Version: | 0.1.0 |
| Version: | 0.0.6 |
| Throws: | E_OTS_FileLoaderError When error occurs during file operation. |
| Since: | 0.0.6 |
| Throws: | E_OTS_OutOfBuffer When there is read attemp after end of stream. |
Redefinition of:
- OTS_FileLoader::loadFile()
- Opens file.
API Tags:
| Deprecated: | 0.1.0 Use getIterator(). |
| Access: | public |
Information Tags:
| Version: | 0.0.8 |
| Version: | 0.0.6 |
| Since: | 0.0.8 |
| Since: | 0.0.6 |
bool offsetExists(
string|int
$offset
)
|
|
Checks if given element exists.
Checks if given element exists.
Parameters:
|
string|int |
$offset: |
Array key. |
API Tags:
| Return: | True if it's set. |
| Access: | public |
Information Tags:
| Version: | 0.1.0 |
| Version: | 0.0.6 |
| Since: | 0.0.6 |
| Since: | 0.1.0 |
Implementation of:
- ArrayAccess::offsetExists
mixed offsetGet(
string|int
$offset
)
|
|
Returns item from given position.
Returns item from given position.
Parameters:
|
string|int |
$offset: |
Array key. |
API Tags:
| Return: | If key is an integer (type-sensitive!) then returns town name. If it's a string then return associated ID found by town name. False if offset is not set. |
| Access: | public |
Information Tags:
| Version: | 0.1.0 |
| Version: | 0.0.6 |
| Since: | 0.0.6 |
| Since: | 0.1.0 |
Implementation of:
- ArrayAccess::offsetGet
void offsetSet(
string|int
$offset, mixed
$value
)
|
|
This method is implemented for ArrayAccess interface.
This method is implemented for ArrayAccess interface. In fact you can't write/append to towns list. Any call to this method will cause E_OTS_ReadOnly raise.
Parameters:
|
string|int |
$offset: |
Array key. |
|
mixed |
$value: |
Field value. |
API Tags:
Information Tags:
| Version: | 0.1.0 |
| Version: | 0.0.6 |
| Throws: | E_OTS_ReadOnly Always - this class is read-only. |
| Since: | 0.1.0 |
| Since: | 0.0.6 |
Implementation of:
- ArrayAccess::offsetSet
void offsetUnset(
string|int
$offset
)
|
|
This method is implemented for ArrayAccess interface.
This method is implemented for ArrayAccess interface. In fact you can't write/append to towns list. Any call to this method will cause E_OTS_ReadOnly raise.
Parameters:
|
string|int |
$offset: |
Array key. |
API Tags:
Information Tags:
| Version: | 0.1.0 |
| Version: | 0.0.6 |
| Throws: | E_OTS_ReadOnly Always - this class is read-only. |
| Since: | 0.1.0 |
| Since: | 0.0.6 |
Implementation of:
- ArrayAccess::offsetUnset
API Tags:
| Deprecated: | 0.1.0 Use getIterator(). |
| Access: | public |
Information Tags:
| Version: | 0.0.8 |
| Version: | 0.0.6 |
| Since: | 0.0.8 |
| Since: | 0.0.6 |
API Tags:
| Return: | If iterator has anything more. |
| Deprecated: | 0.1.0 Use getIterator(). |
| Access: | public |
Information Tags:
| Version: | 0.0.8 |
| Version: | 0.0.6 |
| Since: | 0.0.8 |
| Since: | 0.0.6 |
mixed __get(
string
$name
)
|
|
Magic PHP5 method.
Magic PHP5 method.
Parameters:
|
string |
$name: |
Property name. |
API Tags:
| Return: | Property value. |
| Access: | public |
Information Tags:
| Version: | 0.1.0 |
| Version: | 0.0.6 |
| Throws: | OutOfBoundsException For non-supported properties. |
| Since: | 0.1.0 |
| Since: | 0.0.6 |
Returns string representation of object.
Returns string representation of object.
If any display driver is currently loaded then it uses it's method.
API Tags:
| Return: | String representation of object. |
| Access: | public |
Information Tags:
| Version: | 0.1.3 |
| Version: | 0.0.6 |
| Since: | 0.0.6 |
| Since: | 0.1.3 |
Magic PHP5 method.
Magic PHP5 method.
Allows object unserialisation.
API Tags:
Information Tags:
| Version: | 0.0.6 |
| Throws: | E_OTS_FileLoaderError When error occurs during file operation. |
| Since: | 0.0.6 |