Merge pull request #233 from andgeno/docs

Improved Docs

Author: TwoTenPvP

docs/_data/docs.yml

@@ -35,4 +35,8 @@
   - custom-transports
   - network-profiler-window
   - custom-serialization
-  - boxing-systems
+  - boxing-systems
+
+- title: Troubleshooting
+  docs:
+  - common-mistakes

docs/_docs/getting-started/connection-approval.md

@@ -36,7 +36,7 @@ The ConnectionData will then be passed to the server and it will decide if the c
 
 
 ### Timeout
-The MLAPI uses a callback system in order to allow for external validation. Forexample, you might have a steam authentication ticket sent as the ConnectionData (encrypted and authenticated by the MLAPI) that you want to validate against steams servers. This can take some time. If you don't call the callback method within the time specified in the ``ClientConnectionBufferTimeout`` configuration. The connection will be dropped. This time starts counting when the transport has told the MLAPI about the connection. This means that you cannot attack the MLAPI by never sending the buffer, it will still time you out.
+The MLAPI uses a callback system in order to allow for external validation. For example, you might have a steam authentication ticket sent as the ConnectionData (encrypted and authenticated by the MLAPI) that you want to validate against steams servers. This can take some time. If you don't call the callback method within the time specified in the ``ClientConnectionBufferTimeout`` configuration the connection will be dropped. This time starts counting when the transport has told the MLAPI about the connection. This means that you cannot attack the MLAPI by never sending the buffer, it will still time you out.
 
 
 ### Security

docs/_docs/the-basics/messaging-system.md

@@ -23,9 +23,9 @@ void MyMethod(int myInt)
 
 #### Convenience Example
 ```csharp
-private void Update()
+private void OnGUI()
 {
-    if (GUI.Button("SendRandomInt"))
+    if (GUILayout.Button("SendRandomInt"))
     {
         if (IsServer)
         {
@@ -41,14 +41,14 @@ private void Update()
 [ServerRPC]
 private void MyServerRPC(int number)
 {
-    Debug.Log("The number recieved was: " + number);
+    Debug.Log("The number received was: " + number);
     Debug.Log("This method ran on the server upon the request of a client");
 }
 
 [ClientRPC]
 private void MyClientRPC(int number)
 {
-    Debug.Log("The number recieved was: " + number);
+    Debug.Log("The number received was: " + number);
     Debug.Log("This method ran on the client upon the request of the server");
 }
 ```
@@ -83,9 +83,9 @@ public float MyRpcWithReturnValue(float x, float y)
 To use the performance mode, the RPC method require the following signature ``void (ulong clientId, Stream readStream)`` and the sender is required to use the non generic Stream overload.
 
 ```csharp
-private void Update()
+private void OnGUI()
 {
-    if (GUI.Button("SendRandomInt"))
+    if (GUILayout.Button("SendRandomInt"))
     {
         if (IsServer)
         {
@@ -120,7 +120,7 @@ private void MyServerRPC(ulong clientId, Stream stream) //This signature is REQU
     using (PooledBitReader reader = PooledBitReader.Get(stream))
     {
         int number = reader.ReadInt32Packed();
-        Debug.Log("The number recieved was: " + number);
+        Debug.Log("The number received was: " + number);
         Debug.Log("This method ran on the server upon the request of a client");
     }
 }
@@ -131,7 +131,7 @@ private void MyClientRPC(ulong clientId, Stream stream) //This signature is REQU
     using (PooledBitReader reader = PooledBitReader.Get(stream))
     {
         int number = reader.ReadInt32Packed();
-        Debug.Log("The number recieved was: " + number);
+        Debug.Log("The number received was: " + number);
         Debug.Log("This method ran on the client upon the request of the server");
     }
 }
@@ -167,9 +167,9 @@ If you don't want to use the MLAPI's messaging. You don't have to. You can use a
 
 #### Usage
 ```csharp
-void Start()
+private void Start()
 {
-    //Recieving
+    //Receiving
     NetworkingManager.Singleton.OnIncommingCustomMessage += ((clientId, stream) =>
     {
         using (PooledBitReader reader = PooledBitReader.Get(stream))

docs/_docs/troubleshooting/common-mistakes.md

@@ -0,0 +1,30 @@
+---
+title: Common Mistakes
+permalink: /wiki/common-mistakes/
+---
+
+This is a collection of common mistakes:
+
+- [`NullReferenceException` when trying to start a server/host/client](#err-001)
+
+---
+
+### <a name="err-001"></a>`NullReferenceException` when trying to start a server/host/client
+
+#### Problem
+When trying to start a server, host, or client by executing one of these lines of code
+
+```csharp
+NetworkingManager.Singleton.StartServer()
+NetworkingManager.Singleton.StartHost()
+NetworkingManager.Singleton.StartClient()
+```
+
+the following exception is thrown:
+
+```csharp
+NullReferenceException: Object reference not set to an instance of an object
+```
+
+#### Solution
+You most likely forgot to add the `NetworkingManager` component to a game object in your scene.