mirror of
https://github.com/MirrorNetworking/Mirror.git
synced 2024-11-18 11:00:32 +00:00
76b75dbb9b
* Documentation Outline * Spacing adjustments * Captured old wiki content * yml fix * Docs work * resize images * Replaced images * Removed md from links * Renamed Misty to Fizzy * Captured Unity docs * links cleanup * clear links * Cleanup and moved NetworkBehavior to Classes. * added slashes to yml paths * reverted slashes * Fixes bad link * Update Ignorance.md This should be enough documentation for now, yeah? * Localized images * Update Ignorance.md formatting updates * Lots of Cleanup * fix link * Formatting * fix code blocks * Lots of content and cleanup * fixed yml * Added blank line * Added spaces in titles * tightened bullets * Fixed bullet spacing * Fixed more bullets * unbolded content * Cleanup and removal of empty pages Updated README with links to docs pages * Restored prior version * Contributing * Improvements to content * lower case fix * fix link * renamed Contributions * fixed link * home page content * Fixed Encoding * Moved Why TCP * Replaced Unity with Mirror * Telepathy Description * changed to h2 * Moved Sample down * Removed dead links * Copied Contributions Added Test Fixed h3's * Fixed headings * added to Test * Fixed image alts and links * fixed last alt
21 lines
1.3 KiB
Markdown
21 lines
1.3 KiB
Markdown
# NetworkProximityChecker
|
||
|
||
The Network Proximity Checker component controls the visibility of GameObjects for network clients, based on proximity to players.
|
||
|
||
|
||
|
||
- **Vis Range**
|
||
Define the range that the GameObject should be visible in.
|
||
- **Vis Update Interval**
|
||
Define how often (in seconds) the GameObject should check for players entering its visible range.
|
||
- **Check Method**
|
||
Define which type of physics (2D or 3D) to use for proximity checking.
|
||
- **Force Hidden**
|
||
Tick this checkbox to hide this object from all players.
|
||
|
||
With the Network Proximity Checker, a game running on a client doesn’t have information about GameObjects that are not visible. This has two main benefits: it reduces the amount of data sent across the network, and it makes your game more secure against hacking.
|
||
|
||
This component relies on physics to calculate visibility, so the GameObject must also have a collider component on it.
|
||
|
||
A GameObject with a Network Proximity Checker component must also have a [Network Identity] component. When you create a Network Proximity Checker component on a GameObject, Mirror also creates a Network Identity component on that GameObject if it does not already have one.
|