Module: Yuki::FollowMe

Defined in:
docs/01450_Systems_00003_Map_Engine.rb

Class Method Summary collapse

Class Method Details

.clear

Clears the follower (and dispose them)



959
960
# File 'docs/01450_Systems_00003_Map_Engine.rb', line 959

def clear
end

.dispose

Dispose the follower and release resources.



990
991
# File 'docs/01450_Systems_00003_Map_Engine.rb', line 990

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



970
971
# File 'docs/01450_Systems_00003_Map_Engine.rb', line 970

def each_follower(&block)
end

.enabledBoolean

Tell if the system is enabled or not

Returns:

  • (Boolean)


861
862
# File 'docs/01450_Systems_00003_Map_Engine.rb', line 861

def enabled
end

.enabled=(state)

Enable or disabled the system

Parameters:

  • state (Boolean)

    new enabled state



865
866
# File 'docs/01450_Systems_00003_Map_Engine.rb', line 865

def enabled=(state)
end

.fix_follower_event

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



915
916
# File 'docs/01450_Systems_00003_Map_Engine.rb', line 915

def fix_follower_event
end

.follower_entitiesArray<#character_name>

Get the follower entities (those giving information about character_name)

Returns:

  • (Array<#character_name>)


927
928
# File 'docs/01450_Systems_00003_Map_Engine.rb', line 927

def follower_entities
end

.get_follower(i) ⇒ Game_Character

Retrieve a follower

Parameters:

  • i (Integer)

    index of the follower in the @followers Array

Returns:



964
965
# File 'docs/01450_Systems_00003_Map_Engine.rb', line 964

def get_follower(i)
end

.human_countInteger

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

Returns:

  • (Integer)


877
878
# File 'docs/01450_Systems_00003_Map_Engine.rb', line 877

def human_count
end

.human_count=(count)

Set the number of human following the player

Parameters:

  • count (Integer)

    number of human



881
882
# File 'docs/01450_Systems_00003_Map_Engine.rb', line 881

def human_count=(count)
end

.human_entitiesArray<#character_name>

Get the human follower entities

Returns:

  • (Array<#character_name>)


931
932
# File 'docs/01450_Systems_00003_Map_Engine.rb', line 931

def human_entities
end

.in_lets_go_mode?Boolean

Is the FollowMe in Let’s Go Mode

Returns:

  • (Boolean)


901
902
# File 'docs/01450_Systems_00003_Map_Engine.rb', line 901

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



912
913
# File 'docs/01450_Systems_00003_Map_Engine.rb', line 912

def init(viewport)
end

.is_player_follower?(character) ⇒ Boolean

Test if a character is a Follower of the player

Parameters:

Returns:

  • (Boolean)


981
982
# File 'docs/01450_Systems_00003_Map_Engine.rb', line 981

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



905
906
# File 'docs/01450_Systems_00003_Map_Engine.rb', line 905

def lets_go_mode=(mode)
end

.other_pokemon_countInteger

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

Returns:

  • (Integer)


893
894
# File 'docs/01450_Systems_00003_Map_Engine.rb', line 893

def other_pokemon_count
end

.other_pokemon_count=(count)

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

Parameters:

  • count (Integer)


897
898
# File 'docs/01450_Systems_00003_Map_Engine.rb', line 897

def other_pokemon_count=(count)
end

.other_pokemon_entitiesArray<#character_name>

Get the friend’s pokemon follower entities

Returns:

  • (Array<#character_name>)


943
944
# File 'docs/01450_Systems_00003_Map_Engine.rb', line 943

def other_pokemon_entities
end

.particle_push

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



987
988
# File 'docs/01450_Systems_00003_Map_Engine.rb', line 987

def particle_push
end

.player_pokemon_entitiesArray<#character_name>

Get the player’s pokemon follower entities

Returns:

  • (Array<#character_name>)


935
936
# File 'docs/01450_Systems_00003_Map_Engine.rb', line 935

def player_pokemon_entities
end

.player_pokemon_lets_go_entityArray<#character_name>

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

Returns:

  • (Array<#character_name>)


939
940
# File 'docs/01450_Systems_00003_Map_Engine.rb', line 939

def player_pokemon_lets_go_entity
end

.pokemon_countInteger

Get the number of pokemon following the player

Returns:

  • (Integer)


885
886
# File 'docs/01450_Systems_00003_Map_Engine.rb', line 885

def pokemon_count
end

.pokemon_count=(count)

Set the number of pokemon following the player

Parameters:

  • count (Integer)


889
890
# File 'docs/01450_Systems_00003_Map_Engine.rb', line 889

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



956
957
# File 'docs/01450_Systems_00003_Map_Engine.rb', line 956

def position_character(c, i)
end

.reset_position

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



977
978
# File 'docs/01450_Systems_00003_Map_Engine.rb', line 977

def reset_position
end

.selected_followerInteger

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

Returns:

  • (Integer)

    0 = no follower selected



869
870
# File 'docs/01450_Systems_00003_Map_Engine.rb', line 869

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



873
874
# File 'docs/01450_Systems_00003_Map_Engine.rb', line 873

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.



984
985
# File 'docs/01450_Systems_00003_Map_Engine.rb', line 984

def set_battle_entry(v = true)
end

.set_player_follower_particles(value)

Enable / Disable the particles for the player followers



999
1000
# File 'docs/01450_Systems_00003_Map_Engine.rb', line 999

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



974
975
# File 'docs/01450_Systems_00003_Map_Engine.rb', line 974

def set_positions(*args)
end

.smart_disable

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



993
994
# File 'docs/01450_Systems_00003_Map_Engine.rb', line 993

def smart_disable
end

.smart_enable

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



996
997
# File 'docs/01450_Systems_00003_Map_Engine.rb', line 996

def smart_enable
end

.update

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



918
919
# File 'docs/01450_Systems_00003_Map_Engine.rb', line 918

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



951
952
# File 'docs/01450_Systems_00003_Map_Engine.rb', line 951

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:



923
924
# File 'docs/01450_Systems_00003_Map_Engine.rb', line 923

def update_follower_event(last_follower, follower_event)
end