mystnb/tutorials/02-un-peu-de-logique-temporelle.txt

[center][big][brown][b]02 : Un peu de logique temporelle ![/b][/brown][/big][/center]
Maintenant qu'on s'est un peu échauffés avec le menu principal, il est temps de regarder comment on va coder le moteur de notre jeu. Voilà ce qu'on va faire dans ce tutoriel :

• Créer un plateau de jeu vide de la taille de l'écran (sans scrolling) ;
• Ajouter un personnage et des animations ;
• Prendre des entrées clavier pendant que les animations tournent.

Pour l'instant la map sera juste un rectangle vide avec des bords, le minimum nécessaire pour déplacer le joueur sans sortir des bornes du niveau. On verra dans le prochain tutoriel comment encoder proprement la map. Notre objectif est d'atteindre le résultat suivant ! :D

[center][img][/img]
[i]Image 1 : Full graphismes et zéro gameplay. Que demande le peuple ?[/i][/center]
Ce tutoriel contient pas mal de code spécifique au jeu qu'on est en train de créer et un peu moins de code gint que le précédent. Cependant, je pense qu'il est utile de réfléchir ensemble à comment séparer les différentes parties du jeu pour rendre le code flexible et élégant à l'échelle du projet complet. Ça peut vous sembler superflu à ce stade, mais il faut réaliser que vous transformez sans cesse le code de votre jeu pour ajouter ou modifier des fonctions, et s'il est mal codé la structure ne [i]résistera[/i] pas. Et donc autant commencer tout de suite à faire les choses bien. ;)

On arrivera vite au point où le code et les fonctions de gint se complexifient par rapport au programme simple de la dernière fois. Je continuerai à expliquer les aspects du langage C au fur et à mesure, mais ce tutoriel ne peut pas être un cours complet de C, donc n'hésitez pas à en consulter un (par exemple [url=https://zestedesavoir.com/tutoriels/755/le-langage-c-1/]celui de Zestes de Savoir[/url]) ou à poser des questions [url=http://www.planet-casio.com/Fr/forums/lecture_sujet.php?id=14915&page=1]sur le topic des commentaires[/url] si quelque chose vous échappe. ^^

[brown][b]Les bases du moteur : joueurs, niveaux et parties[/b][/brown]

On va tout de suite commencer par définir les types fondamentaux du moteur. Je vais le faire dans deux nouveaux fichiers, `engine.h` et `engine.c`. Lorsqu'on programe avec plusieurs fichiers, il est important que chaque fichier source (`.c`) possède un en-tête associé (`.h`) qui récapitule les fonctions et types qui y sont définis. C'est parce que le compilateur compile tous les fichiers sources indépendamment les uns des autres, et c'est cette information qui lui permet de se faire une vision d'ensemble. Vous pouvez trouver de plus amples détails dans le [url=https://www.planet-casio.com/Fr/forums/topic15378-1-tdm-n07-ecrire-des-programmes-c-avec-plusieurs-fichiers.html]TDM n°7[/url] sur ce sujet.

En pratique, le fichier d'en-tête contient une description des types de données manipulés par le fichier source associé et les prototypes de ses fonctions publiques. C'est une sorte de « résumé » si vous voulez.

On n'oublie pas qu'il faut ajouter les fichiers source au `CMakeLists.txt` pour qu'ils soient compilés. Les fichiers d'en-tête sont détectés automatiquement donc on n'y touche pas.

[code]set(SOURCES
  src/main.c
  src/engine.c
  # ...
)[/code]
Je vais commencer par ajouter dans `engine.h` la définition d'une structure `player` qui décrit l'information complète d'un joueur présent sur la map. J'en profite aussi pour choisir des valeurs pour désigner les quatre directions donc j'aurai souvent besoin.

[code]#ifndef _MYSTNB_ENGINE_H
#define _MYSTNB_ENGINE_H

/* Directions */
#define DIR_DOWN   0
#define DIR_RIGHT  1
#define DIR_UP     2
#define DIR_LEFT   3

/* struct player: A player on the map, triggering actions as they move */
struct player
{
	/* Position in map */
	int x, y;
	/* Direction currently facing */
	int dir;
	/* Animation and frame */
	struct animation const *anim;
	int frame;
};

#endif /* _MYSTNB_ENGINE_H */[/code]
Vous noterez que le fichier commence et se termine par des instructions préprocesseur (lignes qui commencent par `#`). L'objectif de ces lignes est de faire en sorte que les contenus de `engine.h` ne soient lus qu'une seule fois par le compilateur, même si le fichier est inclus plusieurs fois (ce qui arrive souvent quand des en-têtes incluent d'autres en-têtes). Ça marche de la façon suivante : le contenu du fichier n'est lu que si la macro `_MYSTNB_ENGINE_H` n'est pas définie (ça c'est le `#ifndef`), et si c'est le cas alors on lit le fichier et on la définit immédiatement (ça c'est le `#define`). Du coup si on réinclut l'en-tête le `#ifndef` ne passera plus et tout sera ignoré jusqu'à `#endif` tout à la fin.

