Créer ses propres syntax skript-mirror

[Olyno]

Bonjour,

dans ce tutoriel, je vais vous expliquer comment créer ses propres syntax skript tel que des effets, des conditions, des expressions, des types et des événements (pas encore disponible pour les types et éventements).

Bien, commençons par savoir par quoi commencer :

Qu'est-ce skript-mirror ?

 

Pour résumer, skript-mirror est un addon vous permettant d'utiliser du java dans skript.

 

Dans un premier temps, vous devrez télécharger l'addon skript-mirror qui est disponible sur le forum de skunity : https://forums.skunity.com/resources/skript-mirror.254/

Il vous suffit de le mettre dans votre dossier "plugins" et de relancer votre serveur.

 

A la base, SkQuery permettait de faire ça à partir de fichiers skq mais ce système n'était plus à jour. Skript-mirror à donc remis à jour ce système mais de façon bien meilleur.

 

Créer ses propres syntax:

 

/!\ Attention /!\ Une partie de ce tutoriel ne sera que de la traduction du tutoriel de base pour créer ses propres syntax.

 

/!\ Attention /!\ Tout les "return" dans les codes/exemples sont qu'à partir de la version 0.9+ de skript-mirror. Pensez donc à bien avoir la bonne version de celui-ci. Sinon, remplacer "return" par "continue".

 

Vous pouvez créer des effets et des expressions personnalisés pour créer des blocs de code réutilisables. La syntaxe personnalisée peut être utilisée dans tous les scripts, mais elle ne peut être utilisée qu'après avoir été analysée, alors prenez soin de vous assurer que les scripts contenant des déclarations syntaxiques personnalisées sont chargés en premier.

 

La syntaxe personnalisée présente quelques avantages par rapport aux fonctions Skript:

 

* Ils ressemblent plus à d'autres effets Skript et expressions

* Ils se comportent bien avec les retards et l'effet de changement tel que les wait....

 

Création d'effets personnalisés

 

Les effets personnalisés peuvent être créés à l'aide de la syntaxe suivante:

 

effect <syntax>:
 # code

 

 

Par exemple:

 

effect greet the world:
   broadcast "Hello, world!"

 

Cela crée un effet personnalisé pour dire "Hello world!"

 

La syntaxe peut utiliser tous les éléments de pattern que Skript utilise, même les expressions imbriquées:

 

effect greet [the] world %number% times:
   loop expression-1 times:
       broadcast "Hello, world"

 

 

Les expressions peuvent être consultées avec la syntaxe suivante:

 

[the] expr[ession][s](-| )%*number%

 

 

Pluraliser l'expression vous permet d'accepter plusieurs valeurs. Remarque, le code suivant utilise expressions-1 PAS expression-1.

 

effect greet %strings%:
   loop expressions-1:
       broadcast "Hello, %loop-expression%"

 

 

Si l'effet n'est pas terminé immédiatement (par exemple, il y a une attente ou un effet asynchrone), vous devez déclarer que l'effet a un délai avant que le délai ne soit exécuté. Vous devez également continuer (PAS arrêter) après que l'effet soit terminé pour indiquer que le code d'appel peut continuer.

 

effect greet [the] world slowly:
   delay the current effect
   broadcast "Hello"
   wait 10 seconds
   broadcast "World"
   continue

 

 

Pour les effets personnalisés, avoir un continue n'est nécessaire que pour les effets retardés.

 

Création d'expressions personnalisées :

 

Les expressions personnalisées sont créées de manière similaire. Les expressions doivent toujours se poursuivre, avec une valeur de retour optionnelle.

 

get expression <syntax>:
   # code
   return <valeur retournée>

 

 

C'est une expression qui retourne toujours 6.28:

 

get expression tau:
   return 6.28

 

 

Si une expression a toujours la possibilité de renvoyer plusieurs valeurs, elle doit être définie comme telle:

 

get plural expression %number% random numbers:
   loop expression-1 times:
       add 4 to {_output::*}
   return {_output::*}

 

 

Dans certains cas, vous aurez une expression qui renvoie plusieurs valeurs si plusieurs valeurs lui sont données et seulement une seule valeur si une seule valeur lui est donné. Vous pouvez préfixer ce paramètre par un $ pour indiquer que son montant détermine si l'expression peut renvoyer plusieurs valeurs.

 

get expression just %$strings%:
   return expressions-1

# Autorise à écrire des deux façon
set {single} to just "une valeur simple"
set {multiple::*} to just "plusieurs", "valeurs", "différentes"

 

 

Il y a aussi un raccourci pour écrire les expressions de propriété sous forme de

[the] <quoi> of %$type%"

 

