UndoPro

Se décoller

UNDOPRO est un système UNDO basé sur des commandes intégré dans le système par défaut d'Unity. Cela permet aux développeurs d'utiliser des actions pour leurs opérations d'annulation / refaire sans forcer l'utilisateur à un nouveau débit de travail!

Fil de forum

Installer

Selon la façon dont vous souhaitez utiliser undopro / distribuer votre outil, vous avez plusieurs options.

1. Unity Package Manager (recommandé)
   Accédez à Unity Package Manager, ajoutez par Git URL et entrez: https://github.com/seneral/undopro.git#release-pkg
   Ou télécharger à partir de la branche version-pkg et installer à partir du disque sur les versions d'unité antérieures
   Si vous distribuez votre outil en fonction de UNPOPRO, vos utilisateurs devraient d'abord installer manuellement UNPOPRO, alors votre outil
   Mais cette option est la plus compatible avec d'autres outils utilisant undopro et peut également mettre à jour automatiquement
2. Installer et distribuer undopro séparément
   Deuxième meilleures options, ne modifiez pas UNDOPRO et vous pourrez le distribuer très longtemps tant que tous les outils impliqués gardent les Guids intacts. Mais vous rencontrerez des problèmes lorsque l'unité casse undopro et un salon à chaud est nécessaire pour le faire fonctionner, mais vous ou d'autres outils distribuez toujours des versions UNDOPRO plus anciennes aux côtés de votre outil
3. Incorporer undopro dans votre projet
   Assurez-vous absolument de modifier tous les guides et d'enveloppez tout le code Undopro en espaces de noms distincts, et modifiez également les définitions d'assemblage, sinon il entrera en conflit avec d'autres outils.
   Pas recommandé, car vous serez uniquement responsable de vous assurer que la version Undopro que vous distribuez est à jour.
   Ne faites cela que si vous avez absolument besoin d'une version spécifique d'Undopro ou si vous souhaitez le modifier avant de l'utiliser dans votre outil.

Caractéristiques

• Rappels étendus pour UNOD: séparer les noms de rédaction / refaire avec des noms d'enregistrement, onddundoreCord, ...
• API pour créer des enregistrements d'annulation basés sur les commandes
• Gère la plupart des actions anonymes sans problèmes, même en utilisant le contexte!

Comment ça marche

Unity ne fournit que des informations très limitées sur le système d'annulation:

• L'ID de l'enregistrement actuel, mais ce n'est pas unique, plutôt que d'augmenter régulièrement: /
• Le nom enregistré / groupe actuel (pas unique)
• Avec réflexion, la pile complète UNDO / REDO uniquement par son nom (pas unique)
• Rappel non coopéré

En interne, UNDOPRO crée un enregistrement factice dans le système par défaut lorsque l'API pour l'ajout d'un enregistrement basé sur des commandes est appelée. Ceci est ensuite suivi à l'aide du rappel disponible et les commandes sont exécutées lorsqu'ils passent respectivement de la pile de rénovations ou de l'inverse. Un grand Hurden était le comportement du système d'annulation par défaut: il est presque imprévisible! Les enregistrements peuvent dupliquer dans certaines conditions lorsqu'ils sont annulés / refaits ou disparaître. C'est très difficile, mais une exigence pour faire un algorithme de suivi solide. De toute évidence, l'ajout de nouveaux enregistrements doit également être détecté.

Lorsque le suivi a été effectué, une valeur de décalage pour la pile d'annulation et de rénovation en séparation est calculée (rappelez-vous, les enregistrements peuvent disparaître ou dupliquer pendant l'annulation / refaire!). Les enregistrements internes sont ensuite mis à jour en conséquence et les enregistrements à annuler / refaire sont décrits.

Sur le chemin de tout cela, les rappels supplémentaires sur OunDoperformed / OnRedEperformed / OnAddunDoreCord sont appelés.

Sérialisation des enregistrements basés sur les commandes

La sérialisation est également un gros problème, car les actions, et les actions anonymes encore pires, sont difficiles à sérialiser. UNDOPRO maintient un GameObject temporaire caché dans la scène actuelle qui contient tous les enregistrements personnalisés qui doivent être sérialisés. La sérialisation est réalisée par quelques classes d'emballage qui gèrent intelligemment toutes les combinaisons pour les actions, les objets, les méthodes, etc.

