diasurgical/devilutionX

Replace "int x, int y" arguments with "Point point"

Open

#1,684 opened on Apr 25, 2021

View on GitHub
 (2 comments) (1 reaction) (0 assignees)C++ (743 forks)batch import
good first issuehelp wanted

Repository metrics

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

Description

A lot of functions take two ints as the coordinates for their operations, this is both verbose and error-prone. Instead we should use the Point structure, see an example of this type of cleanup done for the GetDirection() https://github.com/diasurgical/devilutionX/commit/f77c52941afd73d4e734c0696d082218cd04c3a7

Try to split the changes up in one function per commit to making it easy to review and less prone to typos.

Contributor guide

Research direction
Study the example commit for GetDirection() to understand the pattern, then identify all functions with 'int x, int y' parameters and refactor them one per commit, ensuring each commit compiles and passes tests.
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.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
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
GitC++
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60