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,2001 @@
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: SteamGame
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 (S)</a> &raquo;
35
+
36
+
37
+ <span class="title">SteamGame</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: SteamGame
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">SteamGame</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="Cacheable.html" title="Cacheable (module)">Cacheable</a></span></dd>
95
+
96
+
97
+
98
+
99
+
100
+ <dt class="r1 last">Defined in:</dt>
101
+ <dd class="r1 last">lib/steam/community/steam_game.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>This class represents a game available on Steam</p>
110
+
111
+
112
+ </div>
113
+ </div>
114
+ <div class="tags">
115
+
116
+ <p class="tag_title">Author:</p>
117
+ <ul class="author">
118
+
119
+ <li>
120
+
121
+
122
+
123
+
124
+
125
+ <div class='inline'>
126
+ <p>Sebastian Staudt</p>
127
+ </div>
128
+
129
+ </li>
130
+
131
+ </ul>
132
+
133
+ </div>
134
+
135
+
136
+
137
+ <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
138
+ <ul class="summary">
139
+
140
+ <li class="public ">
141
+ <span class="summary_signature">
142
+
143
+ <a href="#app_id-instance_method" title="#app_id (instance method)">- (Fixnum) <strong>app_id</strong> </a>
144
+
145
+
146
+
147
+ </span>
148
+
149
+
150
+
151
+
152
+ <span class="note title readonly">readonly</span>
153
+
154
+
155
+
156
+
157
+
158
+
159
+
160
+
161
+
162
+ <span class="summary_desc"><div class='inline'>
163
+ <p>Returns the Steam application ID of this game.</p>
164
+ </div></span>
165
+
166
+ </li>
167
+
168
+
169
+ <li class="public ">
170
+ <span class="summary_signature">
171
+
172
+ <a href="#icon_url-instance_method" title="#icon_url (instance method)">- (String) <strong>icon_url</strong> </a>
173
+
174
+
175
+
176
+ </span>
177
+
178
+
179
+
180
+
181
+ <span class="note title readonly">readonly</span>
182
+
183
+
184
+
185
+
186
+
187
+
188
+
189
+
190
+
191
+ <span class="summary_desc"><div class='inline'>
192
+ <p>Returns the URL for the icon image of this game.</p>
193
+ </div></span>
194
+
195
+ </li>
196
+
197
+
198
+ <li class="public ">
199
+ <span class="summary_signature">
200
+
201
+ <a href="#name-instance_method" title="#name (instance method)">- (String) <strong>name</strong> </a>
202
+
203
+
204
+
205
+ </span>
206
+
207
+
208
+
209
+
210
+ <span class="note title readonly">readonly</span>
211
+
212
+
213
+
214
+
215
+
216
+
217
+
218
+
219
+
220
+ <span class="summary_desc"><div class='inline'>
221
+ <p>Returns the full name of this game.</p>
222
+ </div></span>
223
+
224
+ </li>
225
+
226
+
227
+ <li class="public ">
228
+ <span class="summary_signature">
229
+
230
+ <a href="#short_name-instance_method" title="#short_name (instance method)">- (String) <strong>short_name</strong> </a>
231
+
232
+
233
+
234
+ </span>
235
+
236
+
237
+
238
+
239
+ <span class="note title readonly">readonly</span>
240
+
241
+
242
+
243
+
244
+
245
+
246
+
247
+
248
+
249
+ <span class="summary_desc"><div class='inline'>
250
+ <p>Returns the short name of this game (also known as “friendly name”).</p>
251
+ </div></span>
252
+
253
+ </li>
254
+
255
+
256
+ </ul>
257
+
258
+
259
+
260
+
261
+
262
+ <h3 class="inherited">Attributes included from <span class='object_link'><a href="Cacheable.html" title="Cacheable (module)">Cacheable</a></span></h3>
263
+ <p class="inherited"><span class='object_link'><a href="Cacheable.html#fetch_time-instance_method" title="Cacheable#fetch_time (method)">#fetch_time</a></span></p>
264
+
265
+
266
+
267
+ <h2>
268
+ Class Method Summary
269
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
270
+ </h2>
271
+
272
+ <ul class="summary">
273
+
274
+ <li class="public ">
275
+ <span class="summary_signature">
276
+
277
+ <a href="#check_steam_inf-class_method" title="check_steam_inf (class method)">+ (Boolean) <strong>check_steam_inf</strong>(path) </a>
278
+
279
+
280
+
281
+ </span>
282
+
283
+
284
+
285
+
286
+
287
+
288
+
289
+
290
+
291
+ <span class="summary_desc"><div class='inline'>
292
+ <p>Checks if a game is up-to-date by reading information from a
293
+ <code>steam.inf</code> file and comparing it using the Web API.</p>
294
+ </div></span>
295
+
296
+ </li>
297
+
298
+
299
+ <li class="public ">
300
+ <span class="summary_signature">
301
+
302
+ <a href="#new-class_method" title="new (class method)">+ (Object) <strong>new</strong>(app_id, game_data = nil) </a>
303
+
304
+
305
+
306
+ </span>
307
+
308
+
309
+
310
+
311
+
312
+
313
+
314
+
315
+
316
+ <span class="summary_desc"><div class='inline'>
317
+ <p>Creates a new instance of a game with the given data and caches it.</p>
318
+ </div></span>
319
+
320
+ </li>
321
+
322
+
323
+ <li class="public ">
324
+ <span class="summary_signature">
325
+
326
+ <a href="#uptodate%3F-class_method" title="uptodate? (class method)">+ (Boolean) <strong>uptodate?</strong>(app_id, version) </a>
327
+
328
+
329
+
330
+ </span>
331
+
332
+
333
+
334
+
335
+
336
+
337
+
338
+
339
+
340
+ <span class="summary_desc"><div class='inline'>
341
+ <p>Returns whether the given version of the game with the given application ID
342
+ is up-to-date.</p>
343
+ </div></span>
344
+
345
+ </li>
346
+
347
+
348
+ </ul>
349
+
350
+ <h2>
351
+ Instance Method Summary
352
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
353
+ </h2>
354
+
355
+ <ul class="summary">
356
+
357
+ <li class="public ">
358
+ <span class="summary_signature">
359
+
360
+ <a href="#has_stats%3F-instance_method" title="#has_stats? (instance method)">- (Boolean) <strong>has_stats?</strong> </a>
361
+
362
+
363
+
364
+ </span>
365
+
366
+
367
+
368
+
369
+
370
+
371
+
372
+
373
+
374
+ <span class="summary_desc"><div class='inline'>
375
+ <p>Returns whether this game has statistics available.</p>
376
+ </div></span>
377
+
378
+ </li>
379
+
380
+
381
+ <li class="public ">
382
+ <span class="summary_signature">
383
+
384
+ <a href="#id-instance_method" title="#id (instance method)">- (Fixnum, String) <strong>id</strong> </a>
385
+
386
+
387
+
388
+ </span>
389
+
390
+
391
+
392
+
393
+
394
+
395
+
396
+
397
+
398
+ <span class="summary_desc"><div class='inline'>
399
+ <p>Returns a unique identifier for this game.</p>
400
+ </div></span>
401
+
402
+ </li>
403
+
404
+
405
+ <li class="private ">
406
+ <span class="summary_signature">
407
+
408
+ <a href="#initialize-instance_method" title="#initialize (instance method)">- (SteamGame) <strong>initialize</strong>(app_id, game_data) </a>
409
+
410
+
411
+
412
+ </span>
413
+
414
+
415
+ <span class="note title constructor">constructor</span>
416
+
417
+
418
+ <span class="note title private">private</span>
419
+
420
+
421
+
422
+
423
+
424
+ <span class="summary_desc"><div class='inline'>
425
+ <p>Creates a new instance of a game with the given data and caches it.</p>
426
+ </div></span>
427
+
428
+ </li>
429
+
430
+
431
+ <li class="public ">
432
+ <span class="summary_signature">
433
+
434
+ <a href="#leaderboard-instance_method" title="#leaderboard (instance method)">- (GameLeaderboard) <strong>leaderboard</strong>(id) </a>
435
+
436
+
437
+
438
+ </span>
439
+
440
+
441
+
442
+
443
+
444
+
445
+
446
+
447
+
448
+ <span class="summary_desc"><div class='inline'>
449
+ <p>Returns the leaderboard for this game and the given leaderboard ID or name.</p>
450
+ </div></span>
451
+
452
+ </li>
453
+
454
+
455
+ <li class="public ">
456
+ <span class="summary_signature">
457
+
458
+ <a href="#leaderboards-instance_method" title="#leaderboards (instance method)">- (Array&lt;GameLeaderboard&gt;) <strong>leaderboards</strong> </a>
459
+
460
+
461
+
462
+ </span>
463
+
464
+
465
+
466
+
467
+
468
+
469
+
470
+
471
+
472
+ <span class="summary_desc"><div class='inline'>
473
+ <p>Returns an array containing all of this game&#39;s leaderboards.</p>
474
+ </div></span>
475
+
476
+ </li>
477
+
478
+
479
+ <li class="public ">
480
+ <span class="summary_signature">
481
+
482
+ <a href="#logo_thumbnail_url-instance_method" title="#logo_thumbnail_url (instance method)">- (String) <strong>logo_thumbnail_url</strong> </a>
483
+
484
+
485
+
486
+ </span>
487
+
488
+
489
+
490
+
491
+
492
+
493
+
494
+
495
+
496
+ <span class="summary_desc"><div class='inline'>
497
+ <p>Returns the URL for the logo thumbnail image of this game.</p>
498
+ </div></span>
499
+
500
+ </li>
501
+
502
+
503
+ <li class="public ">
504
+ <span class="summary_signature">
505
+
506
+ <a href="#logo_url-instance_method" title="#logo_url (instance method)">- (String) <strong>logo_url</strong> </a>
507
+
508
+
509
+
510
+ </span>
511
+
512
+
513
+
514
+
515
+
516
+
517
+
518
+
519
+
520
+ <span class="summary_desc"><div class='inline'>
521
+ <p>Returns the URL for the logo image of this game.</p>
522
+ </div></span>
523
+
524
+ </li>
525
+
526
+
527
+ <li class="public ">
528
+ <span class="summary_signature">
529
+
530
+ <a href="#player_count-instance_method" title="#player_count (instance method)">- (Fixnum) <strong>player_count</strong> </a>
531
+
532
+
533
+
534
+ </span>
535
+
536
+
537
+
538
+
539
+
540
+
541
+
542
+
543
+
544
+ <span class="summary_desc"><div class='inline'>
545
+ <p>Returns the overall number of players currently playing this game.</p>
546
+ </div></span>
547
+
548
+ </li>
549
+
550
+
551
+ <li class="public ">
552
+ <span class="summary_signature">
553
+
554
+ <a href="#store_url-instance_method" title="#store_url (instance method)">- (String) <strong>store_url</strong> </a>
555
+
556
+
557
+
558
+ </span>
559
+
560
+
561
+
562
+
563
+
564
+
565
+
566
+
567
+
568
+ <span class="summary_desc"><div class='inline'>
569
+ <p>Returns the URL of this game&#39;s page in the Steam Store.</p>
570
+ </div></span>
571
+
572
+ </li>
573
+
574
+
575
+ <li class="public ">
576
+ <span class="summary_signature">
577
+
578
+ <a href="#uptodate%3F-instance_method" title="#uptodate? (instance method)">- (Boolean) <strong>uptodate?</strong>(version) </a>
579
+
580
+
581
+
582
+ </span>
583
+
584
+
585
+
586
+
587
+
588
+
589
+
590
+
591
+
592
+ <span class="summary_desc"><div class='inline'>
593
+ <p>Returns whether the given version of this game is up-to-date.</p>
594
+ </div></span>
595
+
596
+ </li>
597
+
598
+
599
+ <li class="public ">
600
+ <span class="summary_signature">
601
+
602
+ <a href="#user_stats-instance_method" title="#user_stats (instance method)">- (GameStats) <strong>user_stats</strong>(steam_id) </a>
603
+
604
+
605
+
606
+ </span>
607
+
608
+
609
+
610
+
611
+
612
+
613
+
614
+
615
+
616
+ <span class="summary_desc"><div class='inline'>
617
+ <p>Creates a stats object for the given user and this game.</p>
618
+ </div></span>
619
+
620
+ </li>
621
+
622
+
623
+ </ul>
624
+
625
+
626
+
627
+
628
+
629
+
630
+
631
+
632
+
633
+
634
+
635
+ <h3 class="inherited">Methods included from <span class='object_link'><a href="Cacheable.html" title="Cacheable (module)">Cacheable</a></span></h3>
636
+ <p class="inherited"><span class='object_link'><a href="Cacheable.html#cache-instance_method" title="Cacheable#cache (method)">#cache</a></span>, <span class='object_link'><a href="Cacheable.html#cache_id_value-instance_method" title="Cacheable#cache_id_value (method)">#cache_id_value</a></span>, <span class='object_link'><a href="Cacheable.html#cache_ids-instance_method" title="Cacheable#cache_ids (method)">#cache_ids</a></span>, <span class='object_link'><a href="Cacheable.html#cached_instance-instance_method" title="Cacheable#cached_instance (method)">#cached_instance</a></span>, <span class='object_link'><a href="Cacheable.html#fetch-instance_method" title="Cacheable#fetch (method)">#fetch</a></span>, <span class='object_link'><a href="Cacheable.html#fetched%3F-instance_method" title="Cacheable#fetched? (method)">#fetched?</a></span>, <span class='object_link'><a href="Cacheable.html#included-class_method" title="Cacheable.included (method)">included</a></span></p>
637
+ <div id="constructor_details" class="method_details_list">
638
+ <h2>Constructor Details</h2>
639
+
640
+ <div class="method_details first">
641
+ <h3 class="signature first" id="initialize-instance_method">
642
+
643
+ - (<tt><span class='object_link'><a href="" title="SteamGame (class)">SteamGame</a></span></tt>) <strong>initialize</strong>(app_id, game_data) <span class="extras">(private)</span>
644
+
645
+
646
+
647
+
648
+
649
+ </h3><div class="docstring">
650
+ <div class="discussion">
651
+
652
+ <div class="note notetag">
653
+ <strong>Note:</strong>
654
+ <div class='inline'>
655
+ <p>The real constructor of <code>SteamGame</code> is <span class='object_link'><a href="#new-class_method" title="SteamGame.new (method)">new</a></span></p>
656
+ </div>
657
+ </div>
658
+
659
+
660
+ <p>Creates a new instance of a game with the given data and caches it</p>
661
+
662
+
663
+ </div>
664
+ </div>
665
+ <div class="tags">
666
+ <p class="tag_title">Parameters:</p>
667
+ <ul class="param">
668
+
669
+ <li>
670
+
671
+ <span class='name'>app_id</span>
672
+
673
+
674
+ <span class='type'>(<tt>Fixnum</tt>)</span>
675
+
676
+
677
+
678
+ &mdash;
679
+ <div class='inline'>
680
+ <p>The application ID of the game</p>
681
+ </div>
682
+
683
+ </li>
684
+
685
+ <li>
686
+
687
+ <span class='name'>game_data</span>
688
+
689
+
690
+ <span class='type'>(<tt>Hash&lt;String, Object&gt;</tt>)</span>
691
+
692
+
693
+
694
+ &mdash;
695
+ <div class='inline'>
696
+ <p>The XML data of the game</p>
697
+ </div>
698
+
699
+ </li>
700
+
701
+ </ul>
702
+
703
+
704
+ </div><table class="source_code">
705
+ <tr>
706
+ <td>
707
+ <pre class="lines">
708
+
709
+
710
+ 173
711
+ 174
712
+ 175
713
+ 176
714
+ 177
715
+ 178
716
+ 179
717
+ 180
718
+ 181
719
+ 182
720
+ 183
721
+ 184
722
+ 185
723
+ 186
724
+ 187
725
+ 188
726
+ 189
727
+ 190
728
+ 191</pre>
729
+ </td>
730
+ <td>
731
+ <pre class="code"><span class="info file"># File 'lib/steam/community/steam_game.rb', line 173</span>
732
+
733
+ <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_app_id'>app_id</span><span class='comma'>,</span> <span class='id identifier rubyid_game_data'>game_data</span><span class='rparen'>)</span>
734
+ <span class='ivar'>@app_id</span> <span class='op'>=</span> <span class='id identifier rubyid_app_id'>app_id</span>
735
+
736
+ <span class='kw'>if</span> <span class='id identifier rubyid_game_data'>game_data</span><span class='period'>.</span><span class='id identifier rubyid_key?'>key?</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>name</span><span class='tstring_end'>&#39;</span></span>
737
+ <span class='id identifier rubyid_hash'>hash</span> <span class='op'>=</span> <span class='id identifier rubyid_game_data'>game_data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>logo</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_match'>match</span> <span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>\/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_app_id'>app_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>\/([0-9a-f]+).jpg</span><span class='regexp_end'>/</span></span>
738
+ <span class='ivar'>@logo_hash</span> <span class='op'>=</span> <span class='id identifier rubyid_hash'>hash</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span> <span class='kw'>unless</span> <span class='id identifier rubyid_hash'>hash</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
739
+ <span class='ivar'>@name</span> <span class='op'>=</span> <span class='id identifier rubyid_game_data'>game_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>
740
+
741
+ <span class='kw'>if</span> <span class='id identifier rubyid_game_data'>game_data</span><span class='period'>.</span><span class='id identifier rubyid_key?'>key?</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>globalStatsLink</span><span class='tstring_end'>&#39;</span></span>
742
+ <span class='ivar'>@short_name</span> <span class='op'>=</span> <span class='id identifier rubyid_game_data'>game_data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>globalStatsLink</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_match'>match</span><span class='lparen'>(</span><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>http:\/\/steamcommunity.com\/stats\/([^?\/]+)\/achievements\/</span><span class='regexp_end'>/</span></span><span class='rparen'>)</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_downcase'>downcase</span>
743
+ <span class='kw'>end</span>
744
+ <span class='kw'>else</span>
745
+ <span class='ivar'>@icon_url</span> <span class='op'>=</span> <span class='id identifier rubyid_game_data'>game_data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>gameIcon</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
746
+ <span class='ivar'>@logo_hash</span> <span class='op'>=</span> <span class='id identifier rubyid_game_data'>game_data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>gameLogo</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_match'>match</span><span class='lparen'>(</span><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>\/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_app_id'>app_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>\/([0-9a-f]+).jpg</span><span class='regexp_end'>/</span></span><span class='rparen'>)</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span>
747
+ <span class='ivar'>@name</span> <span class='op'>=</span> <span class='id identifier rubyid_game_data'>game_data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>gameName</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
748
+ <span class='ivar'>@short_name</span> <span class='op'>=</span> <span class='id identifier rubyid_game_data'>game_data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>gameFriendlyName</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_downcase'>downcase</span>
749
+ <span class='ivar'>@short_name</span> <span class='op'>=</span> <span class='ivar'>@app_id</span> <span class='kw'>if</span> <span class='ivar'>@short_name</span> <span class='op'>==</span> <span class='ivar'>@app_id</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span>
750
+ <span class='kw'>end</span>
751
+ <span class='kw'>end</span></pre>
752
+ </td>
753
+ </tr>
754
+ </table>
755
+ </div>
756
+
757
+ </div>
758
+
759
+ <div id="instance_attr_details" class="attr_details">
760
+ <h2>Instance Attribute Details</h2>
761
+
762
+
763
+ <span id=""></span>
764
+ <div class="method_details first">
765
+ <h3 class="signature first" id="app_id-instance_method">
766
+
767
+ - (<tt>Fixnum</tt>) <strong>app_id</strong> <span class="extras">(readonly)</span>
768
+
769
+
770
+
771
+
772
+
773
+ </h3><div class="docstring">
774
+ <div class="discussion">
775
+
776
+ <p>Returns the Steam application ID of this game</p>
777
+
778
+
779
+ </div>
780
+ </div>
781
+ <div class="tags">
782
+
783
+ <p class="tag_title">Returns:</p>
784
+ <ul class="return">
785
+
786
+ <li>
787
+
788
+
789
+ <span class='type'>(<tt>Fixnum</tt>)</span>
790
+
791
+
792
+
793
+ &mdash;
794
+ <div class='inline'>
795
+ <p>The Steam application ID of this game</p>
796
+ </div>
797
+
798
+ </li>
799
+
800
+ </ul>
801
+
802
+ </div><table class="source_code">
803
+ <tr>
804
+ <td>
805
+ <pre class="lines">
806
+
807
+
808
+ 22
809
+ 23
810
+ 24</pre>
811
+ </td>
812
+ <td>
813
+ <pre class="code"><span class="info file"># File 'lib/steam/community/steam_game.rb', line 22</span>
814
+
815
+ <span class='kw'>def</span> <span class='id identifier rubyid_app_id'>app_id</span>
816
+ <span class='ivar'>@app_id</span>
817
+ <span class='kw'>end</span></pre>
818
+ </td>
819
+ </tr>
820
+ </table>
821
+ </div>
822
+
823
+
824
+ <span id=""></span>
825
+ <div class="method_details ">
826
+ <h3 class="signature " id="icon_url-instance_method">
827
+
828
+ - (<tt>String</tt>) <strong>icon_url</strong> <span class="extras">(readonly)</span>
829
+
830
+
831
+
832
+
833
+
834
+ </h3><div class="docstring">
835
+ <div class="discussion">
836
+
837
+ <p>Returns the URL for the icon image of this game</p>
838
+
839
+
840
+ </div>
841
+ </div>
842
+ <div class="tags">
843
+
844
+ <p class="tag_title">Returns:</p>
845
+ <ul class="return">
846
+
847
+ <li>
848
+
849
+
850
+ <span class='type'>(<tt>String</tt>)</span>
851
+
852
+
853
+
854
+ &mdash;
855
+ <div class='inline'>
856
+ <p>The URL for the game icon</p>
857
+ </div>
858
+
859
+ </li>
860
+
861
+ </ul>
862
+
863
+ </div><table class="source_code">
864
+ <tr>
865
+ <td>
866
+ <pre class="lines">
867
+
868
+
869
+ 27
870
+ 28
871
+ 29</pre>
872
+ </td>
873
+ <td>
874
+ <pre class="code"><span class="info file"># File 'lib/steam/community/steam_game.rb', line 27</span>
875
+
876
+ <span class='kw'>def</span> <span class='id identifier rubyid_icon_url'>icon_url</span>
877
+ <span class='ivar'>@icon_url</span>
878
+ <span class='kw'>end</span></pre>
879
+ </td>
880
+ </tr>
881
+ </table>
882
+ </div>
883
+
884
+
885
+ <span id=""></span>
886
+ <div class="method_details ">
887
+ <h3 class="signature " id="name-instance_method">
888
+
889
+ - (<tt>String</tt>) <strong>name</strong> <span class="extras">(readonly)</span>
890
+
891
+
892
+
893
+
894
+
895
+ </h3><div class="docstring">
896
+ <div class="discussion">
897
+
898
+ <p>Returns the full name of this game</p>
899
+
900
+
901
+ </div>
902
+ </div>
903
+ <div class="tags">
904
+
905
+ <p class="tag_title">Returns:</p>
906
+ <ul class="return">
907
+
908
+ <li>
909
+
910
+
911
+ <span class='type'>(<tt>String</tt>)</span>
912
+
913
+
914
+
915
+ &mdash;
916
+ <div class='inline'>
917
+ <p>The full name of this game</p>
918
+ </div>
919
+
920
+ </li>
921
+
922
+ </ul>
923
+
924
+ </div><table class="source_code">
925
+ <tr>
926
+ <td>
927
+ <pre class="lines">
928
+
929
+
930
+ 32
931
+ 33
932
+ 34</pre>
933
+ </td>
934
+ <td>
935
+ <pre class="code"><span class="info file"># File 'lib/steam/community/steam_game.rb', line 32</span>
936
+
937
+ <span class='kw'>def</span> <span class='id identifier rubyid_name'>name</span>
938
+ <span class='ivar'>@name</span>
939
+ <span class='kw'>end</span></pre>
940
+ </td>
941
+ </tr>
942
+ </table>
943
+ </div>
944
+
945
+
946
+ <span id=""></span>
947
+ <div class="method_details ">
948
+ <h3 class="signature " id="short_name-instance_method">
949
+
950
+ - (<tt>String</tt>) <strong>short_name</strong> <span class="extras">(readonly)</span>
951
+
952
+
953
+
954
+
955
+
956
+ </h3><div class="docstring">
957
+ <div class="discussion">
958
+
959
+ <p>Returns the short name of this game (also known as “friendly name”)</p>
960
+
961
+
962
+ </div>
963
+ </div>
964
+ <div class="tags">
965
+
966
+ <p class="tag_title">Returns:</p>
967
+ <ul class="return">
968
+
969
+ <li>
970
+
971
+
972
+ <span class='type'>(<tt>String</tt>)</span>
973
+
974
+
975
+
976
+ &mdash;
977
+ <div class='inline'>
978
+ <p>The short name of this game</p>
979
+ </div>
980
+
981
+ </li>
982
+
983
+ </ul>
984
+
985
+ </div><table class="source_code">
986
+ <tr>
987
+ <td>
988
+ <pre class="lines">
989
+
990
+
991
+ 37
992
+ 38
993
+ 39</pre>
994
+ </td>
995
+ <td>
996
+ <pre class="code"><span class="info file"># File 'lib/steam/community/steam_game.rb', line 37</span>
997
+
998
+ <span class='kw'>def</span> <span class='id identifier rubyid_short_name'>short_name</span>
999
+ <span class='ivar'>@short_name</span>
1000
+ <span class='kw'>end</span></pre>
1001
+ </td>
1002
+ </tr>
1003
+ </table>
1004
+ </div>
1005
+
1006
+ </div>
1007
+
1008
+
1009
+ <div id="class_method_details" class="method_details_list">
1010
+ <h2>Class Method Details</h2>
1011
+
1012
+
1013
+ <div class="method_details first">
1014
+ <h3 class="signature first" id="check_steam_inf-class_method">
1015
+
1016
+ + (<tt>Boolean</tt>) <strong>check_steam_inf</strong>(path)
1017
+
1018
+
1019
+
1020
+
1021
+
1022
+ </h3><div class="docstring">
1023
+ <div class="discussion">
1024
+
1025
+ <p>Checks if a game is up-to-date by reading information from a
1026
+ <code>steam.inf</code>
1027
+ file and comparing it using the Web API</p>
1028
+
1029
+
1030
+ </div>
1031
+ </div>
1032
+ <div class="tags">
1033
+ <p class="tag_title">Parameters:</p>
1034
+ <ul class="param">
1035
+
1036
+ <li>
1037
+
1038
+ <span class='name'>path</span>
1039
+
1040
+
1041
+ <span class='type'>(<tt>String</tt>)</span>
1042
+
1043
+
1044
+
1045
+ &mdash;
1046
+ <div class='inline'>
1047
+ <p>The file system path of the <code>steam.inf</code> file</p>
1048
+ </div>
1049
+
1050
+ </li>
1051
+
1052
+ </ul>
1053
+
1054
+ <p class="tag_title">Returns:</p>
1055
+ <ul class="return">
1056
+
1057
+ <li>
1058
+
1059
+
1060
+ <span class='type'>(<tt>Boolean</tt>)</span>
1061
+
1062
+
1063
+
1064
+ &mdash;
1065
+ <div class='inline'>
1066
+ <p><code>true</code> if the game is up-to-date</p>
1067
+ </div>
1068
+
1069
+ </li>
1070
+
1071
+ </ul>
1072
+
1073
+ </div><table class="source_code">
1074
+ <tr>
1075
+ <td>
1076
+ <pre class="lines">
1077
+
1078
+
1079
+ 44
1080
+ 45
1081
+ 46
1082
+ 47
1083
+ 48
1084
+ 49
1085
+ 50
1086
+ 51
1087
+ 52
1088
+ 53</pre>
1089
+ </td>
1090
+ <td>
1091
+ <pre class="code"><span class="info file"># File 'lib/steam/community/steam_game.rb', line 44</span>
1092
+
1093
+ <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_check_steam_inf'>check_steam_inf</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span>
1094
+ <span class='id identifier rubyid_steam_inf'>steam_inf</span> <span class='op'>=</span> <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_read'>read</span> <span class='id identifier rubyid_path'>path</span>
1095
+ <span class='kw'>begin</span>
1096
+ <span class='id identifier rubyid_app_id'>app_id</span> <span class='op'>=</span> <span class='id identifier rubyid_steam_inf'>steam_inf</span><span class='period'>.</span><span class='id identifier rubyid_match'>match</span><span class='lparen'>(</span><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>^\s*appID=(\d+)\s*$</span><span class='regexp_end'>/im</span></span><span class='rparen'>)</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span>
1097
+ <span class='id identifier rubyid_version'>version</span> <span class='op'>=</span> <span class='id identifier rubyid_steam_inf'>steam_inf</span><span class='period'>.</span><span class='id identifier rubyid_match'>match</span><span class='lparen'>(</span><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>^\s*PatchVersion=([\d\.]+)\s*$</span><span class='regexp_end'>/im</span></span><span class='rparen'>)</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_gsub'>gsub</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>.</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span>
1098
+ <span class='kw'>rescue</span>
1099
+ <span class='id identifier rubyid_raise'>raise</span> <span class='const'>SteamCondenserError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>The steam.inf file at \&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_path'>path</span><span class='embexpr_end'>}</span><span class='tstring_content'>\&quot; is invalid.</span><span class='tstring_end'>&quot;</span></span>
1100
+ <span class='kw'>end</span>
1101
+ <span class='id identifier rubyid_uptodate?'>uptodate?</span> <span class='id identifier rubyid_app_id'>app_id</span><span class='comma'>,</span> <span class='id identifier rubyid_version'>version</span>
1102
+ <span class='kw'>end</span></pre>
1103
+ </td>
1104
+ </tr>
1105
+ </table>
1106
+ </div>
1107
+
1108
+ <div class="method_details ">
1109
+ <h3 class="signature " id="new-class_method">
1110
+
1111
+ + (<tt>Object</tt>) <strong>new</strong>(app_id, game_data = nil)
1112
+
1113
+
1114
+
1115
+
1116
+
1117
+ </h3><div class="docstring">
1118
+ <div class="discussion">
1119
+
1120
+ <p>Creates a new instance of a game with the given data and caches it</p>
1121
+
1122
+
1123
+ </div>
1124
+ </div>
1125
+ <div class="tags">
1126
+ <p class="tag_title">Parameters:</p>
1127
+ <ul class="param">
1128
+
1129
+ <li>
1130
+
1131
+ <span class='name'>app_id</span>
1132
+
1133
+
1134
+ <span class='type'>(<tt>Fixnum</tt>)</span>
1135
+
1136
+
1137
+
1138
+ &mdash;
1139
+ <div class='inline'>
1140
+ <p>The application ID of the game</p>
1141
+ </div>
1142
+
1143
+ </li>
1144
+
1145
+ <li>
1146
+
1147
+ <span class='name'>game_data</span>
1148
+
1149
+
1150
+ <span class='type'>(<tt>Hash&lt;String, Object&gt;</tt>)</span>
1151
+
1152
+
1153
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1154
+
1155
+
1156
+ &mdash;
1157
+ <div class='inline'>
1158
+ <p>The XML data of the game</p>
1159
+ </div>
1160
+
1161
+ </li>
1162
+
1163
+ </ul>
1164
+
1165
+
1166
+ </div><table class="source_code">
1167
+ <tr>
1168
+ <td>
1169
+ <pre class="lines">
1170
+
1171
+
1172
+ 59
1173
+ 60
1174
+ 61
1175
+ 62
1176
+ 63
1177
+ 64
1178
+ 65
1179
+ 66
1180
+ 67</pre>
1181
+ </td>
1182
+ <td>
1183
+ <pre class="code"><span class="info file"># File 'lib/steam/community/steam_game.rb', line 59</span>
1184
+
1185
+ <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_app_id'>app_id</span><span class='comma'>,</span> <span class='id identifier rubyid_game_data'>game_data</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
1186
+ <span class='kw'>if</span> <span class='id identifier rubyid_cached?'>cached?</span> <span class='id identifier rubyid_app_id'>app_id</span>
1187
+ <span class='id identifier rubyid_class_variable_get'>class_variable_get</span><span class='lparen'>(</span><span class='symbol'>:@@cache</span><span class='rparen'>)</span><span class='lbracket'>[</span><span class='id identifier rubyid_app_id'>app_id</span><span class='rbracket'>]</span>
1188
+ <span class='kw'>else</span>
1189
+ <span class='id identifier rubyid_game'>game</span> <span class='op'>=</span> <span class='const'>SteamGame</span><span class='period'>.</span><span class='id identifier rubyid_allocate'>allocate</span>
1190
+ <span class='id identifier rubyid_game'>game</span><span class='period'>.</span><span class='id identifier rubyid_send'>send</span> <span class='symbol'>:initialize</span><span class='comma'>,</span> <span class='id identifier rubyid_app_id'>app_id</span><span class='comma'>,</span> <span class='id identifier rubyid_game_data'>game_data</span>
1191
+ <span class='id identifier rubyid_game'>game</span>
1192
+ <span class='kw'>end</span>
1193
+ <span class='kw'>end</span></pre>
1194
+ </td>
1195
+ </tr>
1196
+ </table>
1197
+ </div>
1198
+
1199
+ <div class="method_details ">
1200
+ <h3 class="signature " id="uptodate?-class_method">
1201
+
1202
+ + (<tt>Boolean</tt>) <strong>uptodate?</strong>(app_id, version)
1203
+
1204
+
1205
+
1206
+
1207
+
1208
+ </h3><div class="docstring">
1209
+ <div class="discussion">
1210
+
1211
+ <p>Returns whether the given version of the game with the given application
1212
+ ID
1213
+ is up-to-date</p>
1214
+
1215
+
1216
+ </div>
1217
+ </div>
1218
+ <div class="tags">
1219
+ <p class="tag_title">Parameters:</p>
1220
+ <ul class="param">
1221
+
1222
+ <li>
1223
+
1224
+ <span class='name'>app_id</span>
1225
+
1226
+
1227
+ <span class='type'>(<tt>Fixnum</tt>)</span>
1228
+
1229
+
1230
+
1231
+ &mdash;
1232
+ <div class='inline'>
1233
+ <p>The application ID of the game to check</p>
1234
+ </div>
1235
+
1236
+ </li>
1237
+
1238
+ <li>
1239
+
1240
+ <span class='name'>version</span>
1241
+
1242
+
1243
+ <span class='type'>(<tt>Fixnum</tt>)</span>
1244
+
1245
+
1246
+
1247
+ &mdash;
1248
+ <div class='inline'>
1249
+ <p>The version to check against the Web API</p>
1250
+ </div>
1251
+
1252
+ </li>
1253
+
1254
+ </ul>
1255
+
1256
+ <p class="tag_title">Returns:</p>
1257
+ <ul class="return">
1258
+
1259
+ <li>
1260
+
1261
+
1262
+ <span class='type'>(<tt>Boolean</tt>)</span>
1263
+
1264
+
1265
+
1266
+ &mdash;
1267
+ <div class='inline'>
1268
+ <p><code>true</code> if the given version is up-to-date</p>
1269
+ </div>
1270
+
1271
+ </li>
1272
+
1273
+ </ul>
1274
+ <p class="tag_title">Raises:</p>
1275
+ <ul class="raise">
1276
+
1277
+ <li>
1278
+
1279
+
1280
+ <span class='type'>(<tt><span class='object_link'><a href="SteamCondenserError.html" title="SteamCondenserError (class)">SteamCondenserError</a></span></tt>)</span>
1281
+
1282
+
1283
+
1284
+ </li>
1285
+
1286
+ </ul>
1287
+
1288
+ </div><table class="source_code">
1289
+ <tr>
1290
+ <td>
1291
+ <pre class="lines">
1292
+
1293
+
1294
+ 75
1295
+ 76
1296
+ 77
1297
+ 78
1298
+ 79
1299
+ 80
1300
+ 81</pre>
1301
+ </td>
1302
+ <td>
1303
+ <pre class="code"><span class="info file"># File 'lib/steam/community/steam_game.rb', line 75</span>
1304
+
1305
+ <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_uptodate?'>uptodate?</span><span class='lparen'>(</span><span class='id identifier rubyid_app_id'>app_id</span><span class='comma'>,</span> <span class='id identifier rubyid_version'>version</span><span class='rparen'>)</span>
1306
+ <span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='symbol'>:appid</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_app_id'>app_id</span><span class='comma'>,</span> <span class='symbol'>:version</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_version'>version</span> <span class='rbrace'>}</span>
1307
+ <span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='const'>WebApi</span><span class='period'>.</span><span class='id identifier rubyid_json'>json</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>ISteamApps</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>UpToDateCheck</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='int'>1</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span>
1308
+ <span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='const'>MultiJson</span><span class='period'>.</span><span class='id identifier rubyid_load'>load</span><span class='lparen'>(</span><span class='id identifier rubyid_result'>result</span><span class='comma'>,</span> <span class='lbrace'>{</span> <span class='symbol'>:symbolize_keys</span> <span class='op'>=&gt;</span> <span class='kw'>true</span><span class='rbrace'>}</span><span class='rparen'>)</span><span class='lbracket'>[</span><span class='symbol'>:response</span><span class='rbracket'>]</span>
1309
+ <span class='id identifier rubyid_raise'>raise</span> <span class='const'>SteamCondenserError</span><span class='comma'>,</span> <span class='id identifier rubyid_result'>result</span><span class='lbracket'>[</span><span class='symbol'>:error</span><span class='rbracket'>]</span> <span class='kw'>unless</span> <span class='id identifier rubyid_result'>result</span><span class='lbracket'>[</span><span class='symbol'>:success</span><span class='rbracket'>]</span>
1310
+ <span class='id identifier rubyid_result'>result</span><span class='lbracket'>[</span><span class='symbol'>:up_to_date</span><span class='rbracket'>]</span>
1311
+ <span class='kw'>end</span></pre>
1312
+ </td>
1313
+ </tr>
1314
+ </table>
1315
+ </div>
1316
+
1317
+ </div>
1318
+
1319
+ <div id="instance_method_details" class="method_details_list">
1320
+ <h2>Instance Method Details</h2>
1321
+
1322
+
1323
+ <div class="method_details first">
1324
+ <h3 class="signature first" id="has_stats?-instance_method">
1325
+
1326
+ - (<tt>Boolean</tt>) <strong>has_stats?</strong>
1327
+
1328
+
1329
+
1330
+
1331
+
1332
+ </h3><div class="docstring">
1333
+ <div class="discussion">
1334
+
1335
+ <p>Returns whether this game has statistics available</p>
1336
+
1337
+
1338
+ </div>
1339
+ </div>
1340
+ <div class="tags">
1341
+
1342
+ <p class="tag_title">Returns:</p>
1343
+ <ul class="return">
1344
+
1345
+ <li>
1346
+
1347
+
1348
+ <span class='type'>(<tt>Boolean</tt>)</span>
1349
+
1350
+
1351
+
1352
+ &mdash;
1353
+ <div class='inline'>
1354
+ <p><code>true</code> if this game has stats</p>
1355
+ </div>
1356
+
1357
+ </li>
1358
+
1359
+ </ul>
1360
+
1361
+ </div><table class="source_code">
1362
+ <tr>
1363
+ <td>
1364
+ <pre class="lines">
1365
+
1366
+
1367
+ 96
1368
+ 97
1369
+ 98</pre>
1370
+ </td>
1371
+ <td>
1372
+ <pre class="code"><span class="info file"># File 'lib/steam/community/steam_game.rb', line 96</span>
1373
+
1374
+ <span class='kw'>def</span> <span class='id identifier rubyid_has_stats?'>has_stats?</span>
1375
+ <span class='op'>!</span><span class='ivar'>@short_name</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
1376
+ <span class='kw'>end</span></pre>
1377
+ </td>
1378
+ </tr>
1379
+ </table>
1380
+ </div>
1381
+
1382
+ <div class="method_details ">
1383
+ <h3 class="signature " id="id-instance_method">
1384
+
1385
+ - (<tt>Fixnum</tt>, <tt>String</tt>) <strong>id</strong>
1386
+
1387
+
1388
+
1389
+
1390
+
1391
+ </h3><div class="docstring">
1392
+ <div class="discussion">
1393
+
1394
+ <p>Returns a unique identifier for this game</p>
1395
+
1396
+ <p>This is either the numeric application ID or the unique short name</p>
1397
+
1398
+
1399
+ </div>
1400
+ </div>
1401
+ <div class="tags">
1402
+
1403
+ <p class="tag_title">Returns:</p>
1404
+ <ul class="return">
1405
+
1406
+ <li>
1407
+
1408
+
1409
+ <span class='type'>(<tt>Fixnum</tt>, <tt>String</tt>)</span>
1410
+
1411
+
1412
+
1413
+ &mdash;
1414
+ <div class='inline'>
1415
+ <p>The application ID or short name of the game</p>
1416
+ </div>
1417
+
1418
+ </li>
1419
+
1420
+ </ul>
1421
+
1422
+ </div><table class="source_code">
1423
+ <tr>
1424
+ <td>
1425
+ <pre class="lines">
1426
+
1427
+
1428
+ 105
1429
+ 106
1430
+ 107</pre>
1431
+ </td>
1432
+ <td>
1433
+ <pre class="code"><span class="info file"># File 'lib/steam/community/steam_game.rb', line 105</span>
1434
+
1435
+ <span class='kw'>def</span> <span class='id identifier rubyid_id'>id</span>
1436
+ <span class='ivar'>@short_name</span> <span class='op'>==</span> <span class='ivar'>@app_id</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span> <span class='op'>?</span> <span class='ivar'>@app_id</span> <span class='op'>:</span> <span class='ivar'>@short_name</span>
1437
+ <span class='kw'>end</span></pre>
1438
+ </td>
1439
+ </tr>
1440
+ </table>
1441
+ </div>
1442
+
1443
+ <div class="method_details ">
1444
+ <h3 class="signature " id="leaderboard-instance_method">
1445
+
1446
+ - (<tt><span class='object_link'><a href="GameLeaderboard.html" title="GameLeaderboard (class)">GameLeaderboard</a></span></tt>) <strong>leaderboard</strong>(id)
1447
+
1448
+
1449
+
1450
+
1451
+
1452
+ </h3><div class="docstring">
1453
+ <div class="discussion">
1454
+
1455
+ <p>Returns the leaderboard for this game and the given leaderboard ID or name</p>
1456
+
1457
+
1458
+ </div>
1459
+ </div>
1460
+ <div class="tags">
1461
+ <p class="tag_title">Parameters:</p>
1462
+ <ul class="param">
1463
+
1464
+ <li>
1465
+
1466
+ <span class='name'>id</span>
1467
+
1468
+
1469
+ <span class='type'>(<tt>Fixnum</tt>, <tt>String</tt>)</span>
1470
+
1471
+
1472
+
1473
+ &mdash;
1474
+ <div class='inline'>
1475
+ <p>The ID or name of the leaderboard to return</p>
1476
+ </div>
1477
+
1478
+ </li>
1479
+
1480
+ </ul>
1481
+
1482
+ <p class="tag_title">Returns:</p>
1483
+ <ul class="return">
1484
+
1485
+ <li>
1486
+
1487
+
1488
+ <span class='type'>(<tt><span class='object_link'><a href="GameLeaderboard.html" title="GameLeaderboard (class)">GameLeaderboard</a></span></tt>)</span>
1489
+
1490
+
1491
+
1492
+ &mdash;
1493
+ <div class='inline'>
1494
+ <p>The matching leaderboard if available</p>
1495
+ </div>
1496
+
1497
+ </li>
1498
+
1499
+ </ul>
1500
+
1501
+ </div><table class="source_code">
1502
+ <tr>
1503
+ <td>
1504
+ <pre class="lines">
1505
+
1506
+
1507
+ 113
1508
+ 114
1509
+ 115</pre>
1510
+ </td>
1511
+ <td>
1512
+ <pre class="code"><span class="info file"># File 'lib/steam/community/steam_game.rb', line 113</span>
1513
+
1514
+ <span class='kw'>def</span> <span class='id identifier rubyid_leaderboard'>leaderboard</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='rparen'>)</span>
1515
+ <span class='const'>GameLeaderboard</span><span class='period'>.</span><span class='id identifier rubyid_leaderboard'>leaderboard</span> <span class='ivar'>@short_name</span><span class='comma'>,</span> <span class='id identifier rubyid_id'>id</span>
1516
+ <span class='kw'>end</span></pre>
1517
+ </td>
1518
+ </tr>
1519
+ </table>
1520
+ </div>
1521
+
1522
+ <div class="method_details ">
1523
+ <h3 class="signature " id="leaderboards-instance_method">
1524
+
1525
+ - (<tt>Array&lt;<span class='object_link'><a href="GameLeaderboard.html" title="GameLeaderboard (class)">GameLeaderboard</a></span>&gt;</tt>) <strong>leaderboards</strong>
1526
+
1527
+
1528
+
1529
+
1530
+
1531
+ </h3><div class="docstring">
1532
+ <div class="discussion">
1533
+
1534
+ <p>Returns an array containing all of this game&#39;s leaderboards</p>
1535
+
1536
+
1537
+ </div>
1538
+ </div>
1539
+ <div class="tags">
1540
+
1541
+ <p class="tag_title">Returns:</p>
1542
+ <ul class="return">
1543
+
1544
+ <li>
1545
+
1546
+
1547
+ <span class='type'>(<tt>Array&lt;<span class='object_link'><a href="GameLeaderboard.html" title="GameLeaderboard (class)">GameLeaderboard</a></span>&gt;</tt>)</span>
1548
+
1549
+
1550
+
1551
+ &mdash;
1552
+ <div class='inline'>
1553
+ <p>The leaderboards for this game</p>
1554
+ </div>
1555
+
1556
+ </li>
1557
+
1558
+ </ul>
1559
+
1560
+ </div><table class="source_code">
1561
+ <tr>
1562
+ <td>
1563
+ <pre class="lines">
1564
+
1565
+
1566
+ 120
1567
+ 121
1568
+ 122</pre>
1569
+ </td>
1570
+ <td>
1571
+ <pre class="code"><span class="info file"># File 'lib/steam/community/steam_game.rb', line 120</span>
1572
+
1573
+ <span class='kw'>def</span> <span class='id identifier rubyid_leaderboards'>leaderboards</span>
1574
+ <span class='const'>GameLeaderboard</span><span class='period'>.</span><span class='id identifier rubyid_leaderboards'>leaderboards</span> <span class='ivar'>@short_name</span>
1575
+ <span class='kw'>end</span></pre>
1576
+ </td>
1577
+ </tr>
1578
+ </table>
1579
+ </div>
1580
+
1581
+ <div class="method_details ">
1582
+ <h3 class="signature " id="logo_thumbnail_url-instance_method">
1583
+
1584
+ - (<tt>String</tt>) <strong>logo_thumbnail_url</strong>
1585
+
1586
+
1587
+
1588
+
1589
+
1590
+ </h3><div class="docstring">
1591
+ <div class="discussion">
1592
+
1593
+ <p>Returns the URL for the logo thumbnail image of this game</p>
1594
+
1595
+
1596
+ </div>
1597
+ </div>
1598
+ <div class="tags">
1599
+
1600
+ <p class="tag_title">Returns:</p>
1601
+ <ul class="return">
1602
+
1603
+ <li>
1604
+
1605
+
1606
+ <span class='type'>(<tt>String</tt>)</span>
1607
+
1608
+
1609
+
1610
+ &mdash;
1611
+ <div class='inline'>
1612
+ <p>The URL for the game logo thumbnail</p>
1613
+ </div>
1614
+
1615
+ </li>
1616
+
1617
+ </ul>
1618
+
1619
+ </div><table class="source_code">
1620
+ <tr>
1621
+ <td>
1622
+ <pre class="lines">
1623
+
1624
+
1625
+ 135
1626
+ 136
1627
+ 137
1628
+ 138</pre>
1629
+ </td>
1630
+ <td>
1631
+ <pre class="code"><span class="info file"># File 'lib/steam/community/steam_game.rb', line 135</span>
1632
+
1633
+ <span class='kw'>def</span> <span class='id identifier rubyid_logo_thumbnail_url'>logo_thumbnail_url</span>
1634
+ <span class='kw'>return</span> <span class='kw'>nil</span> <span class='kw'>if</span> <span class='ivar'>@logo_hash</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
1635
+ <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>http://media.steampowered.com/steamcommunity/public/images/apps/</span><span class='embvar'>#</span><span class='ivar'>@app_id</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='ivar'>@logo_hash</span><span class='embexpr_end'>}</span><span class='tstring_content'>_thumb.jpg</span><span class='tstring_end'>&quot;</span></span>
1636
+ <span class='kw'>end</span></pre>
1637
+ </td>
1638
+ </tr>
1639
+ </table>
1640
+ </div>
1641
+
1642
+ <div class="method_details ">
1643
+ <h3 class="signature " id="logo_url-instance_method">
1644
+
1645
+ - (<tt>String</tt>) <strong>logo_url</strong>
1646
+
1647
+
1648
+
1649
+
1650
+
1651
+ </h3><div class="docstring">
1652
+ <div class="discussion">
1653
+
1654
+ <p>Returns the URL for the logo image of this game</p>
1655
+
1656
+
1657
+ </div>
1658
+ </div>
1659
+ <div class="tags">
1660
+
1661
+ <p class="tag_title">Returns:</p>
1662
+ <ul class="return">
1663
+
1664
+ <li>
1665
+
1666
+
1667
+ <span class='type'>(<tt>String</tt>)</span>
1668
+
1669
+
1670
+
1671
+ &mdash;
1672
+ <div class='inline'>
1673
+ <p>The URL for the game logo</p>
1674
+ </div>
1675
+
1676
+ </li>
1677
+
1678
+ </ul>
1679
+
1680
+ </div><table class="source_code">
1681
+ <tr>
1682
+ <td>
1683
+ <pre class="lines">
1684
+
1685
+
1686
+ 127
1687
+ 128
1688
+ 129
1689
+ 130</pre>
1690
+ </td>
1691
+ <td>
1692
+ <pre class="code"><span class="info file"># File 'lib/steam/community/steam_game.rb', line 127</span>
1693
+
1694
+ <span class='kw'>def</span> <span class='id identifier rubyid_logo_url'>logo_url</span>
1695
+ <span class='kw'>return</span> <span class='kw'>nil</span> <span class='kw'>if</span> <span class='ivar'>@logo_hash</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
1696
+ <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>http://media.steampowered.com/steamcommunity/public/images/apps/</span><span class='embvar'>#</span><span class='ivar'>@app_id</span><span class='tstring_content'>/</span><span class='embvar'>#</span><span class='ivar'>@logo_hash</span><span class='tstring_content'>.jpg</span><span class='tstring_end'>&quot;</span></span>
1697
+ <span class='kw'>end</span></pre>
1698
+ </td>
1699
+ </tr>
1700
+ </table>
1701
+ </div>
1702
+
1703
+ <div class="method_details ">
1704
+ <h3 class="signature " id="player_count-instance_method">
1705
+
1706
+ - (<tt>Fixnum</tt>) <strong>player_count</strong>
1707
+
1708
+
1709
+
1710
+
1711
+
1712
+ </h3><div class="docstring">
1713
+ <div class="discussion">
1714
+
1715
+ <p>Returns the overall number of players currently playing this game</p>
1716
+
1717
+
1718
+ </div>
1719
+ </div>
1720
+ <div class="tags">
1721
+
1722
+ <p class="tag_title">Returns:</p>
1723
+ <ul class="return">
1724
+
1725
+ <li>
1726
+
1727
+
1728
+ <span class='type'>(<tt>Fixnum</tt>)</span>
1729
+
1730
+
1731
+
1732
+ &mdash;
1733
+ <div class='inline'>
1734
+ <p>The number of players playing this game</p>
1735
+ </div>
1736
+
1737
+ </li>
1738
+
1739
+ </ul>
1740
+
1741
+ </div><table class="source_code">
1742
+ <tr>
1743
+ <td>
1744
+ <pre class="lines">
1745
+
1746
+
1747
+ 86
1748
+ 87
1749
+ 88
1750
+ 89
1751
+ 90
1752
+ 91</pre>
1753
+ </td>
1754
+ <td>
1755
+ <pre class="code"><span class="info file"># File 'lib/steam/community/steam_game.rb', line 86</span>
1756
+
1757
+ <span class='kw'>def</span> <span class='id identifier rubyid_player_count'>player_count</span>
1758
+ <span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='symbol'>:appid</span> <span class='op'>=&gt;</span> <span class='ivar'>@app_id</span> <span class='rbrace'>}</span>
1759
+ <span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='const'>WebApi</span><span class='period'>.</span><span class='id identifier rubyid_json'>json</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>ISteamUserStats</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>GetNumberOfCurrentPlayers</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='int'>1</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span>
1760
+ <span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='const'>MultiJson</span><span class='period'>.</span><span class='id identifier rubyid_load'>load</span><span class='lparen'>(</span><span class='id identifier rubyid_result'>result</span><span class='comma'>,</span> <span class='lbrace'>{</span> <span class='symbol'>:symbolize_keys</span> <span class='op'>=&gt;</span> <span class='kw'>true</span><span class='rbrace'>}</span><span class='rparen'>)</span><span class='lbracket'>[</span><span class='symbol'>:response</span><span class='rbracket'>]</span>
1761
+ <span class='id identifier rubyid_result'>result</span><span class='lbracket'>[</span><span class='symbol'>:player_count</span><span class='rbracket'>]</span>
1762
+ <span class='kw'>end</span></pre>
1763
+ </td>
1764
+ </tr>
1765
+ </table>
1766
+ </div>
1767
+
1768
+ <div class="method_details ">
1769
+ <h3 class="signature " id="store_url-instance_method">
1770
+
1771
+ - (<tt>String</tt>) <strong>store_url</strong>
1772
+
1773
+
1774
+
1775
+
1776
+
1777
+ </h3><div class="docstring">
1778
+ <div class="discussion">
1779
+
1780
+ <p>Returns the URL of this game&#39;s page in the Steam Store</p>
1781
+
1782
+
1783
+ </div>
1784
+ </div>
1785
+ <div class="tags">
1786
+
1787
+ <p class="tag_title">Returns:</p>
1788
+ <ul class="return">
1789
+
1790
+ <li>
1791
+
1792
+
1793
+ <span class='type'>(<tt>String</tt>)</span>
1794
+
1795
+
1796
+
1797
+ &mdash;
1798
+ <div class='inline'>
1799
+ <p>This game&#39;s store page</p>
1800
+ </div>
1801
+
1802
+ </li>
1803
+
1804
+ </ul>
1805
+
1806
+ </div><table class="source_code">
1807
+ <tr>
1808
+ <td>
1809
+ <pre class="lines">
1810
+
1811
+
1812
+ 143
1813
+ 144
1814
+ 145</pre>
1815
+ </td>
1816
+ <td>
1817
+ <pre class="code"><span class="info file"># File 'lib/steam/community/steam_game.rb', line 143</span>
1818
+
1819
+ <span class='kw'>def</span> <span class='id identifier rubyid_store_url'>store_url</span>
1820
+ <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>http://store.steampowered.com/app/</span><span class='embvar'>#</span><span class='ivar'>@app_id</span><span class='tstring_end'>&quot;</span></span>
1821
+ <span class='kw'>end</span></pre>
1822
+ </td>
1823
+ </tr>
1824
+ </table>
1825
+ </div>
1826
+
1827
+ <div class="method_details ">
1828
+ <h3 class="signature " id="uptodate?-instance_method">
1829
+
1830
+ - (<tt>Boolean</tt>) <strong>uptodate?</strong>(version)
1831
+
1832
+
1833
+
1834
+
1835
+
1836
+ </h3><div class="docstring">
1837
+ <div class="discussion">
1838
+
1839
+ <p>Returns whether the given version of this game is up-to-date</p>
1840
+
1841
+
1842
+ </div>
1843
+ </div>
1844
+ <div class="tags">
1845
+ <p class="tag_title">Parameters:</p>
1846
+ <ul class="param">
1847
+
1848
+ <li>
1849
+
1850
+ <span class='name'>version</span>
1851
+
1852
+
1853
+ <span class='type'>(<tt>Fixnum</tt>)</span>
1854
+
1855
+
1856
+
1857
+ &mdash;
1858
+ <div class='inline'>
1859
+ <p>The version to check against the Web API</p>
1860
+ </div>
1861
+
1862
+ </li>
1863
+
1864
+ </ul>
1865
+
1866
+ <p class="tag_title">Returns:</p>
1867
+ <ul class="return">
1868
+
1869
+ <li>
1870
+
1871
+
1872
+ <span class='type'>(<tt>Boolean</tt>)</span>
1873
+
1874
+
1875
+
1876
+ &mdash;
1877
+ <div class='inline'>
1878
+ <p><code>true</code> if the given version is up-to-date</p>
1879
+ </div>
1880
+
1881
+ </li>
1882
+
1883
+ </ul>
1884
+
1885
+ </div><table class="source_code">
1886
+ <tr>
1887
+ <td>
1888
+ <pre class="lines">
1889
+
1890
+
1891
+ 151
1892
+ 152
1893
+ 153</pre>
1894
+ </td>
1895
+ <td>
1896
+ <pre class="code"><span class="info file"># File 'lib/steam/community/steam_game.rb', line 151</span>
1897
+
1898
+ <span class='kw'>def</span> <span class='id identifier rubyid_uptodate?'>uptodate?</span><span class='lparen'>(</span><span class='id identifier rubyid_version'>version</span><span class='rparen'>)</span>
1899
+ <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_uptodate?'>uptodate?</span> <span class='ivar'>@app_id</span><span class='comma'>,</span> <span class='id identifier rubyid_version'>version</span>
1900
+ <span class='kw'>end</span></pre>
1901
+ </td>
1902
+ </tr>
1903
+ </table>
1904
+ </div>
1905
+
1906
+ <div class="method_details ">
1907
+ <h3 class="signature " id="user_stats-instance_method">
1908
+
1909
+ - (<tt><span class='object_link'><a href="GameStats.html" title="GameStats (class)">GameStats</a></span></tt>) <strong>user_stats</strong>(steam_id)
1910
+
1911
+
1912
+
1913
+
1914
+
1915
+ </h3><div class="docstring">
1916
+ <div class="discussion">
1917
+
1918
+ <p>Creates a stats object for the given user and this game</p>
1919
+
1920
+
1921
+ </div>
1922
+ </div>
1923
+ <div class="tags">
1924
+ <p class="tag_title">Parameters:</p>
1925
+ <ul class="param">
1926
+
1927
+ <li>
1928
+
1929
+ <span class='name'>steam_id</span>
1930
+
1931
+
1932
+ <span class='type'>(<tt>String</tt>, <tt>Fixnum</tt>)</span>
1933
+
1934
+
1935
+
1936
+ &mdash;
1937
+ <div class='inline'>
1938
+ <p>The custom URL or the 64bit Steam ID of
1939
+ the user</p>
1940
+ </div>
1941
+
1942
+ </li>
1943
+
1944
+ </ul>
1945
+
1946
+ <p class="tag_title">Returns:</p>
1947
+ <ul class="return">
1948
+
1949
+ <li>
1950
+
1951
+
1952
+ <span class='type'>(<tt><span class='object_link'><a href="GameStats.html" title="GameStats (class)">GameStats</a></span></tt>)</span>
1953
+
1954
+
1955
+
1956
+ &mdash;
1957
+ <div class='inline'>
1958
+ <p>The stats of this game for the given user</p>
1959
+ </div>
1960
+
1961
+ </li>
1962
+
1963
+ </ul>
1964
+
1965
+ </div><table class="source_code">
1966
+ <tr>
1967
+ <td>
1968
+ <pre class="lines">
1969
+
1970
+
1971
+ 160
1972
+ 161
1973
+ 162
1974
+ 163
1975
+ 164</pre>
1976
+ </td>
1977
+ <td>
1978
+ <pre class="code"><span class="info file"># File 'lib/steam/community/steam_game.rb', line 160</span>
1979
+
1980
+ <span class='kw'>def</span> <span class='id identifier rubyid_user_stats'>user_stats</span><span class='lparen'>(</span><span class='id identifier rubyid_steam_id'>steam_id</span><span class='rparen'>)</span>
1981
+ <span class='kw'>return</span> <span class='kw'>unless</span> <span class='id identifier rubyid_has_stats?'>has_stats?</span>
1982
+
1983
+ <span class='const'>GameStats</span><span class='period'>.</span><span class='id identifier rubyid_create_game_stats'>create_game_stats</span> <span class='id identifier rubyid_steam_id'>steam_id</span><span class='comma'>,</span> <span class='ivar'>@short_name</span>
1984
+ <span class='kw'>end</span></pre>
1985
+ </td>
1986
+ </tr>
1987
+ </table>
1988
+ </div>
1989
+
1990
+ </div>
1991
+
1992
+ </div>
1993
+
1994
+ <div id="footer">
1995
+ Generated on Tue Jul 22 07:10:22 2014 by
1996
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1997
+ 0.8.7.3 (ruby-2.0.0).
1998
+ </div>
1999
+
2000
+ </body>
2001
+ </html>