koraktor/steam-condenser-ruby

# This code is free software; you can redistribute it and/or modify it under
# the terms of the new BSD License.
#
# Copyright (c) 2008-2013, Sebastian Staudt

require 'steam-condenser/servers/packets/base_packet'

module SteamCondenser::Servers::Packets

  # This class represents a S2A_RULES response sent by a game server
  #
  # It is used to transfer a list of server rules (a.k.a. CVARs) with their
  # active values.
  #
  # @author Sebastian Staudt
  # @see GameServer#update_rules_info
  class S2A_RULES_Packet

    include BasePacket

    # Returns the list of server rules (a.k.a. CVars) with the current values
    #
    # @return [Hash<String, String>] A list of server rules
    attr_reader :rules_hash

    # Creates a new S2A_RULES response object based on the given data
    #
    # @param [String] content_data The raw packet data sent by the server
    def initialize(content_data)
      if content_data.nil?
        raise SteamCondenser::Error::PacketFormat, 'Wrong formatted S2A_RULES response packet.'
      end

      super BasePacket::S2A_RULES_HEADER, content_data

      rules_count = @content_data.short

      @rules_hash = {}

      rules_count.times do
        rule  = @content_data.cstring
        value = @content_data.cstring

        break if rule.empty?

        @rules_hash[rule] = value
      end
    end

  end
end