CleverRaven/Cataclysm-DDA

Migrate legacy activities to the activity actor system

Open

#40,013 opened on Apr 29, 2020

View on GitHub
 (0 comments) (0 reactions) (0 assignees)C++ (3,991 forks)batch import
(P5 - Long-term)Code: Infrastructure / Style / Static AnalysisGood First Issue[C++]

Repository metrics

Stars
 (9,264 stars)
PR merge metrics
 (Avg merge 6d 5h) (292 merged PRs in 30d)

Description

We have a new system for creating activities that is more robust and flexible that the previous one. However, most activities still use use the old system. It would be good if we could migrate these legacy activities to the new system, as the resulting code is easier to read, understand, and maintain.

For reference, the initial PR implementing the system is #37450 and a few example PRs migrating an activity to the new system are #39297 and #39646. Documentation for the activity actor system can be found here: doc/PLAYER_ACTIVITY.md. The activity handlers needing migration can be found in src/activity_handling.cpp.

If you'd like to help with this and have questions, feel free to hit me up on IRC or the development discord or just ping me for a pull request review.

Contributor guide

Research direction
Study the activity actor system documentation in doc/PLAYER ACTIVITY.md and examine example PRs #39297 and #39646. Then pick an activity handler from src/activity handling.cpp and refactor it to use the new system, following the patterns shown.
Tech stack
cpp
Domain
desktop dev
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-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++Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80