Below is a demonstration of Squadron in action.
Squadron-Tele-Collide.mp4
Below is a demonstration of the, updated orientation options, and the elevation tracking options.
squadron-third-dimension.mp4
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.
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".
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.
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.
Signature: async squadron.follow(leaderId, followerId, sceneId, orientation = squadron.CONST.QUERY, options={elevation=true,snap=true})
leaderId: "string "Id of the token that the token specified by followerId should follow.
followerId: "string "Id of the token that should follow the token specified by leaderId.
sceneId: "string "Id of the scene the tokens can be found in.
orientation: {object} Specifies the orientation the follower token is supposed to keep in regards to the leading token. Accepts any of the values accessible in squadron.CONST. Namely squadron.CONST.DOWN, squadron.CONST.LEFT, squadron.CONST.NONE, squadron.CONST.RIGHT, squadron.CONST.UP and squadron.CONST.QUERY. In the case squadron.CONST.QUERY is passed the user will be asked for the direction when the script is executed. This is also the default value.
options: {object} Accepts an object in which the elevation and snap keys can be specified as boolean values. These specify whether the following token follows elevation changes aswell and whether it is supposed to snap to grid when following respectively. By default both are true.
Signature: async squadron.stop(tokenDocument)
tokenDocument: {tokenDocument} Stops the token associated with the passed token document from following other tokens and clears all configured following behaviour on it.
Signature: async squadron.pause(tokenDocument)
tokenDocument: {tokenDocument} Temporarily stops the token associated with the passed token document from following other tokens but does not clear configured following behaviour.
Signature: async squadron.resume(tokenDocument)
tokenDocument: {tokenDocument} Resumes paused following behaviour of the token associated with the passed token document.
Included with Squadron is squadron.disband, which 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.
Bundled with care by
