Module: Yuki::FollowMe

Defined in:
docs/4_Systems_003_Map_Engine.rb

Overview

The Player Follower Manager

Author:

  • Nuri Yuri

Defined Under Namespace

Modules: FMSceneMapUpdate, FMSpriteSetMapPlugin

Class Method Summary collapse

Class Method Details

.clear

Clears the follower (and dispose them)



1427
1428
# File 'docs/4_Systems_003_Map_Engine.rb', line 1427

def clear
end

.dispose

Dispose the follower and release resources.



1465
1466
# File 'docs/4_Systems_003_Map_Engine.rb', line 1465

def dispose
end

.each_follower(&block) {|character| ... }

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

Yield Parameters:



1439
1440
# File 'docs/4_Systems_003_Map_Engine.rb', line 1439

def each_follower(&block)
end

.enabled ⇒ Boolean

Tell if the system is enabled or not

Returns:

  • (Boolean)


1329
1330
# File 'docs/4_Systems_003_Map_Engine.rb', line 1329

def enabled
end

.enabled=(state)

Enable or disabled the system

Parameters:

  • state (Boolean) —

    new enabled state



1333
1334
# File 'docs/4_Systems_003_Map_Engine.rb', line 1333

def enabled=(state)
end

.fix_follower_event

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



1383
1384
# File 'docs/4_Systems_003_Map_Engine.rb', line 1383

def fix_follower_event
end

.follower_entities ⇒ Array<#character_name>

Get the follower entities (those giving information about character_name)

Returns:

  • (Array<#character_name>)


1395
1396
# File 'docs/4_Systems_003_Map_Engine.rb', line 1395

def follower_entities
end

.get_follower(i) ⇒ Game_Character

Retrieve a follower

Parameters:

  • i (Integer) —

    index of the follower in the @followers Array

Returns:



1432
1433
# File 'docs/4_Systems_003_Map_Engine.rb', line 1432

def get_follower(i)
end

.human_count ⇒ Integer

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

Returns:

  • (Integer)


1345
1346
# File 'docs/4_Systems_003_Map_Engine.rb', line 1345

def human_count
end

.human_count=(count)

Set the number of human following the player

Parameters:

  • count (Integer) —

    number of human



1349
1350
# File 'docs/4_Systems_003_Map_Engine.rb', line 1349

def human_count=(count)
end

.human_entities ⇒ Array<#character_name>

Get the human follower entities

Returns:

  • (Array<#character_name>)


1399
1400
# File 'docs/4_Systems_003_Map_Engine.rb', line 1399

def human_entities
end

.in_lets_go_mode? ⇒ Boolean

Is the FollowMe in Let's Go Mode

Returns:

  • (Boolean)


1369
1370
# File 'docs/4_Systems_003_Map_Engine.rb', line 1369

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



1380
1381
# File 'docs/4_Systems_003_Map_Engine.rb', line 1380

def init(viewport)
end

.is_player_follower?(character) ⇒ Boolean

Test if a character is a Follower of the player

Parameters:

Returns:

  • (Boolean)


1456
1457
# File 'docs/4_Systems_003_Map_Engine.rb', line 1456

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



1373
1374
# File 'docs/4_Systems_003_Map_Engine.rb', line 1373

def lets_go_mode=(mode)
end

.other_pokemon_count ⇒ Integer

Get the number of Pokemon from "other_party" following the player

Returns:

  • (Integer)


1361
1362
# File 'docs/4_Systems_003_Map_Engine.rb', line 1361

def other_pokemon_count
end

.other_pokemon_count=(count)

Set the number of Pokemon from "other_party" following the player

Parameters:

  • count (Integer)


1365
1366
# File 'docs/4_Systems_003_Map_Engine.rb', line 1365

def other_pokemon_count=(count)
end

.other_pokemon_entities ⇒ Array<#character_name>

Get the friend's pokemon follower entities

Returns:

  • (Array<#character_name>)


1411
1412
# File 'docs/4_Systems_003_Map_Engine.rb', line 1411

def other_pokemon_entities
end

.particle_push

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



1462
1463
# File 'docs/4_Systems_003_Map_Engine.rb', line 1462

def particle_push
end

.player_pokemon_entities ⇒ Array<#character_name>

Get the player's pokemon follower entities

Returns:

  • (Array<#character_name>)


1403
1404
# File 'docs/4_Systems_003_Map_Engine.rb', line 1403

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>)


1407
1408
# File 'docs/4_Systems_003_Map_Engine.rb', line 1407

def player_pokemon_lets_go_entity
end

.pokemon_count ⇒ Integer

Get the number of pokemon following the player

Returns:

  • (Integer)


1353
1354
# File 'docs/4_Systems_003_Map_Engine.rb', line 1353

def pokemon_count
end

.pokemon_count=(count)

Set the number of pokemon following the player

Parameters:

  • count (Integer)


1357
1358
# File 'docs/4_Systems_003_Map_Engine.rb', line 1357

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



1424
1425
# File 'docs/4_Systems_003_Map_Engine.rb', line 1424

def position_character(c, i)
end

.reload_position_after_battle

Positions followers in the correct place after battle



1446
1447
# File 'docs/4_Systems_003_Map_Engine.rb', line 1446

def reload_position_after_battle
end

.reset_position

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



1452
1453
# File 'docs/4_Systems_003_Map_Engine.rb', line 1452

def reset_position
end

.save_follower_positions

Saves follower positions to user_data



1449
1450
# File 'docs/4_Systems_003_Map_Engine.rb', line 1449

def save_follower_positions
end

.selected_follower ⇒ Integer

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

Returns:

  • (Integer) —

    0 = no follower selected



1337
1338
# File 'docs/4_Systems_003_Map_Engine.rb', line 1337

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



1341
1342
# File 'docs/4_Systems_003_Map_Engine.rb', line 1341

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.



1459
1460
# File 'docs/4_Systems_003_Map_Engine.rb', line 1459

def set_battle_entry(v = true)
end

.set_player_follower_particles(value)

Enable / Disable the particles for the player followers



1474
1475
# File 'docs/4_Systems_003_Map_Engine.rb', line 1474

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



1443
1444
# File 'docs/4_Systems_003_Map_Engine.rb', line 1443

def set_positions(*args)
end

.smart_disable

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



1468
1469
# File 'docs/4_Systems_003_Map_Engine.rb', line 1468

def smart_disable
end

.smart_enable

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



1471
1472
# File 'docs/4_Systems_003_Map_Engine.rb', line 1471

def smart_enable
end

.update

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



1386
1387
# File 'docs/4_Systems_003_Map_Engine.rb', line 1386

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



1419
1420
# File 'docs/4_Systems_003_Map_Engine.rb', line 1419

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:



1391
1392
# File 'docs/4_Systems_003_Map_Engine.rb', line 1391

def update_follower_event(last_follower, follower_event)
end