Element index for package OpenTTDLib
[ a ]
[ c ]
[ d ]
[ e ]
[ f ]
[ g ]
[ h ]
[ i ]
[ n ]
[ o ]
[ p ]
[ q ]
[ r ]
[ s ]
[ u ]
[ _ ]
_
- $_cache
- in file OpenTTDLibCache.php, variable OpenTTDLibCache::$_cache
- $_cache
- in file OpenTTDLib.php, variable OpenTTDLib::$_cache
- $_detail
- in file OpenTTDLib.php, variable OpenTTDLib::$_detail
- $_file
- in file OpenTTDLibCache.php, variable OpenTTDLibCache::$_file
- $_has_info
- in file OpenTTDLib.php, variable OpenTTDLib::$_has_info
- $_host
- in file OpenTTDLibException.php, variable OpenTTDLibException::$_host
- $_info
- in file OpenTTDLib.php, variable OpenTTDLib::$_info
- $_newgrf
- in file OpenTTDLib.php, variable OpenTTDLib::$_newgrf
- $_newgrf_request
- in file OpenTTDLib.php, variable OpenTTDLib::$_newgrf_request
- $_packet
- in file OpenTTDLibException.php, variable OpenTTDLibException::$_packet
- $_packet
- in file OpenTTDLib.php, variable OpenTTDLib::$_packet
- $_port
- in file OpenTTDLibException.php, variable OpenTTDLibException::$_port
- $_updated
- in file OpenTTDLibCache.php, variable OpenTTDLibCache::$_updated
- _prependCodeMessage
- in file OpenTTDLibException.php, method OpenTTDLibException::_prependCodeMessage()
set the error message according to the error code
- __construct
- in file OpenTTDLibPacket.php, method OpenTTDLibPacket::__construct()
initiate the packet instance
- __construct
- in file OpenTTDLib.php, method OpenTTDLib::__construct()
prepares the class with certain variables and values
- __construct
- in file OpenTTDLibCache.php, method OpenTTDLibCache::__construct()
constructor of OpenTTDLIbCache
- __construct
- in file OpenTTDLibException.php, method OpenTTDLibException::__construct()
cunstructor to OpenTTDLibException
- __sleep
- in file OpenTTDLibPacket.php, method OpenTTDLibPacket::__sleep()
binary safe storing the packet data
- __toString
- in file OpenTTDLibException.php, method OpenTTDLibException::__toString()
logic of how the class in converted to a string
- __wakeup
- in file OpenTTDLibPacket.php, method OpenTTDLibPacket::__wakeup()
binary safe restoring the packet data
top
top
top
d
- Date2YMD
- in file OpenTTDLib.php, method OpenTTDLib::Date2YMD()
Converts OpenTTD Date to YMD (tnx to WizKid for converting)
- disconnect
- in file OpenTTDLib.php, method OpenTTDLib::disconnect()
Disconnect from the server, but only if a connection is still open
- dumpForDebug
- in file OpenTTDLibException.php, method OpenTTDLibException::dumpForDebug()
returns all the instances data base64 encoded, making it easy find out what went wrong
top
e
- ERROR_CACHE_NOT_READABLE
- in file OpenTTDLibException.php, class constant OpenTTDLibException::ERROR_CACHE_NOT_READABLE
$var integer error value to pass to OpenTTDLibException::__construct()
- ERROR_CACHE_NOT_WRITEABLE
- in file OpenTTDLibException.php, class constant OpenTTDLibException::ERROR_CACHE_NOT_WRITEABLE
$var integer error value to pass to OpenTTDLibException::__construct()
- ERROR_CONNECT_FAILD
- in file OpenTTDLibException.php, class constant OpenTTDLibException::ERROR_CONNECT_FAILD
$var integer error value to pass to OpenTTDLibException::__construct()
- ERROR_CONNECT_TIMEOUT
- in file OpenTTDLibException.php, class constant OpenTTDLibException::ERROR_CONNECT_TIMEOUT
$var integer error value to pass to OpenTTDLibException::__construct()
- ERROR_CUSTOM
- in file OpenTTDLibException.php, class constant OpenTTDLibException::ERROR_CUSTOM
$var integer error value to pass to OpenTTDLibException::__construct()
- ERROR_GAME_INFO_VERSION
- in file OpenTTDLibException.php, class constant OpenTTDLibException::ERROR_GAME_INFO_VERSION
$var integer error value to pass to OpenTTDLibException::__construct()
- ERROR_PACKET_INVALID
- in file OpenTTDLibException.php, class constant OpenTTDLibException::ERROR_PACKET_INVALID
$var integer error value to pass to OpenTTDLibException::__construct()
- ERROR_PACKET_SEND
- in file OpenTTDLibException.php, class constant OpenTTDLibException::ERROR_PACKET_SEND
$var integer error value to pass to OpenTTDLibException::__construct()
- ERROR_PACKET_SIZE
- in file OpenTTDLibException.php, class constant OpenTTDLibException::ERROR_PACKET_SIZE
$var integer error value to pass to OpenTTDLibException::__construct()
- ERROR_PACKET_TYPE
- in file OpenTTDLibException.php, class constant OpenTTDLibException::ERROR_PACKET_TYPE
$var integer error value to pass to OpenTTDLibException::__construct()
top
top
g
- getCache
- in file OpenTTDLib.php, method OpenTTDLib::getCache()
get the cache
- getData
- in file OpenTTDLibPacket.php, method OpenTTDLibPacket::getData()
get the actual packet data
- getDetail
- in file OpenTTDLib.php, method OpenTTDLib::getDetail()
convert $this->detail and return
- getInfo
- in file OpenTTDLib.php, method OpenTTDLib::getInfo()
Get's the info (if any) from the internal buffer
- getNewGrf
- in file OpenTTDLibCache.php, method OpenTTDLibCache::getNewGrf()
get newgrf data from the cache if it can be found
- getNewGrf
- in file OpenTTDLib.php, method OpenTTDLib::getNewGrf()
get the new grf details
- getOption
- in file OpenTTDLib.php, method OpenTTDLib::getOption()
get an option previously set with OpenTTDLib::setOption() or the respective default value
- getPacket
- in file OpenTTDLib.php, method OpenTTDLib::getPacket()
get the instance of OpenTTDLibPacket which is holding the received packet data
- getPos
- in file OpenTTDLibPacket.php, method OpenTTDLibPacket::getPos()
get the postion for next read
- getSize
- in file OpenTTDLibPacket.php, method OpenTTDLibPacket::getSize()
get the size of the packet
top
h
- hasInfo
- in file OpenTTDLib.php, method OpenTTDLib::hasInfo()
check there is info on the internal buffer
top
top
top
o
- OpenTTDLib.php
- procedural page OpenTTDLib.php
- OpenTTDLibCache.php
- procedural page OpenTTDLibCache.php
- OpenTTDLibException.php
- procedural page OpenTTDLibException.php
- OpenTTDLibPacket.php
- procedural page OpenTTDLibPacket.php
- OpenTTDLib
- in file OpenTTDLib.php, class OpenTTDLib
OpenTTDLib a php class to query a running OpenTTD server
- OpenTTDLibCache
- in file OpenTTDLibCache.php, class OpenTTDLibCache
OpenTTDLibCache handles cached newgrf details, once a grfid and grf_md5sum pair is known, we dont have to query the game for it again.
- OpenTTDLibException
- in file OpenTTDLibException.php, class OpenTTDLibException
OpenTTDLibException is as of rev24 thrown by OpenTTDLib
- OpenTTDLibPacket
- in file OpenTTDLibPacket.php, class OpenTTDLibPacket
OpenTTDLibPacket provides OpenTTDLib with means for reading from and writing to a udp packet
- OPTION_CACHE_FILE
- in file OpenTTDLib.php, class constant OpenTTDLib::OPTION_CACHE_FILE
Option constants, use with OpenTTDLib::setOption() and OpenTTDLib::getOption()
- OPTION_CACHE_GAME
- in file OpenTTDLib.php, class constant OpenTTDLib::OPTION_CACHE_GAME
Option constants, use with OpenTTDLib::setOption() and OpenTTDLib::getOption()
- OPTION_CACHE_NEWGRF
- in file OpenTTDLib.php, class constant OpenTTDLib::OPTION_CACHE_NEWGRF
Option constants, use with OpenTTDLib::setOption() and OpenTTDLib::getOption()
- OPTION_CACHE_UPDATE
- in file OpenTTDLib.php, class constant OpenTTDLib::OPTION_CACHE_UPDATE
Option constants, use with OpenTTDLib::setOption() and OpenTTDLib::getOption()
- OPTION_CONVERT_MAPSET
- in file OpenTTDLib.php, class constant OpenTTDLib::OPTION_CONVERT_MAPSET
Option constants, use with OpenTTDLib::setOption() and OpenTTDLib::getOption()
- OPTION_CONVERT_NETLANG
- in file OpenTTDLib.php, class constant OpenTTDLib::OPTION_CONVERT_NETLANG
Option constants, use with OpenTTDLib::setOption() and OpenTTDLib::getOption()
- OPTION_CONVERT_STATIONTYPE
- in file OpenTTDLib.php, class constant OpenTTDLib::OPTION_CONVERT_STATIONTYPE
Option constants, use with OpenTTDLib::setOption() and OpenTTDLib::getOption()
- OPTION_CONVERT_VEHICLETYPE
- in file OpenTTDLib.php, class constant OpenTTDLib::OPTION_CONVERT_VEHICLETYPE
Option constants, use with OpenTTDLib::setOption() and OpenTTDLib::getOption()
- OPTION_DEFAULT_CACHE_FILE
- in file OpenTTDLib.php, class constant OpenTTDLib::OPTION_DEFAULT_CACHE_FILE
respective default values to the options
- OPTION_DEFAULT_CACHE_GAME
- in file OpenTTDLib.php, class constant OpenTTDLib::OPTION_DEFAULT_CACHE_GAME
respective default values to the options
- OPTION_DEFAULT_CACHE_NEWGRF
- in file OpenTTDLib.php, class constant OpenTTDLib::OPTION_DEFAULT_CACHE_NEWGRF
respective default values to the options
- OPTION_DEFAULT_CACHE_UPDATE
- in file OpenTTDLib.php, class constant OpenTTDLib::OPTION_DEFAULT_CACHE_UPDATE
respective default values to the options
- OPTION_DEFAULT_CONVERT_MAPSET
- in file OpenTTDLib.php, class constant OpenTTDLib::OPTION_DEFAULT_CONVERT_MAPSET
respective default values to the options
- OPTION_DEFAULT_CONVERT_NETLANG
- in file OpenTTDLib.php, class constant OpenTTDLib::OPTION_DEFAULT_CONVERT_NETLANG
respective default values to the options
- OPTION_DEFAULT_CONVERT_STATIONTYPE
- in file OpenTTDLib.php, class constant OpenTTDLib::OPTION_DEFAULT_CONVERT_STATIONTYPE
respective default values to the options
- OPTION_DEFAULT_CONVERT_VEHICLETYPE
- in file OpenTTDLib.php, class constant OpenTTDLib::OPTION_DEFAULT_CONVERT_VEHICLETYPE
respective default values to the options
- OPTION_DEFAULT_NEWGRF_MAX_REQUEST
- in file OpenTTDLib.php, class constant OpenTTDLib::OPTION_DEFAULT_NEWGRF_MAX_REQUEST
respective default values to the options
- OPTION_DEFAULT_QUERYTYPE
- in file OpenTTDLib.php, class constant OpenTTDLib::OPTION_DEFAULT_QUERYTYPE
respective default values to the options
- OPTION_DEFAULT_RETURNTYPE
- in file OpenTTDLib.php, class constant OpenTTDLib::OPTION_DEFAULT_RETURNTYPE
respective default values to the options
- OPTION_DEFAULT_TIMEOUT
- in file OpenTTDLib.php, class constant OpenTTDLib::OPTION_DEFAULT_TIMEOUT
respective default values to the options
- OPTION_NEWGRF_MAX_REQUEST
- in file OpenTTDLib.php, class constant OpenTTDLib::OPTION_NEWGRF_MAX_REQUEST
Option constants, use with OpenTTDLib::setOption() and OpenTTDLib::getOption()
- OPTION_QUERYTYPE
- in file OpenTTDLib.php, class constant OpenTTDLib::OPTION_QUERYTYPE
Option constants, use with OpenTTDLib::setOption() and OpenTTDLib::getOption()
- OPTION_RETURNTYPE
- in file OpenTTDLib.php, class constant OpenTTDLib::OPTION_RETURNTYPE
Option constants, use with OpenTTDLib::setOption() and OpenTTDLib::getOption()
- OPTION_TIMEOUT
- in file OpenTTDLib.php, class constant OpenTTDLib::OPTION_TIMEOUT
Option constants, use with OpenTTDLib::setOption() and OpenTTDLib::getOption()
top
top
top
r
- ReadRawPacketSize
- in file OpenTTDLibPacket.php, method OpenTTDLibPacket::ReadRawPacketSize()
resets the internal position pointer to 0 and readas packet size from packet (first 2 bytes)
- RecvData
- in file OpenTTDLib.php, method OpenTTDLib::RecvData()
Try to receive some data, on success a new OpenTTDLibPacket Object will be stored in $this->packet
- Recv_string
- in file OpenTTDLibPacket.php, method OpenTTDLibPacket::Recv_string()
read the next few bytes, process and return a value we can work with
- Recv_uint8
- in file OpenTTDLibPacket.php, method OpenTTDLibPacket::Recv_uint8()
read the next few byets, process and return a value we can work with
- Recv_uint16
- in file OpenTTDLibPacket.php, method OpenTTDLibPacket::Recv_uint16()
- Recv_uint32
- in file OpenTTDLibPacket.php, method OpenTTDLibPacket::Recv_uint32()
- Recv_uint64
- in file OpenTTDLibPacket.php, method OpenTTDLibPacket::Recv_uint64()
64 bit integer handling using BCMath extentions
- resetPos
- in file OpenTTDLibPacket.php, method OpenTTDLibPacket::resetPos()
set the internal pointer back to 0
- RETURNTYPE_ARRAY
- in file OpenTTDLib.php, class constant OpenTTDLib::RETURNTYPE_ARRAY
- RETURNTYPE_OBJECT
- in file OpenTTDLib.php, class constant OpenTTDLib::RETURNTYPE_OBJECT
top
s
- sendPacket
- in file OpenTTDLib.php, method OpenTTDLib::sendPacket()
Send a packet
- SEND_MTU
- in file OpenTTDLibPacket.php, class constant OpenTTDLibPacket::SEND_MTU
size of a packet
- Send_string
- in file OpenTTDLibPacket.php, method OpenTTDLibPacket::Send_string()
- Send_uint8
- in file OpenTTDLibPacket.php, method OpenTTDLibPacket::Send_uint8()
- Send_uint16
- in file OpenTTDLibPacket.php, method OpenTTDLibPacket::Send_uint16()
- Send_uint32
- in file OpenTTDLibPacket.php, method OpenTTDLibPacket::Send_uint32()
- setOption
- in file OpenTTDLib.php, method OpenTTDLib::setOption()
checks if the option to be set is valid, if not it is ignored
- sizeOK
- in file OpenTTDLibPacket.php, method OpenTTDLibPacket::sizeOK()
compare actual packet size with claimed packet size
- startTimer
- in file OpenTTDLib.php, method OpenTTDLib::startTimer()
start the internal timer for checking if a timeout has occured
top
u
- UDP_CLIENT_DETAIL_INFO
- in file OpenTTDLibPacket.php, class constant OpenTTDLibPacket::UDP_CLIENT_DETAIL_INFO
upd packet enum as found in network_udp.c (0.5) or src/network/core/udp.h (trunk)
- UDP_CLIENT_FIND_SERVER
- in file OpenTTDLibPacket.php, class constant OpenTTDLibPacket::UDP_CLIENT_FIND_SERVER
upd packet enum as found in network_udp.c (0.5) or src/network/core/udp.h (trunk)
- UDP_CLIENT_GET_NEWGRFS
- in file OpenTTDLibPacket.php, class constant OpenTTDLibPacket::UDP_CLIENT_GET_NEWGRFS
upd packet enum as found in network_udp.c (0.5) or src/network/core/udp.h (trunk)
- UDP_SERVER_DETAIL_INFO
- in file OpenTTDLibPacket.php, class constant OpenTTDLibPacket::UDP_SERVER_DETAIL_INFO
upd packet enum as found in network_udp.c (0.5) or src/network/core/udp.h (trunk)
- UDP_SERVER_NEWGRFS
- in file OpenTTDLibPacket.php, class constant OpenTTDLibPacket::UDP_SERVER_NEWGRFS
upd packet enum as found in network_udp.c (0.5) or src/network/core/udp.h (trunk)
- UDP_SERVER_RESPONSE
- in file OpenTTDLibPacket.php, class constant OpenTTDLibPacket::UDP_SERVER_RESPONSE
upd packet enum as found in network_udp.c (0.5) or src/network/core/udp.h (trunk)
- uniqueNewGrf
- in file OpenTTDLibCache.php, method OpenTTDLibCache::uniqueNewGrf()
remove double entries, determind by grf_id and grf_md5sum
- updateCache
- in file OpenTTDLibCache.php, method OpenTTDLibCache::updateCache()
writes data from OpenTTDLibCache::asPrettyXML() back to the cache file, but only if the cache is different from that in the file
- updateCache
- in file OpenTTDLib.php, method OpenTTDLib::updateCache()
save the cache to it's file, if options are set, and $this->_cache is an instance of OpenTTDLibCache
top
|
|