class ProtonBot::Hook

Hook. Created by plugins, it's block is called if emitted event matches pattern @!attribute [r] pattern

@return [Hash<Symbol>] Hook's pattern

@!attribute [r] block

@return [Proc] Block

@!attribute [r] extra

@return [Hash] Extra data. Usually used by hook modifiers

@!attribute [r] chain

@return [Array<Proc>] Proc array. These are executed before calling main block.
  If any returns false value, main block is not called

Attributes

block[R]
chain[R]
extra[R]
pattern[R]

Public Class Methods

new(pattern, &block) click to toggle source

@param pattern [Hash<Symbol>] @param block [Proc]

# File lib/protonbot/hook.rb, line 16
def initialize(pattern, &block)
  @pattern = pattern
  @block   = block
  @extra   = {}
  @chain   = []
end

Public Instance Methods

cooldown!(seconds, mode = :user_and_target, verbose = true) click to toggle source

Basic hook modifier for checking cooldowns. Added by core plugin. @param seconds [Integer] Cooldown @param mode [Symbol] :global, :user_local, :target_local, :user_and_target @param verbose [Boolean] @return [Hook] self

# File lib/protonbot/core_plugin/apis/cooldowns.rb, line 7
def cooldown!(seconds, mode = :user_and_target, verbose = true)
  self.extra[:cooldown_seconds] = seconds
  self.extra[:cooldown_verbose] = verbose
  if [:global, :user_local, :target_local, :user_and_target].include? mode
    self.extra[:cooldown_mode] = mode
  else
    self.extra[:cooldown_mode] = :user_and_target
  end

  self.chain << proc do |dat, hook|
    lu_sign =
      case hook.extra[:cooldown_mode]
      when :global
        :"last_used_#{dat[:plug].name}"
      when :user_local
        :"last_used_#{dat[:plug].name}_#{dat[:host]}"
      when :target_local
        :"last_used_#{dat[:plug].name}_#{dat[:target]}"
      when :user_and_target
        :"last_used_#{dat[:plug].name}_#{dat[:target]}_#{dat[:host]}"
      end
    if dat[:bot].core.getpermsr(dat[:plug], dat[:host]).include? 'nocooldown'
      true
    elsif hook.extra[lu_sign]
      curtime = Time.now.to_i
      cmp = hook.extra[lu_sign] - curtime + hook.extra[:cooldown_seconds]
      if (cmp) <= 0
        hook.extra[lu_sign] = curtime
        true
      else
        dat.nreply("You need to wait %B#{cmp}%N more seconds to use this!") if
          hook.extra[:cooldown_verbose]
        false
      end
    else
      hook.extra[lu_sign] = Time.now.to_i
      true
    end
  end
end
perm!(*perms) click to toggle source

Basic hook modifier for checking permissions. Added by core plugin. @param perms [String] Permission names @return [Hook] self

# File lib/protonbot/core_plugin/apis/perms.rb, line 5
def perm!(*perms)
  self.extra[:needed_perms] = perms
  self.chain << proc do |dat, hook|
    perms = dat[:perms]
    canrun = true
    needed = hook.extra[:needed_perms]
    not_enough = needed - perms
    available = needed - not_enough
    if not_enough == []
      canrun = true
    else
      canrun = false
      available_  = available.map{|i|'%C%GREEN' + i + '%N'}
      not_enough_ = not_enough.map{|i|'%C%RED' + i + '%N'}
      status      = (available_ + not_enough_).join(' ')
      dat.nreply("Not enough permissions to use this! (#{status})")
    end
    canrun
    #
  end
  self
end