Module: Lich::Gemstone::ActiveSpell

Defined in:
documented/gemstone/infomon/activespell.rb

Overview

Provides functionality for managing spell durations and updates. This module addresses spell timing discrepancies in the game.

Examples:

Usage

Lich::Gemstone::ActiveSpell.update_spell_durations

Class Method Summary collapse

Class Method Details

.block_until_update_requested ⇒ Time

Blocks execution until an update request is made.

Examples:

Blocking until an update is requested

time = Lich::Gemstone::ActiveSpell.block_until_update_requested

Returns:

  • (Time) —

    The time when the update was requested



209
210
211
212
213
 
# File 'documented/gemstone/infomon/activespell.rb', line 209

def self.block_until_update_requested
  event = queue.pop
  queue.clear
  event
end

.get_spell_info(spell_check = XMLData.active_spells) ⇒ Array

Retrieves information about active spells and their durations.

Examples:

Getting spell info

names, durations = Lich::Gemstone::ActiveSpell.get_spell_info
puts names
puts durations

Parameters:

  • spell_check (Hash) (defaults to: XMLData.active_spells) —

    A hash of active spells to check against (default is XMLData.active_spells)

Returns:

  • (Array) —

    An array containing spell names and their durations



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'documented/gemstone/infomon/activespell.rb', line 35

