> For the complete documentation index, see [llms.txt](https://hider.somadocs.fr/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://hider.somadocs.fr/api-developpeur/reference-de-lapi.md).

# Référence de l'API

Tous les types sont dans `top.soma.hider.api`.

### SomaHiderProvider

Point d'accès statique.

| Membre          | Rôle                                                                         |
| --------------- | ---------------------------------------------------------------------------- |
| `get()`         | L'instance de `SomaHider`. Lève une exception si le plugin n'est pas chargé. |
| `getOrNull()`   | L'instance, ou `null`.                                                       |
| `isAvailable()` | `true` si SomaHider est chargé.                                              |

### SomaHider

| Méthode               | Rôle                                                                 |
| --------------------- | -------------------------------------------------------------------- |
| `hide()`              | Ouvre un `ZoneBuilder` pour tout le serveur.                         |
| `hide(Region region)` | Ouvre un `ZoneBuilder` borné par `region`.                           |
| `zones()`             | Les zones ouvertes.                                                  |
| `refresh()`           | Réévalue les règles immédiatement. Sûr depuis n'importe quel thread. |

### ZoneBuilder

| Méthode                          | Rôle                                                                              |
| -------------------------------- | --------------------------------------------------------------------------------- |
| `named(String)`                  | Nomme la zone.                                                                    |
| `disguise(DisguiseProfile)`      | Impose une apparence à la zone.                                                   |
| `disguise(ConfigurationSection)` | Lit l'apparence d'une section de config, par-dessus le déguisement par défaut.    |
| `duration(Duration)`             | Ferme la zone toute seule après un délai.                                         |
| `groupResolver(GroupResolver)`   | Associe chaque joueur à un id de groupe, pour cette zone.                         |
| `reveal(VisibilityRule...)`      | Les règles de révélation (combinées en OU). Sans règle, tout le monde est masqué. |
| `open()`                         | Ouvre la zone et renvoie un `HiderZone`.                                          |

### HiderZone

| Méthode   | Rôle               |
| --------- | ------------------ |
| `name()`  | Le nom de la zone. |
| `close()` | Ferme la zone.     |

### Region

Interface fonctionnelle : `boolean contains(Location)`.

| Membre                            | Rôle                                       |
| --------------------------------- | ------------------------------------------ |
| `Region.circle(Location, double)` | Un disque horizontal (l'axe Y est ignoré). |

### Reveal

Fabriques de `VisibilityRule`.

| Fabrique                                       | Rôle                                                 |
| ---------------------------------------------- | ---------------------------------------------------- |
| `sameGroup()`                                  | Révèle les joueurs du même groupe que l'observateur. |
| `group(String)`                                | Révèle un groupe à tout le monde.                    |
| `group(Supplier<String>)`                      | Idem, avec une valeur relue à chaque passage.        |
| `groupsTogether(Supplier<Collection<String>>)` | Révèle un ensemble de groupes entre eux.             |
| `permission(String)`                           | Révèle tout le monde aux porteurs d'une permission.  |
| `of(BiPredicate<Player, Player>)`              | Un test sur `(viewer, target)`.                      |
| `never()`                                      | Ne révèle personne.                                  |

### VisibilityRule

Interface fonctionnelle : `boolean reveals(Player viewer, Player target, RuleContext context)`. Se combine avec `or`, `and` et `negate`.

### DisguiseProfile

Record qui décrit une apparence : `showName`, `showHealth`, `namePrefix`, `showArmor`, `showFire`, `showStuckArrows`, `showCape`, `showNbts`. Construisez-le avec `DisguiseProfile.builder()`, ou lisez-le d'une section avec `DisguiseProfile.fromSection(section, defaut)`.


---

# 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, and the optional `goal` query parameter:

```
GET https://hider.somadocs.fr/api-developpeur/reference-de-lapi.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.