charleslemaux/Mirror
1
0
Fork 0
mirror of https://github.com/MirrorNetworking/Mirror.git synced 2024-11-18 11:00:32 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
4cf77ca7c7
Mirror/doc/Components/NetworkLogSettings.md

30 lines
1.2 KiB
Markdown
Raw Normal View History

feat: LogSettings that can be saved and included in a build (#1863) * Moving code that draws the log levels to its own class this allows other scripts to use the same code to draw the log levels * adding LogSettings to store the log levels * adding GUI method to create LogSettings * Creating Editor for LogSettings that uses LogLevelsGUI * adding helper to find Existing LogSettings * Adding field to LogLevelWindow to use LogSettings * Adding LogSettings to drawer and save on changed check * fixing field default value of null so that c# compiler doesnt complain * loading existing settings into LogFactory when the editor starts * component to load log settings in a build * changing namespace * Moving logging scripts to subfolder * NetworkLogSettings editor Makes the component use the same gui as the Window and ScriptableObject * Making NetworkLogSettings find existing settings on Reset reset is called when component is added * adding attributes * adding docs * adding icon * doc. * documentation and images * fixing image extension * Update Assets/Mirror/Runtime/Logging/EditorLogSettingsLoader.cs Co-authored-by: vis2k <info@noobtuts.com> Co-authored-by: vis2k <info@noobtuts.com>
2020-05-08 22:51:21 +00:00
# Network Log Settings
**See also <xref:Mirror.LogFactory> in the API Reference.**
## Network Log Settings component
doc: Updated NetworkLogSettings doc
2020-05-09 02:39:53 +00:00
The Network Log Settings component allows you to configure logging levels and load the settings in a build.
feat: LogSettings that can be saved and included in a build (#1863) * Moving code that draws the log levels to its own class this allows other scripts to use the same code to draw the log levels * adding LogSettings to store the log levels * adding GUI method to create LogSettings * Creating Editor for LogSettings that uses LogLevelsGUI * adding helper to find Existing LogSettings * Adding field to LogLevelWindow to use LogSettings * Adding LogSettings to drawer and save on changed check * fixing field default value of null so that c# compiler doesnt complain * loading existing settings into LogFactory when the editor starts * component to load log settings in a build * changing namespace * Moving logging scripts to subfolder * NetworkLogSettings editor Makes the component use the same gui as the Window and ScriptableObject * Making NetworkLogSettings find existing settings on Reset reset is called when component is added * adding attributes * adding docs * adding icon * doc. * documentation and images * fixing image extension * Update Assets/Mirror/Runtime/Logging/EditorLogSettingsLoader.cs Co-authored-by: vis2k <info@noobtuts.com> Co-authored-by: vis2k <info@noobtuts.com>
2020-05-08 22:51:21 +00:00
doc: Updated NetworkLogSettings doc
2020-05-09 02:39:53 +00:00
When you first add NetworkLogSettings you will have to Create a new LogSettings asset that will store the settings.
feat: LogSettings that can be saved and included in a build (#1863) * Moving code that draws the log levels to its own class this allows other scripts to use the same code to draw the log levels * adding LogSettings to store the log levels * adding GUI method to create LogSettings * Creating Editor for LogSettings that uses LogLevelsGUI * adding helper to find Existing LogSettings * Adding field to LogLevelWindow to use LogSettings * Adding LogSettings to drawer and save on changed check * fixing field default value of null so that c# compiler doesnt complain * loading existing settings into LogFactory when the editor starts * component to load log settings in a build * changing namespace * Moving logging scripts to subfolder * NetworkLogSettings editor Makes the component use the same gui as the Window and ScriptableObject * Making NetworkLogSettings find existing settings on Reset reset is called when component is added * adding attributes * adding docs * adding icon * doc. * documentation and images * fixing image extension * Update Assets/Mirror/Runtime/Logging/EditorLogSettingsLoader.cs Co-authored-by: vis2k <info@noobtuts.com> Co-authored-by: vis2k <info@noobtuts.com>
2020-05-08 22:51:21 +00:00
![Inspector With No Settings](NetworkLogSettingsNoSettings.png)
doc: Updated NetworkLogSettings doc
2020-05-09 02:39:53 +00:00
> **Note:** If a LogSettings asset already exists the NetworkLogSettings component will set the Settings field when it is added to a game object.
feat: LogSettings that can be saved and included in a build (#1863) * Moving code that draws the log levels to its own class this allows other scripts to use the same code to draw the log levels * adding LogSettings to store the log levels * adding GUI method to create LogSettings * Creating Editor for LogSettings that uses LogLevelsGUI * adding helper to find Existing LogSettings * Adding field to LogLevelWindow to use LogSettings * Adding LogSettings to drawer and save on changed check * fixing field default value of null so that c# compiler doesnt complain * loading existing settings into LogFactory when the editor starts * component to load log settings in a build * changing namespace * Moving logging scripts to subfolder * NetworkLogSettings editor Makes the component use the same gui as the Window and ScriptableObject * Making NetworkLogSettings find existing settings on Reset reset is called when component is added * adding attributes * adding docs * adding icon * doc. * documentation and images * fixing image extension * Update Assets/Mirror/Runtime/Logging/EditorLogSettingsLoader.cs Co-authored-by: vis2k <info@noobtuts.com> Co-authored-by: vis2k <info@noobtuts.com>
2020-05-08 22:51:21 +00:00
## Log Settings
doc: Updated NetworkLogSettings doc
2020-05-09 02:39:53 +00:00
When you first set up LogSettings the list of components may be empty or incomplete. Running the game will cause Mirror scripts to add their respective loggers to the list so their logging levels can be changed.
feat: LogSettings that can be saved and included in a build (#1863) * Moving code that draws the log levels to its own class this allows other scripts to use the same code to draw the log levels * adding LogSettings to store the log levels * adding GUI method to create LogSettings * Creating Editor for LogSettings that uses LogLevelsGUI * adding helper to find Existing LogSettings * Adding field to LogLevelWindow to use LogSettings * Adding LogSettings to drawer and save on changed check * fixing field default value of null so that c# compiler doesnt complain * loading existing settings into LogFactory when the editor starts * component to load log settings in a build * changing namespace * Moving logging scripts to subfolder * NetworkLogSettings editor Makes the component use the same gui as the Window and ScriptableObject * Making NetworkLogSettings find existing settings on Reset reset is called when component is added * adding attributes * adding docs * adding icon * doc. * documentation and images * fixing image extension * Update Assets/Mirror/Runtime/Logging/EditorLogSettingsLoader.cs Co-authored-by: vis2k <info@noobtuts.com> Co-authored-by: vis2k <info@noobtuts.com>
2020-05-08 22:51:21 +00:00
![Inspector](NetworkLogSettings.png)
doc: Updated NetworkLogSettings doc
2020-05-09 02:39:53 +00:00
Log settings can also be changed using the "Mirror Log Level" window, which can be opened from the editor menu: Window > Analysis > Mirror Log Levels.
feat: LogSettings that can be saved and included in a build (#1863) * Moving code that draws the log levels to its own class this allows other scripts to use the same code to draw the log levels * adding LogSettings to store the log levels * adding GUI method to create LogSettings * Creating Editor for LogSettings that uses LogLevelsGUI * adding helper to find Existing LogSettings * Adding field to LogLevelWindow to use LogSettings * Adding LogSettings to drawer and save on changed check * fixing field default value of null so that c# compiler doesnt complain * loading existing settings into LogFactory when the editor starts * component to load log settings in a build * changing namespace * Moving logging scripts to subfolder * NetworkLogSettings editor Makes the component use the same gui as the Window and ScriptableObject * Making NetworkLogSettings find existing settings on Reset reset is called when component is added * adding attributes * adding docs * adding icon * doc. * documentation and images * fixing image extension * Update Assets/Mirror/Runtime/Logging/EditorLogSettingsLoader.cs Co-authored-by: vis2k <info@noobtuts.com> Co-authored-by: vis2k <info@noobtuts.com>
2020-05-08 22:51:21 +00:00
![Window](LogLevelWindow.png)
To change settings at runtime please see <xref:Mirror.LogFactory>.
## Issues
doc: Updated NetworkLogSettings doc
2020-05-09 02:39:53 +00:00
Mirrors Logging api is currently work in progress. If there is a bug or a feature you want added please make an issue [here](https://github.com/vis2k/Mirror/issues).
Reference in New Issue Copy Permalink