et

%$type%'[s] <quoi>

 

.

L'expression passée à %type% est toujours stockée dans l'expression-1 et toutes les expressions de <quoi> sont stockées dans les expressions suivantes.

 

# [the] charisma of %player%
# %player%'[s] charisma
get player property charisma:
   return {charisma::%expression-1%}

 

 

Création de conditions personnalisés:

 

Les conditions personnalisées sont créées de même manière que les effets. Les conditions doivent toujours se poursuive.

 

condition player has variable %string% set:
   if {players::%expression-1%} is set:
       return true
   else:
       return false

 

 

Utilisation concrète :

 

Pour utiliser ces effets, conditions et expressions personnalisés, vous devez les mettre dans un second fichier nommé "!!!lenomquevoussouhaitez". Les 3 points d'exclamations permettent au fichier d'être chargé en premier. Les effets que vous utilisez directement dans un script doivent être en dehors de votre fichier contenant les syntax personnalisés. (Jusqu'à la version prochainement)

 

Merci de m'avoir lu et j'espère avoir pu vous apprendre quelque chose.

 

Scripts possédants ce système:

- GameAPI : https://skript-mc.fr/forum/resources/gameapi.1294/

 

Pensez à me signaler les scripts possédant ce type de système pour que je puisse les ajouter à la liste ?

 

/!\ Le tutoriel ci-dessus n'est valable que pour la version 0.9.0 de skript-mirror maximum /!\

 

Pour skript-mirror + 0.9.0, il y a quelques changements. Par exemple, pour récupéré la donnée d'un effet, il vous faudra utiliser "trigger", comme dans l'exemple suivant:

effect mon magnifique effet:
   trigger:
      send "Wow ca fonctionne !" to console

 Pour les expressions, il vous faudra préciser le changer (add, remove, set...) dont get pour récupéré la valeur:

expression ceci est un test:
   get:
       return "magnifique!"
   set:
      set {mavar} to change value #Ca donne: set ceci est un test to "coucou" . "change value" représente la valeur "coucou" . Ca peut très bien être un chiffre ou autre valeur...

 

Si vous voulez changer la valeur d'une expression, tel que "set ceci est un test to "oh, ca a changé", il vous faudra utiliser cette méthode:

 

expression ceci est un test:
   set:
       set {test} to change value

Enfin, le "return" ne doit etre utiliser uniquement pour les expressions. En ce qui concerne les conditions, il faut "continue" lorsque c'est vrai et ne rien faire lorsque c'est faux. Il faut utiliser "continue" dans les effets en cas de timer, tel que "wait 3 seconds" par exemple.

Pour les conditions, il faudra utiliser "check", comme:

condition ceci est une condition:
   check:
       if (1+2) = 3:
           continue

 

Rappel:  La documentation officiel se trouve ici: https://skript-mirror.gitbook.io/docs/advanced/custom-syntax

Modifié le 12 septembre 2018 par AlexLew
oublies

[McLincoln2]

Très utile merci :)

[Mildojos]

Très utile merci :)

Pas faux mais cela n'a pas l'air de fonctionner en 1.12.2. x)

[Invité]

Tes explications restent cohérentes et adéquate à la situation, mais, juste, en aucun cas il y a l'utilisation de Java dans le code même avec l'utilisation de l'addon, si tu pouvais corriger celà ^^'

[Olyno]

Tes explications restent cohérentes et adéquate à la situation, mais, juste, en aucun cas il y a l'utilisation de Java dans le code même avec l'utilisation de l'addon, si tu pouvais corriger celà ^^'

Parce que ici tu apprends à créer des syntax, mais ce que j'ai dis est cohérent, tu peux utiliser du java dans le code

[Invité]

Tu peux me montrer un exemple ?

[Spartan9802]

Voilà plusieurs exemples, l'addon utilise la reflection

https://github.com/btk5h/skript-mirror/wiki/Calling-Java-from-Skript

[KyloRen3600]

Pour les effet il ne faut pas oublier le "trigger"

[noftaly]

Il y a 1 heure, KyloRen3600 a dit :

Pour les effet il ne faut pas oublier le "trigger"

Ah oui c'est vrai qu'il ne les a pas mis ?

[Olyno]

il y a une heure, noftaly a dit :

Ah oui c'est vrai qu'il ne les a pas mis ?

 

Il y a 3 heures, KyloRen3600 a dit :

Pour les effet il ne faut pas oublier le "trigger"

Merci de me l'avoir signalé, ca a été corrigé par la suite

[Rémi]

Salut,

Franchement, bien joué. Bien expliqué, bien détaillé, parfait ? !