GabrielTofvesson/MLAPI
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Added class summaries

Browse Source
This commit is contained in:
Albin Corén 2018-03-31 10:19:37 +02:00
parent 7079765b2c
commit 16ee90adfd
17 changed files with 118 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

72
Docs.shfbproj Normal file
View File

@ -0,0 +1,72 @@
<?xml version="1.0" encoding="utf-8"?>
<Project ToolsVersion="14.0" DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
<PropertyGroup>
<!-- The configuration and platform will be used to determine which assemblies to include from solution and
project documentation sources -->
<Configuration Condition=" '$(Configuration)' == '' ">Debug</Configuration>
<Platform Condition=" '$(Platform)' == '' ">AnyCPU</Platform>
<SchemaVersion>2.0</SchemaVersion>
<ProjectGuid>{6bae2f52-652d-4268-923d-0e1198bdc825}</ProjectGuid>
<SHFBSchemaVersion>2017.9.26.0</SHFBSchemaVersion>
<!-- AssemblyName, Name, and RootNamespace are not used by SHFB but Visual Studio adds them anyway -->
<AssemblyName>Documentation</AssemblyName>
<RootNamespace>Documentation</RootNamespace>
<Name>Documentation</Name>
<!-- SHFB properties -->
<FrameworkVersion>.NET Framework 3.5</FrameworkVersion>
<OutputPath>Docs\</OutputPath>
<HtmlHelpName>Documentation</HtmlHelpName>
<Language>en-US</Language>
<HelpFileFormat>Markdown</HelpFileFormat>
<SyntaxFilters>C#</SyntaxFilters>
<PresentationStyle>Markdown</PresentationStyle>
<CleanIntermediates>True</CleanIntermediates>
<KeepLogFile>True</KeepLogFile>
<DisableCodeBlockComponent>False</DisableCodeBlockComponent>
<IndentHtml>False</IndentHtml>
<BuildAssemblerVerbosity>OnlyWarningsAndErrors</BuildAssemblerVerbosity>
<HelpTitle>MLAPI API Reference</HelpTitle>
<HelpFileVersion>1.0.0.0</HelpFileVersion>
<RootNamespaceContainer>False</RootNamespaceContainer>
<NamespaceGrouping>False</NamespaceGrouping>
<Preliminary>False</Preliminary>
<SdkLinkTarget>Blank</SdkLinkTarget>
<NamingMethod>MemberName</NamingMethod>
<ContentPlacement>AboveNamespaces</ContentPlacement>
<SourceCodeBasePath>MLAPI\</SourceCodeBasePath>
<WarnOnMissingSourceContext>False</WarnOnMissingSourceContext>
<DocumentationSources>
<DocumentationSource sourceFile="MLAPI\bin\Debug\MLAPI.dll" />
<DocumentationSource sourceFile="MLAPI\bin\Debug\MLAPI.xml" /></DocumentationSources>
<MissingTags>Summary, Parameter, Returns, AutoDocumentCtors, TypeParameter, AutoDocumentDispose</MissingTags>
</PropertyGroup>
<!-- There are no properties for these groups. AnyCPU needs to appear in order for Visual Studio to perform
the build. The others are optional common platform types that may appear. -->
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|AnyCPU' ">
</PropertyGroup>
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
</PropertyGroup>
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|x86' ">
</PropertyGroup>
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|x86' ">
</PropertyGroup>
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|x64' ">
</PropertyGroup>
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|x64' ">
</PropertyGroup>
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|Win32' ">
</PropertyGroup>
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|Win32' ">
</PropertyGroup>
<!-- Import the SHFB build targets -->
<Import Project="$(SHFBROOT)\SandcastleHelpFileBuilder.targets" />
<!-- The pre-build and post-build event properties must appear *after* the targets file import in order to be
evaluated correctly. -->
<PropertyGroup>
<PreBuildEvent>
</PreBuildEvent>
<PostBuildEvent>
</PostBuildEvent>
<RunPostBuildEvent>OnBuildSuccess</RunPostBuildEvent>
</PropertyGroup>
</Project>

3
MLAPI/Data/NetworkingConfiguration.cs
View File

