Class: Contest::Move

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

Overview

Class representing a basic contest move

Constant Summary collapse

CONTEST_CONDITIONS =

Possible contest conditions

Returns:

  • (Array<Symbol>)
%i[__undef__ cool beautiful cute clever tough]
COMBO_BONUS =

Bonus score given when a combo is successfully executed

Returns:

  • (Integer)
3

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scene, db_symbol) ⇒ Move

Create a new move

Parameters:

  • db_symbol (Symbol) —

    db_symbol of the move in the database



24
25
# File 'docs/6_Contest_05_Move.rb', line 24

def initialize(scene, db_symbol)
end

Instance Attribute Details

#db_symbol ⇒ Symbol (readonly)

DbSymbol of the move in the database

Returns:

  • (Symbol)


18
19
20
# File 'docs/6_Contest_05_Move.rb', line 18

def db_symbol
  @db_symbol
end

#effect_tag_mechanics ⇒ Array<Contest::EffectTagMechanic> (readonly)

List of effect tag mechanics of the move

Returns:



21
22
23
# File 'docs/6_Contest_05_Move.rb', line 21

def effect_tag_mechanics
  @effect_tag_mechanics
end

#id ⇒ Integer (readonly)

ID of the move in the database

Returns:

  • (Integer)


15
16
17
# File 'docs/6_Contest_05_Move.rb', line 15

def id
  @id
end

#logic ⇒ Contest::Logic (readonly)

The Logic class of the contest

Returns:



12
13
14
# File 'docs/6_Contest_05_Move.rb', line 12

def logic
  @logic
end

#scene ⇒ Contest::Scene (readonly)

Scene the move belong to

Returns:



9
10
11
# File 'docs/6_Contest_05_Move.rb', line 9

def scene
  @scene
end

Instance Method Details

#appeal ⇒ Integer

Return the appeal value of the move

Returns:

  • (Integer)


57
58
# File 'docs/6_Contest_05_Move.rb', line 57

def appeal
end

#atk_class ⇒ Integer

Note:

Here to make move animations work

Return the class of the skill (used by the UI)

Returns:

  • (Integer) —

    1, 2, 3



85
86
# File 'docs/6_Contest_05_Move.rb', line 85

def atk_class
end

#combo_execution_message(user)

Show the combo execution message

Parameters:



144
145
# File 'docs/6_Contest_05_Move.rb', line 144

def combo_execution_message(user)
end

#combo_moves ⇒ Array<Symbol>

Return the list of combo moves that can follow this move

Returns:

  • (Array<Symbol>)


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

def combo_moves
end

#combo_preparation_message(user)

Show the combo preparation message

Parameters:



135
136
# File 'docs/6_Contest_05_Move.rb', line 135

def combo_preparation_message(user)
end

#condition ⇒ Integer

Return the condition of the move

Returns:

  • (Integer)


44
45
# File 'docs/6_Contest_05_Move.rb', line 44

def condition
end

#data ⇒ Studio::Move

Return the data of the skill

Returns:



33
34
# File 'docs/6_Contest_05_Move.rb', line 33

def data
end

#description ⇒ String

Return the skill description

Returns:



40
41
# File 'docs/6_Contest_05_Move.rb', line 40

def description
end

#effect_tag?(tag) ⇒ Boolean

Check if the move has a specific effect tag

Parameters:

  • tag (Symbol) —

    tag to check

Returns:

  • (Boolean)


53
54
# File 'docs/6_Contest_05_Move.rb', line 53

def effect_tag?(tag)
end

#effect_tags ⇒ Array<Symbol>

Return the effect tags of the move

Returns:

  • (Array<Symbol>)


48
49
# File 'docs/6_Contest_05_Move.rb', line 48

def effect_tags
end

#jam ⇒ Integer

Return the jam value of the move

Returns:

  • (Integer)


61
62
# File 'docs/6_Contest_05_Move.rb', line 61

def jam
end

#name

Return the name of the skill



36
37
# File 'docs/6_Contest_05_Move.rb', line 36

def name
end

#physical? ⇒ Boolean

Note:

Here to make move animations work

Is the skill physical ?

Returns:

  • (Boolean)


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

def physical?
end

#play_animation(user)

Prepare the move animation

Parameters:



99
100
# File 'docs/6_Contest_05_Move.rb', line 99

def play_animation(user)
end

#play_animation_internal(user)

Play the move animation itself

Parameters:



103
104
# File 'docs/6_Contest_05_Move.rb', line 103

def play_animation_internal(user)
end

#proceed(user) ⇒ Integer, Boolean

Function starting the move procedure

Parameters:

Returns:

  • (Integer, Boolean) —

    the calculated appeal and whether a combo was executed or not



112
113
# File 'docs/6_Contest_05_Move.rb', line 112

def proceed(user)
end

#proceed_combo(user) ⇒ Boolean

Proceed the combo mechanic for the move

Parameters:

Returns:

  • (Boolean) —

    whether the combo was successfully executed or not



127
128
# File 'docs/6_Contest_05_Move.rb', line 127

def proceed_combo(user)
end

#proceed_combo_execution(user) ⇒ Boolean

Check if the current move completes a combo and apply the bonus

Parameters:

Returns:

  • (Boolean) —

    whether the combo was successfully executed or not



140
141
# File 'docs/6_Contest_05_Move.rb', line 140

def proceed_combo_execution(user)
end

#proceed_combo_preparation(user)

Check if the move can start a combo and prepare it

Parameters:



131
132
# File 'docs/6_Contest_05_Move.rb', line 131

def proceed_combo_preparation(user)
end

#proceed_effect_tag_mechanic(mechanic, appeal) ⇒ Integer

Play the different phases of each effect tag mechanic linked to the move

Parameters:

  • mechanic (Contest::EffectTagMechanic) —

    the effect tag mechanic to play effects for

  • appeal (Integer) —

    the appeal value to apply modifications on

Returns:

  • (Integer) —

    the appeal value after modifications have been applied



118
119
# File 'docs/6_Contest_05_Move.rb', line 118

def proceed_effect_tag_mechanic(mechanic, appeal)
end

#special? ⇒ Boolean

Note:

Here to make move animations work

Is the skill special ?

Returns:

  • (Boolean)


75
76
# File 'docs/6_Contest_05_Move.rb', line 75

def special?
end

#status? ⇒ Boolean

Note:

Here to make move animations work

Is the skill status ?

Returns:

  • (Boolean)


80
81
# File 'docs/6_Contest_05_Move.rb', line 80

def status?
end

#to_s ⇒ String Also known as: inspect

Format move for logging purpose

Returns:



28
29
# File 'docs/6_Contest_05_Move.rb', line 28

def to_s
end

#type ⇒ Integer

Note:

Here to make move animations work

Return the current type of the move

Returns:

  • (Integer)


90
91
# File 'docs/6_Contest_05_Move.rb', line 90

def type
end

#usage_message(user)

Show the move usage message

Parameters:



122
123
# File 'docs/6_Contest_05_Move.rb', line 122

def usage_message(user)
end