-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathindex.html
More file actions
100 lines (94 loc) · 7.51 KB
/
index.html
File metadata and controls
100 lines (94 loc) · 7.51 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
<!DOCTYPE html>
<html lang=en>
<head>
<title>MW Unity Namespace</title>
<link rel="stylesheet" href="Docs/HTML/CSS/MWUnityNamespace.css">
<meta charset=UTF-8>
</head>
<body>
<div class=header id=top>MW UNITY NAMESPACE</div>
<div style="width: 100%; display: table;">
<div style="display: table-row">
<div style="width: 200px; display: table-cell;">
<div class="navLinks"><a href="Docs/HTML/Audio.html">Audio</a></div><br><div class="navLinks"><a href="Docs/HTML/Behaviour.html">Behaviour</a></div><br><div class="navLinks"><a href="Docs/HTML/CameraUtils.html">CameraUtils</a></div><br><div class="navLinks"><a href="Docs/HTML/Console.html">Console</a></div><br><div class="navLinks"><a href="Docs/HTML/Conversion.html">Conversion</a></div><br><div class="navLinks"><a href="Docs/HTML/Diagnostics.html">Diagnostics</a></div><br><div class="navLinks"><a href="Docs/HTML/EButton.html">EButton</a></div><br><div class="navLinks"><a href="Docs/HTML/EComponentAxis.html">EComponentAxis</a></div><br><div class="navLinks"><a href="Docs/HTML/EDirection.html">EDirection</a></div><br><div class="navLinks"><a href="Docs/HTML/EEquation.html">EEquation</a></div><br><div class="navLinks"><a href="Docs/HTML/EUnit.html">EUnit</a></div><br><div class="navLinks"><a href="Docs/HTML/Easing.html">Easing</a></div><br><div class="navLinks"><a href="Docs/HTML/Extensions.html">Extensions</a></div><br><div class="navLinks"><a href="Docs/HTML/FMath.html">FMath</a></div><br><div class="navLinks"><a href="Docs/HTML/FVector.html">FVector</a></div><br><div class="navLinks"><a href="Docs/HTML/HUD.html">HUD</a></div><br><div class="navLinks"><a href="Docs/HTML/HUD.Line.html">HUD.Line</a></div><br><div class="navLinks"><a href="Docs/HTML/HUD.UI.html">HUD.UI</a></div><br><div class="navLinks"><a href="Docs/HTML/IHeapItem.html">IHeapItem</a></div><br><div class="navLinks"><a href="Docs/HTML/IO.html">IO</a></div><br><div class="navLinks"><a href="Docs/HTML/Kinetic.html">Kinetic</a></div><br><div class="navLinks"><a href="Docs/HTML/MArray.html">MArray</a></div><br><div class="navLinks"><a href="Docs/HTML/MRotator.html">MRotator</a></div><br><div class="navLinks"><a href="Docs/HTML/MVector.html">MVector</a></div><br><div class="navLinks"><a href="Docs/HTML/Math.html">Math</a></div><br><div class="navLinks"><a href="Docs/HTML/Math.Magic.html">Math.Magic</a></div><br><div class="navLinks"><a href="Docs/HTML/Memory.html">Memory</a></div><br><div class="navLinks"><a href="Docs/HTML/Pathfinding.html">Pathfinding</a></div><br><div class="navLinks"><a href="Docs/HTML/THeap.html">THeap</a></div><br><div class="navLinks"><a href="Docs/HTML/TPair2.html">TPair2</a></div><br><div class="navLinks"><a href="Docs/HTML/TTriple3.html">TTriple3</a></div><br><div class="navLinks"><a href="Docs/HTML/Utils.html">Utils</a></div>
</div>
<br><br>
<div style="display: table-cell;">
<br>
<br>
<h1 class="classHead C">The MW Unity Namespace</h1>
<p class="simplePara L">
Welcome to the MW Namespace Source Code!
<br /><br />
A library containing helpful classes, methods, functions, and data structures to help with game development in the Unity Engine.
<br /><br />
The MW Namespace isn't exclusively restricted to extending the Unity Engine! Most functionality and utilities provided by the namespace can be
used to extend the normal C# language.
</p>
<h2 class="basicHead">Usage</h2>
<p class="simplePara">
The MW Unity Namespace was built for <code style="font-family: 'Cascadia Code', sans-serif; font-weight: 600; font-size: 120%;">Unity Engine 2021.1.3f1</code> and previously <code style="font-family: 'Cascadia Code', sans-serif; font-weight: 600; font-size: 120%;">Unity Engine 2020.2.4f1</code>.
<ul class="simplePara">
<li>Either:</li>
<li> <a class="link" href="https://github.com/WichaelMu/MW-Unity-Namespace#building-and-compiling-mw" target="_blank">See how to Build and Compile MW</a>.
<li> Download the latest release of MW.</li>
<li>Drag MW.dll, and MW.xml if you want documentation, somewhere in your Assets/ folder in your Unity Project.</li>
<li>Unity will recompile with MW.dll.</li>
<li>In any C# script in your Project, add:</li>
<li><pre><span class="PrimitiveType">using</span> MW;</pre></li>
<li>or any other sub-namespace, such as</li>
<li><pre><span class="PrimitiveType">using</span> MW.Math;</pre></li>
<li>You should now have access to the MW Namespace.</li>
</ul>
</p>
<h2 class="basicHead">The Documentation</h2>
<p class="simplePara">
Navigate using the links on the left of the page listing the Classes or Namespaces of MW.
The Content Area is everything excluding the left navigation menu.
<br>
<br>
The documentation is structured such that the Main Text in the middle of the Content Area is the name of the class with a summary underneath.
<br>
<br>
Any non-bolded text (without brackets) are variables (properties or fields) of that class.
<br>
Any bolded text (with brackets) are publicly callable methods or functions of that class.
<br>
<br>
You can see the declaration signature for variables, methods, and functions, showing their visibility, modifier, return type, and attributes (if any).
<br>
Underneath the method or function, you will see a summary of what the method or function does, along with any input parameters and return values.
<br>
<br>
Underneath the method or function, you will see a summary of what the method or function does, along with any input parameters and return values.
<code class="PrimitiveType" style="font-family: 'Cascadia Code', sans-serif; font-weight: 600; font-size: 120%;">ref</code> or <code class="PrimitiveType" style="font-family: 'Cascadia Code', sans-serif; font-weight: 600; font-size: 120%;">out</code> parameters are denoted with an <code class="PrimitiveType" style="font-family: 'Cascadia Code', sans-serif; font-weight: 600; font-size: 120%;">&</code> at the end of the parameter type.
<br>
<br>
The documentation is automatically by <a class="link" href="https://github.com/WichaelMu/MW-Unity-Namespace/tree/main/MGenerator" target="_blank">MGenerator</a>. The source code for generation is separate from MW..
</p>
<h2 class="basicHead">About the MW Namespace</h2>
<p class="simplePara">
The MW Unity Namespace was an idea conceived in December 2020, after four months of developing games in the Unity Engine.
<br>
<br>
The mission is to provide as much re-usable code in one place that will help game development in Unity.
<br>
<br>
Other engines, such as CRYENGINE and UnrealEngine, have a significant number of utility classes, methods, and functions that the Unity API lacks.
The MW Unity Namespace aims to bridge the gap by providing implementations for such utilities for the Unity Engine.
<br>
<br>
The MW Unity Namespace is under constant development.
</p>
<h2 class="basicHead">Additional Notes</h2>
<p class="simplePara">
The MW Unity Namespace is purpose-built for a private game project for the simulation of Airplanes.
<br>
<br>
While most, if not all, methods and functions have gone through testing, some, especially Aerodynamics, are purpose-built and tested only on the project mentioned above, which may not work on your project.
</p>
</div>
</div>
</div>
</body>
</html>