Module: Yuki::FollowMe
- Defined in:
- docs/01450_Systems_00003_Map_Engine.rb
Class Method Summary collapse
-
.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.
-
.reset_position
Reset position of each follower to the player (entering in a building).
-
.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)
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
970 971 |
# File 'docs/01450_Systems_00003_Map_Engine.rb', line 970 def each_follower(&block) end |
.enabled ⇒ Boolean
Tell if the system is enabled or not
861 862 |
# File 'docs/01450_Systems_00003_Map_Engine.rb', line 861 def enabled end |
.enabled=(state)
Enable or disabled the system
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_entities ⇒ Array<#character_name>
Get the follower entities (those giving information about 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
964 965 |
# File 'docs/01450_Systems_00003_Map_Engine.rb', line 964 def get_follower(i) end |
.human_count ⇒ Integer
Get the number of human following the player (Heroes from 2 to n+1)
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
881 882 |
# File 'docs/01450_Systems_00003_Map_Engine.rb', line 881 def human_count=(count) end |
.human_entities ⇒ Array<#character_name>
Get the human follower entities
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
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.
912 913 |
# File 'docs/01450_Systems_00003_Map_Engine.rb', line 912 def init() end |
.is_player_follower?(character) ⇒ Boolean
Test if a character is a Follower of the player
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
905 906 |
# File 'docs/01450_Systems_00003_Map_Engine.rb', line 905 def lets_go_mode=(mode) end |
.other_pokemon_count ⇒ Integer
Get the number of Pokemon from “other_party” following the player
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
897 898 |
# File 'docs/01450_Systems_00003_Map_Engine.rb', line 897 def other_pokemon_count=(count) end |
.other_pokemon_entities ⇒ Array<#character_name>
Get the friend’s pokemon follower entities
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_entities ⇒ Array<#character_name>
Get the player’s pokemon follower entities
935 936 |
# File 'docs/01450_Systems_00003_Map_Engine.rb', line 935 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
939 940 |
# File 'docs/01450_Systems_00003_Map_Engine.rb', line 939 def player_pokemon_lets_go_entity end |
.pokemon_count ⇒ Integer
Get the number of pokemon following the player
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
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
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_follower ⇒ Integer
Get the current selected follower (to move using player moveroutes)
869 870 |
# File 'docs/01450_Systems_00003_Map_Engine.rb', line 869 def selected_follower end |
.selected_follower=(index1)
Set the selected follower
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)
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
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
923 924 |
# File 'docs/01450_Systems_00003_Map_Engine.rb', line 923 def update_follower_event(last_follower, follower_event) end |