Module: AbstractL4DStats

Included in:
L4D2Stats, L4DStats
Defined in:
lib/steam/community/l4d/abstract_l4d_stats.rb

Overview

This module is a base for statistics for Left4Dead and Left4Dead 2. As both games have more or less the same statistics available in the Steam Community the code for both is pretty much the same.

Author:

  • Sebastian Staudt

Constant Summary collapse

SPECIAL_INFECTED =

The names of the special infected in Left4Dead

%w(boomer hunter smoker tank)

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#most_recent_game ⇒ Hash<String, Object> (readonly)

Returns a hash of statistics for this user’s most recently played game

Returns:

  • (Hash<String, Object>) —

    The most recent statistics for this user



21
22
23
 
# File 'lib/steam/community/l4d/abstract_l4d_stats.rb', line 21

def most_recent_game
  @most_recent_game
end

Instance Method Details

#favorites ⇒ Hash<String, Object>

Returns a hash of favorites for this user like weapons and character

If the favorites haven’t been parsed already, parsing is done now.

Returns:

  • (Hash<String, Object>) —

    The favorites of this user



48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/steam/community/l4d/abstract_l4d_stats.rb', line 48

def favorites
  return unless public?

  if @favorites.nil?
    favorites_data = @xml_data['stats']['favorites']

    @favorites = {
      :campaign                 => favorites_data['campaign'],
      :campaign_percentage      => favorites_data['campaignpct'].to_i,
      :character                => favorites_data['character'],
      :character_percentage     => favorites_data['characterpct'].to_i,
      :level1_weapon            => favorites_data['weapon1'],
      :level1_weapon_percentage => favorites_data['weapon1pct'].to_i,
      :level2_weapon            => favorites_data['weapon2'],
      :level2_weapon_percentage => favorites_data['weapon2pct'].to_i
    }
  end

  @favorites
end

#initialize(steam_id, game_name) ⇒ Object

Creates a new instance of statistics for both, Left4Dead and Left4Dead 2 parsing basic common data

Parameters:

  • steam_id (String) —

    The custom URL or 64bit Steam ID of the user

  • game_name (String) —

    The name of the game



28
29
30
31
32
33
34
35
36
37
38
39
40
41
 
# File 'lib/steam/community/l4d/abstract_l4d_stats.rb', line 28

def initialize(steam_id, game_name)
  super steam_id, game_name

  if public?
    most_recent_game_data = @xml_data['stats']['mostrecentgame']

    @most_recent_game = most_recent_game_data.nil? ? {} : {
      :difficulty  => most_recent_game_data['difficulty'],
      :escaped     => (most_recent_game_data['bEscaped'] == 1),
      :movie       => most_recent_game_data['movie'],
      :time_played => most_recent_game_data['time']
    }
  end
end

#lifetime_stats ⇒ Hash<String, Object>

Returns a hash of lifetime statistics for this user like the time played

If the lifetime statistics haven’t been parsed already, parsing is done now.

Returns:

  • (Hash<String, Object>) —

    The lifetime statistics for this user



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/steam/community/l4d/abstract_l4d_stats.rb', line 75

def lifetime_stats
  return unless public?

  if @lifetime_stats.nil?
    lifetime_data = @xml_data['stats']['lifetime']

    @lifetime_stats = {
      :finales_survived            => lifetime_data['finales'].to_i,
      :games_played                => lifetime_data['gamesplayed'].to_i,
      :infected_killed             => lifetime_data['infectedkilled'].to_i,
      :kills_per_hour              => lifetime_data['killsperhour'].to_f,
      :avg_kits_shared             => lifetime_data['kitsshared'].to_f,
      :avg_kits_used               => lifetime_data['kitsused'].to_f,
      :avg_pills_shared            => lifetime_data['pillsshared'].to_f,
      :avg_pills_used              => lifetime_data['pillsused'].to_f,
      :time_played                 => lifetime_data['timeplayed'],
      :finales_survived_percentage => @lifetime_stats[:finales_survived].to_f / @lifetime_stats[:games_played]
    }
  end

  @lifetime_stats
