Module: Lich::Common::GameSettings

Defined in:
lib/common/settings/gamesettings.rb

Class Method Summary collapse

Class Method Details

.[](name) ⇒ Object

Retrieves the value associated with the given setting name.

Examples:

value = GameSettings[:some_setting]

Parameters:

  • name (String) —

    the name of the setting to retrieve

Returns:

  • (Object) —

    the value of the setting



14
15
16
 
# File 'lib/common/settings/gamesettings.rb', line 14

def GameSettings.[](name)
  Settings.to_hash(XMLData.game)[name]
end

.[]=(name, value) ⇒ Object

Sets the value for the given setting name.

Examples:

GameSettings[:some_setting] = 'new_value'

Parameters:

  • name (String) —

    the name of the setting to set

  • value (Object) —

    the value to assign to the setting

Returns:

  • (Object) —

    the value that was set



25
26
27
 
# File 'lib/common/settings/gamesettings.rb', line 25

def GameSettings.[]=(name, value)
  Settings.set_script_settings(XMLData.game, name, value)
end

.auto ⇒ nil

Deprecated.

This method is no longer applicable.

Retrieves the auto setting (deprecated).

Examples:

auto_value = GameSettings.auto

Returns:

  • (nil) —

    always returns nil



100
101
102
103
 
# File 'lib/common/settings/gamesettings.rb', line 100

def GameSettings.auto
  Lich.deprecated('GameSettings.auto', 'not using, not applicable,', caller[0], fe_log: true)
  nil
end

.auto=(_val) ⇒ nil

Deprecated.

This method is no longer applicable.

Sets the auto setting (deprecated).

Examples:

GameSettings.auto = true

Parameters:

  • _val (Object) —

    the value to set for auto (not used)

Returns:

  • (nil) —

    always returns nil



89
90
91
92
 
# File 'lib/common/settings/gamesettings.rb', line 89

def GameSettings.auto=(_val)
  Lich.deprecated('GameSettings.auto=(val)', 'not using, not applicable,', caller[0], fe_log: true)
  return nil
end

.autoload ⇒ nil

Deprecated.

This method is no longer applicable.

Retrieves the autoload setting (deprecated).

Examples:

autoload_value = GameSettings.autoload

Returns:

  • (nil) —

    always returns nil



111
112
113
114
 
# File 'lib/common/settings/gamesettings.rb', line 111

def GameSettings.autoload
  Lich.deprecated('GameSettings.autoload', 'not using, not applicable,', caller[0], fe_log: true)
  nil
end

.clear ⇒ nil

Deprecated.

This method is no longer applicable.

Clears game settings (deprecated).

Examples:

GameSettings.clear

Returns:

  • (nil) —

    always returns nil



77
78
79
80
 
# File 'lib/common/settings/gamesettings.rb', line 77

def GameSettings.clear
  Lich.deprecated('GameSettings.clear', 'not using, not applicable,', caller[0], fe_log: true)
  nil
end

.load ⇒ nil

Deprecated.

This method is no longer applicable.

Loads game settings (deprecated).

Examples:

GameSettings.load

Returns:

  • (nil) —

    always returns nil



44
45
46
47
 
# File 'lib/common/settings/gamesettings.rb', line 44

def GameSettings.load
  Lich.deprecated('GameSettings.load', 'not using, not applicable,', caller[0], fe_log: true)
  nil
end

.save ⇒ nil

Deprecated.

This method is no longer applicable.

Saves game settings (deprecated).

Examples:

GameSettings.save

Returns:

  • (nil) —

    always returns nil



55
56
57
58
 
# File 'lib/common/settings/gamesettings.rb', line 55

def GameSettings.save
  Lich.deprecated('GameSettings.save', 'not using, not applicable,', caller[0], fe_log: true)
  nil
end

.save_all ⇒ nil

Deprecated.

This method is no longer applicable.

Saves all game settings (deprecated).

Examples:

GameSettings.save_all

Returns:

  • (nil) —

    always returns nil



66
67
68
69
 
# File 'lib/common/settings/gamesettings.rb', line 66

def GameSettings.save_all
  Lich.deprecated('GameSettings.save_all', 'not using, not applicable,', caller[0], fe_log: true)
  nil
end

.to_hash ⇒ Hash

Converts the game settings to a hash.

Examples:

settings_hash = GameSettings.to_hash

Returns:

  • (Hash) —

    a hash representation of the game settings



34
35
36
 
# File 'lib/common/settings/gamesettings.rb', line 34

def GameSettings.to_hash
  Settings.to_hash(XMLData.game)
end