diasurgical/devilutionX

Reduce use of globals

Open

#2,435 opened on Jul 20, 2021

View on GitHub
 (21 comments) (0 reactions) (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

The following globals are being referenced a lot where it could instead have been done by reference, changing this will make functions more dependable/testable.

  • Items
  • Lights
  • Missiles
  • Objects
  • QuestData
  • Quests
  • VisionList
  • Players
  • Monsters
  • Towners

Contributor guide

Research direction
Examine each global variable listed, determine where it is used, and refactor functions to accept the variable as a parameter (by reference) instead of relying on the global. Start with the ones already marked as done (Lights, Missiles, VisionList, Monsters, Towners) to understand the pattern, then apply to the remaining items (Items, Objects, QuestData, Quests, Players). Ensure all call sites are updated and the code compiles.
Tech stack
cpp
Domain
game dev
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.
60