]> git.netwichtig.de Git - user/henk/code/ruby/rbot.git/blobdiff - data/rbot/plugins/games/wheelfortune.rb
plugin(wheelfortune): remove botdata dependency
[user/henk/code/ruby/rbot.git] / data / rbot / plugins / games / wheelfortune.rb
index d0178c07b20a11f51cddfb6ae1b3afb11b53af2c..20213e5d6c674a0808934e7eaf3a6d084397eb50 100644 (file)
@@ -9,11 +9,18 @@
 
 # Wheel-of-Fortune Question/Answer
 class WoFQA
-  attr_accessor :cat, :clue, :answer, :hint
+  attr_accessor :cat, :clue, :hint
+  attr_reader :answer
+  attr_accessor :guessed
   def initialize(cat, clue, ans=nil)
     @cat = cat # category
     @clue = clue # clue phrase
     self.answer = ans
+    @guessed = false
+  end
+
+  def guessed?
+    @guessed
   end
 
   def catclue
@@ -42,8 +49,15 @@ class WoFQA
   end
 
   def announcement
-    ret = self.catclue << "\n"
-    ret << _("Letters called so far: ") << @used.join(" ") << "\n" unless @used.empty?
+    ret = self.catclue
+    if !@used.empty?
+      ret << _(" [Letters called so far: %{red}%{letters}%{nocolor}]") % {
+        :red => Irc.color(:red),
+        :letters => @used.join(" "),
+        :nocolor => Irc.color()
+      }
+    end
+    ret << "\n"
     ret << @hint.join
   end
 
@@ -110,6 +124,18 @@ class WoFGame
     @curr_idx+1 rescue 0
   end
 
+  def length
+    @qas.length
+  end
+
+  def qa(round)
+    if @pending and round == self.length + 1
+      @pending
+    else
+      @qas[round-1]
+    end
+  end
+
   def buy(user)
     k = user.botuser
     if @scores.key?(k) and @scores[k][:score] >= @price
@@ -129,6 +155,10 @@ class WoFGame
     end
   end
 
+  def mark_guessed(qa)
+    qa.guessed = true
+  end
+
   def mark_winner(user)
     @running = false
     k = user.botuser
@@ -204,6 +234,23 @@ class WheelOfFortune < Plugin
     @games = Hash.new
   end
 
+  def help(plugin, topic="")
+    case topic
+    when 'play'
+      _("wof [<channel>] play [<name>] for <single> to <max> => starts a wheel-of-fortune game on channel <channel> (default: current channel), named <name> (default: wheelfortune.game_name config setting, or the last game name used by the user), with <single> points per round. the game is won when a player reachers <max> points. vowels cost <single>*<single>/<max> points. The user that starts the game is the game manager and must set up the clues and answers in private. All the other users have to learn the answer to each clue by saying single consonants or the whole sentence. Every time a consonant is guessed, the bot will reveal the partial answer, showing the missing letters as * (asterisks).")
+    when 'category', 'clue', 'answer'
+      _("wof <channel> [category: <cat>,] clue: <clue>, answer: <ans> => set up a new question for the wheel-of-fortune game being played on channel <channel>. This command must be sent in private by the game manager. The category <cat> can be omitted. If you make mistakes, you can use 'wof replace' (see help) before the question gets asked")
+    when 'replace'
+      _("wof <channel> replace <round> [category: <cat>,] [clue: <clue>,] [answer: <ans>] => fix the question for round <round> of the wheel-of-fortune game being played on <channel> by replacing the category and/or clue and/or answer")
+    when 'cancel'
+      _("wof cancel => cancels the wheel-of-fortune being played on the current channel")
+    when 'buy'
+      _("wof buy <vowel> => buy the vowel <vowel>: the user buying the vowel will lose points equal to the vowel price, and the corresponding vowel will be revealed in the answer (if present)")
+    else
+      _("wof: wheel-of-fortune plugin. topics: play, category, clue, answer, replace, cancel, buy")
+    end
+  end
+
   def setup_game(m, p)
     chan = p[:chan] || m.channel
     if !chan
@@ -222,9 +269,9 @@ class WheelOfFortune < Plugin
     end
     name = p[:name].to_s
     if name.empty?
-      name = m.source.get_botdata("wheelfortune.game_name") || @bot.config['wheelfortune.game_name']
+      name = @registry["game_name_#{m.source.to_s}"] || @bot.config['wheelfortune.game_name']
     else
