Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add pause option to play to allow turn based games #1042

Merged

Conversation

foreverska
Copy link
Contributor

@foreverska foreverska commented May 3, 2024

Description

Added new option to play which requires the user to provide an input to move the environment forward. Defaults to False to not break existing implementations.

Fixes #802

Type of change

Please delete options that are not relevant.

  • New feature (non-breaking change which adds functionality)

Checklist:

  • I have run the pre-commit checks with pre-commit run --all-files (see CONTRIBUTING.md instructions to set it up)
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

Copy link
Member

@pseudo-rnd-thoughts pseudo-rnd-thoughts left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, this is a very helpful PR.
Could we have a better argument name than pause, for example,wait_for_user? Also could you add an sentence to the main part of the docstring saying for turn-based environments, then enable X
Otherwise, should be good to merge

@foreverska
Copy link
Contributor Author

Thanks for the quick reply and the kind words. I have made the proposed changes.

Copy link
Member

@pseudo-rnd-thoughts pseudo-rnd-thoughts left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the changes

@pseudo-rnd-thoughts pseudo-rnd-thoughts merged commit 17f161e into Farama-Foundation:main May 4, 2024
11 checks passed
@foreverska foreverska deleted the turnbased_play branch May 4, 2024 21:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Question] Can utils.play.Play be used for playing Blackjack?
2 participants