Squadron

A system agnostic Warp Gate pylon for formation, or marching order, management for Foundry VTT. Requires Warp Gate v1.7.4 or higher.

Usage

Most of the functionality of Squadron is contained within a button added to a token's right click HUD and has three states of operation, which are detailed below.

Default (No Leader)

Clicking the "Pick Leader" button will prompt the user to click on the token they wish to follow. Once a leader has been selected, a dialog will appear that asks for the "formation direction" (as seen below).

This dialog asks the user about how the formation is oriented, or in other words, which direction the leader is marching. For example, in the above picture, if I wanted the Follower token to be _behind_ the Leader token while marching, I would select "Right" as the direction. This indicates that the formation is moving to the right. If I instead wanted to walk side-by-side with the Leader token, I would select "Down" or "Up" depending on the exact side (left or right) of the Leader token I want to be on.

Leave Formation

While following, this button now controls leaving the formation entirely (i.e. stop following). This restores the Follower to the default state and will not respond to any previous Leader's movements.

Rejoin Formation

If a token that is currently in formation or following a leader moves on its own accord (not triggered by its leader moving), then the Follower token will be placed in a "paused" state and will not respond to its Leader's movements. This will also occur (optionally) if the movement required to stay in formation intersects a movement blocking wall. Clicking rejoin formation will cause the Follower to resume following its Leader in formation.

For example, if a group is in formation crawling through a dungeon and enters a room, it is likely that each member of the group will go off and search or investigate their own thing. Once the room as been cleared of monsters or searched, and the group is ready to move on, each follower will simply click Rejoin Formation and will fall back in line with their Leader in the previous formation.

Troubleshooting Utilities

Included with Squadron is a single API command, `squadron.disband` that will remove ALL squadron data from tokens on the current scene (default) or on ALL scenes with `squadron.disband(true)`. In the unlikely event that Squadron breaks down, garbage follower/leader data may be left on tokens and can be removed using this command.