diasurgical/DevilutionX

Refactor missiles.cpp to use Direction enum instead of magic Point/Displacement constants

Offen

#2.260 geöffnet am 28.06.2021

Auf GitHub ansehenContributor Guide
 (11 Kommentare) (2 Reaktionen) (0 zugewiesene Personen)C++ (743 Forks)batch import
good first issue

Repository-Metriken

Stars
 (7.255 Sterne)
PR-Merge-Metriken
 (Durchschn. Merge 2T 12h) (15 gemergte PRs in 30 T)

Beschreibung

There are multiple places in missiles.cpp which iterate through tiles adjacent to a given location.

https://github.com/diasurgical/devilutionX/blob/5537fe748e63b06ed2e474f7dea6ebd1216fa3d3/Source/missiles.cpp#L1634 https://github.com/diasurgical/devilutionX/blob/5537fe748e63b06ed2e474f7dea6ebd1216fa3d3/Source/missiles.cpp#L3417 https://github.com/diasurgical/devilutionX/blob/5537fe748e63b06ed2e474f7dea6ebd1216fa3d3/Source/missiles.cpp#L3995 https://github.com/diasurgical/devilutionX/blob/5537fe748e63b06ed2e474f7dea6ebd1216fa3d3/Source/missiles.cpp#L4017 https://github.com/diasurgical/devilutionX/blob/5537fe748e63b06ed2e474f7dea6ebd1216fa3d3/Source/missiles.cpp#L4772

These lists could be directly replaced with a list of the appropriate Direction enum constants. This would retain the same behaviour as existing code while making the intent clearer.

Contributor Guide

Research-Richtung
Das Problem identifiziert fünf Stellen in missiles.cpp (Zeilen 1634, 3417, 3995, 4017, 4772), an denen magische Konstanten verwendet werden, um benachbarte Kacheln zu durchlaufen. Die Lösung besteht darin, diese durch eine Liste von Direction Enum Konstanten zu ersetzen. Zuerst muss die Definition des Direction Enums gefunden werden (wahrscheinlich in einer separaten Header Datei wie source/engine/direction.h oder ähnlich), und die Zuordnung muss überprüft werden. Dann müssen für jeden der fünf Blöcke die magischen Konstanten durch die entsprechenden Direction Werte ersetzt werden. Das Problem hat 11 Kommentare, die weitere Anleitungen oder Diskussionen zu den erwarteten Enum Werten enthalten können.
Tech Stack
cpp
Domain
backend
Issue Type
Refactoring
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
C++
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
75