[no ci] Shuffle player documentation, add to game event documentation (…

…#685)
roflmuffin · Nov 25, 2024 · b2046b2 · b2046b2
1 parent 3c6be48
commit b2046b2
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 4 deletions.
diff --git a/docfx/docs/features/game-events.md b/docfx/docs/features/game-events.md
@@ -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.

diff --git a/docfx/docs/reference/referencing-players.md → docfx/docs/guides/referencing-players.md b/docfx/docs/reference/referencing-players.md → docfx/docs/guides/referencing-players.md
diff --git a/docfx/docs/guides/toc.yml b/docfx/docs/guides/toc.yml
@@ -6,3 +6,6 @@
 
 - name: Dependency Injection
   href: dependency-injection.md
+
+- name: Referencing Players
+  href: referencing-players.md
diff --git a/docfx/docs/reference/toc.yml b/docfx/docs/reference/toc.yml
@@ -1,5 +1,2 @@
 - name: Core Configuration
-  href: core-configuration.md
-
-- name: Referencing Players
-  href: referencing-players.md
+  href: core-configuration.md