steam-condenser 1.3.8.1 → 1.3.9

Sign up to get free protection for your applications and to get access to all the features.
Files changed (476) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +14 -0
  3. data/Gemfile +1 -1
  4. data/Gemfile.lock +48 -0
  5. data/doc/A2M_GET_SERVERS_BATCH2_Packet.html +1 -1
  6. data/doc/A2S_INFO_Packet.html +1 -1
  7. data/doc/A2S_PLAYER_Packet.html +1 -1
  8. data/doc/A2S_RULES_Packet.html +1 -1
  9. data/doc/A2S_SERVERQUERY_GETCHALLENGE_Packet.html +1 -1
  10. data/doc/AbstractL4DStats.html +1 -1
  11. data/doc/AbstractL4DWeapon.html +1 -1
  12. data/doc/AlienSwarmMission.html +1 -1
  13. data/doc/AlienSwarmStats.html +1 -1
  14. data/doc/AlienSwarmWeapon.html +1 -1
  15. data/doc/AppNews.html +1 -1
  16. data/doc/C2M_CHECKMD5_Packet.html +1 -1
  17. data/doc/CSSMap.html +1 -1
  18. data/doc/CSSStats.html +1 -1
  19. data/doc/CSSWeapon.html +1 -1
  20. data/doc/Cacheable.html +1 -1
  21. data/doc/Cacheable/ClassMethods.html +1 -1
  22. data/doc/DefenseGridStats.html +1 -1
  23. data/doc/DoDSClass.html +1 -1
  24. data/doc/DoDSStats.html +1 -1
  25. data/doc/DoDSWeapon.html +1 -1
  26. data/doc/Dota2BetaInventory.html +1 -1
  27. data/doc/Dota2Inventory.html +1 -1
  28. data/doc/Dota2Item.html +1 -1
  29. data/doc/GameAchievement.html +1 -1
  30. data/doc/GameClass.html +1 -1
  31. data/doc/GameInventory.html +1 -1
  32. data/doc/GameItem.html +1 -1
  33. data/doc/GameItemSchema.html +1 -1
  34. data/doc/GameLeaderboard.html +1 -1
  35. data/doc/GameLeaderboardEntry.html +1 -1
  36. data/doc/GameServer.html +1 -1
  37. data/doc/GameStats.html +1 -1
  38. data/doc/GameWeapon.html +1 -1
  39. data/doc/GoldSrcServer.html +1 -1
  40. data/doc/GoldSrcSocket.html +1 -1
  41. data/doc/L4D2Map.html +1 -1
  42. data/doc/L4D2Stats.html +1 -1
  43. data/doc/L4D2Weapon.html +1 -1
  44. data/doc/L4DExplosive.html +1 -1
  45. data/doc/L4DMap.html +1 -1
  46. data/doc/L4DStats.html +1 -1
  47. data/doc/L4DWeapon.html +1 -1
  48. data/doc/M2A_SERVER_BATCH_Packet.html +1 -1
  49. data/doc/M2C_ISVALIDMD5_Packet.html +1 -1
  50. data/doc/M2S_REQUESTRESTART_Packet.html +1 -1
  51. data/doc/MasterServer.html +1 -1
  52. data/doc/MasterServerSocket.html +1 -1
  53. data/doc/PacketFormatError.html +1 -1
  54. data/doc/Portal2Inventory.html +1 -1
  55. data/doc/Portal2Item.html +1 -1
  56. data/doc/Portal2Stats.html +1 -1
  57. data/doc/RCONAuthRequest.html +1 -1
  58. data/doc/RCONAuthResponse.html +1 -1
  59. data/doc/RCONBanError.html +1 -1
  60. data/doc/RCONExecRequest.html +1 -1
  61. data/doc/RCONExecResponse.html +1 -1
  62. data/doc/RCONGoldSrcRequest.html +1 -1
  63. data/doc/RCONGoldSrcResponse.html +1 -1
  64. data/doc/RCONNoAuthError.html +1 -1
  65. data/doc/RCONPacket.html +1 -1
  66. data/doc/RCONPacketFactory.html +1 -1
  67. data/doc/RCONSocket.html +13 -5
  68. data/doc/RCONTerminator.html +1 -1
  69. data/doc/RequestWithChallenge.html +1 -1
  70. data/doc/S2A_INFO2_Packet.html +1 -1
  71. data/doc/S2A_INFO_BasePacket.html +1 -1
  72. data/doc/S2A_INFO_DETAILED_Packet.html +1 -1
  73. data/doc/S2A_LOGSTRING_Packet.html +1 -1
  74. data/doc/S2A_PLAYER_Packet.html +1 -1
  75. data/doc/S2A_RULES_Packet.html +1 -1
  76. data/doc/S2C_CHALLENGE_Packet.html +1 -1
  77. data/doc/S2M_HEARTBEAT2_Packet.html +1 -1
  78. data/doc/Server.html +1 -1
  79. data/doc/SourceServer.html +33 -34
  80. data/doc/SourceSocket.html +1 -1
  81. data/doc/SteamCondenser.html +2 -2
  82. data/doc/SteamCondenser/Community.html +1 -1
  83. data/doc/SteamCondenser/Servers.html +1 -1
  84. data/doc/SteamCondenser/TimeoutError.html +1 -1
  85. data/doc/SteamCondenserError.html +1 -1
  86. data/doc/SteamGame.html +1 -1
  87. data/doc/SteamGroup.html +1 -1
  88. data/doc/SteamId.html +1 -1
  89. data/doc/SteamPacket.html +1 -1
  90. data/doc/SteamPacketFactory.html +1 -1
  91. data/doc/SteamPlayer.html +1 -1
  92. data/doc/SteamSocket.html +1 -1
  93. data/doc/StringIO.html +1 -1
  94. data/doc/TF2BetaInventory.html +1 -1
  95. data/doc/TF2Class.html +1 -1
  96. data/doc/TF2ClassFactory.html +1 -1
  97. data/doc/TF2Engineer.html +1 -1
  98. data/doc/TF2GoldenWrench.html +1 -1
  99. data/doc/TF2Inventory.html +1 -1
  100. data/doc/TF2Item.html +1 -1
  101. data/doc/TF2Medic.html +1 -1
  102. data/doc/TF2Sniper.html +1 -1
  103. data/doc/TF2Spy.html +1 -1
  104. data/doc/TF2Stats.html +1 -1
  105. data/doc/WebApi.html +1 -1
  106. data/doc/WebApiError.html +1 -1
  107. data/doc/XMLData.html +1 -1
  108. data/doc/_index.html +1 -1
  109. data/doc/file.CHANGELOG.html +20 -1
  110. data/doc/file.CONTRIBUTING.html +1 -1
  111. data/doc/file.LICENSE.html +1 -1
  112. data/doc/file.README.html +1 -1
  113. data/doc/index.html +1 -1
  114. data/doc/top-level-namespace.html +1 -1
  115. data/lib/steam-condenser/version.rb +2 -2
  116. data/lib/steam/servers/source_server.rb +13 -20
  117. data/lib/steam/sockets/rcon_socket.rb +7 -3
  118. data/pkg/steam-condenser-1.3.8.1.gem +0 -0
  119. data/pkg/steam-condenser-1.3.8.1/CHANGELOG.md +233 -0
  120. data/pkg/steam-condenser-1.3.8.1/CONTRIBUTING.md +59 -0
  121. data/pkg/steam-condenser-1.3.8.1/Gemfile +11 -0
  122. data/pkg/steam-condenser-1.3.8.1/LICENSE +25 -0
  123. data/pkg/steam-condenser-1.3.8.1/README.md +75 -0
  124. data/pkg/steam-condenser-1.3.8.1/Rakefile +46 -0
  125. data/pkg/steam-condenser-1.3.8.1/doc/A2M_GET_SERVERS_BATCH2_Packet.html +446 -0
  126. data/pkg/steam-condenser-1.3.8.1/doc/A2S_INFO_Packet.html +264 -0
  127. data/pkg/steam-condenser-1.3.8.1/doc/A2S_PLAYER_Packet.html +300 -0
  128. data/pkg/steam-condenser-1.3.8.1/doc/A2S_RULES_Packet.html +302 -0
  129. data/pkg/steam-condenser-1.3.8.1/doc/A2S_SERVERQUERY_GETCHALLENGE_Packet.html +266 -0
  130. data/pkg/steam-condenser-1.3.8.1/doc/AbstractL4DStats.html +1033 -0
  131. data/pkg/steam-condenser-1.3.8.1/doc/AbstractL4DWeapon.html +752 -0
  132. data/pkg/steam-condenser-1.3.8.1/doc/AlienSwarmMission.html +1598 -0
  133. data/pkg/steam-condenser-1.3.8.1/doc/AlienSwarmStats.html +1035 -0
  134. data/pkg/steam-condenser-1.3.8.1/doc/AlienSwarmWeapon.html +653 -0
  135. data/pkg/steam-condenser-1.3.8.1/doc/AppNews.html +1489 -0
  136. data/pkg/steam-condenser-1.3.8.1/doc/C2M_CHECKMD5_Packet.html +347 -0
  137. data/pkg/steam-condenser-1.3.8.1/doc/CSSMap.html +824 -0
  138. data/pkg/steam-condenser-1.3.8.1/doc/CSSStats.html +888 -0
  139. data/pkg/steam-condenser-1.3.8.1/doc/CSSWeapon.html +910 -0
  140. data/pkg/steam-condenser-1.3.8.1/doc/Cacheable.html +942 -0
  141. data/pkg/steam-condenser-1.3.8.1/doc/Cacheable/ClassMethods.html +721 -0
  142. data/pkg/steam-condenser-1.3.8.1/doc/DefenseGridStats.html +2659 -0
  143. data/pkg/steam-condenser-1.3.8.1/doc/DoDSClass.html +1291 -0
  144. data/pkg/steam-condenser-1.3.8.1/doc/DoDSStats.html +537 -0
  145. data/pkg/steam-condenser-1.3.8.1/doc/DoDSWeapon.html +824 -0
  146. data/pkg/steam-condenser-1.3.8.1/doc/Dota2BetaInventory.html +363 -0
  147. data/pkg/steam-condenser-1.3.8.1/doc/Dota2Inventory.html +363 -0
  148. data/pkg/steam-condenser-1.3.8.1/doc/Dota2Item.html +396 -0
  149. data/pkg/steam-condenser-1.3.8.1/doc/GameAchievement.html +1292 -0
  150. data/pkg/steam-condenser-1.3.8.1/doc/GameClass.html +328 -0
  151. data/pkg/steam-condenser-1.3.8.1/doc/GameInventory.html +1512 -0
  152. data/pkg/steam-condenser-1.3.8.1/doc/GameItem.html +1926 -0
  153. data/pkg/steam-condenser-1.3.8.1/doc/GameItemSchema.html +1477 -0
  154. data/pkg/steam-condenser-1.3.8.1/doc/GameLeaderboard.html +1741 -0
  155. data/pkg/steam-condenser-1.3.8.1/doc/GameLeaderboardEntry.html +642 -0
  156. data/pkg/steam-condenser-1.3.8.1/doc/GameServer.html +2495 -0
  157. data/pkg/steam-condenser-1.3.8.1/doc/GameStats.html +1501 -0
  158. data/pkg/steam-condenser-1.3.8.1/doc/GameWeapon.html +603 -0
  159. data/pkg/steam-condenser-1.3.8.1/doc/GoldSrcServer.html +766 -0
  160. data/pkg/steam-condenser-1.3.8.1/doc/GoldSrcSocket.html +874 -0
  161. data/pkg/steam-condenser-1.3.8.1/doc/L4D2Map.html +758 -0
  162. data/pkg/steam-condenser-1.3.8.1/doc/L4D2Stats.html +1020 -0
  163. data/pkg/steam-condenser-1.3.8.1/doc/L4D2Weapon.html +496 -0
  164. data/pkg/steam-condenser-1.3.8.1/doc/L4DExplosive.html +383 -0
  165. data/pkg/steam-condenser-1.3.8.1/doc/L4DMap.html +789 -0
  166. data/pkg/steam-condenser-1.3.8.1/doc/L4DStats.html +579 -0
  167. data/pkg/steam-condenser-1.3.8.1/doc/L4DWeapon.html +302 -0
  168. data/pkg/steam-condenser-1.3.8.1/doc/M2A_SERVER_BATCH_Packet.html +439 -0
  169. data/pkg/steam-condenser-1.3.8.1/doc/M2C_ISVALIDMD5_Packet.html +390 -0
  170. data/pkg/steam-condenser-1.3.8.1/doc/M2S_REQUESTRESTART_Packet.html +390 -0
  171. data/pkg/steam-condenser-1.3.8.1/doc/MasterServer.html +1104 -0
  172. data/pkg/steam-condenser-1.3.8.1/doc/MasterServerSocket.html +300 -0
  173. data/pkg/steam-condenser-1.3.8.1/doc/PacketFormatError.html +176 -0
  174. data/pkg/steam-condenser-1.3.8.1/doc/Portal2Inventory.html +363 -0
  175. data/pkg/steam-condenser-1.3.8.1/doc/Portal2Item.html +616 -0
  176. data/pkg/steam-condenser-1.3.8.1/doc/Portal2Stats.html +413 -0
  177. data/pkg/steam-condenser-1.3.8.1/doc/RCONAuthRequest.html +325 -0
  178. data/pkg/steam-condenser-1.3.8.1/doc/RCONAuthResponse.html +312 -0
  179. data/pkg/steam-condenser-1.3.8.1/doc/RCONBanError.html +257 -0
  180. data/pkg/steam-condenser-1.3.8.1/doc/RCONExecRequest.html +325 -0
  181. data/pkg/steam-condenser-1.3.8.1/doc/RCONExecResponse.html +416 -0
  182. data/pkg/steam-condenser-1.3.8.1/doc/RCONGoldSrcRequest.html +369 -0
  183. data/pkg/steam-condenser-1.3.8.1/doc/RCONGoldSrcResponse.html +375 -0
  184. data/pkg/steam-condenser-1.3.8.1/doc/RCONNoAuthError.html +256 -0
  185. data/pkg/steam-condenser-1.3.8.1/doc/RCONPacket.html +561 -0
  186. data/pkg/steam-condenser-1.3.8.1/doc/RCONPacketFactory.html +308 -0
  187. data/pkg/steam-condenser-1.3.8.1/doc/RCONSocket.html +725 -0
  188. data/pkg/steam-condenser-1.3.8.1/doc/RCONTerminator.html +312 -0
  189. data/pkg/steam-condenser-1.3.8.1/doc/RequestWithChallenge.html +238 -0
  190. data/pkg/steam-condenser-1.3.8.1/doc/S2A_INFO2_Packet.html +417 -0
  191. data/pkg/steam-condenser-1.3.8.1/doc/S2A_INFO_BasePacket.html +271 -0
  192. data/pkg/steam-condenser-1.3.8.1/doc/S2A_INFO_DETAILED_Packet.html +378 -0
  193. data/pkg/steam-condenser-1.3.8.1/doc/S2A_LOGSTRING_Packet.html +379 -0
  194. data/pkg/steam-condenser-1.3.8.1/doc/S2A_PLAYER_Packet.html +424 -0
  195. data/pkg/steam-condenser-1.3.8.1/doc/S2A_RULES_Packet.html +418 -0
  196. data/pkg/steam-condenser-1.3.8.1/doc/S2C_CHALLENGE_Packet.html +378 -0
  197. data/pkg/steam-condenser-1.3.8.1/doc/S2M_HEARTBEAT2_Packet.html +455 -0
  198. data/pkg/steam-condenser-1.3.8.1/doc/Server.html +886 -0
  199. data/pkg/steam-condenser-1.3.8.1/doc/SourceServer.html +920 -0
  200. data/pkg/steam-condenser-1.3.8.1/doc/SourceSocket.html +359 -0
  201. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser.html +157 -0
  202. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community.html +138 -0
  203. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/AbstractL4DStats.html +1026 -0
  204. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/AbstractL4DWeapon.html +749 -0
  205. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/AlienSwarmMission.html +1557 -0
  206. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/AlienSwarmStats.html +1013 -0
  207. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/AlienSwarmWeapon.html +641 -0
  208. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/AppNews.html +1441 -0
  209. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/CSSMap.html +805 -0
  210. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/CSSStats.html +866 -0
  211. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/CSSWeapon.html +889 -0
  212. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/Cacheable.html +911 -0
  213. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/Cacheable/ClassMethods.html +695 -0
  214. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/DefenseGridStats.html +2593 -0
  215. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/DoDSClass.html +1263 -0
  216. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/DoDSStats.html +520 -0
  217. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/DoDSWeapon.html +803 -0
  218. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/Dota2BetaInventory.html +354 -0
  219. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/Dota2Inventory.html +354 -0
  220. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/Dota2Item.html +388 -0
  221. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/Dota2Match.html +505 -0
  222. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/GameAchievement.html +1100 -0
  223. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/GameClass.html +321 -0
  224. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/GameInventory.html +1469 -0
  225. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/GameItem.html +1900 -0
  226. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/GameItemSchema.html +1444 -0
  227. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/GameLeaderboard.html +1707 -0
  228. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/GameLeaderboardEntry.html +630 -0
  229. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/GameStats.html +1461 -0
  230. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/GameStatsSchema.html +771 -0
  231. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/GameStatsValue.html +596 -0
  232. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/GameStatsValue/Instance.html +262 -0
  233. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/GameWeapon.html +608 -0
  234. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/L4D2Map.html +737 -0
  235. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/L4D2Stats.html +989 -0
  236. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/L4D2Weapon.html +486 -0
  237. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/L4DExplosive.html +375 -0
  238. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/L4DMap.html +775 -0
  239. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/L4DStats.html +564 -0
  240. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/L4DWeapon.html +296 -0
  241. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/Portal2Inventory.html +354 -0
  242. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/Portal2Item.html +603 -0
  243. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/Portal2Stats.html +400 -0
  244. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/SteamGame.html +1862 -0
  245. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/SteamGroup.html +1018 -0
  246. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/SteamId.html +4430 -0
  247. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/TF2BetaInventory.html +345 -0
  248. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/TF2Class.html +1186 -0
  249. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/TF2ClassFactory.html +273 -0
  250. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/TF2Engineer.html +555 -0
  251. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/TF2GoldenWrench.html +760 -0
  252. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/TF2Inventory.html +354 -0
  253. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/TF2Item.html +602 -0
  254. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/TF2Medic.html +463 -0
  255. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/TF2Sniper.html +372 -0
  256. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/TF2Spy.html +553 -0
  257. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/TF2Stats.html +728 -0
  258. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/UserStats.html +760 -0
  259. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/WebApi.html +1116 -0
  260. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/XMLData.html +274 -0
  261. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Error.html +380 -0
  262. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Error/PacketFormat.html +173 -0
  263. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Error/RCONBan.html +253 -0
  264. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Error/RCONNoAuth.html +252 -0
  265. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Error/Timeout.html +254 -0
  266. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Error/WebApi.html +354 -0
  267. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Logging.html +616 -0
  268. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Servers.html +137 -0
  269. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Servers/BaseServer.html +870 -0
  270. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Servers/GameServer.html +2428 -0
  271. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Servers/GoldSrcServer.html +738 -0
  272. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Servers/MasterServer.html +819 -0
  273. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Servers/Packets.html +132 -0
  274. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Servers/Packets/A2M_GET_SERVERS_BATCH2_Packet.html +427 -0
  275. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Servers/Packets/A2S_INFO_Packet.html +260 -0
  276. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Servers/Packets/A2S_PLAYER_Packet.html +295 -0
  277. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Servers/Packets/A2S_RULES_Packet.html +296 -0
  278. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Servers/Packets/A2S_SERVERQUERY_GETCHALLENGE_Packet.html +261 -0
  279. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Servers/Packets/BasePacket.html +462 -0
  280. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Servers/Packets/M2A_SERVER_BATCH_Packet.html +430 -0
  281. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Servers/Packets/RCON.html +119 -0
  282. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Servers/Packets/RCON/BasePacket.html +564 -0
  283. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Servers/Packets/RCON/RCONAuthRequest.html +317 -0
  284. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Servers/Packets/RCON/RCONAuthResponse.html +305 -0
  285. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Servers/Packets/RCON/RCONExecRequest.html +317 -0
  286. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Servers/Packets/RCON/RCONExecResponse.html +406 -0
  287. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Servers/Packets/RCON/RCONGoldSrcRequest.html +363 -0
  288. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Servers/Packets/RCON/RCONGoldSrcResponse.html +368 -0
  289. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Servers/Packets/RCON/RCONPacketFactory.html +302 -0
  290. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Servers/Packets/RCON/RCONTerminator.html +304 -0
  291. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Servers/Packets/RequestWithChallenge.html +233 -0
  292. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Servers/Packets/S2A_INFO2_Packet.html +416 -0
  293. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Servers/Packets/S2A_INFO_BasePacket.html +266 -0
  294. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Servers/Packets/S2A_INFO_DETAILED_Packet.html +371 -0
  295. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Servers/Packets/S2A_LOGSTRING_Packet.html +373 -0
  296. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Servers/Packets/S2A_PLAYER_Packet.html +417 -0
  297. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Servers/Packets/S2A_RULES_Packet.html +411 -0
  298. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Servers/Packets/S2C_CHALLENGE_Packet.html +370 -0
  299. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Servers/Packets/SteamPacketFactory.html +532 -0
  300. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Servers/Sockets.html +119 -0
  301. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Servers/Sockets/BaseSocket.html +733 -0
  302. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Servers/Sockets/GoldSrcSocket.html +862 -0
  303. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Servers/Sockets/MasterServerSocket.html +306 -0
  304. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Servers/Sockets/RCONSocket.html +709 -0
  305. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Servers/Sockets/SourceSocket.html +367 -0
  306. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Servers/SourceServer.html +892 -0
  307. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Servers/SteamPlayer.html +1764 -0
  308. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/TimeoutError.html +260 -0
  309. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenserError.html +378 -0
  310. data/pkg/steam-condenser-1.3.8.1/doc/SteamGame.html +2001 -0
  311. data/pkg/steam-condenser-1.3.8.1/doc/SteamGroup.html +1587 -0
  312. data/pkg/steam-condenser-1.3.8.1/doc/SteamId.html +4428 -0
  313. data/pkg/steam-condenser-1.3.8.1/doc/SteamPacket.html +457 -0
  314. data/pkg/steam-condenser-1.3.8.1/doc/SteamPacketFactory.html +574 -0
  315. data/pkg/steam-condenser-1.3.8.1/doc/SteamPlayer.html +1808 -0
  316. data/pkg/steam-condenser-1.3.8.1/doc/SteamSocket.html +728 -0
  317. data/pkg/steam-condenser-1.3.8.1/doc/StringIO.html +986 -0
  318. data/pkg/steam-condenser-1.3.8.1/doc/TF2BetaInventory.html +338 -0
  319. data/pkg/steam-condenser-1.3.8.1/doc/TF2Class.html +1228 -0
  320. data/pkg/steam-condenser-1.3.8.1/doc/TF2ClassFactory.html +281 -0
  321. data/pkg/steam-condenser-1.3.8.1/doc/TF2Engineer.html +572 -0
  322. data/pkg/steam-condenser-1.3.8.1/doc/TF2GoldenWrench.html +776 -0
  323. data/pkg/steam-condenser-1.3.8.1/doc/TF2Inventory.html +363 -0
  324. data/pkg/steam-condenser-1.3.8.1/doc/TF2Item.html +617 -0
  325. data/pkg/steam-condenser-1.3.8.1/doc/TF2Medic.html +476 -0
  326. data/pkg/steam-condenser-1.3.8.1/doc/TF2Sniper.html +381 -0
  327. data/pkg/steam-condenser-1.3.8.1/doc/TF2Spy.html +567 -0
  328. data/pkg/steam-condenser-1.3.8.1/doc/TF2Stats.html +751 -0
  329. data/pkg/steam-condenser-1.3.8.1/doc/WebApi.html +1156 -0
  330. data/pkg/steam-condenser-1.3.8.1/doc/WebApiError.html +375 -0
  331. data/pkg/steam-condenser-1.3.8.1/doc/XMLData.html +280 -0
  332. data/pkg/steam-condenser-1.3.8.1/doc/_index.html +728 -0
  333. data/pkg/steam-condenser-1.3.8.1/doc/class_list.html +54 -0
  334. data/pkg/steam-condenser-1.3.8.1/doc/css/common.css +1 -0
  335. data/pkg/steam-condenser-1.3.8.1/doc/css/full_list.css +57 -0
  336. data/pkg/steam-condenser-1.3.8.1/doc/css/style.css +338 -0
  337. data/pkg/steam-condenser-1.3.8.1/doc/file.CHANGELOG.html +472 -0
  338. data/pkg/steam-condenser-1.3.8.1/doc/file.CONTRIBUTING.html +156 -0
  339. data/pkg/steam-condenser-1.3.8.1/doc/file.LICENSE.html +118 -0
  340. data/pkg/steam-condenser-1.3.8.1/doc/file.README.html +179 -0
  341. data/pkg/steam-condenser-1.3.8.1/doc/file_list.html +65 -0
  342. data/pkg/steam-condenser-1.3.8.1/doc/frames.html +26 -0
  343. data/pkg/steam-condenser-1.3.8.1/doc/index.html +179 -0
  344. data/pkg/steam-condenser-1.3.8.1/doc/js/app.js +219 -0
  345. data/pkg/steam-condenser-1.3.8.1/doc/js/full_list.js +178 -0
  346. data/pkg/steam-condenser-1.3.8.1/doc/js/jquery.js +4 -0
  347. data/pkg/steam-condenser-1.3.8.1/doc/method_list.html +3191 -0
  348. data/pkg/steam-condenser-1.3.8.1/doc/top-level-namespace.html +114 -0
  349. data/pkg/steam-condenser-1.3.8.1/lib/core_ext/stringio.rb +93 -0
  350. data/pkg/steam-condenser-1.3.8.1/lib/errors/packet_format_error.rb +13 -0
  351. data/pkg/steam-condenser-1.3.8.1/lib/errors/rcon_ban_error.rb +22 -0
  352. data/pkg/steam-condenser-1.3.8.1/lib/errors/rcon_no_auth_error.rb +21 -0
  353. data/pkg/steam-condenser-1.3.8.1/lib/errors/steam_condenser_error.rb +26 -0
  354. data/pkg/steam-condenser-1.3.8.1/lib/errors/timeout_error.rb +28 -0
  355. data/pkg/steam-condenser-1.3.8.1/lib/errors/web_api_error.rb +57 -0
  356. data/pkg/steam-condenser-1.3.8.1/lib/steam-condenser.rb +18 -0
  357. data/pkg/steam-condenser-1.3.8.1/lib/steam-condenser/community.rb +24 -0
  358. data/pkg/steam-condenser-1.3.8.1/lib/steam-condenser/servers.rb +24 -0
  359. data/pkg/steam-condenser-1.3.8.1/lib/steam-condenser/version.rb +11 -0
  360. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/alien_swarm/alien_swarm_mission.rb +120 -0
  361. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/alien_swarm/alien_swarm_stats.rb +188 -0
  362. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/alien_swarm/alien_swarm_weapon.rb +49 -0
  363. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/app_news.rb +133 -0
  364. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/cacheable.rb +199 -0
  365. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/css/css_map.rb +61 -0
  366. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/css/css_stats.rb +140 -0
  367. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/css/css_weapon.rb +69 -0
  368. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/defense_grid/defense_grid_stats.rb +238 -0
  369. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/dods/dods_class.rb +90 -0
  370. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/dods/dods_stats.rb +62 -0
  371. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/dods/dods_weapon.rb +67 -0
  372. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/dota2/dota2_beta_inventory.rb +30 -0
  373. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/dota2/dota2_inventory.rb +30 -0
  374. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/dota2/dota2_item.rb +33 -0
  375. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/game_achievement.rb +109 -0
  376. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/game_class.rb +22 -0
  377. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/game_inventory.rb +171 -0
  378. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/game_item.rb +155 -0
  379. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/game_item_schema.rb +131 -0
  380. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/game_leaderboard.rb +212 -0
  381. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/game_leaderboard_entry.rb +43 -0
  382. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/game_stats.rb +175 -0
  383. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/game_weapon.rb +41 -0
  384. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/l4d/abstract_l4d_stats.rb +188 -0
  385. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/l4d/abstract_l4d_weapon.rb +56 -0
  386. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/l4d/l4d2_map.rb +90 -0
  387. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/l4d/l4d2_stats.rb +179 -0
  388. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/l4d/l4d2_weapon.rb +38 -0
  389. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/l4d/l4d_explosive.rb +34 -0
  390. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/l4d/l4d_map.rb +65 -0
  391. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/l4d/l4d_stats.rb +73 -0
  392. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/l4d/l4d_weapon.rb +26 -0
  393. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/portal2/portal2_inventory.rb +30 -0
  394. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/portal2/portal2_item.rb +55 -0
  395. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/portal2/portal2_stats.rb +33 -0
  396. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/steam_game.rb +193 -0
  397. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/steam_group.rb +176 -0
  398. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/steam_id.rb +496 -0
  399. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/tf2/tf2_beta_inventory.rb +28 -0
  400. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/tf2/tf2_class.rb +92 -0
  401. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/tf2/tf2_class_factory.rb +40 -0
  402. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/tf2/tf2_engineer.rb +43 -0
  403. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/tf2/tf2_golden_wrench.rb +70 -0
  404. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/tf2/tf2_inventory.rb +30 -0
  405. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/tf2/tf2_item.rb +55 -0
  406. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/tf2/tf2_medic.rb +35 -0
  407. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/tf2/tf2_sniper.rb +28 -0
  408. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/tf2/tf2_spy.rb +41 -0
  409. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/tf2/tf2_stats.rb +77 -0
  410. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/web_api.rb +139 -0
  411. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/xml_data.rb +27 -0
  412. data/pkg/steam-condenser-1.3.8.1/lib/steam/packets/a2m_get_servers_batch2_packet.rb +59 -0
  413. data/pkg/steam-condenser-1.3.8.1/lib/steam/packets/a2s_info_packet.rb +24 -0
  414. data/pkg/steam-condenser-1.3.8.1/lib/steam/packets/a2s_player_packet.rb +31 -0
  415. data/pkg/steam-condenser-1.3.8.1/lib/steam/packets/a2s_rules_packet.rb +32 -0
  416. data/pkg/steam-condenser-1.3.8.1/lib/steam/packets/a2s_serverquery_getchallenge_packet.rb +25 -0
  417. data/pkg/steam-condenser-1.3.8.1/lib/steam/packets/c2m_checkmd5_packet.rb +31 -0
  418. data/pkg/steam-condenser-1.3.8.1/lib/steam/packets/m2a_server_batch_packet.rb +52 -0
  419. data/pkg/steam-condenser-1.3.8.1/lib/steam/packets/m2c_isvalidmd5_packet.rb +34 -0
  420. data/pkg/steam-condenser-1.3.8.1/lib/steam/packets/m2s_requestrestart_packet.rb +34 -0
  421. data/pkg/steam-condenser-1.3.8.1/lib/steam/packets/rcon/rcon_auth_request.rb +28 -0
  422. data/pkg/steam-condenser-1.3.8.1/lib/steam/packets/rcon/rcon_auth_response.rb +30 -0
  423. data/pkg/steam-condenser-1.3.8.1/lib/steam/packets/rcon/rcon_exec_request.rb +28 -0
  424. data/pkg/steam-condenser-1.3.8.1/lib/steam/packets/rcon/rcon_exec_response.rb +37 -0
  425. data/pkg/steam-condenser-1.3.8.1/lib/steam/packets/rcon/rcon_goldsrc_request.rb +35 -0
  426. data/pkg/steam-condenser-1.3.8.1/lib/steam/packets/rcon/rcon_goldsrc_response.rb +34 -0
  427. data/pkg/steam-condenser-1.3.8.1/lib/steam/packets/rcon/rcon_packet.rb +57 -0
  428. data/pkg/steam-condenser-1.3.8.1/lib/steam/packets/rcon/rcon_packet_factory.rb +43 -0
  429. data/pkg/steam-condenser-1.3.8.1/lib/steam/packets/rcon/rcon_terminator.rb +29 -0
  430. data/pkg/steam-condenser-1.3.8.1/lib/steam/packets/request_with_challenge.rb +19 -0
  431. data/pkg/steam-condenser-1.3.8.1/lib/steam/packets/s2a_info2_packet.rb +76 -0
  432. data/pkg/steam-condenser-1.3.8.1/lib/steam/packets/s2a_info_base_packet.rb +25 -0
  433. data/pkg/steam-condenser-1.3.8.1/lib/steam/packets/s2a_info_detailed_packet.rb +64 -0
  434. data/pkg/steam-condenser-1.3.8.1/lib/steam/packets/s2a_logstring_packet.rb +30 -0
  435. data/pkg/steam-condenser-1.3.8.1/lib/steam/packets/s2a_player_packet.rb +44 -0
  436. data/pkg/steam-condenser-1.3.8.1/lib/steam/packets/s2a_rules_packet.rb +48 -0
  437. data/pkg/steam-condenser-1.3.8.1/lib/steam/packets/s2c_challenge_packet.rb +35 -0
  438. data/pkg/steam-condenser-1.3.8.1/lib/steam/packets/s2m_heartbeat2_packet.rb +72 -0
  439. data/pkg/steam-condenser-1.3.8.1/lib/steam/packets/steam_packet.rb +52 -0
  440. data/pkg/steam-condenser-1.3.8.1/lib/steam/packets/steam_packet_factory.rb +113 -0
  441. data/pkg/steam-condenser-1.3.8.1/lib/steam/servers/game_server.rb +393 -0
  442. data/pkg/steam-condenser-1.3.8.1/lib/steam/servers/goldsrc_server.rb +74 -0
  443. data/pkg/steam-condenser-1.3.8.1/lib/steam/servers/master_server.rb +188 -0
  444. data/pkg/steam-condenser-1.3.8.1/lib/steam/servers/server.rb +115 -0
  445. data/pkg/steam-condenser-1.3.8.1/lib/steam/servers/source_server.rb +123 -0
  446. data/pkg/steam-condenser-1.3.8.1/lib/steam/sockets/goldsrc_socket.rb +142 -0
  447. data/pkg/steam-condenser-1.3.8.1/lib/steam/sockets/master_server_socket.rb +34 -0
  448. data/pkg/steam-condenser-1.3.8.1/lib/steam/sockets/rcon_socket.rb +103 -0
  449. data/pkg/steam-condenser-1.3.8.1/lib/steam/sockets/source_socket.rb +73 -0
  450. data/pkg/steam-condenser-1.3.8.1/lib/steam/sockets/steam_socket.rb +91 -0
  451. data/pkg/steam-condenser-1.3.8.1/lib/steam/steam_player.rb +143 -0
  452. data/pkg/steam-condenser-1.3.8.1/steam-condenser.gemspec +25 -0
  453. data/pkg/steam-condenser-1.3.8.1/test/core_ext/test_stringio.rb +59 -0
  454. data/pkg/steam-condenser-1.3.8.1/test/fixtures/invalid.xml +2 -0
  455. data/pkg/steam-condenser-1.3.8.1/test/fixtures/sonofthor.xml +882 -0
  456. data/pkg/steam-condenser-1.3.8.1/test/fixtures/status_goldsrc +3 -0
  457. data/pkg/steam-condenser-1.3.8.1/test/fixtures/status_source +3 -0
  458. data/pkg/steam-condenser-1.3.8.1/test/fixtures/valve-members.xml +261 -0
  459. data/pkg/steam-condenser-1.3.8.1/test/helper.rb +48 -0
  460. data/pkg/steam-condenser-1.3.8.1/test/steam/community/test_cacheable.rb +103 -0
  461. data/pkg/steam-condenser-1.3.8.1/test/steam/community/test_steam_group.rb +94 -0
  462. data/pkg/steam-condenser-1.3.8.1/test/steam/community/test_steam_id.rb +144 -0
  463. data/pkg/steam-condenser-1.3.8.1/test/steam/community/test_web_api.rb +124 -0
  464. data/pkg/steam-condenser-1.3.8.1/test/steam/packets/test_steam_packet.rb +37 -0
  465. data/pkg/steam-condenser-1.3.8.1/test/steam/servers/test_game_server.rb +296 -0
  466. data/pkg/steam-condenser-1.3.8.1/test/steam/servers/test_goldsrc_server.rb +59 -0
  467. data/pkg/steam-condenser-1.3.8.1/test/steam/servers/test_master_server.rb +131 -0
  468. data/pkg/steam-condenser-1.3.8.1/test/steam/servers/test_server.rb +72 -0
  469. data/pkg/steam-condenser-1.3.8.1/test/steam/servers/test_source_server.rb +145 -0
  470. data/pkg/steam-condenser-1.3.8.1/test/steam/sockets/test_goldsrc_socket.rb +127 -0
  471. data/pkg/steam-condenser-1.3.8.1/test/steam/sockets/test_master_server_socket.rb +42 -0
  472. data/pkg/steam-condenser-1.3.8.1/test/steam/sockets/test_rcon_socket.rb +118 -0
  473. data/pkg/steam-condenser-1.3.8.1/test/steam/sockets/test_source_socket.rb +77 -0
  474. data/pkg/steam-condenser-1.3.8.1/test/steam/sockets/test_steam_socket.rb +97 -0
  475. data/test/steam/sockets/test_rcon_socket.rb +3 -7
  476. metadata +360 -2
