Aller au contenu

Unreal Engine - Conventions

De PLOTFALL Wiki

Convention de nommage

La convention de nommage utilisée est celle basée sur les conventions officielles d'Epic's (Allar's style guide).

Lien : Convention de nommage

Structure des dossiers

Structure des dossiers - Allar Style Guide
Structure des dossiers - Allar Style Guide

Hybride : Allar Style Guide

Des dossiers dédiés à la plupart des éléments, ainsi qu'un dossier _Shared pour les ressources qui n'appartiennent à aucune fonctionnalité en particulier. Par exemple, les matériaux de base, les plans techniques et les textures communes. Cette organisation s'inspire du guide de style UE d'Allar.

Avantages

  • Les fonctionnalités restent bien délimitées, et les éléments partagés ont une place bien définie
  • Convient aussi bien aux petits projets qu'aux plus grands
  • La plupart des développeurs UE reconnaîtront immédiatement cette structure

Inconvénients

  • On se demandera souvent ce qui doit aller dans le dossier _Shared et ce qui doit aller dans un dossier dédié à une fonctionnalité
  • La convention consistant à utiliser un trait de soulignement comme préfixe prête parfois à confusion
  • C'est un peu plus complexe à maîtriser que le classement par type pour quelqu'un qui débute

Lien : Structure des dossiers

Fonctions et variables

Comment nommer les fonctions, les variables, les paramètres, les variables booléennes, les délégués et les gestionnaires d'événements afin qu'ils correspondent aux attentes du moteur et des autres développeurs.

Lien : Fonctions et variables