-      m.source.set_botdata("wheelfortune.game_name", name.dup)
+      @registry["game_name_#{m.source.to_s}"] = name
     end
     @games[ch] = game = WoFGame.new(name, m.botuser, p[:single], p[:max])
     @bot.say chan, _("%{who} just created a new %{name} game to %{max} points (%{single} per question, %{price} per vowel)") % {
@@ -249,6 +296,14 @@ class WheelOfFortune < Plugin
       return
     end
     game = @games[ch]
+
+    if m.botuser != game.manager and !m.botuser.permit?('wheelfortune::manage::other::add')
+      m.reply _("you can't add questions to the %{name} game on %{chan}") % {
+        :name => game.name,
+        :chan => p[:chan]
+      }
+    end
+
     cat = p[:cat].to_s
     clue = p[:clue].to_s
     ans = p[:ans].to_s
@@ -260,27 +315,107 @@ class WheelOfFortune < Plugin
     if !clue.empty?
       worked, qa = game.start_add_qa(cat, clue)
       if worked
-        str = ans.empty? ?  _("ok, new clue added for %{chan}: %{catclue}") : nil
+        str = ans.empty? ?  _("ok, clue added for %{name} round %{count} on %{chan}: %{catclue}") : nil
       else
-        str = _("there's already a pending clue for %{chan}: %{catclue}")
+        str = _("there's already a pending clue for %{name} round %{count} on %{chan}: %{catclue}")
       end
-      m.reply _(str) % { :chan => p[:chan], :catclue => qa.catclue } if str
-      return unless worked or !ans.empty?
+      m.reply _(str) % {
+        :chan => p[:chan],
+        :catclue => qa.catclue,
+        :name => game.name,
+        :count => game.length+1
+      } if str
+      return unless worked and !ans.empty?
     end
     if !ans.empty?
       qa = game.finish_add_qa(ans)
       if qa
-        str = _("ok, new QA added for %{chan}: %{catclue} => %{ans}")
+        str = _("ok, QA added for %{name} round %{count} on %{chan}: %{catclue} => %{ans}")
       else
-        str = _("there's no pending clue for %{chan}!")
+        str = _("there's no pending clue for %{name} on %{chan}!")
       end
-      m.reply _(str) % { :chan => p[:chan], :catclue => qa ? qa.catclue : nil, :ans => qa ? qa.answer : nil}
-      announce(m, p.merge({ :next => true }) ) unless game.running?
+      m.reply _(str) % {
+        :chan => p[:chan],
+        :catclue => qa ? qa.catclue : nil,
+        :ans => qa ? qa.answer : nil,
+        :name => game.name,
+        :count => game.length
+      }
+      announce(m, p) unless game.running?
     else
-      m.reply _("something went wrong, I can't seem to understand what you're trying to set up")
+      m.reply _("something went wrong, I can't seem to understand what you're trying to set up") if clue.empty?
     end
   end
 
+  def replace_qa(m, p)
+    ch = p[:chan].irc_downcase(m.server.casemap).intern
+    if !@games.key?(ch)
+      m.reply _("there's no %{name} game running on %{chan}") % {
+        :name => @bot.config['wheelfortune.game_name'],
+        :chan => p[:chan]
+      }
+      return
+    end
+    game = @games[ch]
+
+    if m.botuser != game.manager and !m.botuser.permit?('wheelfortune::manage::other::add')
+      m.reply _("you can't replace questions to the %{name} game on %{chan}") % {
+        :name => game.name,
+        :chan => p[:chan]
+      }
+    end
+
+    round = p[:round].to_i
+
+    min = game.round
+    max = game.length
+    max += 1 if game.pending
+    if round <= min or round > max
+      if min == max
+        m.reply _("there are no questions in the %{name} game on %{chan} which can be replaced") % {
+          :name => game.name,
+          :chan => p[:chan]
+        }
+      else
+        m.reply _("you can only replace questions between rounds %{min} and %{max} in the %{name} game on %{chan}") % {
+          :name => game.name,
+          :min => min,
+          :max => max,
+          :chan => p[:chan]
+        }
+      end
+      return
+    end
+
+    cat = p[:cat].to_s
+    clue = p[:clue].to_s
+    ans = p[:ans].to_s
+    if ans.include?('*')
+      m.reply _("sorry, the answer cannot contain the '*' character")
+      return
+    end
+
+    qa = game.qa(round)
+    qa.cat = cat unless cat.empty?
+    qa.clue = clue unless clue.empty?
+    unless ans.empty?
+      if game.pending and round == max
+        game.finish_add_qa(ans)
+      else
+        qa.answer = ans
+      end
+    end
+
+    str = _("ok, replaced QA for %{name} round %{count} on %{chan}: %{catclue} => %{ans}")
+    m.reply str % {
+      :chan => p[:chan],
+      :catclue => qa ? qa.catclue : nil,
+      :ans => qa ? qa.answer : nil,
+      :name => game.name,
+      :count => round
+    }
+  end
+
   def announce(m, p={})
     chan = p[:chan] || m.channel
     ch = chan.irc_downcase(m.server.casemap).intern
@@ -292,7 +427,10 @@ class WheelOfFortune < Plugin
       return
     end
     game = @games[ch]
-    qa = p[:next] ? game.next : game.current
+    qa = game.current
+    if !qa or qa.guessed?
+      qa = game.next
+    end
     if !qa
       m.reply _("there are no %{name} questions for %{chan}, I'm waiting for %{who} to add them") % {
         :name => game.name,
@@ -338,9 +476,7 @@ class WheelOfFortune < Plugin
       # m.reply "STUPID! YOU SO STUPID!"
       return
     when *game.must_buy
-      m.nickreply _("You must buy the %{vowel}") % {
-        :vowel => check
-      }
+      m.reply _("You must buy the %{vowel}") % {:vowel => check}, :nick => true
     when :wrong
       return
     when Numeric, :missing
@@ -348,6 +484,7 @@ class WheelOfFortune < Plugin
       # TODO what happens when the last hint reveals the whole answer?
       announce(m)
     when :gotit
+      game.mark_guessed(game.current)
       want_more = game.mark_winner(m.source)
       m.reply _("%{who} got it! The answer was: %{ans}") % {
         :who => m.sourcenick,
@@ -365,7 +502,7 @@ class WheelOfFortune < Plugin
         }
         score_table(m.channel, game)
         @games.delete(ch)
-      else :more
+      else
         m.reply _("%{bold}%{color}%{name}%{bold}, round %{count}%{nocolor} -- score so far:") % {
           :bold => Bold,
           :color => Irc.color(:green),
@@ -374,7 +511,7 @@ class WheelOfFortune < Plugin
           :nocolor => Irc.color()
         }
         score_table(m.channel, game)
-        announce(m, :next => true)
+        announce(m)
       end
     else
       # can this happen?
@@ -382,11 +519,12 @@ class WheelOfFortune < Plugin
     end
   end
 
-  def listen(m)
-    return unless m.kind_of?(PrivMessage) and not m.address?
+  def message(m)
+    return if m.address?
     ch = m.channel.irc_downcase(m.server.casemap).intern
     return unless game = @games[ch]
     return unless game.running?
+    return unless game.current and not game.current.guessed?
     check = game.check(m.message, :buy => false)
     react_on_check(m, ch, game, check)
   end
@@ -438,7 +576,12 @@ class WheelOfFortune < Plugin
       }
       return
     end
-    do_cancel(ch)
+    # is the botuser the manager or allowed to cancel someone else's game?
+    if m.botuser == @games[ch].manager or m.botuser.permit?('wheelfortune::manage::other::cancel')
+      do_cancel(ch)
+    else
+      m.reply _("you can't cancel the current game")
+    end
   end
 
   def do_cancel(ch)
@@ -464,4 +607,7 @@ plugin.map "wof cancel", :action => 'cancel', :private => false
 plugin.map "wof [:chan] play [*name] for :single [points] to :max [points]", :action => 'setup_game'
 plugin.map "wof :chan [category: *cat,] clue: *clue[, answer: *ans]", :action => 'setup_qa', :public => false
 plugin.map "wof :chan answer: *ans", :action => 'setup_qa', :public => false
+plugin.map "wof :chan replace :round [category: *cat,] clue: *clue[, answer: *ans]", :action => 'replace_qa', :public => false
+plugin.map "wof :chan replace :round [category: *cat,] answer: *ans", :action => 'replace_qa', :public => false
+plugin.map "wof :chan replace :round category: *cat[, clue: *clue[, answer: *ans]]", :action => 'replace_qa', :public => false
 plugin.map "wof buy :vowel", :action => 'buy', :requirements => { :vowel => /./u }