Skip to content

Commit 1fbf2ac

Browse files
imroxxorimroxxor
authored
Amélioration Variables (#250)
1 parent 0ded654 commit 1fbf2ac

1 file changed

Lines changed: 125 additions & 21 deletions

File tree

‎docs/3.autres/6.variables.md‎

Lines changed: 125 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,19 @@ updatedAt: '2025-10-23'
88

99
## Syntaxe générale
1010

11+
Les variables s'utilisent toujours entre accolades `{}` et suivent l'une des structures suivantes :
12+
1113
- `{variable}` : Variable simple
1214
- `{variable:paramètres}` : Variable avec paramètres
1315
- `{variable?modifieur}` : Variable avec modificateur
1416
- `{variable:paramètres?modifieur}` : Variable avec paramètres et modificateur
1517

18+
**Exemple :**
19+
20+
- `{user.username}`
21+
- `{user.created_at:format=DD/MM/YYYY}`
22+
- `{level.rank?ordinal}`
23+
1624
## Paramètres
1725

1826
Les paramètres permettent d'affiner le comportement d'une variable en lui transmettant des informations complémentaires. Ils s'ajoutent après le nom de la variable, chacun étant précédé du symbole deux-points `:`.
@@ -24,6 +32,75 @@ Chaque paramètre suit la structure `nom=valeur`. Lorsque vous souhaitez utilise
2432
- `{level.rank:user_id=123456789012345678}`
2533
- `{user.created_at:user_id=123456789012345678:format=DD MMMM YYYY}`
2634

35+
## Paramètres communs
36+
37+
Cette section regroupe les paramètres utilisés par plusieurs variables. Lorsqu'un paramètre est mentionné plus loin sans explication détaillée, référez-vous à cette section.
38+
39+
### user_id
40+
41+
Identifiant Discord d'un utilisateur ciblé par la variable.
42+
43+
- **Type :** ID Discord
44+
- **Obligatoire :** Selon la variable
45+
46+
### role_id
47+
48+
Identifiant Discord d'un rôle.
49+
50+
- **Type :** ID Discord
51+
- **Obligatoire :** Pour les variables liées aux rôles
52+
53+
::hint{ type="warning" }
54+
Ce paramètre est obligatoire pour toutes les variables de rôle.
55+
::
56+
57+
### channel_id
58+
59+
Identifiant Discord d'un salon.
60+
61+
- **Type :** ID Discord
62+
- **Obligatoire :** selon la variable
63+
64+
### format
65+
66+
Définit le format d'affichage des dates et heures.
67+
68+
- **Valeur par défaut :** `L` (date) ou `LT` (heure)
69+
70+
- **Valeurs acceptées :**
71+
72+
- `relative` → affichage relatif (ex : il y a 2 heures)
73+
74+
- format personnalisé (ex : DD/MM/YYYY, HH:mm)
75+
76+
::hint{ type="info" }
77+
La liste des différents formats est disponible sur [cette page](/docs/autres/timestamps) de la documentation.
78+
::
79+
80+
| Variable | Exemple format | Exemple réponse |
81+
|----------|----------------|-----------------|
82+
| stream.start_at | Le stream débutera le `{stream.start_at:format=DD/MM/YYYY}`. | Le stream débutera le 31/12/2025.
83+
| date | Il est `{date:format=DD/MM/YYYY,HH:mm}`. | Il est . |
84+
85+
### separator
86+
87+
Caractère(s) utilisés pour séparer plusieurs valeurs.
88+
89+
- **Valeur par défaut :** `, `
90+
91+
### style
92+
93+
::card
94+
---
95+
title: Timestamps
96+
icon: material-symbols:schedule
97+
to: /docs/autres/timestamps#paramètre-style
98+
target: _blank
99+
color: '#D1D5DB'
100+
---
101+
Découvrez les différents paramètres de styles
102+
::
103+
27104
## Modificateurs
28105

29106
Les modificateurs permettent de transformer l'affichage des variables. Ils s'ajoutent après le nom de la variable ou après le ou les paramètres, précédés du symbole point d'interrogation `?`.
@@ -58,8 +135,12 @@ Les modificateurs permettent de transformer l'affichage des variables. Ils s'ajo
58135
| `{user.joined_at}` | Date d'arrivée sur le serveur | 11/03/2018 |
59136

60137
**Paramètres :**
61-
- `user_id` : Identifiant d'un utilisateur.
62-
- `format` : Format d'affichage de la date (par défaut : `L`). Accepte `relative` pour un affichage relatif (ex : "il y a 2 heures") ou un format personnalisé comme `DD/MM/YYYY`.
138+
- `user_id`
139+
- `format`
140+
141+
::hint{ type="info" }
142+
Pour le détail des paramètres, [`cliquez ici`](#paramètres-communs).
143+
::
63144

64145
### Serveur
65146

@@ -79,7 +160,11 @@ Les modificateurs permettent de transformer l'affichage des variables. Ils s'ajo
79160
| `{server.created_at}` | Date de création du serveur | 10/03/2018 |
80161

81162
**Paramètres :**
82-
- `format` : Format d'affichage de la date (par défaut : `L`). Accepte `relative` pour un affichage relatif (ex : "il y a 2 heures") ou un format personnalisé comme `DD/MM/YYYY`.
163+
- `format`
164+
165+
::hint{ type="info" }
166+
Pour le détail des paramètres, [`cliquez ici`](#paramètres-communs).
167+
::
83168

84169
### Salon
85170

@@ -95,8 +180,12 @@ Les modificateurs permettent de transformer l'affichage des variables. Ils s'ajo
95180
| `{channel.parent.created_at}` | Date de création parent | 16/04/2020 |
96181

97182
**Paramètres :**
98-
- `channel_id` : Identifiant d'un salon.
99-
- `format` : Format d'affichage de la date (par défaut : `L`). Accepte `relative` pour un affichage relatif (ex : "il y a 2 heures") ou un format personnalisé comme `DD/MM/YYYY`.
183+
- `channel_id`
184+
- `format`
185+
186+
::hint{ type="info" }
187+
Pour le détail des paramètres, [`cliquez ici`](#paramètres-communs).
188+
::
100189

101190
### Rôle
102191

@@ -111,11 +200,11 @@ Les modificateurs permettent de transformer l'affichage des variables. Ils s'ajo
111200
| `{role.created_at}` | Date de création | 12/04/2020 |
112201

113202
**Paramètres :**
114-
- `role_id` : Identifiant d'un rôle.
115-
- `format` : Format d'affichage de la date (par défaut : `L`). Accepte `relative` pour un affichage relatif (ex : "il y a 2 heures") ou un format personnalisé comme `DD/MM/YYYY`.
203+
- `role_id`
204+
- `format`
116205

117-
::hint{ type="warning" }
118-
Le paramètre `role_id` est obligatoire.
206+
::hint{ type="info" }
207+
Pour le détail des paramètres, [`cliquez ici`](#paramètres-communs).
119208
::
120209

121210
### Temporalité
@@ -126,11 +215,13 @@ Les modificateurs permettent de transformer l'affichage des variables. Ils s'ajo
126215
| `{time}` | Heure actuelle | 11:01 |
127216
| `{timestamp}` | Timestamp Discord | 1495962098 |
128217

129-
**Paramètres (date et time) :**
130-
- `format` : Format d'affichage de la date ou de l'heure (par défaut : `L` ou `LT`). Accepte `relative` pour un affichage relatif (ex : "il y a 2 heures") ou un format personnalisé comme `DD/MM/YYYY` ou `hh:mm a`. La liste des différents formats est disponible sur la [documentation](https://day.js.org/docs/en/display/format) de la bibliothèque **dayjs**.
218+
**Paramètres :**
219+
- `format` (date et time)
220+
- `style` (timestamp)
131221

132-
**Paramètres (timestamp) :**
133-
- `style` : Style d'affichage du timestamp. Vous pouvez retrouver la liste complète sur la [documentation](https://discord.com/developers/docs/reference#message-formatting-timestamp-styles) de Discord.
222+
::hint{ type="info" }
223+
Pour le détail des paramètres, [`cliquez ici`](#paramètres-communs).
224+
::
134225

135226
## Variables par modules
136227

@@ -149,7 +240,11 @@ Les modificateurs permettent de transformer l'affichage des variables. Ils s'ajo
149240
| `{money.to_position:position=N}` | Argent nécessaire pour atteindre la position N dans le classement | 1 200 |
150241

151242
**Paramètres :**
152-
- `user_id` : Identifiant d'un utilisateur.
243+
- `user_id`
244+
245+
::hint{ type="info" }
246+
Pour le détail des paramètres, [`cliquez ici`](#paramètres-communs).
247+
::
153248

154249
### Niveaux
155250

@@ -171,7 +266,11 @@ Les modificateurs permettent de transformer l'affichage des variables. Ils s'ajo
171266
| `{xp.to_position:position=N}` | Expérience nécessaire pour atteindre la position N dans le classement | 5,000 |
172267

173268
**Paramètres :**
174-
- `user_id` : Identifiant d'un utilisateur.
269+
- `user_id`
270+
271+
::hint{ type="info" }
272+
Pour le détail des paramètres, [`cliquez ici`](#paramètres-communs).
273+
::
175274

176275
### Récompenses de niveaux
177276

@@ -217,7 +316,11 @@ Les modificateurs permettent de transformer l'affichage des variables. Ils s'ajo
217316
| `{age}` | Âge de l'utilisateur | 25 ans |
218317

219318
**Paramètres :**
220-
- `user_id` : Identifiant d'un utilisateur.
319+
- `user_id`
320+
321+
::hint{ type="info" }
322+
Pour le détail des paramètres, [`cliquez ici`](#paramètres-communs).
323+
::
221324

222325
::hint{ type="info" }
223326
Les variables d'[économie](#economie) et de [niveaux](#niveaux) sont aussi disponibles dans les commandes personnalisées.
@@ -318,12 +421,13 @@ Les modificateurs permettent de transformer l'affichage des variables. Ils s'ajo
318421
| `{stream.start_at}` | Date de début | il y a 2 heures |
319422
| `{stream.tags}` | Tags du live | français, développement |
320423

321-
**Paramètres (start_at) :**
322-
- `format` : Format d'affichage de la date ou de l'heure (par défaut : `relative`). Accepte `relative` pour un affichage relatif (ex : "il y a 2 heures") ou un format personnalisé comme `DD/MM/YYYY` ou `hh:mm a`. La liste des différents formats est disponible sur la [documentation](https://day.js.org/docs/en/display/format) de la bibliothèque **dayjs**.
323-
324-
**Paramètres (tags) :**
424+
**Paramètres :**
425+
- `format`
426+
- `separator`
325427

326-
- `separator` : Caractères de séparation des différents tags du stream (par défaut : `, `)
428+
::hint{ type="info" }
429+
Pour le détail des paramètres, [`cliquez ici`](#paramètres-communs).
430+
::
327431

328432
### Reddit
329433

0 commit comments

Comments
 (0)