end

#survival_stats ⇒ Hash<String, Object>

Returns a hash of Survival statistics for this user like revived teammates

If the Survival statistics haven’t been parsed already, parsing is done now.

Returns:

  • (Hash<String, Object>) —

    The Survival statistics for this user



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/steam/community/l4d/abstract_l4d_stats.rb', line 104

def survival_stats
  return unless public?

  if @survival_stats.nil?
    survival_data = @xml_data['stats']['survival']

    @survival_stats = {
      :gold_medals   => survival_data['goldmedals'].to_i,
      :silver_medals => survival_data['silvermedals'].to_i,
      :bronze_medals => survival_data['bronzemedals'].to_i,
      :rounds_played => survival_data['roundsplayed'].to_i,
      :best_time     => survival_data['besttime'].to_f
    }
  end

  @survival_stats
end

#teamplay_stats ⇒ Hash<String, Object>

Returns a hash of teamplay statistics for this user like revived teammates

If the teamplay statistics haven’t been parsed already, parsing is done now.

Returns:

  • (Hash<String, Object>) —

    The teamplay statistics for this



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/steam/community/l4d/abstract_l4d_stats.rb', line 128

def teamplay_stats
  return unless public?

  if @teamplay_stats.nil?
    teamplay_data = @xml_data['stats']['teamplay']

    @teamplay_stats = {
      :revived                       => teamplay_data['revived'].to_i,
      :most_revived_difficulty       => teamplay_data['reviveddiff'],
      :avg_revived                   => teamplay_data['revivedavg'].to_f,
      :avg_was_revived               => teamplay_data['wasrevivedavg'].to_f,
      :protected                     => teamplay_data['protected'].to_i,
      :most_protected_difficulty     => teamplay_data['protecteddiff'],
      :avg_protected                 => teamplay_data['protectedavg'].to_f,
      :avg_was_protected             => teamplay_data['wasprotectedavg'].to_f,
      :friendly_fire_damage          => teamplay_data['ffdamage'].to_i,
      :most_friendly_fire_difficulty => teamplay_data['ffdamagediff'],
      :avg_friendly_fire_damage      => teamplay_data['ffdamageavg'].to_f
    }
  end

  @teamplay_stats
end

#versus_stats ⇒ Hash<String, Object>

Returns a hash of Versus statistics for this user like percentage of rounds won

If the Versus statistics haven’t been parsed already, parsing is done now.

Returns:

  • (Hash<String, Object>) —

    The Versus statistics for this user



158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/steam/community/l4d/abstract_l4d_stats.rb', line 158

def versus_stats
  return unless public?

  if @versus_stats.nil?
    versus_data = @xml_data['stats']['versus']

    @versus_stats = {
      :games_played                => versus_data['gamesplayed'].to_i,
      :games_completed             => versus_data['gamescompleted'].to_i,
      :finales_survived            => versus_data['finales'].to_i,
      :points                      => versus_data['points'].to_i,
      :most_points_infected        => versus_data['pointsas'],
      :games_won                   => versus_data['gameswon'].to_i,
      :games_lost                  => versus_data['gameslost'].to_i,
      :highest_survivor_score      => versus_data['survivorscore'].to_i,
      :finales_survived_percentage => @versus_stats[:finales_survived].to_f / @versus_stats[:games_played]
    }

    self.class.const_get(:SPECIAL_INFECTED).each do |infected|
      @versus_stats[infected] = {
        :special_attacks => versus_data["#{infected}special"].to_i,
        :most_damage     => versus_data["#{infected}dmg"].to_i,
        :avg_lifespan    => versus_data["#{infected}lifespan"].to_i
      }
    end
  end

  @versus_stats
end