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

Rename ConnectionSettings close_after_match #32

Open
NicEastvillage opened this issue Nov 3, 2024 · 2 comments
Open

Rename ConnectionSettings close_after_match #32

NicEastvillage opened this issue Nov 3, 2024 · 2 comments
Labels
enhancement New feature or request

Comments

@NicEastvillage
Copy link
Contributor

The ConnectionSettings::close_after_match has confused a few people using the lower level interfaces since the connection is not actually closed when the match ends, but rather, when a match is stopped with a StopMatch message or a new match begins with a StartMatch message. I propose renaming it to close_between_matches.

@NicEastvillage NicEastvillage added the enhancement New feature or request label Nov 3, 2024
@swz-git
Copy link
Member

swz-git commented Nov 3, 2024

I think its pretty hard to define the behavior of this field with a short name. close_between_matches still implies that the bot will get closed after a match. The best we could do IMO is replace/append this comment with something like /// RLBot doesn't actually know when a match ends. Therefor, your bot/script will only be closed once a StopMatch or StartMatch packet is sent.

@NicEastvillage
Copy link
Contributor Author

Yeah, that comment would be a great addition to remove all confusion. But I still think close_between_matches is slightly better since it does not have immediacy to it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants