Module: Lich::Common::GameLoader

Defined in:
documented/common/game-loader.rb

Overview

Handles instances of modules that are game dependent This module provides methods to load game-specific resources.

Examples:

Loading a game

Lich::Common::GameLoader.load!

Class Method Summary collapse

Class Method Details

.common_after ⇒ void

This method returns an undefined value.

Placeholder for actions to perform after loading.

Examples:

Finalizing after loading

Lich::Common::GameLoader.common_after


78
79
80
 
# File 'documented/common/game-loader.rb', line 78

def self.common_after
  # nil
end

.common_before ⇒ void

This method returns an undefined value.

Loads common dependencies before game-specific loading.

Examples:

Loading common dependencies

Lich::Common::GameLoader.common_before


18
19
20
21
22
23
 
# File 'documented/common/game-loader.rb', line 18

def self.common_before
  require File.join(LIB_DIR, 'common', 'log.rb')
  require File.join(LIB_DIR, 'common', 'spell.rb')
  require File.join(LIB_DIR, 'util', 'util.rb')
  require File.join(LIB_DIR, 'common', 'hmr.rb')
end

.dragon_realms ⇒ void

This method returns an undefined value.

Loads game-specific resources for Dragon Realms.

Examples:

Loading Dragon Realms resources

Lich::Common::GameLoader.dragon_realms


65
66
67
68
69
70
71
72
 
# File 'documented/common/game-loader.rb', line 65

def self.dragon_realms
  self.common_before
  require File.join(LIB_DIR, 'common', 'map', 'map_dr.rb')
  require File.join(LIB_DIR, 'attributes', 'char.rb')
  require File.join(LIB_DIR, 'dragonrealms', 'drinfomon.rb')
  require File.join(LIB_DIR, 'dragonrealms', 'commons.rb')
  self.common_after
end

.gemstone ⇒ void

This method returns an undefined value.

Loads game-specific resources for GemStone.

Examples:

Loading GemStone resources

Lich::Common::GameLoader.gemstone


29
30
31
32
33
34
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
 
# File 'documented/common/game-loader.rb', line 29

def self.gemstone
  self.common_before
  require File.join(LIB_DIR, 'gemstone', 'sk.rb')
  require File.join(LIB_DIR, 'common', 'map', 'map_gs.rb')
  require File.join(LIB_DIR, 'gemstone', 'effects.rb')
  require File.join(LIB_DIR, 'gemstone', 'bounty.rb')
  require File.join(LIB_DIR, 'gemstone', 'claim.rb')
  require File.join(LIB_DIR, 'gemstone', 'infomon.rb')
  require File.join(LIB_DIR, 'attributes', 'resources.rb')
  require File.join(LIB_DIR, 'attributes', 'stats.rb')
  require File.join(LIB_DIR, 'attributes', 'spells.rb')
  require File.join(LIB_DIR, 'attributes', 'skills.rb')
  require File.join(LIB_DIR, 'gemstone', 'society.rb')
  require File.join(LIB_DIR, 'gemstone', 'infomon', 'status.rb')
  require File.join(LIB_DIR, 'gemstone', 'experience.rb')
  require File.join(LIB_DIR, 'attributes', 'spellsong.rb')
  require File.join(LIB_DIR, 'gemstone', 'infomon', 'activespell.rb')
  require File.join(LIB_DIR, 'gemstone', 'psms.rb')
  require File.join(LIB_DIR, 'attributes', 'char.rb')
  require File.join(LIB_DIR, 'gemstone', 'infomon', 'currency.rb')
  # require File.join(LIB_DIR, 'gemstone', 'character', 'disk.rb') # dup
  require File.join(LIB_DIR, 'gemstone', 'group.rb')
  require File.join(LIB_DIR, 'gemstone', 'critranks')
  require File.join(LIB_DIR, 'gemstone', 'wounds.rb')
  require File.join(LIB_DIR, 'gemstone', 'scars.rb')
  require File.join(LIB_DIR, 'gemstone', 'gift.rb')
  require File.join(LIB_DIR, 'gemstone', 'readylist.rb')
  require File.join(LIB_DIR, 'gemstone', 'stowlist.rb')
  ActiveSpell.watch!
  self.common_after
end

.load! ⇒ void

This method returns an undefined value.

Loads the appropriate game based on XMLData.

Examples:

Loading a game

Lich::Common::GameLoader.load!

Raises:

  • (RuntimeError) —

    if the game cannot be loaded



87
88
89
90
91
92
 
# File 'documented/common/game-loader.rb', line 87

def self.load!
  sleep 0.1 while XMLData.game.nil? or XMLData.game.empty?
  return self.dragon_realms if XMLData.game =~ /DR/
  return self.gemstone if XMLData.game =~ /GS/
  echo "could not load game specifics for %s" % XMLData.game
end