Class: PFM::MapOverlay

Inherits:
Object show all
Defined in:
docs/4_Systems_952_MapOverlay.rb

Overview

Class for the data of Map overlays that will be saved

Defined Under Namespace

Modules: PresetWithDistanceFactor, PresetWithMapAffix, PresetWithPosition, PresetWithResolution, PresetWithSampleColor Classes: PresetBase, PresetFogOverlay, PresetGodRaysOverlay, PresetNausea, PresetRippleOverlay, PresetScrollImage, PresetStaticImage, PresetWaterOverlay, UVResolver

Constant Summary collapse

REGISTERED_PRESETS =

List of registered presets

Returns:

  • (Hash{Symbol => Class})
{}

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#current_preset ⇒ PresetBase? (readonly)

Current preset

Returns:



6
7
8
# File 'docs/4_Systems_952_MapOverlay.rb', line 6

def current_preset
  @current_preset
end

Class Method Details

.register_preset(preset_name, klass)

Register a preset

Parameters:

  • preset_name (Symbol)
  • klass (Class)


22
23
# File 'docs/4_Systems_952_MapOverlay.rb', line 22

def register_preset(preset_name, klass)
end

Instance Method Details

#change_overlay_preset(new_preset)

Change to a new preset

Parameters:

  • new_preset (Symbol) —

    Symbol of the preset



9
10
# File 'docs/4_Systems_952_MapOverlay.rb', line 9

def change_overlay_preset(new_preset)
end

#stop_overlay_preset ⇒ Boolean

Erase overlay and dispose resources

Returns:

  • (Boolean) —

    False if overlay was already stopped, true otherwise



13
14
# File 'docs/4_Systems_952_MapOverlay.rb', line 13

def stop_overlay_preset
end