def self.get_spell_info(spell_check = XMLData.active_spells)
  respond "spell update requested\r\n" if $infomon_debug
  spell_update_durations = spell_check
  spell_update_names = []
  makeychange = []
  spell_update_durations.each do |k, _v|
    case k
    when /(?:Mage Armor|520) - /
      makeychange << k
      spell_update_names.push('Mage Armor')
      next
    when /(?:CoS|712) - /
      makeychange << k
      spell_update_names.push('Cloak of Shadows')
      next
    when /Enh\./
      makeychange << k
      case k
      when /Enh\. Strength/
        spell_update_names.push('Surge of Strength')
      when /Enh\. (?:Dexterity|Agility)/
        spell_update_names.push('Burst of Swiftness')
      end
      next
    when /Empowered/
      makeychange << k
      spell_update_names.push('Shout')
      next
    when /Multi-Strike/
      makeychange << k
      spell_update_names.push('MStrike Cooldown')
      next
    when /Next Bounty Cooldown/
      makeychange << k
      spell_update_names.push('Next Bounty')
      next
    when /(?:Resist Nature|620) (?:- (?:Heat|Cold) \(\d\d%|- Steam \(\d\d|- Lightning|\(\d\d%\))/
      makeychange << k
      spell_update_names.push('Resist Nature')
      next
    end
    spell_update_names << k
  end
  makeychange.each do |changekey|
    next unless spell_update_durations.key?(changekey)

    case changekey
    when /(?:Mage Armor|520) - /
      spell_update_durations['Mage Armor'] = spell_update_durations.delete changekey
    when /(?:CoS|712) - /
      spell_update_durations['Cloak of Shadows'] = spell_update_durations.delete changekey
    when /Enh\. Strength/
      spell_update_durations['Surge of Strength'] = spell_update_durations.delete changekey
    when /Enh\. (?:Dexterity|Agility)/
      spell_update_durations['Burst of Swiftness'] = spell_update_durations.delete changekey
    when /Empowered/
      spell_update_durations['Shout'] = spell_update_durations.delete changekey
    when /Multi-Strike/
      spell_update_durations['MStrike Cooldown'] = spell_update_durations.delete changekey
    when /Next Bounty Cooldown/
      spell_update_durations['Next Bounty'] = spell_update_durations.delete changekey
    when /Next Group Bounty Cooldown/
      spell_update_durations['Next Group Bounty'] = spell_update_durations.delete changekey
    when /(?:Resist Nature|620) (?:- (?:Heat|Cold) \(\d\d%|- Steam \(\d\d|- Lightning|\(\d\d%\))/
      spell_update_durations['Resist Nature'] = spell_update_durations.delete changekey
    end
  end
  [spell_update_names, spell_update_durations]
end

.queue ⇒ Queue

Provides access to the queue for update requests.

Examples:

Accessing the update queue

queue = Lich::Gemstone::ActiveSpell.queue

Returns:

  • (Queue) —

    The queue used for managing update requests



201
202
203
 
# File 'documented/gemstone/infomon/activespell.rb', line 201

def self.queue
  @queue ||= Queue.new
end

.request_update ⇒ Object

Requests an update for spell durations. This method queues a request to update spell durations.

Examples:

Requesting an update

Lich::Gemstone::ActiveSpell.request_update


193
194
195
 
# File 'documented/gemstone/infomon/activespell.rb', line 193

def self.request_update
  queue << Time.now
end

.show_duration_change ⇒ Object

Displays changes in active spell durations. This method checks for active spells and updates their durations accordingly.

Examples:

Showing duration changes

Lich::Gemstone::ActiveSpell.show_duration_change


109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'documented/gemstone/infomon/activespell.rb', line 109

def self.show_duration_change
  active_durations = Array.new
  group_effects = [307, 310, 1605, 1609, 1618, 1608]
  [Effects::Spells.dup, Effects::Cooldowns.dup, Effects::Buffs.dup, Effects::Debuffs.dup].each do |effect_type|
    active_durations += effect_type.to_h.keys
    effect_type.to_h.each do |effect, end_time|
      next unless effect.is_a?(String)
      effect, end_time = ActiveSpell.get_spell_info({ effect=>end_time })
      effect = effect.join
      end_time = end_time[effect]
      next unless (spell = Spell.list.find { |s| s.num == effect.to_i || s.name =~ /^#{effect}$/ })
      if effect_type.to_h.find { |k, _v| k == spell.num }
        effect_key = spell.num
      else
        effect_key = spell.name
      end
      time_left = ((end_time - Time.now) / 60).to_f
      duration = ((end_time - (@current_durations[effect_key].nil? ? Time.now : @current_durations[effect_key])) / 60).to_f
      if @durations_first_pass_complete && (@current_durations[effect_key].nil? || end_time > @current_durations[effect_key]) && duration > (0.1).to_f && !(group_effects.include?(spell.num) && !spell.known?)
        respond "[ #{spell.num} #{spell.name}: +#{duration.as_time}, #{time_left.as_time} ]"
      end
      @current_durations[effect_key] = end_time
    end
  end
  (@current_durations.keys - active_durations).each do |spell|
    respond "[ #{Spell.list.find { |s| s.num == spell.to_i || s.name =~ /#{spell}/ }.num} #{Spell.list.find { |s| s.num == spell.to_i || s.name =~ /#{spell}/ }.name}: Ended ]" if @durations_first_pass_complete
    @current_durations.delete(spell)
  end
  @durations_first_pass_complete = true
end

.show_durations? ⇒ Boolean

Checks if spell durations should be displayed.

Examples:

Checking duration display

if Lich::Gemstone::ActiveSpell.show_durations?
  puts "Durations are shown"
end

Returns:

  • (Boolean) —

    true if durations should be shown, false otherwise



24
25
26
 
# File 'documented/gemstone/infomon/activespell.rb', line 24

def self.show_durations?
  Infomon.get_bool("infomon.show_durations")
end

.update_spell_durations ⇒ Object

Updates the durations of currently active spells. This method handles the logic for updating spell durations and managing active spells.

Examples:

Updating spell durations

Lich::Gemstone::ActiveSpell.update_spell_durations

Raises:

  • (StandardError) —

    if an error occurs during the update process



145
146
147
148
149
150
151
152
153
154
155
156
157
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
187
 
# File 'documented/gemstone/infomon/activespell.rb', line 145

def self.update_spell_durations
  begin
    respond "[infomon] updating spell durations..." if $infomon_debug
    spell_update_names, spell_update_durations = ActiveSpell.get_spell_info
    respond "#{spell_update_names}\r\n" if $infomon_debug
    respond "#{spell_update_durations}\r\n" if $infomon_debug

    existing_spell_names = []
    active_spells = Spell.active
    ignore_spells = ["Berserk", "Council Task", "Council Punishment", "Briar Betrayer", "Rapid Fire Penalty"]
    active_spells.each { |s| existing_spell_names << s.name }
    inactive_spells = existing_spell_names - ignore_spells - spell_update_names
    inactive_spells.reject! do |s|
      s =~ /^Aspect of the \w+ Cooldown|^[\w\s]+ Recovery/
    end
    inactive_spells.each do |s|
      badspell = Spell[s].num
      Spell[badspell].putdown if Spell[s].active?
    end

    spell_update_durations.uniq.each do |k, v|
      if (spell = Spell.list.find { |s| (s.name.downcase == k.strip.downcase) || (s.num.to_s == k.strip) })
        if (spell.circle.to_i == 10) and not active_spells.any? { |s| s.circle.to_i == 10 }
          Spellsong.renewed
        end
        spell.active = true
        spell.timeleft = if v - Time.now > 300 * 60
                           600.01
                         else
                           ((v - Time.now) / 60)
                         end
      elsif $infomon_debug
        respond "no spell matches #{k}"
      end
    end
    show_duration_change if show_durations?
  rescue StandardError => e
    if $infomon_debug
      respond 'Error in spell durations thread'
      respond e.inspect
    end
  end
end

.watch! ⇒ Object

Starts a thread to watch for update requests and process them. This method continuously checks for update requests and updates spell durations accordingly.

Examples:

Starting the watch thread

Lich::Gemstone::ActiveSpell.watch!


219
220
221
222
223
224
225
226
227
228
229
 
# File 'documented/gemstone/infomon/activespell.rb', line 219

def self.watch!
  @thread ||= Thread.new do
    loop do
      block_until_update_requested
      update_spell_durations
    rescue StandardError => e
      respond 'Error in spell durations thread'
      respond e.inspect
    end
  end
end