Description de vos fonctions dans l'auto-complétion

En trifouillant le code source de l'éditeur AGS pour gérer les accents dans l’auto-complétion, j'ai remarqué que le fichier listant les fonctions, méthodes, propriétés... prédéfinies d'AGS (qui contient la description de la fonction affichée sur la ligne du bas de l'auto-complétion) était traité comme un simple en-tête de script !

Du coup je me suis demandé s'il nous était possible à nous aussi, développeurs de modules, d'utiliser le même formatage pour aider les utilisateurs à comprendre ce qu'ils font lorsqu'ils utilisent nos fonctions. Et il se trouve que oui, ça fonctionne !

Pour ce faire, juste au-dessus de la ligne d'importation de votre fonction dans l'en-tête de votre module, entrez une ligne descriptive précédée de ///, comme suit :

Code:

/// Retourne la somme des deux entiers que vous passez comme arguments
import int Addition(int a, int b);

Bien sûr cela fonctionne également pour les fonctions membres de structures :

Code:

struct MathSup {
  /// Retourne la somme des deux entiers que vous passez comme arguments
  static int Addition(int a, int b);
};

Vous remarquerez que je n'ai pas mis d'accents dans la description puisque les versions actuelles d'AGS ne gèrent pas les caractères non ASCII dans l’auto-complétion.
J'ai quasiment résolu le problème pour les fonctions prédéfinies, mais pas encore pour ce genre de descriptions personnalisées (il faudrait pouvoir enregistrer vos scripts en UTF8).
EDIT : Apparemment c'est résolu. Vous pourrez donc accentuer vos propos librement dans une prochaine version française de l'éditeur.

Youpi !
Très utile pour les modules est les gros projets de longue haleine. J'aime. Merci pour l'astuce.

Petit soucis dans mon script header :

Code:

59  /// Walk to point (x,y) using only the 8 directions if possible.
60  function U8D_Walk(int x, int y, BlockingStyle blocage = eNoBlock, WalkWhere zonesEmpruntables = eWalkableAreas);

AGS a écrit:

Use8Directions.ash(60): Error (line 60): PE02: Parse error at '='

En lisant le manuel, à fonction :

AGS manual a écrit:

You can make int parameters optional if there is a default value that the user doesn't need to supply. To do this, change the script header import declaration like this:

Il semble que seul les int puissent être optionnel. Mais j'ai peut être mal compris.
Peut-on, et si oui, comment rendre les enums optionnels ?

EDIT: Hihi
J'avais oublié de mettre import devant ma fonction. Mais où avais-je la tête ?

C'est corrigé, et ça fonctionne. On peut bien mettre une valeure par défaut.