• 06 Décembre 2019, 02:46:04


Auteur Sujet: Quelques règles de base pour mieux scripter  (Lu 10027 fois)

0 Membres et 1 Invité sur ce sujet

Hors ligne Syg

  • Expert programmeur C/C++/PAWN
  • *
  • The GTAOnline Jesus
  • Messages: 3911
    • Voir le profil
Quelques règles de base pour mieux scripter
« le: 06 Janvier 2009, 17:22:59 »
Voici un topic qui énumère quelques règles simples que tout bon scripteur peut (doit ?) appliquer.
Si je fais ce topic, c'est simplement parce que beaucoup de problèmes sont liés à la non application de certaines de ces règles (qui peuvent être adaptées selon le cas et les humeurs de chacun, je ne veux aucunement m'imposer).

L'INDENTATION

L'indentation d'un script n'est pas là que pour faire joli, elle augmente le lisibilité du code et permet de détecter certaines erreurs facheuses très difficilement détectable dans un script non indenté.
L'indentation doit devenir un réflexe au moment de l'écriture du script, pas après coup car ça peut être compliqué et source d'erreurs.

Voici un exemple pris dans un post de ce forum :

Ce bout de script compile et s'exécute.
Mais si l'on teste ce bout de script, on se rendra compte que la commande /dm ne fonctionne pas.

Si on indente correctement ce bout de script, l'erreur saute au yeux :
La commande /dm est incluse dans la commande /tunning.

LES ACCOLADES

Les accolades servent à délimiter des bloc d'instructions dans un script.
On peut en mettre autant qu'on veut du moment qu'une accolade ouvrante correspond à une accolade fermante de même niveau.
Même si elles ne paraissent pas nécessaire, il faut prendre l'habitude de toujours mettre les accolades.
Prenons un bout de script :
et imaginons, que dans le cas où a égale 10, je veuille aussi changer la valeur de c. Je rajoute donc une ligne à la suite :
Mais ce bout de code ne fait pas ce qu'on attend de lui, il affecte systématiquement la valeur 49 à c, quelque soit la valeur de a.
Le code correct est :
Et si dès le départ on avait écrit :
l'erreur n'aurai pas pu être faîte.
L'exemple en question est simple et beaucoup d'entre vous n'aurait pas fait l'erreur mais je peux vous assurer que dans un script plus compliqué, c'est une erreur que l'on peut faire facilement et qui se révèle très difficile à trouver.

LA FACTORISATION

Quand je développe (en C/C++ ou en PAWN), j'applique toujours la règle la plus importante à mes yeux : la factorisation.
Ce que j'appelle factorisation, c'est mettre en "facteur" la partie commune à plusieurs bouts de code, comme en math lorsque que l'on factorise une expression.
Exemple en math : (x+1)(x+2)+(x+1)(2x+4) = (x+1)(3x+6) = 3(x+1)(x+2)

Dans le cas d'un script, on cherchera à créer une fonction à partir d'un bout de script que l'on retrouve plus d'une fois à l'identique dans le script.
Exemple :

Dans le code ci dessus, on trouve deux parties de code identique (aux valeurs des paramètres près).
Si je veux par exemple positionner l'angle du joueur quand il est à pied, il faut que je corrige à deux endroits (plus si j'ai plus de commandes de téléport).
Je vais donc factoriser pour faire une fonction que j'appellerais TeleporterJoueur :

Le code du dessus peut donc maintenant s'écrire :

On voit tout de suite les avantages d'un telle factorisation :
   - Si un téléport fonctionne alors tous les autres fonctionneront (sauf si les coordonnées sont fausses),
   - L'ajout d'un nouveau téléport est simple, rapide et sans risque,
   - La correction d'un bug ne conduit qu'à la modification de la fonction TeleporterJoueur, pas des 10 ou 15 commandes de téléport,
   - L'ajout d'une nouvelle fonctionnalité dans le téléport est très simple à mettre en œuvre et à tester,
   - Le code est plus concis et lisible donc plus facilement corrigible et modifiable.

Je le répète, la factorisation est la règle la plus importante de tout bon développeur.
Et elle peut s'appliquer dans de très nombreux cas, pas seulement avec les téléports.

LES VARIABLES

