Skip to content

Commit

Permalink
doc
Browse files Browse the repository at this point in the history
  • Loading branch information
Brambor committed Sep 17, 2024
1 parent 86dafe9 commit bbc1164
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 3 deletions.
5 changes: 5 additions & 0 deletions doc/OBSOLETION_AND_MIGRATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -244,6 +244,11 @@ For EOC/dialogue variables you can use `var_migration`. This currently only migr
}
```

# Activity Migration
See if it is mentioned in `src/savegame_legacy.cpp`.

In `src/savegame_json.cpp` in `player_activity::deserialize( const JsonObject &data )` add to `std::set<std::string> obs_activities` the activity ID with comment to remove it after the next version (after 0.B when in 0.A experimental). There should always be at least one example left.

# Ammo types

Ammo types don't need an infrastructure to be obsoleted, but it is required to remove all items that use this ammo type
Expand Down
6 changes: 3 additions & 3 deletions src/uistate.h
Original file line number Diff line number Diff line change
Expand Up @@ -215,12 +215,12 @@ class uistatedata
return input_history[id];
}
/**
* A function pointer to be run before the player's next action.
* A function pointer to be run before the player's next action (but after activities conclude).
*
* Useful for opening a menu with passed arguments.
* As it is not serialized it should not be used for any game state logic! Like moving a character.
*/
// NOLINTNEXTLINE(cata-serialize)
std::optional<std::function<void()>> open_menu;
std::optional<std::function<void()>> open_menu; // NOLINT(cata-serialize)

// nice little convenience function for serializing an array, regardless of amount. :^)
template<typename T>
Expand Down

0 comments on commit bbc1164

Please sign in to comment.