Class: Contest::EffectTagMechanic

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

Overview

Class describing an effect tag's mechanic components

Defined Under Namespace

Classes: BonusEarlier, BonusExcitement, BonusFirst, BonusHalfPreviousAppeals, BonusLast, BonusLater, BonusSameConditionPrevious, CancelOthersCombo, CantActAnymore, ComparePreviousAppeal, CopyPreviousAppeal, JamAll, JamHighestScore, JamPrevious, JamSameCondition, JammingEffectBase, LockExcitement, LowerOthersCondition, MoreSensitiveToJam, PlayFirstNextTurn, PlayLastNextTurn, PreventJamOneTime, PreventJamOneTurn, RaiseCondition, RandomAppeal, RandomizeNextTurnOrder, SkipNextTurn, TryMakeNervous, VeryExcitingFirst, VeryExcitingLast

Constant Summary collapse

REGISTERED_EFFECT_TAG_MECHANICS =

Hash containing all the registered effect tag mechanics

Returns:

  • (Hash{Symbol => Class}) —

    list of the registered effect tag mechanics

Hash.new(EffectTagMechanic)

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scene, move) ⇒ EffectTagMechanic

Create a new effect tag mechanic

Parameters:



164
165
# File 'docs/6_Contest_05_Move.rb', line 164

def initialize(scene, move)
end

Instance Attribute Details

#logic ⇒ Contest::Logic (readonly)

The Logic class of the contest

Returns:



157
158
159
# File 'docs/6_Contest_05_Move.rb', line 157

def logic
  @logic
end

#move ⇒ Contest::Move

The move using the effect tag

Returns:



160
161
162
# File 'docs/6_Contest_05_Move.rb', line 160

def move
  @move
end

#scene ⇒ Contest::Scene (readonly)

The Scene class of the contest

Returns:



154
155
156
# File 'docs/6_Contest_05_Move.rb', line 154

def scene
  @scene
end

Class Method Details

.[](symbol) ⇒ Class<Contest::EffectTagMechanic>

Retrieve a registered effect tag mechanic

Parameters:

  • symbol (Symbol) —

    symbol of the effect tag

Returns:



218
219
# File 'docs/6_Contest_05_Move.rb', line 218

def [](symbol)
end

.register(symbol, klass)

Register an effect tag mechanic

Parameters:

  • symbol (Symbol) —

    symbol of the effect tag

  • klass (Class) —

    class of the effect tag mechanic



223
224
# File 'docs/6_Contest_05_Move.rb', line 223

def register(symbol, klass)
end

Instance Method Details

#affects_next_contestants? ⇒ Boolean

Does this effect tag affect the next contestants?

Returns:

  • (Boolean)


208
209
# File 'docs/6_Contest_05_Move.rb', line 208

def affects_next_contestants?
end

#affects_previous_contestants? ⇒ Boolean

Does this effect tag affect the previous contestants?

Returns:

  • (Boolean)


212
213
# File 'docs/6_Contest_05_Move.rb', line 212

def affects_previous_contestants?
end

#appeal_modifier ⇒ Integer

Method called to apply the appeal bonuses linked to this effect tag

Returns:

  • (Integer) —

    modifications to apply on the appeal



168
169
# File 'docs/6_Contest_05_Move.rb', line 168

def appeal_modifier
end

#apply_effects

Method called to apply the effects linked to this effect tag



174
175
# File 'docs/6_Contest_05_Move.rb', line 174

def apply_effects
end

#apply_jamming

Method called to apply the jamming linked to this effect tag



171
172
# File 'docs/6_Contest_05_Move.rb', line 171

def apply_jamming
end

#better_early_contest? ⇒ Boolean

Is this effect tag better used early in a contest?

Returns:

  • (Boolean)


192
193
# File 'docs/6_Contest_05_Move.rb', line 192

def better_early_contest?
end

#better_early_round? ⇒ Boolean

Is this effect tag better used early in a round?

Returns:

  • (Boolean)


184
185
# File 'docs/6_Contest_05_Move.rb', line 184

def better_early_round?
end

#better_late_contest? ⇒ Boolean

Is this effect tag better used late in a contest?

Returns:

  • (Boolean)


196
197
# File 'docs/6_Contest_05_Move.rb', line 196

def better_late_contest?
end

#better_late_round? ⇒ Boolean

Is this effect tag better used late in a round?

Returns:

  • (Boolean)


188
189
# File 'docs/6_Contest_05_Move.rb', line 188

def better_late_round?
end

#inflicts_jam? ⇒ Boolean

Does this effect tag inflict jam?

Returns:

  • (Boolean)


200
201
# File 'docs/6_Contest_05_Move.rb', line 200

def inflicts_jam?
end

#prevents_jam? ⇒ Boolean

Does this effect tag prevent jam?

Returns:

  • (Boolean)


204
205
# File 'docs/6_Contest_05_Move.rb', line 204

def prevents_jam?
end

#show_message_after

Show the message linked to this effect tag after applying it



180
181
# File 'docs/6_Contest_05_Move.rb', line 180

def show_message_after
end

#show_message_before

Show the message linked to this effect tag before applying it



177
178
# File 'docs/6_Contest_05_Move.rb', line 177

def show_message_before
end