Il existe deux type de variables en PAWN :
- Les variables locales (déclarées dans les fonctions, callback ou bloc d'instructions)
- Les variables globales (déclarées en dehors de toute fonction ou callback)

Les variables locales ne peuvent être utilisées que dans le bloc d'instructions où elles sont déclarées.
Les variables globales peuvent être utilisées dans toutes les fonctions ou callback du script.

Les variables locales ne posent pas de problème particulier car leur portée est limitée au bloc d'instructions dans lequel elles sont declarées.
Par contre, il faut faire attention avec les variables globales qui peuvent être modifiées partout dans le script.
Cette particularité peut être source d'erreurs quand une fonction ou callback modifie la valeur d'un variable globale pendant qu'un autre fonction ou callback est en train de la lire.
Il faut donc être très rigoureux dans l'utilisation que l'on fait de ce type de variables.

Chaque fois que c'est possible, on utilisera des variables locales.

Une bonne habitude consiste à déclarer toutes ses variables locale (même celle utilisées dans les boucles) en début de fonction ou de callback pour éviter les surprises à la compilation (voire à l'exécution).

Exemple qui ne compile pas :

En PAWN, il n'existe qu'un seul type de variable (contrairement au C/C++). Ce type par défaut est entier.
Mais il est possible d'utiliser un tag (étiquette) pour transformer cette variable en un autre type.
Le seul tag disponible en standard en PAWN est Float:. Il permet de transformer une variable de type entier en variable de type décimal (ou nombre à virgule flottante).
Exemple :
L'utilisation de ce type de variable consomme plus de ressource que pour le type par défaut, il ne faut donc les utiliser que quand c'est nécessaire.

LES CONDITIONS

Les conditions sont la clé d'un code non linéraire. Elles permettent d'orienter le script en fonction de ce qui se passe sur le serveur.
Les conditions s'utilisent avec les mots clés (ou instructions) suivants : if, while, do/while et for.
Les conditions peuvent très vite devenir très compliquées à formuler et il ne faut pas hésiter à les éclater en plusieurs conditions.
Par exemple, on veut tester pour chaque joueur qui est connecté si il est passager d'un véhicule ou si il est à pied.
On pourrait écrire :
On voit très vite dans ce bout de code qu'il est très facile de se tromper dans la condition (parenthèses, opérateurs).

Il vaut donc mieux écrire :
NB : Ici, on tombe dans un autre travers où l'on est obligé d'utiliser deux fois le même code (/* On fait quelque chose */) mais ce n'est qu'un exemple

Dans un test, les termes (séparés par && ou ||) sont évalués un par un et comparer à 1 (vrai).
Dans le cas d'un condition ne comportant que des &&, l'évaluation de cette condition s'arrête dès qu'un des termes est faux. Ceci peut avoir des conséquences inattendues.
Exemple :
Dans ce bout de script, on test la valeur de a puis la valeur incrémentée de b.
Si a=2 et b=4 alors les test est vérifié et en sortie, a=2 et b=5 (puisqu'il sera incrémenté)
Si a<>2 et b=4 alors le test n'est pas vérifié mais en sortie, b est toujours égal à 4 car comme a n'est pas égal à 2, l'évaluation de la condition s'arrête et le code se poursuit après le bloc d'instructions du if.

++
Syg
Courtesy of GtaManiac

Hors ligne [email protected]

  • *
  • GTAOnline Addict
  • Messages: 4655
    • Voir le profil
Re : Quelques règles de base pour mieux scripter
« Réponse #1 le: 06 Janvier 2009, 17:26:11 »
Bon boulot Syg, je suis sûr que ça va en aider certains ;)

++
[email protected]




Hors ligne cristab

  • *
  • Messages: 8392
    • Voir le profil
Re : Quelques règles de base pour mieux scripter
« Réponse #2 le: 06 Janvier 2009, 17:36:21 »
gg syg la au moin c'est clairement expliquer, dit donc l'année 2009 fleurit avec de super tuto si seulement ces tuto aurais pus être la quand j'ai commencer au mois d'Aout j'aurais perdu moins de cheveux   :P
pas d'aide en PM, vous êtes sur un forum est il me semble que vous êtes la pour avoir de l'aide donc pourquoi MP une seul personne qui ne vous répondra pas alors qu'il y a plein de membre ici

Hors ligne NatiVe

  • N a t i V e ™
  • *
  • Messages: 7976
    • Voir le profil
Re : Quelques règles de base pour mieux scripter
« Réponse #3 le: 06 Janvier 2009, 17:51:05 »
Beau taff Syg :D

NV. 8)

N a t i V e ™ - T r i s t a n ™


Asus P8Z77-V LX - Intel Core i5 3470 - Corsair Hydro Series H60 - GeForce MSI TFZ GTX970 GAMING 4G OC 4Gb - G.Skill 16Go DDR3 PC12800 Ripjaws X CAS9 DC - 2 x Iiyama ProLite E2483HS-B1 x2 - Logitech G710+ - Logitech G700

MSI FX720 : i3 2310M - GeForce GTX520M 1Gb - 4Go DDR3 - Logitech MX Performance

"J'te crois pas, j'te crois plus, j'te crois pas j't'ai jamais cru!"

Hors ligne Azz45

  • Good Player
  • *
  • Mafioso
  • RolePlay Player
  • Messages: 2813
    • Voir le profil
Re : Quelques règles de base pour mieux scripter
« Réponse #4 le: 06 Janvier 2009, 17:55:23 »
Gg Syg :D

En parlant de tuning en haut , avec /vmenu le tuning se sauvegarde pas une idée ?

Cris t'es cheveux t'en as beaucoup encore  :lmfao ( Je parle de ton Avatar Of Course )

~•~  ~•~  ~•~  ~•~  ~•~  ~•~  ~•~  ~•~  ~•~  ~•~  ~•~


~•~  ~•~  ~•~  ~•~  ~•~  ~•~  ~•~  ~•~  ~•~  ~•~  ~•~~•~  ~•~  ~•~  ~•~
Avancement du GM : 3%
~•~  ~•~  ~•~  ~•~  ~•~  ~•~  ~•~  ~•~  ~•~  ~•~  ~•~
~•Merci Kloken, pour la vidéo lors de mon anniversaire•~

Hors ligne Nikko™

  • *
  • Mafioso
  • Messages: 2396
    • Voir le profil
Re : Quelques règles de base pour mieux scripter
« Réponse #5 le: 07 Janvier 2009, 11:25:59 »
Beau travail comme a chaque fois  ::)
Efectivement, pas mal de tuto fleurissent ^^

