Module: Yuki::FollowMe

Defined in:

docs/4_Systems_003_Map_Engine.rb

Class Method Summary

• .clear

  Clears the follower (and dispose them).

• .dispose

  Dispose the follower and release resources.

• .each_follower(&block)

  yield a block on each Followers.

• .enabled ⇒ Boolean

  Tell if the system is enabled or not.

• .enabled=(state)

  Enable or disabled the system.

• .fix_follower_event

  Remove event follower from player when the FollowMe gets re-initialized.

• .follower_entities ⇒ Array<#character_name>

  Get the follower entities (those giving information about character_name).

• .get_follower(i) ⇒ Game_Character

  Retrieve a follower.

• .human_count ⇒ Integer

  Get the number of human following the player (Heroes from 2 to n+1).

• .human_count=(count)

  Set the number of human following the player.

• .human_entities ⇒ Array<#character_name>

  Get the human follower entities.

• .in_lets_go_mode? ⇒ Boolean

  Is the FollowMe in Let’s Go Mode.

• .init(viewport)

  Init the FollowMe on a new viewport.

• .is_player_follower?(character) ⇒ Boolean

  Test if a character is a Follower of the player.

• .lets_go_mode=(mode)

  Set the FollowMe Let’s Go Mode state.

• .other_pokemon_count ⇒ Integer

  Get the number of Pokemon from “other_party” following the player.

• .other_pokemon_count=(count)

  Set the number of Pokemon from “other_party” following the player.

• .other_pokemon_entities ⇒ Array<#character_name>

  Get the friend’s pokemon follower entities.

• .particle_push

  Push particle of each character if the Follower Manager was in Battle mode.

• .player_pokemon_entities ⇒ Array<#character_name>

  Get the player’s pokemon follower entities.

• .player_pokemon_lets_go_entity ⇒ Array<#character_name>

  Get the player’s pokemon follower entity if the FollowMe mode is Let’s Go.

• .pokemon_count ⇒ Integer

  Get the number of pokemon following the player.

• .pokemon_count=(count)

  Set the number of pokemon following the player.

• .position_character(c, i)

  Sets the default position of a follower.

• .reload_position_after_battle

  Positions followers in the correct place after battle.

• .reset_position

  Reset position of each follower to the player (entering in a building).

• .save_follower_positions

  Saves follower positions to user_data.

• .selected_follower ⇒ Integer

  Get the current selected follower (to move using player moveroutes).

• .selected_follower=(index1)

  Set the selected follower.

• .set_battle_entry(v = true)

  Set the Follower Manager in Battle mode.

• .set_player_follower_particles(value)

  Enable / Disable the particles for the player followers.

• .set_positions(*args)

  Sets the position of each follower (Warp).

• .smart_disable

  Smart disable the following system (keep it active when smart_enable is called).

• .smart_enable

  Smart disable the following system (keep it active when smart_enable is called).

• .update

  Update of the Follower Management.

• .update_follower(last_follower, i, entity, chara_update) ⇒ Game_Character

  Update of a single follower.

• .update_follower_event(last_follower, follower_event)

  Function that attempts to set the event as last follower.

Class Method Details

.clear

Clears the follower (and dispose them)

# File 'docs/4_Systems_003_Map_Engine.rb', line 1257

def clear
end

.dispose

Dispose the follower and release resources.

# File 'docs/4_Systems_003_Map_Engine.rb', line 1294

def dispose
end

.each_follower(&block)

yield a block on each Followers

Examples:

Turn each follower down

Yuki::FollowMe.each_follower { |c| c.turn_down }

Parameters:

• block (Proc) —

  the block to call

# File 'docs/4_Systems_003_Map_Engine.rb', line 1268

def each_follower(&block)
end

.enabled ⇒ Boolean

Tell if the system is enabled or not

Returns:

• (Boolean)

# File 'docs/4_Systems_003_Map_Engine.rb', line 1159

def enabled
end