@@ -0,0 +1,1741 @@
1
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4
+ <head>
5
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
6
+ <title>
7
+ Class: GameLeaderboard
8
+
9
+ &mdash; Metior — API Documentation
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
14
+
15
+ <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
16
+
17
+ <script type="text/javascript" charset="utf-8">
18
+ hasFrames = window.top.frames.main ? true : false;
19
+ relpath = '';
20
+ framesUrl = "frames.html#!" + escape(window.location.href);
21
+ </script>
22
+
23
+
24
+ <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
25
+
26
+ <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
27
+
28
+
29
+ </head>
30
+ <body>
31
+ <div id="header">
32
+ <div id="menu">
33
+
34
+ <a href="_index.html">Index (G)</a> &raquo;
35
+
36
+
37
+ <span class="title">GameLeaderboard</span>
38
+
39
+
40
+ <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
41
+ </div>
42
+
43
+ <div id="search">
44
+
45
+ <a class="full_list_link" id="class_list_link"
46
+ href="class_list.html">
47
+ Class List
48
+ </a>
49
+
50
+ <a class="full_list_link" id="method_list_link"
51
+ href="method_list.html">
52
+ Method List
53
+ </a>
54
+
55
+ <a class="full_list_link" id="file_list_link"
56
+ href="file_list.html">
57
+ File List
58
+ </a>
59
+
60
+ </div>
61
+ <div class="clear"></div>
62
+ </div>
63
+
64
+ <iframe id="search_frame"></iframe>
65
+
66
+ <div id="content"><h1>Class: GameLeaderboard
67
+
68
+
69
+
70
+ </h1>
71
+
72
+ <dl class="box">
73
+
74
+ <dt class="r1">Inherits:</dt>
75
+ <dd class="r1">
76
+ <span class="inheritName">Object</span>
77
+
78
+ <ul class="fullTree">
79
+ <li>Object</li>
80
+
81
+ <li class="next">GameLeaderboard</li>
82
+
83
+ </ul>
84
+ <a href="#" class="inheritanceTree">show all</a>
85
+
86
+ </dd>
87
+
88
+
89
+
90
+
91
+
92
+
93
+ <dt class="r2">Includes:</dt>
94
+ <dd class="r2"><span class='object_link'><a href="XMLData.html" title="XMLData (module)">XMLData</a></span></dd>
95
+
96
+
97
+
98
+
99
+
100
+ <dt class="r1 last">Defined in:</dt>
101
+ <dd class="r1 last">lib/steam/community/game_leaderboard.rb</dd>
102
+
103
+ </dl>
104
+ <div class="clear"></div>
105
+
106
+ <h2>Overview</h2><div class="docstring">
107
+ <div class="discussion">
108
+
109
+ <p>The GameLeaderboard class represents a single leaderboard for a specific
110
+ game</p>
111
+
112
+
113
+ </div>
114
+ </div>
115
+ <div class="tags">
116
+
117
+ <p class="tag_title">Author:</p>
118
+ <ul class="author">
119
+
120
+ <li>
121
+
122
+
123
+
124
+
125
+
126
+ <div class='inline'>
127
+ <p>Sebastian Staudt</p>
128
+ </div>
129
+
130
+ </li>
131
+
132
+ </ul>
133
+
134
+ </div>
135
+ <h2>Constant Summary</h2>
136
+
137
+ <dl class="constants">
138
+
139
+ <dt id="DISPLAY_TYPE_NONE-constant" class="">DISPLAY_TYPE_NONE =
140
+
141
+ </dt>
142
+ <dd><pre class="code"><span class='int'>0</span></pre></dd>
143
+
144
+ <dt id="DISPLAY_TYPE_NUMERIC-constant" class="">DISPLAY_TYPE_NUMERIC =
145
+
146
+ </dt>
147
+ <dd><pre class="code"><span class='int'>1</span></pre></dd>
148
+
149
+ <dt id="DISPLAY_TYPE_SECONDS-constant" class="">DISPLAY_TYPE_SECONDS =
150
+
151
+ </dt>
152
+ <dd><pre class="code"><span class='int'>2</span></pre></dd>
153
+
154
+ <dt id="DISPLAY_TYPE_MILLISECONDS-constant" class="">DISPLAY_TYPE_MILLISECONDS =
155
+
156
+ </dt>
157
+ <dd><pre class="code"><span class='int'>3</span></pre></dd>
158
+
159
+ <dt id="SORT_METHOD_NONE-constant" class="">SORT_METHOD_NONE =
160
+
161
+ </dt>
162
+ <dd><pre class="code"><span class='int'>0</span></pre></dd>
163
+
164
+ <dt id="SORT_METHOD_ASC-constant" class="">SORT_METHOD_ASC =
165
+
166
+ </dt>
167
+ <dd><pre class="code"><span class='int'>1</span></pre></dd>
168
+
169
+ <dt id="SORT_METHOD_DESC-constant" class="">SORT_METHOD_DESC =
170
+
171
+ </dt>
172
+ <dd><pre class="code"><span class='int'>2</span></pre></dd>
173
+
174
+ <dt id="leaderboards-classvariable" class="">@@leaderboards =
175
+
176
+ </dt>
177
+ <dd><pre class="code"><span class='lbrace'>{</span><span class='rbrace'>}</span></pre></dd>
178
+
179
+ </dl>
180
+
181
+
182
+
183
+
184
+
185
+ <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
186
+ <ul class="summary">
187
+
188
+ <li class="public ">
189
+ <span class="summary_signature">
190
+
191
+ <a href="#display_type-instance_method" title="#display_type (instance method)">- (Fixnum) <strong>display_type</strong> </a>
192
+
193
+
194
+
195
+ </span>
196
+
197
+
198
+
199
+
200
+ <span class="note title readonly">readonly</span>
201
+
202
+
203
+
204
+
205
+
206
+
207
+
208
+
209
+
210
+ <span class="summary_desc"><div class='inline'>
211
+ <p>Returns the display type of the scores on this leaderboard.</p>
212
+ </div></span>
213
+
214
+ </li>
215
+
216
+
217
+ <li class="public ">
218
+ <span class="summary_signature">
219
+
220
+ <a href="#entry_count-instance_method" title="#entry_count (instance method)">- (Fixnum) <strong>entry_count</strong> </a>
221
+
222
+
223
+
224
+ </span>
225
+
226
+
227
+
228
+
229
+ <span class="note title readonly">readonly</span>
230
+
231
+
232
+
233
+
234
+
235
+
236
+
237
+
238
+
239
+ <span class="summary_desc"><div class='inline'>
240
+ <p>Returns the number of entries on this leaderboard.</p>
241
+ </div></span>
242
+
243
+ </li>
244
+
245
+
246
+ <li class="public ">
247
+ <span class="summary_signature">
248
+
249
+ <a href="#id-instance_method" title="#id (instance method)">- (Fixnum) <strong>id</strong> </a>
250
+
251
+
252
+
253
+ </span>
254
+
255
+
256
+
257
+
258
+ <span class="note title readonly">readonly</span>
259
+
260
+
261
+
262
+
263
+
264
+
265
+
266
+
267
+
268
+ <span class="summary_desc"><div class='inline'>
269
+ <p>Returns the ID of the leaderboard.</p>
270
+ </div></span>
271
+
272
+ </li>
273
+
274
+
275
+ <li class="public ">
276
+ <span class="summary_signature">
277
+
278
+ <a href="#name-instance_method" title="#name (instance method)">- (String) <strong>name</strong> </a>
279
+
280
+
281
+
282
+ </span>
283
+
284
+
285
+
286
+
287
+ <span class="note title readonly">readonly</span>
288
+
289
+
290
+
291
+
292
+
293
+
294
+
295
+
296
+
297
+ <span class="summary_desc"><div class='inline'>
298
+ <p>Returns the name of the leaderboard.</p>
299
+ </div></span>
300
+
301
+ </li>
302
+
303
+
304
+ <li class="public ">
305
+ <span class="summary_signature">
306
+
307
+ <a href="#sort_method-instance_method" title="#sort_method (instance method)">- (Fixnum) <strong>sort_method</strong> </a>
308
+
309
+
310
+
311
+ </span>
312
+
313
+
314
+
315
+
316
+ <span class="note title readonly">readonly</span>
317
+
318
+
319
+
320
+
321
+
322
+
323
+
324
+
325
+
326
+ <span class="summary_desc"><div class='inline'>
327
+ <p>Returns the method that is used to sort the entries on the leaderboard.</p>
328
+ </div></span>
329
+
330
+ </li>
331
+
332
+
333
+ </ul>
334
+
335
+
336
+
337
+
338
+
339
+ <h2>
340
+ Class Method Summary
341
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
342
+ </h2>
343
+
344
+ <ul class="summary">
345
+
346
+ <li class="public ">
347
+ <span class="summary_signature">
348
+
349
+ <a href="#leaderboard-class_method" title="leaderboard (class method)">+ (GameLeaderboard) <strong>leaderboard</strong>(game_name, id) </a>
350
+
351
+
352
+
353
+ </span>
354
+
355
+
356
+
357
+
358
+
359
+
360
+
361
+
362
+
363
+ <span class="summary_desc"><div class='inline'>
364
+ <p>Returns the leaderboard for the given game and leaderboard ID or name.</p>
365
+ </div></span>
366
+
367
+ </li>
368
+
369
+
370
+ <li class="public ">
371
+ <span class="summary_signature">
372
+
373
+ <a href="#leaderboards-class_method" title="leaderboards (class method)">+ (Array&lt;GameLeaderboard&gt;) <strong>leaderboards</strong>(game_name) </a>
374
+
375
+
376
+
377
+ </span>
378
+
379
+
380
+
381
+
382
+
383
+
384
+
385
+
386
+
387
+ <span class="summary_desc"><div class='inline'>
388
+ <p>Returns an array containing all of a game&#39;s leaderboards.</p>
389
+ </div></span>
390
+
391
+ </li>
392
+
393
+
394
+ <li class="private ">
395
+ <span class="summary_signature">
396
+
397
+ <a href="#load_leaderboards-class_method" title="load_leaderboards (class method)">+ (Object) <strong>load_leaderboards</strong>(game_name) </a>
398
+
399
+
400
+
401
+ </span>
402
+
403
+
404
+
405
+ <span class="note title private">private</span>
406
+
407
+
408
+
409
+
410
+
411
+ <span class="summary_desc"><div class='inline'>
412
+ <p>Loads the leaderboards of the specified games into the cache.</p>
413
+ </div></span>
414
+
415
+ </li>
416
+
417
+
418
+ </ul>
419
+
420
+ <h2>
421
+ Instance Method Summary
422
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
423
+ </h2>
424
+
425
+ <ul class="summary">
426
+
427
+ <li class="public ">
428
+ <span class="summary_signature">
429
+
430
+ <a href="#entry_for_steam_id-instance_method" title="#entry_for_steam_id (instance method)">- (GameLeaderboardEntry) <strong>entry_for_steam_id</strong>(steam_id) </a>
431
+
432
+
433
+
434
+ </span>
435
+
436
+
437
+
438
+
439
+
440
+
441
+
442
+
443
+
444
+ <span class="summary_desc"><div class='inline'>
445
+ <p>Returns the entry on this leaderboard for the user with the given SteamID.</p>
446
+ </div></span>
447
+
448
+ </li>
449
+
450
+
451
+ <li class="public ">
452
+ <span class="summary_signature">
453
+
454
+ <a href="#entry_for_steam_id_friends-instance_method" title="#entry_for_steam_id_friends (instance method)">- (Array&lt;GameLeaderboardEntry&gt;) <strong>entry_for_steam_id_friends</strong>(steam_id) </a>
455
+
456
+
457
+
458
+ </span>
459
+
460
+
461
+
462
+
463
+
464
+
465
+
466
+
467
+
468
+ <span class="summary_desc"><div class='inline'>
469
+ <p>Returns an array of entries on this leaderboard for the user with the given
470
+ SteamID and his/her friends.</p>
471
+ </div></span>
472
+
473
+ </li>
474
+
475
+
476
+ <li class="public ">
477
+ <span class="summary_signature">
478
+
479
+ <a href="#entry_range-instance_method" title="#entry_range (instance method)">- (Array&lt;GameLeaderboardEntry&gt;) <strong>entry_range</strong>(first, last) </a>
480
+
481
+
482
+
483
+ </span>
484
+
485
+
486
+
487
+
488
+
489
+
490
+
491
+
492
+
493
+ <span class="summary_desc"><div class='inline'>
494
+ <p>Returns the entries on this leaderboard for a given rank range.</p>
495
+ </div></span>
496
+
497
+ </li>
498
+
499
+
500
+ <li class="private ">
501
+ <span class="summary_signature">
502
+
503
+ <a href="#initialize-instance_method" title="#initialize (instance method)">- (GameLeaderboard) <strong>initialize</strong>(board_data) </a>
504
+
505
+
506
+
507
+ </span>
508
+
509
+
510
+ <span class="note title constructor">constructor</span>
511
+
512
+
513
+ <span class="note title private">private</span>
514
+
515
+
516
+
517
+
518
+
519
+ <span class="summary_desc"><div class='inline'>
520
+ <p>Creates a new leaderboard instance with the given XML data.</p>
521
+ </div></span>
522
+
523
+ </li>
524
+
525
+
526
+ <li class="private ">
527
+ <span class="summary_signature">
528
+
529
+ <a href="#parse_entries-instance_method" title="#parse_entries (instance method)">- (Array&lt;GameLeaderboardEntry&gt;) <strong>parse_entries</strong> </a>
530
+
531
+
532
+
533
+ </span>
534
+
535
+
536
+
537
+ <span class="note title private">private</span>
538
+
539
+
540
+
541
+
542
+
543
+ <span class="summary_desc"><div class='inline'>
544
+ <p>Parses all entries available in the XML data.</p>
545
+ </div></span>
546
+
547
+ </li>
548
+
549
+
550
+ </ul>
551
+
552
+
553
+
554
+
555
+
556
+
557
+
558
+
559
+
560
+
561
+
562
+ <h3 class="inherited">Methods included from <span class='object_link'><a href="XMLData.html" title="XMLData (module)">XMLData</a></span></h3>
563
+ <p class="inherited"><span class='object_link'><a href="XMLData.html#parse-instance_method" title="XMLData#parse (method)">#parse</a></span></p>
564
+ <div id="constructor_details" class="method_details_list">
565
+ <h2>Constructor Details</h2>
566
+
567
+ <div class="method_details first">
568
+ <h3 class="signature first" id="initialize-instance_method">
569
+
570
+ - (<tt><span class='object_link'><a href="" title="GameLeaderboard (class)">GameLeaderboard</a></span></tt>) <strong>initialize</strong>(board_data) <span class="extras">(private)</span>
571
+
572
+
573
+
574
+
575
+
576
+ </h3><div class="docstring">
577
+ <div class="discussion">
578
+
579
+ <p>Creates a new leaderboard instance with the given XML data</p>
580
+
581
+
582
+ </div>
583
+ </div>
584
+ <div class="tags">
585
+ <p class="tag_title">Parameters:</p>
586
+ <ul class="param">
587
+
588
+ <li>
589
+
590
+ <span class='name'>board_data</span>
591
+
592
+
593
+ <span class='type'>(<tt>Hash&lt;String, Object&gt;</tt>)</span>
594
+
595
+
596
+
597
+ &mdash;
598
+ <div class='inline'>
599
+ <p>The XML data of the leaderboard</p>
600
+ </div>
601
+
602
+ </li>
603
+
604
+ </ul>
605
+
606
+
607
+ </div><table class="source_code">
608
+ <tr>
609
+ <td>
610
+ <pre class="lines">
611
+
612
+
613
+ 167
614
+ 168
615
+ 169
616
+ 170
617
+ 171
618
+ 172
619
+ 173
620
+ 174</pre>
621
+ </td>
622
+ <td>
623
+ <pre class="code"><span class="info file"># File 'lib/steam/community/game_leaderboard.rb', line 167</span>
624
+
625
+ <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_board_data'>board_data</span><span class='rparen'>)</span>
626
+ <span class='ivar'>@url</span> <span class='op'>=</span> <span class='id identifier rubyid_board_data'>board_data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>url</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
627
+ <span class='ivar'>@id</span> <span class='op'>=</span> <span class='id identifier rubyid_board_data'>board_data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>lbid</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span>
628
+ <span class='ivar'>@name</span> <span class='op'>=</span> <span class='id identifier rubyid_board_data'>board_data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>name</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
629
+ <span class='ivar'>@entry_count</span> <span class='op'>=</span> <span class='id identifier rubyid_board_data'>board_data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>entries</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span>
630
+ <span class='ivar'>@sort_method</span> <span class='op'>=</span> <span class='id identifier rubyid_board_data'>board_data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>sortmethod</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span>
631
+ <span class='ivar'>@display_type</span> <span class='op'>=</span> <span class='id identifier rubyid_board_data'>board_data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>displaytype</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span>
632
+ <span class='kw'>end</span></pre>
633
+ </td>
634
+ </tr>
635
+ </table>
636
+ </div>
637
+
638
+ </div>
639
+
640
+ <div id="instance_attr_details" class="attr_details">
641
+ <h2>Instance Attribute Details</h2>
642
+
643
+
644
+ <span id=""></span>
645
+ <div class="method_details first">
646
+ <h3 class="signature first" id="display_type-instance_method">
647
+
648
+ - (<tt>Fixnum</tt>) <strong>display_type</strong> <span class="extras">(readonly)</span>
649
+
650
+
651
+
652
+
653
+
654
+ </h3><div class="docstring">
655
+ <div class="discussion">
656
+
657
+ <p>Returns the display type of the scores on this leaderboard</p>
658
+
659
+
660
+ </div>
661
+ </div>
662
+ <div class="tags">
663
+
664
+ <p class="tag_title">Returns:</p>
665
+ <ul class="return">
666
+
667
+ <li>
668
+
669
+
670
+ <span class='type'>(<tt>Fixnum</tt>)</span>
671
+
672
+
673
+
674
+ &mdash;
675
+ <div class='inline'>
676
+ <p>The display type of the scores</p>
677
+ </div>
678
+
679
+ </li>
680
+
681
+ </ul>
682
+
683
+ </div><table class="source_code">
684
+ <tr>
685
+ <td>
686
+ <pre class="lines">
687
+
688
+
689
+ 33
690
+ 34
691
+ 35</pre>
692
+ </td>
693
+ <td>
694
+ <pre class="code"><span class="info file"># File 'lib/steam/community/game_leaderboard.rb', line 33</span>
695
+
696
+ <span class='kw'>def</span> <span class='id identifier rubyid_display_type'>display_type</span>
697
+ <span class='ivar'>@display_type</span>
698
+ <span class='kw'>end</span></pre>
699
+ </td>
700
+ </tr>
701
+ </table>
702
+ </div>
703
+
704
+
705
+ <span id=""></span>
706
+ <div class="method_details ">
707
+ <h3 class="signature " id="entry_count-instance_method">
708
+
709
+ - (<tt>Fixnum</tt>) <strong>entry_count</strong> <span class="extras">(readonly)</span>
710
+
711
+
712
+
713
+
714
+
715
+ </h3><div class="docstring">
716
+ <div class="discussion">
717
+
718
+ <p>Returns the number of entries on this leaderboard</p>
719
+
720
+
721
+ </div>
722
+ </div>
723
+ <div class="tags">
724
+
725
+ <p class="tag_title">Returns:</p>
726
+ <ul class="return">
727
+
728
+ <li>
729
+
730
+
731
+ <span class='type'>(<tt>Fixnum</tt>)</span>
732
+
733
+
734
+
735
+ &mdash;
736
+ <div class='inline'>
737
+ <p>The number of entries on this leaderboard</p>
738
+ </div>
739
+
740
+ </li>
741
+
742
+ </ul>
743
+
744
+ </div><table class="source_code">
745
+ <tr>
746
+ <td>
747
+ <pre class="lines">
748
+
749
+
750
+ 38
751
+ 39
752
+ 40</pre>
753
+ </td>
754
+ <td>
755
+ <pre class="code"><span class="info file"># File 'lib/steam/community/game_leaderboard.rb', line 38</span>
756
+
757
+ <span class='kw'>def</span> <span class='id identifier rubyid_entry_count'>entry_count</span>
758
+ <span class='ivar'>@entry_count</span>
759
+ <span class='kw'>end</span></pre>
760
+ </td>
761
+ </tr>
762
+ </table>
763
+ </div>
764
+
765
+
766
+ <span id=""></span>
767
+ <div class="method_details ">
768
+ <h3 class="signature " id="id-instance_method">
769
+
770
+ - (<tt>Fixnum</tt>) <strong>id</strong> <span class="extras">(readonly)</span>
771
+
772
+
773
+
774
+
775
+
776
+ </h3><div class="docstring">
777
+ <div class="discussion">
778
+
779
+ <p>Returns the ID of the leaderboard</p>
780
+
781
+
782
+ </div>
783
+ </div>
784
+ <div class="tags">
785
+
786
+ <p class="tag_title">Returns:</p>
787
+ <ul class="return">
788
+
789
+ <li>
790
+
791
+
792
+ <span class='type'>(<tt>Fixnum</tt>)</span>
793
+
794
+
795
+
796
+ &mdash;
797
+ <div class='inline'>
798
+ <p>The ID of the leaderboard</p>
799
+ </div>
800
+
801
+ </li>
802
+
803
+ </ul>
804
+
805
+ </div><table class="source_code">
806
+ <tr>
807
+ <td>
808
+ <pre class="lines">
809
+
810
+
811
+ 43
812
+ 44
813
+ 45</pre>
814
+ </td>
815
+ <td>
816
+ <pre class="code"><span class="info file"># File 'lib/steam/community/game_leaderboard.rb', line 43</span>
817
+
818
+ <span class='kw'>def</span> <span class='id identifier rubyid_id'>id</span>
819
+ <span class='ivar'>@id</span>
820
+ <span class='kw'>end</span></pre>
821
+ </td>
822
+ </tr>
823
+ </table>
824
+ </div>
825
+
826
+
827
+ <span id=""></span>
828
+ <div class="method_details ">
829
+ <h3 class="signature " id="name-instance_method">
830
+
831
+ - (<tt>String</tt>) <strong>name</strong> <span class="extras">(readonly)</span>
832
+
833
+
834
+
835
+
836
+
837
+ </h3><div class="docstring">
838
+ <div class="discussion">
839
+
840
+ <p>Returns the name of the leaderboard</p>
841
+
842
+
843
+ </div>
844
+ </div>
845
+ <div class="tags">
846
+
847
+ <p class="tag_title">Returns:</p>
848
+ <ul class="return">
849
+
850
+ <li>
851
+
852
+
853
+ <span class='type'>(<tt>String</tt>)</span>
854
+
855
+
856
+
857
+ &mdash;
858
+ <div class='inline'>
859
+ <p>The name of the leaderboard</p>
860
+ </div>
861
+
862
+ </li>
863
+
864
+ </ul>
865
+
866
+ </div><table class="source_code">
867
+ <tr>
868
+ <td>
869
+ <pre class="lines">
870
+
871
+
872
+ 48
873
+ 49
874
+ 50</pre>
875
+ </td>
876
+ <td>
877
+ <pre class="code"><span class="info file"># File 'lib/steam/community/game_leaderboard.rb', line 48</span>
878
+
879
+ <span class='kw'>def</span> <span class='id identifier rubyid_name'>name</span>
880
+ <span class='ivar'>@name</span>
881
+ <span class='kw'>end</span></pre>
882
+ </td>
883
+ </tr>
884
+ </table>
885
+ </div>
886
+
887
+
888
+ <span id=""></span>
889
+ <div class="method_details ">
890
+ <h3 class="signature " id="sort_method-instance_method">
891
+
892
+ - (<tt>Fixnum</tt>) <strong>sort_method</strong> <span class="extras">(readonly)</span>
893
+
894
+
895
+
896
+
897
+
898
+ </h3><div class="docstring">
899
+ <div class="discussion">
900
+
901
+ <p>Returns the method that is used to sort the entries on the leaderboard</p>
902
+
903
+
904
+ </div>
905
+ </div>
906
+ <div class="tags">
907
+
908
+ <p class="tag_title">Returns:</p>
909
+ <ul class="return">
910
+
911
+ <li>
912
+
913
+
914
+ <span class='type'>(<tt>Fixnum</tt>)</span>
915
+
916
+
917
+
918
+ &mdash;
919
+ <div class='inline'>
920
+ <p>The sort method</p>
921
+ </div>
922
+
923
+ </li>
924
+
925
+ </ul>
926
+
927
+ </div><table class="source_code">
928
+ <tr>
929
+ <td>
930
+ <pre class="lines">
931
+
932
+
933
+ 53
934
+ 54
935
+ 55</pre>
936
+ </td>
937
+ <td>
938
+ <pre class="code"><span class="info file"># File 'lib/steam/community/game_leaderboard.rb', line 53</span>
939
+
940
+ <span class='kw'>def</span> <span class='id identifier rubyid_sort_method'>sort_method</span>
941
+ <span class='ivar'>@sort_method</span>
942
+ <span class='kw'>end</span></pre>
943
+ </td>
944
+ </tr>
945
+ </table>
946
+ </div>
947
+
948
+ </div>
949
+
950
+
951
+ <div id="class_method_details" class="method_details_list">
952
+ <h2>Class Method Details</h2>
953
+
954
+
955
+ <div class="method_details first">
956
+ <h3 class="signature first" id="leaderboard-class_method">
957
+
958
+ + (<tt><span class='object_link'><a href="" title="GameLeaderboard (class)">GameLeaderboard</a></span></tt>) <strong>leaderboard</strong>(game_name, id)
959
+
960
+
961
+
962
+
963
+
964
+ </h3><div class="docstring">
965
+ <div class="discussion">
966
+
967
+ <p>Returns the leaderboard for the given game and leaderboard ID or name</p>
968
+
969
+
970
+ </div>
971
+ </div>
972
+ <div class="tags">
973
+ <p class="tag_title">Parameters:</p>
974
+ <ul class="param">
975
+
976
+ <li>
977
+
978
+ <span class='name'>game_name</span>
979
+
980
+
981
+ <span class='type'>(<tt>String</tt>)</span>
982
+
983
+
984
+
985
+ &mdash;
986
+ <div class='inline'>
987
+ <p>The short name of the game</p>
988
+ </div>
989
+
990
+ </li>
991
+
992
+ <li>
993
+
994
+ <span class='name'>id</span>
995
+
996
+
997
+ <span class='type'>(<tt>Fixnum</tt>, <tt>String</tt>)</span>
998
+
999
+
1000
+
1001
+ &mdash;
1002
+ <div class='inline'>
1003
+ <p>The ID or name of the leaderboard to return</p>
1004
+ </div>
1005
+
1006
+ </li>
1007
+
1008
+ </ul>
1009
+
1010
+ <p class="tag_title">Returns:</p>
1011
+ <ul class="return">
1012
+
1013
+ <li>
1014
+
1015
+
1016
+ <span class='type'>(<tt><span class='object_link'><a href="" title="GameLeaderboard (class)">GameLeaderboard</a></span></tt>)</span>
1017
+
1018
+
1019
+
1020
+ &mdash;
1021
+ <div class='inline'>
1022
+ <p>The matching leaderboard if available</p>
1023
+ </div>
1024
+
1025
+ </li>
1026
+
1027
+ </ul>
1028
+
1029
+ </div><table class="source_code">
1030
+ <tr>
1031
+ <td>
1032
+ <pre class="lines">
1033
+
1034
+
1035
+ 60
1036
+ 61
1037
+ 62
1038
+ 63
1039
+ 64
1040
+ 65
1041
+ 66
1042
+ 67
1043
+ 68
1044
+ 69
1045
+ 70</pre>
1046
+ </td>
1047
+ <td>
1048
+ <pre class="code"><span class="info file"># File 'lib/steam/community/game_leaderboard.rb', line 60</span>
1049
+
1050
+ <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_leaderboard'>leaderboard</span><span class='lparen'>(</span><span class='id identifier rubyid_game_name'>game_name</span><span class='comma'>,</span> <span class='id identifier rubyid_id'>id</span><span class='rparen'>)</span>
1051
+ <span class='id identifier rubyid_leaderboards'>leaderboards</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_leaderboards'>leaderboards</span> <span class='id identifier rubyid_game_name'>game_name</span>
1052
+
1053
+ <span class='kw'>if</span> <span class='id identifier rubyid_id'>id</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span> <span class='const'>Fixnum</span>
1054
+ <span class='id identifier rubyid_leaderboards'>leaderboards</span><span class='lbracket'>[</span><span class='id identifier rubyid_id'>id</span><span class='rbracket'>]</span>
1055
+ <span class='kw'>else</span>
1056
+ <span class='id identifier rubyid_leaderboards'>leaderboards</span><span class='period'>.</span><span class='id identifier rubyid_each_value'>each_value</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_board'>board</span><span class='op'>|</span>
1057
+ <span class='kw'>return</span> <span class='id identifier rubyid_board'>board</span> <span class='kw'>if</span> <span class='id identifier rubyid_board'>board</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span> <span class='op'>==</span> <span class='id identifier rubyid_id'>id</span>
1058
+ <span class='kw'>end</span>
1059
+ <span class='kw'>end</span>
1060
+ <span class='kw'>end</span></pre>
1061
+ </td>
1062
+ </tr>
1063
+ </table>
1064
+ </div>
1065
+
1066
+ <div class="method_details ">
1067
+ <h3 class="signature " id="leaderboards-class_method">
1068
+
1069
+ + (<tt>Array&lt;<span class='object_link'><a href="" title="GameLeaderboard (class)">GameLeaderboard</a></span>&gt;</tt>) <strong>leaderboards</strong>(game_name)
1070
+
1071
+
1072
+
1073
+
1074
+
1075
+ </h3><div class="docstring">
1076
+ <div class="discussion">
1077
+
1078
+ <p>Returns an array containing all of a game&#39;s leaderboards</p>
1079
+
1080
+
1081
+ </div>
1082
+ </div>
1083
+ <div class="tags">
1084
+ <p class="tag_title">Parameters:</p>
1085
+ <ul class="param">
1086
+
1087
+ <li>
1088
+
1089
+ <span class='name'>game_name</span>
1090
+
1091
+
1092
+ <span class='type'>(<tt>String</tt>)</span>
1093
+
1094
+
1095
+
1096
+ &mdash;
1097
+ <div class='inline'>
1098
+ <p>The name of the game</p>
1099
+ </div>
1100
+
1101
+ </li>
1102
+
1103
+ </ul>
1104
+
1105
+ <p class="tag_title">Returns:</p>
1106
+ <ul class="return">
1107
+
1108
+ <li>
1109
+
1110
+
1111
+ <span class='type'>(<tt>Array&lt;<span class='object_link'><a href="" title="GameLeaderboard (class)">GameLeaderboard</a></span>&gt;</tt>)</span>
1112
+
1113
+
1114
+
1115
+ &mdash;
1116
+ <div class='inline'>
1117
+ <p>The leaderboards for this game</p>
1118
+ </div>
1119
+
1120
+ </li>
1121
+
1122
+ </ul>
1123
+
1124
+ </div><table class="source_code">
1125
+ <tr>
1126
+ <td>
1127
+ <pre class="lines">
1128
+
1129
+
1130
+ 76
1131
+ 77
1132
+ 78
1133
+ 79
1134
+ 80</pre>
1135
+ </td>
1136
+ <td>
1137
+ <pre class="code"><span class="info file"># File 'lib/steam/community/game_leaderboard.rb', line 76</span>
1138
+
1139
+ <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_leaderboards'>leaderboards</span><span class='lparen'>(</span><span class='id identifier rubyid_game_name'>game_name</span><span class='rparen'>)</span>
1140
+ <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_load_leaderboards'>load_leaderboards</span> <span class='id identifier rubyid_game_name'>game_name</span> <span class='kw'>unless</span> <span class='cvar'>@@leaderboards</span><span class='period'>.</span><span class='id identifier rubyid_key?'>key?</span> <span class='id identifier rubyid_game_name'>game_name</span>
1141
+
1142
+ <span class='cvar'>@@leaderboards</span><span class='lbracket'>[</span><span class='id identifier rubyid_game_name'>game_name</span><span class='rbracket'>]</span>
1143
+ <span class='kw'>end</span></pre>
1144
+ </td>
1145
+ </tr>
1146
+ </table>
1147
+ </div>
1148
+
1149
+ <div class="method_details ">
1150
+ <h3 class="signature " id="load_leaderboards-class_method">
1151
+
1152
+ + (<tt>Object</tt>) <strong>load_leaderboards</strong>(game_name) <span class="extras">(private)</span>
1153
+
1154
+
1155
+
1156
+
1157
+
1158
+ </h3><div class="docstring">
1159
+ <div class="discussion">
1160
+
1161
+ <p>Loads the leaderboards of the specified games into the cache</p>
1162
+
1163
+
1164
+ </div>
1165
+ </div>
1166
+ <div class="tags">
1167
+ <p class="tag_title">Parameters:</p>
1168
+ <ul class="param">
1169
+
1170
+ <li>
1171
+
1172
+ <span class='name'>game_name</span>
1173
+
1174
+
1175
+ <span class='type'>(<tt>String</tt>)</span>
1176
+
1177
+
1178
+
1179
+ &mdash;
1180
+ <div class='inline'>
1181
+ <p>The short name of the game</p>
1182
+ </div>
1183
+
1184
+ </li>
1185
+
1186
+ </ul>
1187
+
1188
+ <p class="tag_title">Raises:</p>
1189
+ <ul class="raise">
1190
+
1191
+ <li>
1192
+
1193
+
1194
+ <span class='type'>(<tt>SteamCondenserException</tt>)</span>
1195
+
1196
+
1197
+
1198
+ &mdash;
1199
+ <div class='inline'>
1200
+ <p>if an error occurs while fetching the
1201
+ leaderboards</p>
1202
+ </div>
1203
+
1204
+ </li>
1205
+
1206
+ </ul>
1207
+
1208
+ </div><table class="source_code">
1209
+ <tr>
1210
+ <td>
1211
+ <pre class="lines">
1212
+
1213
+
1214
+ 194
1215
+ 195
1216
+ 196
1217
+ 197
1218
+ 198
1219
+ 199
1220
+ 200
1221
+ 201
1222
+ 202
1223
+ 203
1224
+ 204
1225
+ 205
1226
+ 206
1227
+ 207
1228
+ 208
1229
+ 209
1230
+ 210</pre>
1231
+ </td>
1232
+ <td>
1233
+ <pre class="code"><span class="info file"># File 'lib/steam/community/game_leaderboard.rb', line 194</span>
1234
+
1235
+ <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_load_leaderboards'>load_leaderboards</span><span class='lparen'>(</span><span class='id identifier rubyid_game_name'>game_name</span><span class='rparen'>)</span>
1236
+ <span class='kw'>begin</span>
1237
+ <span class='id identifier rubyid_url'>url</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>http://steamcommunity.com/stats/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_game_name'>game_name</span><span class='embexpr_end'>}</span><span class='tstring_content'>/leaderboards/?xml=1</span><span class='tstring_end'>&quot;</span></span>
1238
+ <span class='id identifier rubyid_boards_data'>boards_data</span> <span class='op'>=</span> <span class='const'>MultiXml</span><span class='period'>.</span><span class='id identifier rubyid_parse'>parse</span><span class='lparen'>(</span><span class='id identifier rubyid_open'>open</span><span class='lparen'>(</span><span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='lbrace'>{</span><span class='symbol'>:proxy</span> <span class='op'>=&gt;</span> <span class='kw'>true</span><span class='rbrace'>}</span><span class='rparen'>)</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_values'>values</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span>
1239
+ <span class='kw'>rescue</span>
1240
+ <span class='id identifier rubyid_raise'>raise</span> <span class='const'>SteamCondenserError</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>XML data could not be parsed.</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='gvar'>$!</span>
1241
+ <span class='kw'>end</span>
1242
+
1243
+ <span class='id identifier rubyid_error'>error</span> <span class='op'>=</span> <span class='id identifier rubyid_boards_data'>boards_data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>error</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
1244
+ <span class='id identifier rubyid_raise'>raise</span> <span class='const'>SteamCondenserError</span><span class='comma'>,</span> <span class='id identifier rubyid_error'>error</span> <span class='kw'>unless</span> <span class='id identifier rubyid_error'>error</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
1245
+
1246
+ <span class='cvar'>@@leaderboards</span><span class='lbracket'>[</span><span class='id identifier rubyid_game_name'>game_name</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
1247
+ <span class='id identifier rubyid_boards_data'>boards_data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>leaderboard</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_board_data'>board_data</span><span class='op'>|</span>
1248
+ <span class='id identifier rubyid_leaderboard'>leaderboard</span> <span class='op'>=</span> <span class='const'>GameLeaderboard</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='id identifier rubyid_board_data'>board_data</span>
1249
+ <span class='cvar'>@@leaderboards</span><span class='lbracket'>[</span><span class='id identifier rubyid_game_name'>game_name</span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='id identifier rubyid_leaderboard'>leaderboard</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_leaderboard'>leaderboard</span>
1250
+ <span class='kw'>end</span>
1251
+ <span class='kw'>end</span></pre>
1252
+ </td>
1253
+ </tr>
1254
+ </table>
1255
+ </div>
1256
+
1257
+ </div>
1258
+
1259
+ <div id="instance_method_details" class="method_details_list">
1260
+ <h2>Instance Method Details</h2>
1261
+
1262
+
1263
+ <div class="method_details first">
1264
+ <h3 class="signature first" id="entry_for_steam_id-instance_method">
1265
+
1266
+ - (<tt><span class='object_link'><a href="GameLeaderboardEntry.html" title="GameLeaderboardEntry (class)">GameLeaderboardEntry</a></span></tt>) <strong>entry_for_steam_id</strong>(steam_id)
1267
+
1268
+
1269
+
1270
+
1271
+
1272
+ </h3><div class="docstring">
1273
+ <div class="discussion">
1274
+
1275
+ <p>Returns the entry on this leaderboard for the user with the given SteamID</p>
1276
+
1277
+ <p>raise [SteamCondenserException] if an error occurs while fetching the
1278
+
1279
+ leaderboard</p>
1280
+
1281
+
1282
+ </div>
1283
+ </div>
1284
+ <div class="tags">
1285
+ <p class="tag_title">Parameters:</p>
1286
+ <ul class="param">
1287
+
1288
+ <li>
1289
+
1290
+ <span class='name'>steam_id</span>
1291
+
1292
+
1293
+ <span class='type'>(<tt>Fixnum</tt>, <tt><span class='object_link'><a href="SteamId.html" title="SteamId (class)">SteamId</a></span></tt>)</span>
1294
+
1295
+
1296
+
1297
+ &mdash;
1298
+ <div class='inline'>
1299
+ <p>The 64bit SteamID or the <code>SteamId</code> object
1300
+ of the user</p>
1301
+ </div>
1302
+
1303
+ </li>
1304
+
1305
+ </ul>
1306
+
1307
+ <p class="tag_title">Returns:</p>
1308
+ <ul class="return">
1309
+
1310
+ <li>
1311
+
1312
+
1313
+ <span class='type'>(<tt><span class='object_link'><a href="GameLeaderboardEntry.html" title="GameLeaderboardEntry (class)">GameLeaderboardEntry</a></span></tt>)</span>
1314
+
1315
+
1316
+
1317
+ &mdash;
1318
+ <div class='inline'>
1319
+ <p>The entry of the user if available</p>
1320
+ </div>
1321
+
1322
+ </li>
1323
+
1324
+ </ul>
1325
+ <p class="tag_title">Raises:</p>
1326
+ <ul class="raise">
1327
+
1328
+ <li>
1329
+
1330
+
1331
+ <span class='type'>(<tt><span class='object_link'><a href="SteamCondenserError.html" title="SteamCondenserError (class)">SteamCondenserError</a></span></tt>)</span>
1332
+
1333
+
1334
+
1335
+ </li>
1336
+
1337
+ </ul>
1338
+
1339
+ </div><table class="source_code">
1340
+ <tr>
1341
+ <td>
1342
+ <pre class="lines">
1343
+
1344
+
1345
+ 89
1346
+ 90
1347
+ 91
1348
+ 92
1349
+ 93
1350
+ 94
1351
+ 95
1352
+ 96
1353
+ 97
1354
+ 98
1355
+ 99
1356
+ 100
1357
+ 101
1358
+ 102
1359
+ 103
1360
+ 104</pre>
1361
+ </td>
1362
+ <td>
1363
+ <pre class="code"><span class="info file"># File 'lib/steam/community/game_leaderboard.rb', line 89</span>
1364
+
1365
+ <span class='kw'>def</span> <span class='id identifier rubyid_entry_for_steam_id'>entry_for_steam_id</span><span class='lparen'>(</span><span class='id identifier rubyid_steam_id'>steam_id</span><span class='rparen'>)</span>
1366
+ <span class='id identifier rubyid_steam_id'>steam_id</span> <span class='op'>=</span> <span class='id identifier rubyid_steam_id'>steam_id</span><span class='period'>.</span><span class='id identifier rubyid_steam_id64'>steam_id64</span> <span class='kw'>if</span> <span class='id identifier rubyid_steam_id'>steam_id</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span> <span class='const'>SteamId</span>
1367
+
1368
+ <span class='id identifier rubyid_parse'>parse</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embvar'>#</span><span class='ivar'>@url</span><span class='tstring_content'>&amp;steamid=</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_steam_id'>steam_id</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
1369
+
1370
+ <span class='id identifier rubyid_error'>error</span> <span class='op'>=</span> <span class='ivar'>@xml_data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>error</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
1371
+ <span class='id identifier rubyid_raise'>raise</span> <span class='const'>SteamCondenserError</span><span class='comma'>,</span> <span class='id identifier rubyid_error'>error</span> <span class='kw'>unless</span> <span class='id identifier rubyid_error'>error</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
1372
+
1373
+ <span class='ivar'>@xml_data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>entries</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>entry</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_entry_data'>entry_data</span><span class='op'>|</span>
1374
+ <span class='kw'>if</span> <span class='id identifier rubyid_entry_data'>entry_data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>steamid</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span> <span class='op'>==</span> <span class='id identifier rubyid_steam_id'>steam_id</span>
1375
+ <span class='kw'>return</span> <span class='const'>GameLeaderboardEntry</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='id identifier rubyid_entry_data'>entry_data</span><span class='comma'>,</span> <span class='kw'>self</span>
1376
+ <span class='kw'>end</span>
1377
+ <span class='kw'>end</span>
1378
+
1379
+ <span class='kw'>nil</span>
1380
+ <span class='kw'>end</span></pre>
1381
+ </td>
1382
+ </tr>
1383
+ </table>
1384
+ </div>
1385
+
1386
+ <div class="method_details ">
1387
+ <h3 class="signature " id="entry_for_steam_id_friends-instance_method">
1388
+
1389
+ - (<tt>Array&lt;<span class='object_link'><a href="GameLeaderboardEntry.html" title="GameLeaderboardEntry (class)">GameLeaderboardEntry</a></span>&gt;</tt>) <strong>entry_for_steam_id_friends</strong>(steam_id)
1390
+
1391
+
1392
+
1393
+
1394
+
1395
+ </h3><div class="docstring">
1396
+ <div class="discussion">
1397
+
1398
+ <p>Returns an array of entries on this leaderboard for the user with the
1399
+ given
1400
+ SteamID and his/her friends</p>
1401
+
1402
+ <p>raise [SteamCondenserException] if an error occurs while fetching the
1403
+
1404
+ leaderboard</p>
1405
+
1406
+
1407
+ </div>
1408
+ </div>
1409
+ <div class="tags">
1410
+ <p class="tag_title">Parameters:</p>
1411
+ <ul class="param">
1412
+
1413
+ <li>
1414
+
1415
+ <span class='name'>steam_id</span>
1416
+
1417
+
1418
+ <span class='type'>(<tt>Fixnum</tt>, <tt><span class='object_link'><a href="SteamId.html" title="SteamId (class)">SteamId</a></span></tt>)</span>
1419
+
1420
+
1421
+
1422
+ &mdash;
1423
+ <div class='inline'>
1424
+ <p>The 64bit SteamID or the <code>SteamId</code> object
1425
+ of the user</p>
1426
+ </div>
1427
+
1428
+ </li>
1429
+
1430
+ </ul>
1431
+
1432
+ <p class="tag_title">Returns:</p>
1433
+ <ul class="return">
1434
+
1435
+ <li>
1436
+
1437
+
1438
+ <span class='type'>(<tt>Array&lt;<span class='object_link'><a href="GameLeaderboardEntry.html" title="GameLeaderboardEntry (class)">GameLeaderboardEntry</a></span>&gt;</tt>)</span>
1439
+
1440
+
1441
+
1442
+ &mdash;
1443
+ <div class='inline'>
1444
+ <p>The entries of the user and his/her
1445
+ friends</p>
1446
+ </div>
1447
+
1448
+ </li>
1449
+
1450
+ </ul>
1451
+ <p class="tag_title">Raises:</p>
1452
+ <ul class="raise">
1453
+
1454
+ <li>
1455
+
1456
+
1457
+ <span class='type'>(<tt><span class='object_link'><a href="SteamCondenserError.html" title="SteamCondenserError (class)">SteamCondenserError</a></span></tt>)</span>
1458
+
1459
+
1460
+
1461
+ </li>
1462
+
1463
+ </ul>
1464
+
1465
+ </div><table class="source_code">
1466
+ <tr>
1467
+ <td>
1468
+ <pre class="lines">
1469
+
1470
+
1471
+ 115
1472
+ 116
1473
+ 117
1474
+ 118
1475
+ 119
1476
+ 120
1477
+ 121
1478
+ 122
1479
+ 123
1480
+ 124</pre>
1481
+ </td>
1482
+ <td>
1483
+ <pre class="code"><span class="info file"># File 'lib/steam/community/game_leaderboard.rb', line 115</span>
1484
+
1485
+ <span class='kw'>def</span> <span class='id identifier rubyid_entry_for_steam_id_friends'>entry_for_steam_id_friends</span><span class='lparen'>(</span><span class='id identifier rubyid_steam_id'>steam_id</span><span class='rparen'>)</span>
1486
+ <span class='id identifier rubyid_steam_id'>steam_id</span> <span class='op'>=</span> <span class='id identifier rubyid_steam_id'>steam_id</span><span class='period'>.</span><span class='id identifier rubyid_steam_id64'>steam_id64</span> <span class='kw'>if</span> <span class='id identifier rubyid_steam_id'>steam_id</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span> <span class='const'>SteamId</span>
1487
+
1488
+ <span class='id identifier rubyid_parse'>parse</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embvar'>#</span><span class='ivar'>@url</span><span class='tstring_content'>&amp;steamid=</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_steam_id'>steam_id</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
1489
+
1490
+ <span class='id identifier rubyid_error'>error</span> <span class='op'>=</span> <span class='ivar'>@xml_data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>error</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
1491
+ <span class='id identifier rubyid_raise'>raise</span> <span class='const'>SteamCondenserError</span><span class='comma'>,</span> <span class='id identifier rubyid_error'>error</span> <span class='kw'>unless</span> <span class='id identifier rubyid_error'>error</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
1492
+
1493
+ <span class='id identifier rubyid_parse_entries'>parse_entries</span>
1494
+ <span class='kw'>end</span></pre>
1495
+ </td>
1496
+ </tr>
1497
+ </table>
1498
+ </div>
1499
+
1500
+ <div class="method_details ">
1501
+ <h3 class="signature " id="entry_range-instance_method">
1502
+
1503
+ - (<tt>Array&lt;<span class='object_link'><a href="GameLeaderboardEntry.html" title="GameLeaderboardEntry (class)">GameLeaderboardEntry</a></span>&gt;</tt>) <strong>entry_range</strong>(first, last)
1504
+
1505
+
1506
+
1507
+
1508
+
1509
+ </h3><div class="docstring">
1510
+ <div class="discussion">
1511
+
1512
+ <p>Returns the entries on this leaderboard for a given rank range</p>
1513
+
1514
+ <p>The range is inclusive and a maximum of 5001 entries can be returned in
1515
+ a
1516
+ single request.</p>
1517
+
1518
+ <p>raise [SteamCondenserException] if an error occurs while fetching the
1519
+
1520
+ leaderboard</p>
1521
+
1522
+
1523
+ </div>
1524
+ </div>
1525
+ <div class="tags">
1526
+ <p class="tag_title">Parameters:</p>
1527
+ <ul class="param">
1528
+
1529
+ <li>
1530
+
1531
+ <span class='name'>first</span>
1532
+
1533
+
1534
+ <span class='type'>(<tt>Fixnum</tt>)</span>
1535
+
1536
+
1537
+
1538
+ &mdash;
1539
+ <div class='inline'>
1540
+ <p>The first entry to return from the leaderboard</p>
1541
+ </div>
1542
+
1543
+ </li>
1544
+
1545
+ <li>
1546
+
1547
+ <span class='name'>last</span>
1548
+
1549
+
1550
+ <span class='type'>(<tt>Fixnum</tt>)</span>
1551
+
1552
+
1553
+
1554
+ &mdash;
1555
+ <div class='inline'>
1556
+ <p>The last entry to return from the leaderboard</p>
1557
+ </div>
1558
+
1559
+ </li>
1560
+
1561
+ </ul>
1562
+
1563
+ <p class="tag_title">Returns:</p>
1564
+ <ul class="return">
1565
+
1566
+ <li>
1567
+
1568
+
1569
+ <span class='type'>(<tt>Array&lt;<span class='object_link'><a href="GameLeaderboardEntry.html" title="GameLeaderboardEntry (class)">GameLeaderboardEntry</a></span>&gt;</tt>)</span>
1570
+
1571
+
1572
+
1573
+ &mdash;
1574
+ <div class='inline'>
1575
+ <p>The entries that match the given rank
1576
+ range</p>
1577
+ </div>
1578
+
1579
+ </li>
1580
+
1581
+ </ul>
1582
+ <p class="tag_title">Raises:</p>
1583
+ <ul class="raise">
1584
+
1585
+ <li>
1586
+
1587
+
1588
+ <span class='type'>(<tt><span class='object_link'><a href="SteamCondenserError.html" title="SteamCondenserError (class)">SteamCondenserError</a></span></tt>)</span>
1589
+
1590
+
1591
+
1592
+ </li>
1593
+
1594
+ </ul>
1595
+
1596
+ </div><table class="source_code">
1597
+ <tr>
1598
+ <td>
1599
+ <pre class="lines">
1600
+
1601
+
1602
+ 137
1603
+ 138
1604
+ 139
1605
+ 140
1606
+ 141
1607
+ 142
1608
+ 143
1609
+ 144
1610
+ 145
1611
+ 146
1612
+ 147
1613
+ 148
1614
+ 149
1615
+ 150
1616
+ 151
1617
+ 152
1618
+ 153
1619
+ 154
1620
+ 155
1621
+ 156
1622
+ 157
1623
+ 158
1624
+ 159
1625
+ 160</pre>
1626
+ </td>
1627
+ <td>
1628
+ <pre class="code"><span class="info file"># File 'lib/steam/community/game_leaderboard.rb', line 137</span>
1629
+
1630
+ <span class='kw'>def</span> <span class='id identifier rubyid_entry_range'>entry_range</span><span class='lparen'>(</span><span class='id identifier rubyid_first'>first</span><span class='comma'>,</span> <span class='id identifier rubyid_last'>last</span><span class='rparen'>)</span>
1631
+ <span class='kw'>if</span> <span class='id identifier rubyid_last'>last</span> <span class='op'>&lt;</span> <span class='id identifier rubyid_first'>first</span>
1632
+ <span class='id identifier rubyid_raise'>raise</span> <span class='const'>SteamCondenserError</span><span class='comma'>,</span>
1633
+ <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>First entry must be prior to last entry for leaderboard entry lookup.</span><span class='tstring_end'>&#39;</span></span>
1634
+ <span class='kw'>end</span>
1635
+
1636
+ <span class='kw'>if</span> <span class='lparen'>(</span><span class='id identifier rubyid_last'>last</span> <span class='op'>-</span> <span class='id identifier rubyid_first'>first</span><span class='rparen'>)</span> <span class='op'>&gt;</span> <span class='int'>5000</span>
1637
+ <span class='id identifier rubyid_raise'>raise</span> <span class='const'>SteamCondenserError</span><span class='comma'>,</span>
1638
+ <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Leaderboard entry lookup is currently limited to a maximum of 5001 entries per request.</span><span class='tstring_end'>&#39;</span></span>
1639
+ <span class='kw'>end</span>
1640
+
1641
+ <span class='id identifier rubyid_parse'>parse</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embvar'>#</span><span class='ivar'>@url</span><span class='tstring_content'>&amp;start=</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_first'>first</span><span class='embexpr_end'>}</span><span class='tstring_content'>&amp;end=</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_last'>last</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
1642
+
1643
+ <span class='id identifier rubyid_error'>error</span> <span class='op'>=</span> <span class='ivar'>@xml_data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>error</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
1644
+ <span class='id identifier rubyid_raise'>raise</span> <span class='const'>SteamCondenserError</span><span class='comma'>,</span> <span class='id identifier rubyid_error'>error</span> <span class='kw'>unless</span> <span class='id identifier rubyid_error'>error</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
1645
+
1646
+ <span class='id identifier rubyid_entries'>entries</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
1647
+ <span class='ivar'>@xml_data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>entries</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>entry</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_entry_data'>entry_data</span><span class='op'>|</span>
1648
+ <span class='id identifier rubyid_rank'>rank</span> <span class='op'>=</span> <span class='id identifier rubyid_entry_data'>entry_data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>rank</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span>
1649
+ <span class='id identifier rubyid_entries'>entries</span><span class='lbracket'>[</span><span class='id identifier rubyid_rank'>rank</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='const'>GameLeaderboardEntry</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='id identifier rubyid_entry_data'>entry_data</span><span class='comma'>,</span> <span class='kw'>self</span>
1650
+ <span class='kw'>end</span>
1651
+
1652
+ <span class='id identifier rubyid_parse_entries'>parse_entries</span>
1653
+ <span class='kw'>end</span></pre>
1654
+ </td>
1655
+ </tr>
1656
+ </table>
1657
+ </div>
1658
+
1659
+ <div class="method_details ">
1660
+ <h3 class="signature " id="parse_entries-instance_method">
1661
+
1662
+ - (<tt>Array&lt;<span class='object_link'><a href="GameLeaderboardEntry.html" title="GameLeaderboardEntry (class)">GameLeaderboardEntry</a></span>&gt;</tt>) <strong>parse_entries</strong> <span class="extras">(private)</span>
1663
+
1664
+
1665
+
1666
+
1667
+
1668
+ </h3><div class="docstring">
1669
+ <div class="discussion">
1670
+
1671
+ <p>Parses all entries available in the XML data</p>
1672
+
1673
+
1674
+ </div>
1675
+ </div>
1676
+ <div class="tags">
1677
+
1678
+ <p class="tag_title">Returns:</p>
1679
+ <ul class="return">
1680
+
1681
+ <li>
1682
+
1683
+
1684
+ <span class='type'>(<tt>Array&lt;<span class='object_link'><a href="GameLeaderboardEntry.html" title="GameLeaderboardEntry (class)">GameLeaderboardEntry</a></span>&gt;</tt>)</span>
1685
+
1686
+
1687
+
1688
+ &mdash;
1689
+ <div class='inline'>
1690
+ <p>All available entries</p>
1691
+ </div>
1692
+
1693
+ </li>
1694
+
1695
+ </ul>
1696
+
1697
+ </div><table class="source_code">
1698
+ <tr>
1699
+ <td>
1700
+ <pre class="lines">
1701
+
1702
+
1703
+ 179
1704
+ 180
1705
+ 181
1706
+ 182
1707
+ 183
1708
+ 184
1709
+ 185
1710
+ 186
1711
+ 187</pre>
1712
+ </td>
1713
+ <td>
1714
+ <pre class="code"><span class="info file"># File 'lib/steam/community/game_leaderboard.rb', line 179</span>
1715
+
1716
+ <span class='kw'>def</span> <span class='id identifier rubyid_parse_entries'>parse_entries</span>
1717
+ <span class='id identifier rubyid_entries'>entries</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
1718
+ <span class='ivar'>@xml_data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>entries</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>entry</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_entry_data'>entry_data</span><span class='op'>|</span>
1719
+ <span class='id identifier rubyid_entries'>entries</span><span class='lbracket'>[</span><span class='id identifier rubyid_entry_data'>entry_data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>rank</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span><span class='rbracket'>]</span> <span class='op'>=</span>
1720
+ <span class='const'>GameLeaderboardEntry</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='id identifier rubyid_entry_data'>entry_data</span><span class='comma'>,</span> <span class='kw'>self</span>
1721
+ <span class='kw'>end</span>
1722
+
1723
+ <span class='id identifier rubyid_entries'>entries</span>
1724
+ <span class='kw'>end</span></pre>
1725
+ </td>
1726
+ </tr>
1727
+ </table>
1728
+ </div>
1729
+
1730
+ </div>
1731
+
1732
+ </div>
1733
+
1734
+ <div id="footer">
1735
+ Generated on Tue Jul 22 07:10:30 2014 by
1736
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1737
+ 0.8.7.3 (ruby-2.0.0).
1738
+ </div>
1739
+
1740
+ </body>
1741
+ </html>