Ce système peut même être utilisé généralement! -> prend en charge tous les objets sérialisables (de UnityEngine.Object et System.Object) et des objets non sérialisables partiellement (une sérialisation des membres en sérialisable d'une couche), tous les autres objets sont encore par défaut -> prend en charge la plupart des actions anonymes (aucune insérialitable encore insérialisable)! Vous pouvez utiliser pleinement le contexte et la référence presque toutes les variables locales (les conditions décrites ci-dessus s'appliquent)!

Problèmes

Ce système semble fiable mais je ne prétends pas qu'il est complètement à l'épreuve des balles! Le pire des cas qui puisse se produire lorsqu'il gâche le suivi, c'est que vos enregistrements sont compensés par un petit montant (les actions sont exécutées un ou deux enregistrements après / avant / avant). Il n'y a actuellement aucune situation de ce type, heureusement, je ne prends aucune responsabilité pour les échecs! Si vous parvenez à le casser, veuillez m'en informer et me fournir des informations sur ce que vous avez fait (par le biais de problèmes) et j'essaie de résoudre ce problème :)

Installation

Mettez simplement le dossier undopro quelque part dans votre projet et vous êtes prêt à partir! Même si cela ne doit pas être dans le dossier de l'éditeur, cela ne signifie pas que vous pouvez l'utiliser à l'exécution! Les fonctionnalités nécessitant l'API de l'éditeur sont exclues au moment de l'exécution par vérification du préprocesseur. Dans le dossier Editor, en revanche, vous trouvez deux fenêtres utiles pour tester les fonctionnalités de 1. Le système d'annulation lui-même et 2. Le système d'action de sérialisation. Parallèlement à ces fenêtres, vous pouvez facilement déboguer le système vous-même pour voir comment il fonctionne par non-écominant #define undo_debug dans undopromanager! Afin d'utiliser simplement le système d'action de sérialisation pour votre propre projet, copiez simplement le dossier undopro / serializableAction avec la licence bien sûr!

API

L'API pour les développeurs est très simple. Ajoutez la dépendance UNDOPRO, puis utilisez undopromanager pour interagir avec le système. Éléments importants:

• RecordOpterationAndPerform - Accepte les actions pour UNDO / REDO avec une étiquette et les ajoute comme un enregistrement. De plus, il effectuera l'action de rétablissement.
• RecordOperation (2 surcharges) - Accepte les actions pour l'annulation / refaire avec une étiquette et les ajoute comme enregistrement. Utiliser si vous avez déjà effectué manuellement l'action
• Rappel ONUNDOPORDED - appelé lorsque l'annulation a été effectuée. Dépasse tous les enregistrements annulés, qui peuvent être multiples s'ils étaient regroupés.
• Rappel OnRedReperFormed - appelé lorsque Redo a été effectué. Passe tous les enregistrements refaits, qui peuvent être multiples s'ils étaient regroupés.
• Rappel OnAddunDoreCord - appelé lorsqu'un enregistrement a été ajouté, à la fois à partir de UNDOPRO et du système par défaut. Passe son nom et s'il est considéré comme «important» (certains enregistrements effacent la pile de rétablissement lorsqu'ils sont ajoutés, certains, comme le changement de sélection, ne le font pas). Cela pourrait également se rapporter à la question de savoir si le dossier ajouté est inclus dans le dernier groupe d'enregistrements ou s'il a ouvert un nouveau groupe (incertain).
• Activerundopro / Disableundopro - Toguez l'état du système. Pas recommandé de désactiver car il créera simplement un trou dans l'enregistrement et gâchera les enregistrements précédents!

Recommandation: Si vous avez calculé quelque chose ou effectué une opération avec un résultat intermédiaire, il est très facile de configurer cela à condition que le résultat soit sérialisable. Au lieu de recalculer dans les actions UNDO / Remo, définissez simplement le résultat sérialisable précédent dans l'action d'annulation et la nouvelle dans l'action de rétablissement. Fait!

Auteur et licence

Cette prolongation a été créée par Sénéral et est publiée dans le cadre de la licence du MIT (spécifiée en outre dans Licence.md)