koraktor/steam-condenser-ruby

View on GitHub
lib/steam-condenser/servers/packets/a2s_rules_packet.rb

Summary

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

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

module SteamCondenser::Servers::Packets

  # This packet class represents a A2S_RULES request send to a game server
  #
  # The game server will return a list of currently active game rules, e.g.
  # `mp_friendlyfire = 1`.
  #
  # This packet type requires the client to challenge the server in advance,
  # which is done automatically if required.
  #
  # @author Sebastian Staudt
  # @see GameServer#update_rules_info
  class A2S_RULES_Packet

    include BasePacket
    include RequestWithChallenge

    # Creates a new A2S_RULES request object including the challenge number
    #
    # @param [Numeric] challenge_number The challenge number received from the
    #        server
    def initialize(challenge_number = -1)
      super A2S_RULES_HEADER, challenge_number
    end

  end
end