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