@ -6,6 +6,9 @@ using UnityEngine.Networking;
namespace MLAPI
{
/// <summary>
/// The configuration object used to start server, client and hosts
/// </summary>
public class NetworkingConfiguration
{
/// <summary>

3
MLAPI/MLAPI.csproj
View File

@ -24,6 +24,7 @@
<ErrorReport>prompt</ErrorReport>
<WarningLevel>4</WarningLevel>
<GenerateSerializationAssemblies>Auto</GenerateSerializationAssemblies>
<DocumentationFile>bin\Debug\MLAPI.xml</DocumentationFile>
</PropertyGroup>
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
<DebugType>pdbonly</DebugType>
@ -43,6 +44,8 @@
<CodeAnalysisRuleSet>MinimumRecommendedRules.ruleset</CodeAnalysisRuleSet>
<GenerateSerializationAssemblies>Auto</GenerateSerializationAssemblies>
<RunCodeAnalysis>false</RunCodeAnalysis>
<DocumentationFile>
</DocumentationFile>
</PropertyGroup>
<PropertyGroup>
<SignAssembly>false</SignAssembly>

3
MLAPI/MonoBehaviours/Core/NetworkedBehaviour.cs
View File

@ -10,6 +10,9 @@ using MLAPI.Data;
namespace MLAPI
{
/// <summary>
/// The base class to override to write networked code. Inherits MonoBehaviour
/// </summary>
public abstract class NetworkedBehaviour : MonoBehaviour
{
/// <summary>

3
MLAPI/MonoBehaviours/Core/NetworkedObject.cs
View File

@ -5,6 +5,9 @@ using UnityEngine;
namespace MLAPI
{
/// <summary>
/// A component used to identify that a GameObject is networked
/// </summary>
[AddComponentMenu("MLAPI/NetworkedObject", -99)]
public class NetworkedObject : MonoBehaviour
{

3
MLAPI/MonoBehaviours/Core/NetworkingManager.cs
View File

@ -11,6 +11,9 @@ using System.Security.Cryptography;
namespace MLAPI
{
/// <summary>
/// The main component of the library
/// </summary>
[AddComponentMenu("MLAPI/NetworkingManager", -100)]
public class NetworkingManager : MonoBehaviour
{

4
MLAPI/MonoBehaviours/Core/TrackedObject.cs
View File

@ -7,6 +7,10 @@ namespace MLAPI.MonoBehaviours.Core
{
//Based on: https://twotenpvp.github.io/lag-compensation-in-unity.html
//Modified to be used with latency rather than fixed frames and subframes. Thus it will be less accrurate but more modular.
/// <summary>
/// A component used for lag compensation. Each object with this component will get tracked
/// </summary>
[AddComponentMenu("MLAPI/TrackedObject", -98)]
public class TrackedObject : MonoBehaviour
{

3
MLAPI/MonoBehaviours/Prototyping/NetworkedAnimator.cs
View File

@ -4,6 +4,9 @@ using UnityEngine;
namespace MLAPI.MonoBehaviours.Prototyping
{
/// <summary>
/// A prototype component for syncing animations
/// </summary>
[AddComponentMenu("MLAPI/NetworkedAnimator")]
public class NetworkedAnimator : NetworkedBehaviour
{

3
MLAPI/MonoBehaviours/Prototyping/NetworkedNavMeshAgent.cs
View File

@ -5,6 +5,9 @@ using UnityEngine.AI;
namespace MLAPI.MonoBehaviours.Prototyping
{
/// <summary>
/// A prototype component for syncing navmeshagents
/// </summary>
[AddComponentMenu("MLAPI/NetworkedNavMeshAgent")]
public class NetworkedNavMeshAgent : NetworkedBehaviour
{

3
MLAPI/MonoBehaviours/Prototyping/NetworkedTransform.cs
View File

@ -3,6 +3,9 @@ using UnityEngine;
namespace MLAPI.MonoBehaviours.Prototyping
{
/// <summary>
/// A prototype component for syncing transforms
/// </summary>
[AddComponentMenu("MLAPI/NetworkedTransform")]
public class NetworkedTransform : NetworkedBehaviour
{

3
MLAPI/NetworkingManagerComponents/CryptographyHelper.cs
View File

@ -4,6 +4,9 @@ using System.IO;
namespace MLAPI.NetworkingManagerComponents
{
/// <summary>
/// Helper class for encryption purposes
/// </summary>
public static class CryptographyHelper
{
/// <summary>

2
MLAPI/NetworkingManagerComponents/DiffieHellman.cs
View File

@ -5,7 +5,7 @@ using System.Security.Cryptography;
namespace MLAPI.NetworkingManagerComponents
{
public class EllipticDiffieHellman
internal class EllipticDiffieHellman
{
protected static readonly RNGCryptoServiceProvider rand = new RNGCryptoServiceProvider();
public static readonly IntX DEFAULT_PRIME = (new IntX(1) << 255) - 19;

4
MLAPI/NetworkingManagerComponents/EllipticCurve.cs
View File

@ -4,7 +4,7 @@ using IntXLib;
namespace MLAPI.NetworkingManagerComponents
{
public class CurvePoint
internal class CurvePoint
{
public static readonly CurvePoint POINT_AT_INFINITY = new CurvePoint();
public IntX X { get; private set; }
@ -22,7 +22,7 @@ namespace MLAPI.NetworkingManagerComponents
}
}
public class EllipticCurve
internal class EllipticCurve
{
public enum CurveType { Weierstrass, Montgomery }

3
MLAPI/NetworkingManagerComponents/LagCompensationManager.cs
View File

@ -6,6 +6,9 @@ using UnityEngine.Networking;
namespace MLAPI.NetworkingManagerComponents
{
/// <summary>
/// The main class for controlling lag compensation
/// </summary>
public static class LagCompensationManager
{
public static List<TrackedObject> SimulationObjects = new List<TrackedObject>();

3
MLAPI/NetworkingManagerComponents/MessageChunker.cs
View File

@ -3,6 +3,9 @@ using System.Collections.Generic;
namespace MLAPI.NetworkingManagerComponents
{
/// <summary>
/// Helper class to chunk messages
/// </summary>
public static class MessageChunker
{
/// <summary>

3
MLAPI/NetworkingManagerComponents/NetworkPoolManager.cs
View File

@ -5,6 +5,9 @@ using UnityEngine;
namespace MLAPI.NetworkingManagerComponents
{
/// <summary>
/// Main class for managing network pools
/// </summary>
public static class NetworkPoolManager
{
internal static Dictionary<ushort, NetworkPool> Pools;

3
MLAPI/NetworkingManagerComponents/NetworkSceneManager.cs
View File

@ -6,6 +6,9 @@ using UnityEngine.SceneManagement;
namespace MLAPI.NetworkingManagerComponents
{
/// <summary>
/// Main class for managing network scenes
/// </summary>
public static class NetworkSceneManager
{
internal static HashSet<string> registeredSceneNames;