Skip to content

How to Use Token Action HUD

Larkinabout edited this page Jun 8, 2023 · 11 revisions

HUD

Unlock/Lock the HUD

token-action-hud-core-unlock-lock-hud

Collapse/Expand the HUD

token-action-hud-core-collapse-expand-hud

Groups

Add a Group

token-action-hud-core-add-group

Remove a Group

token-action-hud-core-remove-group

Move a Group

token-action-hud-core-move-group

Collapse/Expand a Group

token-action-hud-core-collapse-expand-group

Add Image to Group

token-action-hud-core-add-image-to-group

Hide Title from Group

token-action-hud-core-hide-group-title

Actions

Add an Action

token-action-hud-core-add-action

Remove an Action

token-action-hud-core-remove-action

Sort Actions Alphabetically

token-action-hud-core-sort-actions

Module Settings

Customize Style

A dialog of options to customize the style of the HUD. The custom style is only applied when the 'Style' module setting is set to 'Custom'.

Style

The style or theme of the HUD. When 'Custom' is selected, the options from the 'Customize Style' dialog are applied.

Direction

The direction the HUD will expand. 'Auto' will automatically switch the direction based on whether the HUD is located near to the top or bottom of the window.

Grid

When ticked, the grid layout is applied to all actions in the HUD. This setting overrides any other grid setting. The grid layout calculates the median width and sets all actions to the same width. Truncation of the action name may occur.

HUD Scale

The scale of the HUD. Lower the number to decrease the scale of the HUD and raise the number to increase the scale of the HUD.

Dragging

Choose when the HUD can be moved by clicking and dragging on of the top-level buttons. Choices are:

  • Always: Always allow the HUD to be moved.
  • When Unlocked: Only allow the HUD to be moved when the HUD is unlocked.
  • Never: Never allow the HUD to be moved.

Enable HUD

When ticked, the HUD is enabled. This setting can be toggled by pressing the 'Toggle HUD' hotkey (default is H).

Roll Handler

Only available to the GM. The roll handler to use. If the Token Action HUD system module supports multiple roll handlers, the roll handler can be selected here.

Allow HUD

Only available to the GM. Allow the HUD to be used by users with the selected role and above. 'Players' is the lowest role permission and would allow all users to use the HUD.

Enable Customization

Only available to the GM. When unticked, only the default HUD layout will be used and all customization options (aside from module settings) will be disabled.

Always Show HUD

When ticked, the HUD will show the user's assigned character. This is often used by players to show their character's HUD without needing to select their token first. The user must be assigned a character for this setting to work.

Display Character Name

When ticked, the character's name will be displayed above the HUD. This setting is disabled when the HUD expands upwards.

Icon Display

Where available, choose whether to display icons on the actions.

Tooltip Display

Where available, choose how tooltips are displayed when actions are hovered. Choices are:

  • Full Tooltip: Display the full tooltip.
  • Name Only: Display the name only.
  • No Tooltips: Do not display tooltips.

Click to Open

When ticked, the HUD groups open and close when clicked rather than hovered.

Open Item Sheet on Right-Click

When ticked, an item's sheet is opened when the action is right-clicked.

Show Item Macros

Only applicable when the 'Item Macro' is installed. The options determine whether item macros are added to the HUD or replace the original action. The options are:

  • Show original item and item macro: When selected, the item's original action and the item's macro are added as separate actions. Item macro actions are denoted by an 'M'.
  • Show item macro only: The item's original action is replaced by the item macro.
  • Show original item only: Item macros are not added to the HUD.

Mark Active Actions with Asterisk

When ticked, toggleable actions will be marked with an asterisk (*) when they are active.

Debug

When ticked, debug messages will be logged in the browser console. This setting should be switched off during normal play.

Reset HUD

When ticked and 'Save Changes' is clicked, the HUD will reset to the default layout. This setting will untick itself once the HUD is reset.