diasurgical/devilutionX

Reduce use of globals

Open

#2435 opened on Jul 20, 2021

View on GitHub
 (21 comments) (0 reactions) (0 assignees)C++ (7,255 stars) (743 forks)batch import
good first issuehelp wanted

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

Tech stack
cpp
Domain
testing
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.
3-5 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
C++ knowledgeunderstanding of global variablesfamiliarity with DevilutionX codebase
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50
Research direction
Focus on the remaining unchecked globals: Items, Objects, QuestData, Quests, Players. Look at the changes made for the checked globals (Lights, Missiles, VisionList, Monsters, Towners) to understand the expected pattern. Search the source code for global variable usages and refactor them to pass these objects by reference to functions. Check issue comments for any additional guidance.