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.

Sign up for GitHub

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
Merged

Shuffle player documentation, add to game event documentation #685

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4b514c3
Move referencing-players.md from reference to guides
zonical Nov 23, 2024
12e911a
Update game-events.md to add a caution regarding accessing data in Ga…
zonical Nov 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions docfx/docs/features/game-events.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,9 @@ The specific subclass of `GameEvent` will provide strongly typed parameters from

These event properties are mutable so you can update them as normal and they will update in the event instance.

> [!CAUTION]
> `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.
## Preventing Broadcast

You can modify a game event so that it does not get broadcast to clients by modifying the `bool info.DontBroadcast` property. e.g.
Expand Down
0 docfx/docs/reference/referencing-players.md → docfx/docs/guides/referencing-players.md
View file
Open in desktop
File renamed without changes.
3 changes: 3 additions & 0 deletions docfx/docs/guides/toc.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,6 @@

- name: Dependency Injection
href: dependency-injection.md

- name: Referencing Players
href: referencing-players.md
5 changes: 1 addition & 4 deletions docfx/docs/reference/toc.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,2 @@
- name: Core Configuration
href: core-configuration.md

- name: Referencing Players
href: referencing-players.md
href: core-configuration.md
Loading