Class: Contest::Effects::EffectsHandler

Inherits:
Object
  • Object
show all
Defined in:
docs/6_Contest_06_Effects.rb

Overview

Class responsive of handling the effects active on the contestants

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ EffectsHandler

Create a new effect handler



67
68
# File 'docs/6_Contest_06_Effects.rb', line 67

def initialize
end

Instance Attribute Details

#effects ⇒ Array<Contest::Effects::EffectBase> (readonly)

List of managed effects

Returns:



65
66
67
# File 'docs/6_Contest_06_Effects.rb', line 65

def effects
  @effects
end

Instance Method Details

#add(effect)

Add an effect

Parameters:



81
82
# File 'docs/6_Contest_06_Effects.rb', line 81

def add(effect)
end

#delete(name = nil, &block) {|effect| ... }

Delete effects matching a name or a block

Parameters:

  • name (Symbol, nil) (defaults to: nil) —

    name of the effect. Ignored if a block is given.

  • block (Proc, nil) —

    (optional) block testing each effect

Yield Parameters:



111
112
# File 'docs/6_Contest_06_Effects.rb', line 111

def delete(name = nil, &block)
end

#delete_dead_effects

Delete all the dead effects



114
115
# File 'docs/6_Contest_06_Effects.rb', line 114

def delete_dead_effects
end

#each(&block) {|effect| ... }

Call something on all effects

Parameters:

  • block (Proc) —

    block that is called for the each process

Yield Parameters:



105
106
# File 'docs/6_Contest_06_Effects.rb', line 105

def each(&block)
end

#get(name = nil, &block) {|effect| ... } ⇒ EffectBase?

Get an effect using its name or a block

Parameters:

  • name (Symbol, nil) (defaults to: nil) —

    name of the effect. Ignored if a block is given.

  • block (Proc, nil) —

    (optional) block testing each effect

Yield Parameters:

Returns:



93
94
# File 'docs/6_Contest_06_Effects.rb', line 93

def get(name = nil, &block)
end

#get_all(name = nil, &block) {|effect| ... } ⇒ Array<EffectBase>, Array<NilClass>

Get every effects responding to a name or a block

Parameters:

  • name (Symbol, nil) (defaults to: nil) —

    name of the effects. Ignored if a block is given.

  • block (Proc, nil) —

    (optional) block testing each effect

Yield Parameters:

Returns:



100
101
# File 'docs/6_Contest_06_Effects.rb', line 100

def get_all(name = nil, &block)
end

#has?(name = nil, &block) {|effect| ... } ⇒ Boolean

Tell if an effect is present

Parameters:

  • name (Symbol, nil) (defaults to: nil) —

    name of the effect. Ignored if a block is given.

  • block (Proc, nil) —

    (optional) block testing each effect

Yield Parameters:

Returns:

  • (Boolean) —

    if the effect is present



77
78
# File 'docs/6_Contest_06_Effects.rb', line 77

def has?(name = nil, &block)
end

#replace(effect, &block)

Replace the effects matching the block by the new one

Parameters:



86
87
# File 'docs/6_Contest_06_Effects.rb', line 86

def replace(effect, &block)
end

#update_counter

Update the counter of all effects



70
71
# File 'docs/6_Contest_06_Effects.rb', line 70

def update_counter
end