> 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.md).

# API Développeur

SomaHider fournit une API pour que votre plugin ouvre des zones et décide qui voit qui.

### Ajouter la dépendance

Ajoutez le dépôt et dépendez de `top.soma.hider:api`. Utilisez `compileOnly` (Gradle) ou `provided` (Maven) : le plugin installé fournit les classes à l'exécution.

{% tabs %}
{% tab title="Gradle" %}

```gradle
repositories {
    maven { url = uri('https://sowmha.github.io/maven/') }
}

dependencies {
    compileOnly("top.soma.hider:api:1.1.0")
}
```

{% endtab %}

{% tab title="Maven" %}

```xml
<repository>
  <id>soma</id>
  <url>https://sowmha.github.io/maven/</url>
</repository>

<dependency>
  <groupId>top.soma.hider</groupId>
  <artifactId>api</artifactId>
  <version>1.1.0</version>
  <scope>provided</scope>
</dependency>
```

{% endtab %}
{% endtabs %}

Indiquez ensuite au serveur que votre plugin a besoin de SomaHider :

```yaml
depend: [SomaHider]
```

Utilisez plutôt `softdepend` si les zones sont optionnelles, et vérifiez `SomaHiderProvider.isAvailable()` avant d'appeler l'API.

{% hint style="info" %}
L'URL du dépôt et la version indiquées ici correspondent à la configuration actuelle. Confirmez la dernière version publiée avant de livrer.
{% endhint %}

### Récupérer le point d'entrée

```java
SomaHider hider = SomaHiderProvider.get();
```

`get()` lève une exception si SomaHider n'est pas chargé. Pour une intégration optionnelle, utilisez d'abord `isAvailable()` ou `getOrNull()`.

### Ouvrir une zone

Voici le flux complet : couvrir une arène, garder les coéquipiers reconnaissables entre eux, et fermer la zone une fois terminé.

```java
HiderZone zone = SomaHiderProvider.get()
        .hide(arena::contains)                 // n'importe quelle Region : boolean contains(Location)
        .groupResolver(player -> factionId(player))
        .reveal(Reveal.sameGroup())            // les coéquipiers se voient encore
        .open();

// plus tard, à la fin du combat
zone.close();
```

### Les éléments

#### Region

Où la zone s'applique. `Region` est une interface fonctionnelle avec une seule méthode, `boolean contains(Location)` : une référence comme `arena::contains` suffit. `Region.circle(center, radius)` donne un disque. `hide()` sans région couvre tout le serveur.

#### Règles de révélation

Par défaut, personne n'est reconnu dans une zone. Les règles ajoutent des exceptions, combinées en OU. Construisez-les avec `Reveal` et composez-les avec `or`, `and` et `negate`. Des recettes prêtes à l'emploi sont dans [Règles de révélation](/api-developpeur/regles-de-revelation.md).

#### Résolveur de groupe

`groupResolver` associe un joueur à un id de groupe : une faction, une équipe. Il est propre à la zone, donc deux plugins n'entrent jamais en conflit. Un groupe `null` ne correspond jamais.

#### Déguisement et durée

`disguise(...)` remplace l'apparence pour une zone, à partir d'un `DisguiseProfile` ou d'une section de config. `duration(Duration)` ferme la zone toute seule après un délai.

#### refresh()

Les règles sont réévaluées en continu. Appelez `hider.refresh()` pour forcer une réévaluation immédiate après avoir changé une condition externe, afin que le changement tombe sur le même tick. L'appel est sûr depuis n'importe quel thread.

### Aller plus loin

* [Règles de révélation](/api-developpeur/regles-de-revelation.md) : des recettes pour révéler certains joueurs.
* [Référence de l'API](/api-developpeur/reference-de-lapi.md) : tous les types publics.


---

# 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.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.