On fait ça est parce que le compilateur serait très mécontent de voir apparaître deux `struct player`, même si les contenus sont identiques. C'est comme si vous écrivez `int x = 42` deux fois : c'est pas parce que c'est deux fois le même nom et la même valeur que le compilateur va considérer que c'est la même variable. Si tout ça vous échappe un peu, pas d'inquiétude : vous verrez cette construction dans tous les fichiers d'en-tête et vous la connaîtrez par coeur avant d'avoir pu dire « préprocesseur ». :p

Quant à la définition de la structure à proprement parler, rien de bien impressionnant. On y trouve :

• La position du joueur sur la map ;
• La direction où il regarde (pour choisir le bon sprite à afficher) ;
• Et l'animation en cours et le frame où on en est. J'y reviendrai plus tard. Je n'ai pas défini `struct animation` mais c'est pas grave, on a le droit de créer un pointeur vers un type même s'il n'est pas encore bien défini (on dit « incomplet »).

Si vous n'êtes pas encore tout à fait familier·ère avec les structures, c'est le bon moment de se rappeler que cette définition ne crée aucune variable, elle explique simplement ce que les variables de type `struct player` contiendront quand on créera.

On a également besoin de la spritesheet pour pouvoir faire notre affichage. Voici à quoi elle ressemble ; comme d'habitude, ne récupérez pas cette image (qui est agrandie), prenez plutôt la version originale sur le dépôt. Enregistrez-la sous le nom `assets-fx/spritesheet.png`.

[center][img]https://gitea.planet-casio.com/Lephenixnoir/mystnb/raw/branch/master/tutorials/gint-tuto-02-spritesheet.png[/img]
[i]Image 2 : Pour les diagonales, on repassera.[/i][/center]

Je profite de l'occasion pour améliorer le `fxconv-metadata.txt`. Pour l'instant, on a listé tous les fichiers à la main dedans, mais ça devient vite répétitif, surtout qu'il n'y a pas de paramètres particuliers. Nos images ressemblent à ça :

[code]levels.png:
  type: bopti-image
  name: img_levels

title.png:
  type: bopti-image
  name: img_title

spritesheet.png:
  type: bopti-image
  name: img_spritesheet[/code]
Ce serait bien de pouvoir créer un bloc qui traite toutes les images d'un coup et ensuite on n'en parle plus. Et ça tombe bien, car ça existe : on peut spécifier un wildcard dans le nom, par exemple `*.png`.

[code]*.png:
  type: bopti-image
  name: ...[/code]
Par contre on a un problème : on ne peut plus spécifier le nom puisqu'on ne connaît pas le nom du fichier (il est caché par l'étoile). Pour rattraper la situation, [brown][b]fxconv[/b][/brown] propose un paramètre `name_regex` qui permet d'analyser le nom du fichier et de calculer le nom de la variable avec le résultat de l'analyse.

[code]*.png:
  type: bopti-image
  name_regex: (.*)\.png img_\1[/code]
Si vous ne connaissez pas les expressions regulières (regex), ne vous inquiétez pas de la magie en jeu ici. Essentiellement, `(.*)\.png` signifie « le nom du fichier ressemble à `xxxx.png`, trouve-moi `xxxx` ». Et ensuite `img_\1` signifie « maintenant nomme-moi la variable `img_xxxx` ». Il vous suffit de le copier-coller aujourd'hui, vous n'aurez jamais besoin d'y retourner si ça ne vous intéresse pas. ^^

