diasurgical/devilutionX

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

Open

#2,260 opened on Jun 28, 2021

View on GitHub
 (11 comments) (2 reactions) (0 assignees)C++ (743 forks)batch import
good first issue

Repository metrics

Stars
 (7,255 stars)
PR merge metrics
 (Avg merge 2d 12h) (15 merged PRs in 30d)

Description

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 direction
Identify the hardcoded displacement points in missiles.cpp and replace them with the corresponding Direction enum values. Ensure behavior remains identical.
Tech stack
cpp
Domain
backend
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
C++
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75