++
nikko

Hors ligne Kuroba

  • *
  • Bandit
  • Messages: 365
    • Voir le profil
Re : Quelques règles de base pour mieux scripter
« Réponse #6 le: 07 Janvier 2009, 11:52:25 »
Beau boulot Syg  :)


 Userbar by DarSon.

Hors ligne [viruz]rider_77

  • *
  • Mafioso
  • C/C++ programming
  • Messages: 2154
    • Voir le profil
Re : Quelques règles de base pour mieux scripter
« Réponse #7 le: 08 Janvier 2009, 00:11:53 »
Cool, un autre bon tuto pour les débutants de scripting.
GG Syg:D

vincentdu90

  • Invité
Re : Quelques règles de base pour mieux scripter
« Réponse #8 le: 31 Mars 2009, 17:46:31 »
Je comprend pas très bien la factorisation , car moi la je comprend que le joueur sera teleporter au même endroit mais sous un angle différent .

Hors ligne S!m

  • *
  • Messages: 2354
    • Voir le profil
Re : Re : Quelques règles de base pour mieux scripter
« Réponse #9 le: 01 Avril 2009, 01:53:25 »
Salut,

Je comprend pas très bien la factorisation , car moi la je comprend que le joueur sera teleporter au même endroit mais sous un angle différent .

Les codes sont équivalents, du moins au résultat apparent, seulement le code factorisé est beaucoup plus facile à modifier par la suite, si par exemple tu veut ajouter un cout de 250$ à chaque téléportation, il te suffit d'éditer une petite fonction au lieu de modifier chaque commande, comme le signalait Syg

si je ne répond pas à ta question, tente de mieux indiquer ce que tu ne comprend pas

++Sim++





vincentdu90

  • Invité
Re : Quelques règles de base pour mieux scripter
« Réponse #10 le: 01 Avril 2009, 20:02:23 »
Enfaite moi ce que je comprend c'est que on peut crée un nouveau teleporte a partir de la fonction TeleporterJoueur et au lieu de refair a chaque fois le blabla on aurait juste a mettre les nouvelles coordonnées , mais je crois que j'ai mal compris .

Hors ligne S!m

  • *
  • Messages: 2354
    • Voir le profil
Re : Quelques règles de base pour mieux scripter
« Réponse #11 le: 02 Avril 2009, 02:06:46 »
Salut,

si l'on reprend le poste de Syg,


on remarque ici que chacune de ces commandes appellent un certains nombre de fonctions, de surcroit, les mêmes, donc au lieu de réécrire à chaque fois ces fonctions, on les regroupent dans une seule fonction dénommé TeleporterJoueur (dans ce cas-ci) qui les comprend toutes, en y incorporant tous les paramètres nécessaire au plein contrôle de ses téléports....


Ainsi, si l'on appelle cette fonction avec les paramètre indiqué :
TeleporterJoueur (playerid, 1.0, 2.0, 3.0, 4.0);

et que l'on a le code TeleporterJoueur, il s'agit de la même chose (ou presque) que de faire le code suivant (le résultat est le même):


les paramètres entrés dans TeleporterJoueur (playerid, 1.0, 2.0, 3.0, 4.0); sont reliés à ceux des fonctions appelées par cette fonction, ce qui donne le résultat suivant (valeur entre parenthèses):


en espérant avoir été clair (malgré certaines répétitions...)

++Sim++





vincentdu90

  • Invité
Re : Quelques règles de base pour mieux scripter
« Réponse #12 le: 02 Avril 2009, 07:32:38 »
Oui j'ai bien compris enfaite c'est les coordonnées de syg mit au hasard qui me mettait dans l'erreur car je croyais que c'etait des angles . ^^

Sinon bah c'est super praique ce truc , merci syg pour ton cours .