sad
This commit is contained in:
417
docs/api/Awperative.Base.html
Normal file
417
docs/api/Awperative.Base.html
Normal file
@@ -0,0 +1,417 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Class Base | Awperative </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Class Base | Awperative ">
|
||||
|
||||
<meta name="description" content="Base class of Awperative. Carries events from MonoGame into scenes and hooks.">
|
||||
<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_Base.md&value=---%0Auid%3A%20Awperative.Base%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%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 "{query}"">
|
||||
<meta name="loc:searchNoResults" content="No results for "{query}"">
|
||||
<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.Base">
|
||||
|
||||
|
||||
|
||||
<h1 id="Awperative_Base" data-uid="Awperative.Base" class="text-break">
|
||||
Class Base <a class="header-action link-secondary" title="View source" href="https://github.com/BlazeyDotOrg/Awperative/blob/main/Awperative/Kernel/Overhead/Base.cs/#L13"><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>Base class of Awperative. Carries events from MonoGame into scenes and hooks.</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public sealed class Base : Game, IDisposable</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">Game</span></div>
|
||||
<div><span class="xref">Base</span></div>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<dl class="typelist implements">
|
||||
<dt>Implements</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.idisposable">IDisposable</a></div>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
<dl class="typelist inheritedMembers">
|
||||
<dt>Inherited Members</dt>
|
||||
<dd>
|
||||
<div>
|
||||
<span class="xref">Game.Dispose()</span>
|
||||
</div>
|
||||
<div>
|
||||
<span class="xref">Game.Exit()</span>
|
||||
</div>
|
||||
<div>
|
||||
<span class="xref">Game.ResetElapsedTime()</span>
|
||||
</div>
|
||||
<div>
|
||||
<span class="xref">Game.SuppressDraw()</span>
|
||||
</div>
|
||||
<div>
|
||||
<span class="xref">Game.RunOneFrame()</span>
|
||||
</div>
|
||||
<div>
|
||||
<span class="xref">Game.Run()</span>
|
||||
</div>
|
||||
<div>
|
||||
<span class="xref">Game.Run(GameRunBehavior)</span>
|
||||
</div>
|
||||
<div>
|
||||
<span class="xref">Game.Tick()</span>
|
||||
</div>
|
||||
<div>
|
||||
<span class="xref">Game.LaunchParameters</span>
|
||||
</div>
|
||||
<div>
|
||||
<span class="xref">Game.Components</span>
|
||||
</div>
|
||||
<div>
|
||||
<span class="xref">Game.InactiveSleepTime</span>
|
||||
</div>
|
||||
<div>
|
||||
<span class="xref">Game.MaxElapsedTime</span>
|
||||
</div>
|
||||
<div>
|
||||
<span class="xref">Game.IsActive</span>
|
||||
</div>
|
||||
<div>
|
||||
<span class="xref">Game.IsMouseVisible</span>
|
||||
</div>
|
||||
<div>
|
||||
<span class="xref">Game.TargetElapsedTime</span>
|
||||
</div>
|
||||
<div>
|
||||
<span class="xref">Game.IsFixedTimeStep</span>
|
||||
</div>
|
||||
<div>
|
||||
<span class="xref">Game.Services</span>
|
||||
</div>
|
||||
<div>
|
||||
<span class="xref">Game.Content</span>
|
||||
</div>
|
||||
<div>
|
||||
<span class="xref">Game.GraphicsDevice</span>
|
||||
</div>
|
||||
<div>
|
||||
<span class="xref">Game.Window</span>
|
||||
</div>
|
||||
<div>
|
||||
<span class="xref">Game.Activated</span>
|
||||
</div>
|
||||
<div>
|
||||
<span class="xref">Game.Deactivated</span>
|
||||
</div>
|
||||
<div>
|
||||
<span class="xref">Game.Disposed</span>
|
||||
</div>
|
||||
<div>
|
||||
<span class="xref">Game.Exiting</span>
|
||||
</div>
|
||||
<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.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="methods">Methods
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Awperative_Base_Draw_" data-uid="Awperative.Base.Draw*"></a>
|
||||
|
||||
<h3 id="Awperative_Base_Draw_Microsoft_Xna_Framework_GameTime_" data-uid="Awperative.Base.Draw(Microsoft.Xna.Framework.GameTime)">
|
||||
Draw(GameTime)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/BlazeyDotOrg/Awperative/blob/main/Awperative/Kernel/Overhead/Base.cs/#L73"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Draw() is called every frame; after Update(). Override Draw() in scripting tools to call from this event.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">protected override void Draw(GameTime __gameTime)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>__gameTime</code> <span class="xref">GameTime</span></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section" id="Awperative_Base_Draw_Microsoft_Xna_Framework_GameTime__remarks">Remarks</h4>
|
||||
<div class="markdown level1 remarks"><p>Hooks are unable to receive both Update() and Draw()</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Awperative_Base_EndRun_" data-uid="Awperative.Base.EndRun*"></a>
|
||||
|
||||
<h3 id="Awperative_Base_EndRun" data-uid="Awperative.Base.EndRun">
|
||||
EndRun()
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/BlazeyDotOrg/Awperative/blob/main/Awperative/Kernel/Overhead/Base.cs/#L86"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>EndRun() is called if the program closes. Override Terminate() in scripting tools or use hooks to call from this event.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">protected override void EndRun()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section" id="Awperative_Base_EndRun_remarks">Remarks</h4>
|
||||
<div class="markdown level1 remarks"><p>This event may not trigger if the program is force closed.</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Awperative_Base_Initialize_" data-uid="Awperative.Base.Initialize*"></a>
|
||||
|
||||
<h3 id="Awperative_Base_Initialize" data-uid="Awperative.Base.Initialize">
|
||||
Initialize()
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/BlazeyDotOrg/Awperative/blob/main/Awperative/Kernel/Overhead/Base.cs/#L32"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Initialize() is called when the program starts. Goes before LoadContent(). And prepares the kernel for use.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">protected override void Initialize()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section" id="Awperative_Base_Initialize_remarks">Remarks</h4>
|
||||
<div class="markdown level1 remarks"><p>It is recommended not to load content in Initialize()</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Awperative_Base_LoadContent_" data-uid="Awperative.Base.LoadContent*"></a>
|
||||
|
||||
<h3 id="Awperative_Base_LoadContent" data-uid="Awperative.Base.LoadContent">
|
||||
LoadContent()
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/BlazeyDotOrg/Awperative/blob/main/Awperative/Kernel/Overhead/Base.cs/#L47"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>LoadContent() is called when the program starts; right after Initialize(). Override Load() in scripting tools or use hooks to call from this event.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">protected override void LoadContent()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section" id="Awperative_Base_LoadContent_remarks">Remarks</h4>
|
||||
<div class="markdown level1 remarks"><p>It is recommended to load content during LoadContent()</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Awperative_Base_Update_" data-uid="Awperative.Base.Update*"></a>
|
||||
|
||||
<h3 id="Awperative_Base_Update_Microsoft_Xna_Framework_GameTime_" data-uid="Awperative.Base.Update(Microsoft.Xna.Framework.GameTime)">
|
||||
Update(GameTime)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/BlazeyDotOrg/Awperative/blob/main/Awperative/Kernel/Overhead/Base.cs/#L60"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Update() is called every frame; before Draw(). Override Update() in scripting tools to call from this event.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">protected override void Update(GameTime __gameTime)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>__gameTime</code> <span class="xref">GameTime</span></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section" id="Awperative_Base_Update_Microsoft_Xna_Framework_GameTime__remarks">Remarks</h4>
|
||||
<div class="markdown level1 remarks"><p>Hooks are unable to receive both Update() and Draw()</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
<a href="https://github.com/BlazeyDotOrg/Awperative/blob/main/Awperative/Kernel/Overhead/Base.cs/#L13" 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
Block a user