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

Improve documentation of game messages #1027

Closed
wants to merge 1 commit into from

Conversation

Garanas
Copy link
Member

@Garanas Garanas commented Oct 26, 2024

Related to: FAForever/fa#6479

Improves the documentation of some of the game messages.

@Garanas Garanas requested a review from Askaholic October 26, 2024 13:58
Copy link
Collaborator

@Askaholic Askaholic left a comment

Choose a reason for hiding this comment

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

Cool, thanks! I hope to find some time this weekend to implement the established peers.

What are we expecting the server to do with the launch status information? If we’re just ignoring most of it you could also just add the possible options in the docstring and get rid of the empty if chain.

server/gameconnection.py Outdated Show resolved Hide resolved
server/gameconnection.py Outdated Show resolved Hide resolved
server/gameconnection.py Outdated Show resolved Hide resolved
@Askaholic Askaholic force-pushed the documentation/game-messages branch from ba225d9 to aeeb4c2 Compare October 26, 2024 17:02
@Garanas
Copy link
Member Author

Garanas commented Oct 26, 2024

The launch status can help you understand what is happening to a player/connection. For example - a player that has the status Ready is connected to all its peers and is ready to launch. Such a player should never receive a (time) penalty if the lobby does not start for some reason.

edit: perhaps 'launch status' is the wrong term to use here.

@Askaholic
Copy link
Collaborator

I'm just going to combine this with #1028 for simplicity. Thanks for making the initial changes!

@Askaholic Askaholic closed this Oct 27, 2024
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.

2 participants