Avec ce code, toutes les images `.png` dans le dossier seront converties automatiquement. Il y a juste deux détails importants pour que ça ne gêne pas la conversion de la police :

• Les blocs se lus de haut en bas et les informations sont combinées. Par exemple pour `font_mystere.png`, le `type` et le `name_regex` [i]vont s'appliquer[/i], par contre le bloc `font_mystere.png` va s'appliquer aussi et remplacer le `type` et ajouter un `name`.
• Quand `name_regex` et `name` sont spécifiés tous les deux, `name` a la priorité.

Et on n'oublie pas d'ajouter les fichiers à `CMakeLists.txt` dans tous les cas. ^^

[code]set(ASSETS_fx
  assets-fx/levels.png
  assets-fx/title.png
  assets-fx/spritesheet.png
  assets-fx/font_mystere.png
  # ...
)[/code]
Revenons à la conception du jeu.

Le joueur se situe bien sûr à l'intérieur d'un niveau que j'appelle [i]map[/i] par pure commodité. C'est simplement une grille avec des espaces libres, des murs, des portes, et quelques items importants placés au sol. Pour l'instant on ne vas pas trop se demander comment les représenter et les convertir (ce sera dans le tutoriel suivant), on va juste donner une version vague de la structure avec les dimensions de la map histoire de pouvoir déplacer le joueur sans sortir des bords.

[code]/* struct map: A map with moving doors and collectibles */
struct map
{
	/* Width and height */
	int w, h;
	/* Raw data */
	uint8_t *data;
};[/code]
En fait tous les niveaux que j'ai prévus ont la même taille (sensiblement la taille de l'écran), mais ce serait dommage de ne pas se donner un peu de latitude au cas où le jeu évolue dans le futur. Les données brutes ce sera un tableau avec l'état de chaque cellule de la map, stay tuned. Dans l'immédiat, cette structure nous sera utile pour vérifier que le joueur ne sort pas de la map, c'est-à-dire qu'on veut assurer à tout instant :

• `player.x >= 0 && player.x < map.w`
• `player.y >= 0 && player.y < map.h`

Et comme j'aime bien tout formaliser (c'est un défaut de théoricien), je ne vais pas juste me balader deux variables `player` et `map`, je vais mettre tout ça dans une structure représentant la partie en cours. Ce qui m'incite d'ailleurs à faire un [i]tableau[/i] de joueurs, parce que qui sait, le jeu pourrait évoluer dans le futur. :whistle:

[code]#define PLAYER_COUNT 1

/* struct game: A running game with a map and some players */
struct game
{
	/* Current map */
	struct map *map;

	/* Players */
	struct player *players[PLAYER_COUNT + 1];
};[/code]
Comme le nombre de joueurs n'est pas fixe a priori, j'ai juste donné un maximum (`PLAYER_COUNT`) et le tableau se terminera par un `NULL` après le dernier joueur.

Puisque les animations viendront après, on a sensiblement toutes les informations nécessaires pour jouer une partie de mystère noir et blanc... ou plus précisément de mystère blanc étant donné qu'on n'a rien sur la map ! :E

[brown][b]Structure du programme : affichage, logique, et entrées[/b][/brown]

Un point sur lequel je veux m'attarder dès maintenant est la structure du code. Le jeu a pas mal de choses à faire pour fonctionner correctement, et il est important de ne pas les mélanger pour conserver un code extensible qui résistera à tous les tests et modifications qu'on fera pendant le développement.

Ici, on va séparer les tâches en trois catégories :

1. Affichage de l'état du jeu à l'écran (map, joueur et animations)
2. Logique interne et physique (déplacement du joueur, collisions, ouverture des portes)
3. Acquisition des entrées (saisie au clavier et traduction en « instructions »)

Ces trois parties sont sensiblement indépendantes et il est utile de les coder comme telles pour se donner de la flexibilité. Par exemple, il n'y a pas de raison que la vitesse des animations soit liées à la détection des touches. De même, la vitesse des frames à l'écran n'est pas forcément celle des updates internes (FPS vs UPS). (Ici le jeu est au tour par tour donc c'est facile car les updates sont calées sur les saisies au clavier, mais dans un jeu en temps réel la question se poserait.)

L'indépendance doit donc être explicite dans le code, et dans mon cas je vais donner les règles suivantes :

