Replace player
with currentPlayer
option in setActivePlayers
#523
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Supersedes #514, related to #487.
In order to clarify who is being impacted by
setActivePlayers
calls — especially in hooks — this changes the syntax to require acurrentPlayer
option instead of aplayer
option:Breaking Changes
Anyone currently using the
setActivePlayers
event or theturn.activePlayers
option in their game config, who is using aplayer
option may see breaking changes.Migrating will take one of two forms:
Switching to using
currentPlayer
For
turn.activePlayers
orsetActivePlayers
calls whereplayer
was always the current player in any case, users will only have to rename the option:Maintaining
player
behaviourFor
setActivePlayers
calls where the behaviour impacted the player who triggered the move/event specifically, users will need to switch to using thevalue
option, for example:Further considerations
setStage
andendStage
still rely onplayerID
, which is unavoidable. These should probably be disabled inonBegin
andonEnd
hooks for clarity’s sake.