Module: Lich::Gemstone::Currency

Defined in:
documented/gemstone/currency.rb

Overview

Access to the player's current currency and scrip balances.

All methods query the live character data maintained by the Lich engine. Returns are [Integer] or [nil] if the data is not yet available.

Class Method Summary collapse

Class Method Details

.aevit ⇒ Integer?

Returns the player's current Aevit balance.

Returns:

  • (Integer, nil) —

    Aevit amount, or nil if not yet available



88
89
90
 
# File 'documented/gemstone/currency.rb', line 88

def self.aevit
  Lich::Gemstone::Infomon.get('currency.aevit')
end

.blackscrip ⇒ Integer?

Returns the player's current Blackscrip balance.

Returns:

  • (Integer, nil) —

    Blackscrip amount, or nil if not yet available



46
47
48
 
# File 'documented/gemstone/currency.rb', line 46

def self.blackscrip
  Lich::Gemstone::Infomon.get('currency.blackscrip')
end

.bloodscrip ⇒ Integer?

Returns the player's current Bloodscrip balance.

Returns:

  • (Integer, nil) —

    Bloodscrip amount, or nil if not yet available



53
54
55
 
# File 'documented/gemstone/currency.rb', line 53

def self.bloodscrip
  Lich::Gemstone::Infomon.get('currency.bloodscrip')
end

.elans ⇒ Integer?

Returns the player's current Elans balance.

Returns:

  • (Integer, nil) —

    Elans amount, or nil if not yet available



74
75
76
 
# File 'documented/gemstone/currency.rb', line 74

def self.elans
  Lich::Gemstone::Infomon.get('currency.elans')
end

.ethereal_scrip ⇒ Integer?

Returns the player's current Ethereal Scrip balance.

Returns:

  • (Integer, nil) —

    Ethereal Scrip amount, or nil if not yet available



60
61
62
 
# File 'documented/gemstone/currency.rb', line 60

def self.ethereal_scrip
  Lich::Gemstone::Infomon.get('currency.ethereal_scrip')
end

.gemstone_dust ⇒ Integer?

Returns the player's current Gemstone Dust balance.

Returns:

  • (Integer, nil) —

    Gemstone Dust amount, or nil if not yet available



111
112
113
 
# File 'documented/gemstone/currency.rb', line 111

def self.gemstone_dust
  Lich::Gemstone::Infomon.get('currency.gemstone_dust')
end

.gigas_artifact_fragments ⇒ Integer?

Returns the player's current Gigas Artifact Fragments balance.

Returns:

  • (Integer, nil) —

    Gigas Artifact Fragments amount, or nil if not yet available



104
105
106
 
# File 'documented/gemstone/currency.rb', line 104

def self.gigas_artifact_fragments
  Lich::Gemstone::Infomon.get('currency.gigas_artifact_fragments')
end

.gold ⇒ Integer?

Returns the player's current gold balance.

Examples:

Lich::Gemstone::Currency.gold #=> 15000

Returns:

  • (Integer, nil) —

    gold amount, or nil if not yet available



97
98
99
 
# File 'documented/gemstone/currency.rb', line 97

def self.gold
  Lich::Gemstone::Infomon.get('currency.gold')
end

.raikhen ⇒ Integer?

Returns the player's current Raikhen balance.

Returns:

  • (Integer, nil) —

    Raikhen amount, or nil if not yet available



67
68
69
 
# File 'documented/gemstone/currency.rb', line 67

def self.raikhen
  Lich::Gemstone::Infomon.get('currency.raikhen')
end

.redsteel_marks ⇒ Integer?

Returns the player's current Redsteel Marks balance.

Examples:

Lich::Gemstone::Currency.redsteel_marks #=> 42

Returns:

  • (Integer, nil) —

    Redsteel Marks amount, or nil if not yet available



32
33
34
 
# File 'documented/gemstone/currency.rb', line 32

def self.redsteel_marks
  Lich::Gemstone::Infomon.get('currency.redsteel_marks')
end

.silver ⇒ Integer?

Returns the player's current silver balance.

Examples:

Lich::Gemstone::Currency.silver #=> 5000

Returns:

  • (Integer, nil) —

    silver amount, or nil if not yet available



16
17
18
 
# File 'documented/gemstone/currency.rb', line 16

def self.silver
  Lich::Gemstone::Infomon.get('currency.silver')
end

.silver_container ⇒ String?

Returns the item noun of the container holding the player's silver.

Returns:

  • (String, nil) —

    container noun (e.g. "pouch", "sack"), or nil if not yet available



23
24
25
 
# File 'documented/gemstone/currency.rb', line 23

def self.silver_container
  Lich::Gemstone::Infomon.get('currency.silver_container')
end

.soul_shards ⇒ Integer?

Returns the player's current Soul Shards balance.

Returns:

  • (Integer, nil) —

    Soul Shards amount, or nil if not yet available



81
82
83
 
# File 'documented/gemstone/currency.rb', line 81

def self.soul_shards
  Lich::Gemstone::Infomon.get('currency.soul_shards')
end

.tickets ⇒ Integer?

Returns the player's current Tickets balance.

Returns:

  • (Integer, nil) —

    Tickets amount, or nil if not yet available



39
40
41
 
# File 'documented/gemstone/currency.rb', line 39

def self.tickets
  Lich::Gemstone::Infomon.get('currency.tickets')
end