1. L'affichage ne peut que lire les structures du jeu et dessiner à l'écran.
2. La logique ne peut que lire les instructions du joueur et modifier les structures du jeu (joueur, map, etc).
3. La gestion des entrées ne peut que lire le clavier et produire des instructions.

Tout ça sera lié par la fonction principale du programme qui passera les sorties des uns en entrée aux autres et réglera le timing. ^^

[brown][b]Affichage de l'état du jeu à l'écran[/b][/brown]

Commençons par l'affichage de l'état du jeu. Pour l'instant il n'y a pas grand-chose à faire étant donné qu'on n'a que le joueur et pas de map. Par simplicité, je me donne une macro pour calculer la position d'une cellule de la map à l'écran (en supposant qu'on ne scrolle pas) et ça permet tout de suite d'écrire une fonction pour afficher le joueur depuis la spritesheet.

[code]#define CELL_X(x) (-2 + 10 * (x))
#define CELL_Y(y) (-3 + 10 * (y))

static void engine_draw_player(struct player const *player)
{
	extern bopti_image_t img_spritesheet;

	dsubimage(CELL_X(player->x) - 1, CELL_Y(player->y) - 5,
		&img_spritesheet, player->dir * 12, 0, 12, 16, DIMAGE_NONE);
}[/code]
Rien de bien inattendu ici, juste une utilisation un peu maline de `dsubimage()`. Comme vous pouvez le voir, je prends un rectangle de taille 12x16 à la position `player->dir * 12` horizontalement et `0` verticalement : c'est donc le premier frame de l'animation [i]"idle"[/i] pour la direction actuelle du joueur. Dans la deuxième partie de ce tutoriel on ajoutera des vraies animations et donc on viendra modifier cette fonction en conséquence.

[center][img]https://gitea.planet-casio.com/Lephenixnoir/mystnb/raw/branch/master/tutorials/gint-tuto-02-spritesheet-frame1.png[/img]
[i]Image 3 : Tout ce travail et j'utilise qu'un seul frame ![/i][/center]

Pour information, le choix de `CELL_X()` et `CELL_Y()` donne une grille qui a la tête suivante à l'écran. Une partie des cellules est masquée par le bord de l'écran pour gagner de la place.

[center][img]https://gitea.planet-casio.com/Lephenixnoir/mystnb/raw/branch/master/tutorials/gint-tuto-02-mapbounds.png[/img]
[i]Image 4 : C'est asymétrique spécifiquement pour vous embêter.[/i][/center]
Et tout cela suffit pour afficher le jeu complet puisqu'on n'a pas de map.

[code]void engine_draw(struct game const *game)
{
	dclear(C_WHITE);

	for(int p = 0; game->players[p]; p++)
	{
		engine_draw_player(game->players[p]);
	}
}[/code]
Dans la boucle `for`, la condition de sortie `game->players[p]` est équivalente à `game->players[p] != NULL`, donc j'itère sur tous les joueurs présents sur la map pour les afficher.

[brown][b]Logique interne et physique[/b][/brown]

Voyons maintenant comment on peut se déplacer. Comme mentionné tout à l'heure, on ne veut pas que le joueur puisse sortir de la map ni marcher dans les murs. Du coup j'ajoute une fonction `map_walkable()`, qui doit vérifier qu'une case est accessible (ie. pas un mur) et hardcode actuellement des murs sur les bords, comme sur l'image ci-dessous.
[center][img]https://gitea.planet-casio.com/Lephenixnoir/mystnb/raw/branch/master/tutorials/gint-tuto-02-mapgrid.png[/img]
[i]Image 5 : Contrairement à Portal, il n'y a pas vraiment de sortie.[/i][/center]

[code]/* Check whether a cell of the map is walkable */
static int map_walkable(struct map const *map, int x, int y)
{
	return (x >= 1) && (y >= 1) && (x < map->w - 1) && (y < map->h - 1);
}[/code]
À partir de là, on peut écrire une fonction qui tente de déplacer un joueur dans une direction choisie. La fonction renvoie 0 si le déplacement échoue et 1 s'il réussit, car cette information est nécessaire pour décider si le tour est terminé (il se passera des choses avec les portes entre chaque tour de jeu).

[code]int engine_move(struct game *game, struct player *player, int dir)
{
	int dx = (dir == DIR_RIGHT) - (dir == DIR_LEFT);
	int dy = (dir == DIR_DOWN)  - (dir == DIR_UP);

	/* Always update the direction */
	player->dir = dir;

	/* Only move the player if the destination is walkable */
	if(!map_walkable(game->map, player->x + dx, player->y + dy)) return 0;

	player->x += dx;
	player->y += dy;

	return 1;
}[/code]
Notez l'astuce consistant à calculer le déplacement en x et en y avec une différence de booléens pour ne pas s'embêter à faire des `if/else` ou un `switch`.

[brown][b]Acquisition des entrées[/b][/brown]

La gestion des entrées sera très basique pour l'instant donc je l'ai laissée dans `main.c`. Le but de cette fonction est simplement de lire les entrées clavier et de renvoyer la direction dans laquelle le joueur demande à se déplacer. On va donc juste chercher `KEY_DOWN`, `KEY_RIGHT`, `KEY_UP` et `KEY_LEFT` et les renvoyer vers leurs `DIR_*` associés. La paragraphe suivant est long simplement parce que c'est une bonne occasion de parler de la fonction `getkey_opt()`. :)

[code]/* Returns a direction to move in */
static int get_inputs(void)
{
	int opt = GETKEY_DEFAULT & ~GETKEY_REP_ARROWS;

	while(1)
	{
		int key = getkey_opt(opt, NULL).key;

		if(key == KEY_DOWN)  return DIR_DOWN;
		if(key == KEY_RIGHT) return DIR_RIGHT;
		if(key == KEY_UP)    return DIR_UP;
		if(key == KEY_LEFT)  return DIR_LEFT;
	}
}[/code]
Une des fonctionnalités assurées par `getkey()` est la répétition des touches. Si vous gardez une touche appuyée, `getkey()` est susceptible de la renvoyer plusieurs fois. Par défaut, seules les touches fléchées sont répétées (comme `GetKey()`), ce qui permet par exemple de se déplacer dans des listes ou des menus. Mais ici, comme le jeu est un puzzle nécessitant de bien réfléchir à chaque coup, on veut que chaque pression déplace le joueur exactement une fois (sinon on risque un faux mouvement qui gâcherait le niveau).

C'est ici que la fonction `getkey_opt()` entre en jeu. `getkey_opt()` est une version générale de `getkey()` (définie dans `<gint/keyboard.h>`) qui possède plein d'options pour personnaliser la façon dont vous lisez le clavier. Il y a deux arguments : d'abord les options et ensuite le timeout. Expliquer tout le comportement de la fonction serait long, donc je vais juste présenter rapidement les options.

• `GETKEY_MOD_SHIFT` et `GETKEY_MOD_ALPHA` activent l'utilisation de SHIFT et ALPHA comme des modifieurs, pour former des combinaisons comme SHIFT+sin → asin. Lorsque ces options sont activées, `getkey_opt()` ne renvoie jamais d'événement ayant `.key == KEY_SHIFT` ou `.key == KEY_ALPHA` et attend à la place que vous appuyiez sur une autre touche avant de s'arrêter. Dans ce cas, l'événement renvoyé contient `.shift == 1` ou `.alpha == 1` pour indiquer l'état des modifieurs. Une application peut par exemple interpréter un événement ayant `.key == KEY_SIN` et `.shift == 1` comme asin. Activé dans `getkey()`.

• `GETKEY_BACKLIGHT` active la combinaison SHIFT+OPTN pour allumer et éteindre le rétroéclairage sur les modèles monochromes qui le supportent (essentiellement la Graph 75+E et ses prédécesseurs). Activé dans `getkey()`.

• `GETKEY_MENU` autorise le retour au menu en appuyant sur la touche `MENU`. Activé dans `getkey()`.

• `GETKEY_REP_ARROWS` et `GETKEY_REP_ALL` activent la répétition des touches directionnelles et de toutes les touches, respectivement. Le délai de répétition est contrôlé par la fonction `getkey_repeat()`. Par défaut, la première répétition se produit après 400 et les suivantes toutes les 40 ms. Le premier est activé dans `getkey()`, pas le second.

• `GETKEY_REP_FILTER` active le filtre de répétitions, un outil puissant qui vous permet de contrôler la répétition des touches avec finesse. Vous pouvez contrôler quelles touches se répétent, combien de fois, sous quel délai, et même changer les délais d'une fois sur l'autre. Activé dans `getkey()`, mais n'a aucun effet tant que vous n'appelez pas `getkey_repeat_filter()` pour configurer tout ça. J'aurai peut-être l'occasion d'en reparler.

Le premier argument de `getkey_opt()` est une combinaison de ces options (qu'on peut écrire avec `+` ou `|` selon votre préférence). Le second argument que j'ai appelé « timeout » est un pointeur sur un entier : si l'entier est ou devient autre chose que 0 pendant que `getkey_opt()` attend, la fonction s'interrompt et s'arrête immédiatement en renvoyant un événement de type `KEYEV_NONE`. Ça permet de contrôler la durée d'attente voire même d'interrompre à l'improviste.

La fonction `getkey()` en elle-même ne fait qu'appeler `getkey_opt()` avec les options que j'ai mentionnées ci-dessus (la combinaison s'appelle `GETKEY_DEFAULT`) et un délai illimité.

Dans `get_inputs()`, on donne comme options `GETKEY_DEFAULT & ~GETKEY_REP_ARROWS`, ce qui reprend les options par défaut de `getkey()` à l'exception de `GETKEY_REP_ARROWS`, et garde un délai illimité. En deux mots : on désactive la répétition des touches fléchées. ^^

Le reste est direct, comme annoncé on cherche les touches directionnelles et on renvoie les `DIR_*` correspondants. Voyons voir maintenant comment implémenter la logique du jeu avec tout ça !

[brown][b]Logique du jeu avec les déplacements[/b][/brown]

Vous allez voir qu'en fait c'est plus court que ça en a l'air.

[code]int main(void)
{
	int level = main_menu();

	struct player singleplayer = {
		.x = 2,
		.y = 3
	};
	struct map map = {
		.w = 13,
		.h = 7
	};
	struct game game = {
		.map = &map,
		.players = { &singleplayer, NULL }
	};

	int level_finished = 0;

	while(!level_finished)
	{
		int turn_finished = 0;
		while(!turn_finished)
		{
			engine_draw(&game);
			dupdate();

			int dir = get_inputs();
			turn_finished = engine_move(&game, &singleplayer, dir);
		}

		/* Update doors, etc */
	}

	return 1;
}[/code]
On commence par appeler le menu principal que j'ai déplacé dans une fonction `main_menu()`, et ensuite on prépare la partie. Pour cela, on crée :

• Un joueur, dont la position initiale est (2,3) ;
• Une map de taille 13x7 (la taille de l'écran présenté précédemment) ;
• Une partie sur ladite map avec ledit joueur.

Ensuite, la boucle principale tourne tant que le niveau n'est pas terminé. À l'intérieur de la boucle, on fait le lien entre les trois parties qu'on a développées jusqu'à présent : d'abord on affiche l'état du jeu, ensuite on prend des entrées, et enfin on déplace le joueur selon les entrées saisies.

Le jeu est au tour par tour et les portes changent d'état entre les tours (action symbolisée par le commentaire "Update doors, etc"), donc j'ai besoin de savoir précisément quand un tour se termine. Ce n'est pas évident car si le joueur demande une direction dans laquelle il/elle ne peut pas se déplacer, le tour ne sera pas fini (et s'il y a plusieurs joueurs la condition n'est pas non plus évidente). Donc j'ai une variable `turn_finished` pour contrôler ça.

Vous noterez que `level_finished` n'est jamais mis à 1 donc la boucle ne se termine jamais ; ce n'est pas grave parce qu'on peut toujours fuir vers le menu principal durant les appels à `getkey_opt()` en appuyant sur MENU. ^^

Et voilà le résultat.

[center][img]https://gitea.planet-casio.com/Lephenixnoir/mystnb/raw/branch/master/tutorials/gint-tuto-02-basic-movement.gif[/img]
[i]Image 6 : ... ouais en fait non, c'est tout nul.[/i][/center]

Vous comprenez pourquoi j'ai pas mis ça tout en haut du tutoriel. Allez, on va rajouter des animations, ça aidera. ^^"

[brown][b]Animations structurées[/b][/brown]