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

Shuffle player documentation, add to game event documentation #685

Merged
merged 2 commits into from
Nov 25, 2024

Conversation

zonical
Copy link
Collaborator

@zonical zonical commented Nov 23, 2024

Partially addresses #677 and #684

This PR does two things:

  • Adds a caution block to the "Features > Game Events" page to warn developers that GameEvent instances and their parameters no longer exist after the event has been fired. The new text is inserted in the section " Accessing Event Parameters" and states:

GameEvent instances and their properties will cease to exist after the event listener function is called, which means that you will encounter errors when accessing properties in timers and functions like Server.NextFrame(). You should store the value of properties in variables before calling functions like Server.NextFrame() so you can read the data safely.

  • Moves the "Reference Players" page from the "Reference" section to the "Guides" section in an attempt to make the differences between player controllers and player pawns more visible and accessible to developers.

It's been a while since I've touched docfx, so please let me know if I've made any mistakes in rearranging files and the toc.yml files.

@zonical zonical requested a review from roflmuffin as a code owner November 23, 2024 21:16
@zonical zonical added the documentation Issue related to documentation regarding CS2 or CS:S. label Nov 23, 2024
@roflmuffin roflmuffin merged commit b2046b2 into main Nov 25, 2024
5 checks passed
@roflmuffin roflmuffin deleted the fix/documentation branch November 25, 2024 00:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Issue related to documentation regarding CS2 or CS:S.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants