AveryNorris/Awperative
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
fcbe9ff8bc4c64e04d647819fb33cc1693af5a5f
Awperative/_site/api/Awperative.Awperative.html
Avery Norris fcbe9ff8bc DOCUMENTATION
2026-02-09 16:52:39 -05:00

414 lines
14 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Class Awperative | Awperative </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class Awperative | Awperative ">
<meta name="description" content="Initiating class of Awperative. Call Start() to start the kernel.">
<link rel="icon" href="../favicon.ico">
<link rel="stylesheet" href="../public/docfx.min.css">
<link rel="stylesheet" href="../public/main.css">
<meta name="docfx:navrel" content="../toc.html">
<meta name="docfx:tocrel" content="toc.html">
<meta name="docfx:rel" content="../">
<meta name="docfx:docurl" content="https://github.com/BlazeyDotOrg/Awperative/new/main/apiSpec/new?filename=Awperative_Awperative.md&amp;value=---%0Auid%3A%20Awperative.Awperative%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">
<meta name="loc:inThisArticle" content="In this article">
<meta name="loc:searchResultsCount" content="{count} results for &quot;{query}&quot;">
<meta name="loc:searchNoResults" content="No results for &quot;{query}&quot;">
<meta name="loc:tocFilter" content="Filter by title">
<meta name="loc:nextArticle" content="Next">
<meta name="loc:prevArticle" content="Previous">
<meta name="loc:themeLight" content="Light">
<meta name="loc:themeDark" content="Dark">
<meta name="loc:themeAuto" content="Auto">
<meta name="loc:changeTheme" content="Change theme">
<meta name="loc:copy" content="Copy">
<meta name="loc:downloadPdf" content="Download PDF">
<script type="module" src="./../public/docfx.min.js"></script>
<script>
const theme = localStorage.getItem('theme') || 'auto'
document.documentElement.setAttribute('data-bs-theme', theme === 'auto' ? (window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light') : theme)
</script>
</head>
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference">
<header class="bg-body border-bottom">
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
<div class="container-xxl flex-nowrap">
<a class="navbar-brand" href="../index.html">
<img id="logo" class="svg" src="../logo.svg" alt="Awperative">
Awperative
</a>
<button class="btn btn-lg d-md-none border-0" type="button" data-bs-toggle="collapse" data-bs-target="#navpanel" aria-controls="navpanel" aria-expanded="false" aria-label="Toggle navigation">
<i class="bi bi-three-dots"></i>
</button>
<div class="collapse navbar-collapse" id="navpanel">
<div id="navbar">
<form class="search" role="search" id="search">
<i class="bi bi-search"></i>
<input class="form-control" id="search-query" type="search" disabled placeholder="Search" autocomplete="off" aria-label="Search">
</form>
</div>
</div>
</div>
</nav>
</header>
<main class="container-xxl">
<div class="toc-offcanvas">
<div class="offcanvas-md offcanvas-start" tabindex="-1" id="tocOffcanvas" aria-labelledby="tocOffcanvasLabel">
<div class="offcanvas-header">
<h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
<button type="button" class="btn-close" data-bs-dismiss="offcanvas" data-bs-target="#tocOffcanvas" aria-label="Close"></button>
</div>
<div class="offcanvas-body">
<nav class="toc" id="toc"></nav>
</div>
</div>
</div>
<div class="content">
<div class="actionbar">
<button class="btn btn-lg border-0 d-md-none" type="button" data-bs-toggle="offcanvas" data-bs-target="#tocOffcanvas" aria-controls="tocOffcanvas" aria-expanded="false" aria-label="Show table of contents">
<i class="bi bi-list"></i>
</button>
<nav id="breadcrumb"></nav>
</div>
<article data-uid="Awperative.Awperative">
<h1 id="Awperative_Awperative" data-uid="Awperative.Awperative" class="text-break">
Class Awperative <a class="header-action link-secondary" title="View source" href="https://github.com/BlazeyDotOrg/Awperative/blob/main/Awperative/Kernel/Overhead/Core.cs/#L16"><i class="bi bi-code-slash"></i></a>
</h1>
<div class="facts text-secondary">
<dl><dt>Namespace</dt><dd><a class="xref" href="Awperative.html">Awperative</a></dd></dl>
<dl><dt>Assembly</dt><dd>Awperative.dll</dd></dl>
</div>
<div class="markdown summary"><p>Initiating class of Awperative. Call Start() to start the kernel.</p>
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static class Awperative</code></pre>
</div>
<dl class="typelist inheritance">
<dt>Inheritance</dt>
<dd>
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
<div><span class="xref">Awperative</span></div>
</dd>
</dl>
<dl class="typelist inheritedMembers">
<dt>Inherited Members</dt>
<dd>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object, object)</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>
</div>
</dd></dl>
<h2 class="section" id="properties">Properties
</h2>
<a id="Awperative_Awperative_Base_" data-uid="Awperative.Awperative.Base*"></a>
<h3 id="Awperative_Awperative_Base" data-uid="Awperative.Awperative.Base">
Base
<a class="header-action link-secondary" title="View source" href="https://github.com/BlazeyDotOrg/Awperative/blob/main/Awperative/Kernel/Overhead/Core.cs/#L24"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Bottom class of Awperative. Contains the MonoGame instance.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static Base Base { get; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="Awperative.Base.html">Base</a></dt>
<dd></dd>
</dl>
<a id="Awperative_Awperative_ContentManager_" data-uid="Awperative.Awperative.ContentManager*"></a>
<h3 id="Awperative_Awperative_ContentManager" data-uid="Awperative.Awperative.ContentManager">
ContentManager
<a class="header-action link-secondary" title="View source" href="https://github.com/BlazeyDotOrg/Awperative/blob/main/Awperative/Kernel/Overhead/Core.cs/#L47"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Handles loading content through MonoGame.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static ContentManager ContentManager { get; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><span class="xref">ContentManager</span></dt>
<dd></dd>
</dl>
<a id="Awperative_Awperative_EventHooks_" data-uid="Awperative.Awperative.EventHooks*"></a>
<h3 id="Awperative_Awperative_EventHooks" data-uid="Awperative.Awperative.EventHooks">
EventHooks
<a class="header-action link-secondary" title="View source" href="https://github.com/BlazeyDotOrg/Awperative/blob/main/Awperative/Kernel/Overhead/Core.cs/#L64"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>List of all event hooks currently loaded in the kernel.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static List&lt;AwperativeHook&gt; EventHooks { get; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.list-1">List</a>&lt;<a class="xref" href="Awperative.AwperativeHook.html">AwperativeHook</a>&gt;</dt>
<dd></dd>
</dl>
<a id="Awperative_Awperative_GraphicsDeviceManager_" data-uid="Awperative.Awperative.GraphicsDeviceManager*"></a>
<h3 id="Awperative_Awperative_GraphicsDeviceManager" data-uid="Awperative.Awperative.GraphicsDeviceManager">
GraphicsDeviceManager
<a class="header-action link-secondary" title="View source" href="https://github.com/BlazeyDotOrg/Awperative/blob/main/Awperative/Kernel/Overhead/Core.cs/#L33"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Handles graphics settings through MonoGame.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static GraphicsDeviceManager GraphicsDeviceManager { get; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><span class="xref">GraphicsDeviceManager</span></dt>
<dd></dd>
</dl>
<a id="Awperative_Awperative_LoadedScenes_" data-uid="Awperative.Awperative.LoadedScenes*"></a>
<h3 id="Awperative_Awperative_LoadedScenes" data-uid="Awperative.Awperative.LoadedScenes">
LoadedScenes
<a class="header-action link-secondary" title="View source" href="https://github.com/BlazeyDotOrg/Awperative/blob/main/Awperative/Kernel/Overhead/Core.cs/#L56"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>List of all scenes currently loaded in the kernel.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static List&lt;Scene&gt; LoadedScenes { get; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.list-1">List</a>&lt;<a class="xref" href="Awperative.Scene.html">Scene</a>&gt;</dt>
<dd></dd>
</dl>
<a id="Awperative_Awperative_SpriteBatch_" data-uid="Awperative.Awperative.SpriteBatch*"></a>
<h3 id="Awperative_Awperative_SpriteBatch" data-uid="Awperative.Awperative.SpriteBatch">
SpriteBatch
<a class="header-action link-secondary" title="View source" href="https://github.com/BlazeyDotOrg/Awperative/blob/main/Awperative/Kernel/Overhead/Core.cs/#L40"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Handles drawing sprites to the screen through MonoGame.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static SpriteBatch SpriteBatch { get; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><span class="xref">SpriteBatch</span></dt>
<dd></dd>
</dl>
<h2 class="section" id="methods">Methods
</h2>
<a id="Awperative_Awperative_Start_" data-uid="Awperative.Awperative.Start*"></a>
<h3 id="Awperative_Awperative_Start_System_Collections_Generic_List_Awperative_AwperativeHook__" data-uid="Awperative.Awperative.Start(System.Collections.Generic.List{Awperative.AwperativeHook})">
Start(List&lt;AwperativeHook&gt;)
<a class="header-action link-secondary" title="View source" href="https://github.com/BlazeyDotOrg/Awperative/blob/main/Awperative/Kernel/Overhead/Core.cs/#L76"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Start() begins the game; and begins communication with all event hooks.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static void Start(List&lt;AwperativeHook&gt; __hooks)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>__hooks</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.list-1">List</a>&lt;<a class="xref" href="Awperative.AwperativeHook.html">AwperativeHook</a>&gt;</dt>
<dd><p>List of all event hooks you wish to use.</p>
</dd>
</dl>
<h4 class="section" id="Awperative_Awperative_Start_System_Collections_Generic_List_Awperative_AwperativeHook___remarks">Remarks</h4>
<div class="markdown level1 remarks"><p>You cannot add new hooks later; so make sure to register all of them in the Start() method.</p>
</div>
</article>
<div class="contribution d-print-none">
<a href="https://github.com/BlazeyDotOrg/Awperative/blob/main/Awperative/Kernel/Overhead/Core.cs/#L16" class="edit-link">Edit this page</a>
</div>
</div>
<div class="affix">
<nav id="affix"></nav>
</div>
</main>
<div class="container-xxl search-results" id="search-results"></div>
<footer class="border-top text-secondary">
<div class="container-xxl">
<div class="flex-fill">
<span>Made with <a href="https://dotnet.github.io/docfx">docfx</a></span>
</div>
</div>
</footer>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink