非戦闘員のアクターがゲストとしてフォローできるようにするプラグイン – HIME_GuestFollowers.js

-------------------------------------------------------------------------------
== Description ==

Video: https://www.youtube.com/watch?v=5ZJM4KXd19U

In RPG Maker, you have a party of actors.

You can add actors to the party, or remove actors from the party at anytime.
However, by default, all of the actors in the party can be interacted with
in the menu, and may participate in battle.

There may be situations where you just want an actor to "appear" as if they
are part of the the party, but aren't actually in the party. For example,
let's say an NPC asked you to accompany them through a cave, and you wanted
the player to see that the NPC is following them, but you didn't want them
to actually use the NPC in battle.

With this plugin, you can add actors as "guests", which would simply allow
them to show up as non-party followers.

== Terms of Use ==

- Free for use in non-commercial projects with credits
- Free for use in commercial projects, but it would be nice to let me know
- Please provide credits to HimeWorks

== Change Log ==

1.3 - Mar 26, 2016
fixed bug where plugin command fails
1.2 - Mar 25, 2016
added support for guest follower move route mode
1.1 - Mar 22, 2016
Fixed bug where plugin crashes if player has no followers
1.0 - Mar 21, 2016
Initial release

== Usage ==

-- Adding Guest Actors to Party --

To add guest actors to the party, use the script call

PARTY.addGuestActor( ACTOR_ID );

Where the PARTY is a valid Game_Party reference, and ACTOR_ID is the ID of
the actor that you want to add as a guest.

For example, to add actor 4 as a guest to the current party, you can write

$gameParty.addGuestActor(4);

You can only add the same guest actor to your party once. If you attempt to
add the same guest actor multiple times, it will do nothing.

-- Removing Guest Actors from Party --

To remove guest actors from a party, use the script call

PARTY.removeGuestActor( ACTOR_ID );

For example, to remove actor 4 as a guest from the current party, you can write

$gameParty.removeGuestActor(4);

-- Checking if Guest Actor is in Party --

To check if a certain guest actor is in the party, use the script call

PARTY.hasGuestActor( ACTOR_ID );

For example, to check if actor 4 is a guest to the current party, in your
conditional branches you can write

$gameParty.hasGuestActor(4);

Which will return true if actor 4 is a guest in the party.

-- Controlling Guest Followers in Move Routes --

You can use a move route to control guest followers if necessary.
To move a guest, start by writing a plugin command

guest_move_route ID

Followed by a move route command.
The ID means the ID of the actor guest. So if you wanted to move the guest
whose actor ID was 4, you would just write

guest_move_route 4

Followed by a move route command.

-------------------------------------------------------------------------------