.enabled=(state)

Enable or disabled the system

Parameters:

• state (Boolean) —

  new enabled state

# File 'docs/4_Systems_003_Map_Engine.rb', line 1163

def enabled=(state)
end

.fix_follower_event

Remove event follower from player when the FollowMe gets re-initialized

# File 'docs/4_Systems_003_Map_Engine.rb', line 1213

def fix_follower_event
end

.follower_entities ⇒ Array<#character_name>

Get the follower entities (those giving information about character_name)

Returns:

• (Array<#character_name>)

# File 'docs/4_Systems_003_Map_Engine.rb', line 1225

def follower_entities
end

.get_follower(i) ⇒ Game_Character

Retrieve a follower

Parameters:

• i (Integer) —

  index of the follower in the @followers Array

Returns:

• (Game_Character) —

  $game_player if i is invalid

# File 'docs/4_Systems_003_Map_Engine.rb', line 1262

def get_follower(i)
end

.human_count ⇒ Integer

Get the number of human following the player (Heroes from 2 to n+1)

Returns:

• (Integer)

# File 'docs/4_Systems_003_Map_Engine.rb', line 1175

def human_count
end

.human_count=(count)

Set the number of human following the player

Parameters:

• count (Integer) —

  number of human

# File 'docs/4_Systems_003_Map_Engine.rb', line 1179

def human_count=(count)
end

.human_entities ⇒ Array<#character_name>

Get the human follower entities

Returns:

• (Array<#character_name>)

# File 'docs/4_Systems_003_Map_Engine.rb', line 1229

def human_entities
end

.in_lets_go_mode? ⇒ Boolean

Is the FollowMe in Let’s Go Mode

Returns:

• (Boolean)

# File 'docs/4_Systems_003_Map_Engine.rb', line 1199

def in_lets_go_mode?
end

.init(viewport)

Init the FollowMe on a new viewport. Previous Follower are disposed.

Parameters:

• viewport (Viewport) —

  the new viewport

# File 'docs/4_Systems_003_Map_Engine.rb', line 1210

def init(viewport)
end

.is_player_follower?(character) ⇒ Boolean

Test if a character is a Follower of the player

Parameters:

• character (Game_Character)

Returns:

• (Boolean)

# File 'docs/4_Systems_003_Map_Engine.rb', line 1285

def is_player_follower?(character)
end

.lets_go_mode=(mode)

Set the FollowMe Let’s Go Mode state

Parameters:

• mode (Boolean) —

  true if in lets go mode

# File 'docs/4_Systems_003_Map_Engine.rb', line 1203

def lets_go_mode=(mode)
end

.other_pokemon_count ⇒ Integer

Get the number of Pokemon from “other_party” following the player

Returns:

• (Integer)

# File 'docs/4_Systems_003_Map_Engine.rb', line 1191

def other_pokemon_count
end

.other_pokemon_count=(count)

Set the number of Pokemon from “other_party” following the player

Parameters:

• count (Integer)

# File 'docs/4_Systems_003_Map_Engine.rb', line 1195

def other_pokemon_count=(count)
end

.other_pokemon_entities ⇒ Array<#character_name>

Get the friend’s pokemon follower entities

Returns:

• (Array<#character_name>)

# File 'docs/4_Systems_003_Map_Engine.rb', line 1241

def other_pokemon_entities
end

.particle_push

Push particle of each character if the Follower Manager was in Battle mode.

# File 'docs/4_Systems_003_Map_Engine.rb', line 1291

def particle_push
end

.player_pokemon_entities ⇒ Array<#character_name>

Get the player’s pokemon follower entities

Returns:

• (Array<#character_name>)

# File 'docs/4_Systems_003_Map_Engine.rb', line 1233

def player_pokemon_entities
end

.player_pokemon_lets_go_entity ⇒ Array<#character_name>

Get the player’s pokemon follower entity if the FollowMe mode is Let’s Go

Returns:

• (Array<#character_name>)

# File 'docs/4_Systems_003_Map_Engine.rb', line 1237

def player_pokemon_lets_go_entity
end

.pokemon_count ⇒ Integer

Get the number of pokemon following the player

Returns:

• (Integer)

# File 'docs/4_Systems_003_Map_Engine.rb', line 1183

def pokemon_count
end

.pokemon_count=(count)

Set the number of pokemon following the player

Parameters:

• count (Integer)

# File 'docs/4_Systems_003_Map_Engine.rb', line 1187

def pokemon_count=(count)
end

.position_character(c, i)

Sets the default position of a follower

Parameters:

• c (Game_Character) —

  the character

• i (Integer) —

  the index of the caracter in the @followers Array

# File 'docs/4_Systems_003_Map_Engine.rb', line 1254

def position_character(c, i)
end

.reload_position_after_battle

Positions followers in the correct place after battle

# File 'docs/4_Systems_003_Map_Engine.rb', line 1275

def reload_position_after_battle
end

.reset_position

Reset position of each follower to the player (entering in a building)

# File 'docs/4_Systems_003_Map_Engine.rb', line 1281

def reset_position
end

.save_follower_positions

Saves follower positions to user_data

# File 'docs/4_Systems_003_Map_Engine.rb', line 1278

def save_follower_positions
end

.selected_follower ⇒ Integer

Get the current selected follower (to move using player moveroutes)

Returns:

• (Integer) —

  0 = no follower selected

# File 'docs/4_Systems_003_Map_Engine.rb', line 1167

def selected_follower
end

.selected_follower=(index1)

Set the selected follower

Parameters:

• index1 (Integer) —

  index of the follower in the follower stack starting at index 1

# File 'docs/4_Systems_003_Map_Engine.rb', line 1171

def selected_follower=(index1)
end

.set_battle_entry(v = true)

Set the Follower Manager in Battle mode. When getting out of battle every character will get its particle pushed.

# File 'docs/4_Systems_003_Map_Engine.rb', line 1288

def set_battle_entry(v = true)
end

.set_player_follower_particles(value)

Enable / Disable the particles for the player followers

# File 'docs/4_Systems_003_Map_Engine.rb', line 1303

def set_player_follower_particles(value)
end

.set_positions(*args)

Sets the position of each follower (Warp)

Parameters:

• args (Array<Integer, Integer, Integer>) —

  array of x, y, direction

# File 'docs/4_Systems_003_Map_Engine.rb', line 1272

def set_positions(*args)
end

.smart_disable

Smart disable the following system (keep it active when smart_enable is called)

# File 'docs/4_Systems_003_Map_Engine.rb', line 1297

def smart_disable
end

.smart_enable

Smart disable the following system (keep it active when smart_enable is called)

# File 'docs/4_Systems_003_Map_Engine.rb', line 1300

def smart_enable
end

.update

Update of the Follower Management. Their graphics are updated here.

# File 'docs/4_Systems_003_Map_Engine.rb', line 1216

def update
end

.update_follower(last_follower, i, entity, chara_update) ⇒ Game_Character

Update of a single follower

Parameters:

• last_follower (Game_Character) —

  the last follower (in case of Follower creation)

• i (Integer) —

  index in the @followers Array

• entity (PFM::Pokemon, Game_Actor) —

  the entity that is shown as a follower

• chara_update (Boolean) —

  if the character graphics and informations needs to be updated

Returns:

• (Game_Character) —

  the character that will become the last_follower

# File 'docs/4_Systems_003_Map_Engine.rb', line 1249

def update_follower(last_follower, i, entity, chara_update)
end

.update_follower_event(last_follower, follower_event)

Function that attempts to set the event as last follower

Parameters:

• last_follower (Game_Character)
• follower_event (Game_Event)

# File 'docs/4_Systems_003_Map_Engine.rb', line 1221

def update_follower_event(last_follower, follower_event)
end