> For the complete documentation index, see [llms.txt](https://ultimateteams.gitbook.io/ultimateteams-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://ultimateteams.gitbook.io/ultimateteams-docs/hooks.md).

# Hooks

##

## Vault

UltimateTeams can hook into vault, to then use any economy plugin for the economy features

## PlaceholderAPI

UltimateTeams provides certain placeholders to be used within your server when placeholderapi is installed.

{% hint style="info" %}
For placeholders that require players to be in a team, you can customize the value that is shown if they are not in a team from the plugin's config
{% endhint %}

Those placeholders are available starting from version 4.7.5 (still in testing). older placeholders are still supported

| Placeholder                                   | Description                                                | values / example     |
| --------------------------------------------- | ---------------------------------------------------------- | -------------------- |
| %ultimateteams\_team\_name%                   | The name of the team                                       | Text                 |
| %ultimateteams\_team\_name\_raw%              | The name of the team without colors                        | Text                 |
| %ultimateteams\_team\_prefix%                 | the prefix of the team                                     | Text                 |
| %ultimateteams\_team\_owner%                  | The name of the team owner                                 | Text                 |
| %ultimateteams\_team\_role%                   | Your role in the team                                      | Owner/Manager/Member |
| %ultimateteams\_team\_online\_members\_count% | number of online members of your team                      | Number               |
| %ultimateteams\_team\_balance%                | the balance of your team                                   | Number               |
| %ultimateteams\_team\_motd%                   | the MOTD of your team                                      | Text                 |
| %ultimateteams\_team\_fee%                    | the join fee of your team                                  | Number               |
| %ultimateteams\_team\_fee\_status%            | if the join fee is enabled/disabled                        | true/false           |
| %ultimateteams\_team\_pvp%                    | team PvP status                                            | true/false           |
| %ultimateteams\_team\_home\_set%              | if the team has the home set or not                        | true/false           |
| %ultimateteams\_team\_home\_world%            | The world of the team home                                 | Text                 |
| %ultimateteams\_team\_home\_x%                | the x coordinate of the team home                          | Number               |
| %ultimateteams\_team\_home\_y%                | the y coordinate of the team home                          | Number               |
| %ultimateteams\_team\_home\_z%                | the z coordinate of the team home                          | Number               |
| %ultimateteams\_team\_members\_count%         | The number of the team members                             | Number               |
| %ultimateteams\_team\_allies\_count%          | The number of the allied teams                             | Number               |
| %ultimateteams\_team\_enemies\_count%         | The number of the enemies teams                            | Number               |
| %ultimateteams\_team\_max\_members%           | The number of the max team                                 | Number               |
| %ultimateteams\_is\_in\_team%                 |                                                            | true/false           |
| %ultimateteams\_team\_kills\_total%           | The sum of all the kills of each team member               | Number               |
| %ultimateteams\_team\_deaths\_total%          | The sum of all the deaths of each team member              | Number               |
| %ultimateteams\_player\_team\_chat\_talking%  | true if a player has enabled team chat for every message   | true/false           |
| %ultimateteams\_player\_ally\_chat\_talking%  | true if a player has enabled allies chat for every message | true/false           |
| %ultimateteams\_player\_invites\_status%      | true if a player is accepting invitations                  | true/false           |
| %ultimateteams\_team\_balance\_\<team>%       | the balance of a team based to the given name              | Number               |
| %ultimateteams\_is\_in\_team\_\<player>%      |                                                            | true/false           |

{% hint style="info" %}
The message displayed if a player is not in a team is customizable in the plugin's config
{% endhint %}

## LuckPerms

UltimateTeams provides additional [Permission contexts](https://luckperms.net/wiki/Context) for luckperms, letting you for example give certain permissions only to team owners.

Available contexts are:

| Name          | Values             | Description                                    |
| ------------- | ------------------ | ---------------------------------------------- |
| is-in-team    | true/false         | True if a player is in a team                  |
| is-team-owner | true/false         | True if a player is a team owner               |
| team-name     | null/The team name | null if not in a team, otherwise the team name |

## HuskHomes

If HuskHomes is installed, and the hook enabled in the config, UltimateTeams will use it for teleportation.

That ends up with a more customizable teleportation expierence (timer before tp, tp canceletion on player move etc)

## FloodGate

If floodgate is installed and correctly configured (with its API enabled) bedrock players will be automatically managed


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://ultimateteams.gitbook.io/ultimateteams-docs/hooks.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
