Skip to content

Commit

Permalink
deploy: 56c9af9
Browse files Browse the repository at this point in the history
  • Loading branch information
@SFGrenade
SFGrenade committed Jan 2, 2025
0 parents commit b7c3d1c
Show file tree
Hide file tree
Showing 87 changed files with 36,813 additions and 0 deletions.
Empty file added .nojekyll
Empty file.
212 changes: 212 additions & 0 deletions api/SFCore.AchievementHelper.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,212 @@
<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>

<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Class AchievementHelper
</title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class AchievementHelper
">

<link rel="shortcut icon" href="../favicon.ico">
<link rel="stylesheet" href="../styles/docfx.vendor.css">
<link rel="stylesheet" href="../styles/docfx.css">
<link rel="stylesheet" href="../styles/main.css">
<meta property="docfx:navrel" content="../toc.html">
<meta property="docfx:tocrel" content="toc.html">



</head>
<body data-spy="scroll" data-target="#affix" data-offset="120">
<div id="wrapper">
<header>

<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>

<a class="navbar-brand" href="../index.html">
<img id="logo" class="svg" src="../logo.svg" alt="">
</a>
</div>
<div class="collapse navbar-collapse" id="navbar">
<form class="navbar-form navbar-right" role="search" id="search">
<div class="form-group">
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
</div>
</form>
</div>
</div>
</nav>

<div class="subnav navbar navbar-default">
<div class="container hide-when-search" id="breadcrumb">
<ul class="breadcrumb">
<li></li>
</ul>
</div>
</div>
</header>
<div role="main" class="container body-content hide-when-search">

<div class="sidenav hide-when-search">
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
<div class="sidetoggle collapse" id="sidetoggle">
<div id="sidetoc"></div>
</div>
</div>
<div class="article row grid-right">
<div class="col-md-10">
<article class="content wrap" id="_content" data-uid="SFCore.AchievementHelper">


<h1 id="SFCore_AchievementHelper" data-uid="SFCore.AchievementHelper" class="text-break">Class AchievementHelper
</h1>
<div class="markdown level0 summary"><p>Achievement helper class for easily adding custom achievements.
The mod using this needs to handle the following:</p>
<ul>
<li>titleConvo Language string(s)</li>
<li>textConvo Language string(s)</li>
</ul>
</div>
<div class="markdown level0 conceptual"></div>
<div class="inheritance">
<h5>Inheritance</h5>
<div class="level0"><span class="xref">System.Object</span></div>
<div class="level1"><span class="xref">AchievementHelper</span></div>
</div>
<h6><strong>Namespace</strong>: <a class="xref" href="SFCore.html">SFCore</a></h6>
<h6><strong>Assembly</strong>: SFCore.dll</h6>
<h5 id="SFCore_AchievementHelper_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static class AchievementHelper</code></pre>
</div>
<h3 id="methods">Methods
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/SFGrenade/SFCore/new/master/apiSpec/new?filename=SFCore_AchievementHelper_AddAchievement_System_String_Sprite_System_String_System_String_System_Boolean_.md&amp;value=---%0Auid%3A%20SFCore.AchievementHelper.AddAchievement(System.String%2CSprite%2CSystem.String%2CSystem.String%2CSystem.Boolean)%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">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/SFGrenade/SFCore/blob/master/src/AchievementHelper.cs/#L74">View Source</a>
</span>
<a id="SFCore_AchievementHelper_AddAchievement_" data-uid="SFCore.AchievementHelper.AddAchievement*"></a>
<h4 id="SFCore_AchievementHelper_AddAchievement_System_String_Sprite_System_String_System_String_System_Boolean_" data-uid="SFCore.AchievementHelper.AddAchievement(System.String,Sprite,System.String,System.String,System.Boolean)">AddAchievement(string, Sprite, string, string, bool)</h4>
<div class="markdown level1 summary"><p>Adds an achievement to the private list of custom achievements.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="declaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static void AddAchievement(string key, Sprite sprite, string titleConvo, string textConvo, bool hidden)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">string</span></td>
<td><span class="parametername">key</span></td>
<td><p>Achievement key, determines if an achievement is unlocked</p>
</td>
</tr>
<tr>
<td><span class="xref">Sprite</span></td>
<td><span class="parametername">sprite</span></td>
<td><p>Sprite of the achievement</p>
</td>
</tr>
<tr>
<td><span class="xref">string</span></td>
<td><span class="parametername">titleConvo</span></td>
<td><p>Language key of the achievement title</p>
</td>
</tr>
<tr>
<td><span class="xref">string</span></td>
<td><span class="parametername">textConvo</span></td>
<td><p>Language key of the achievement description</p>
</td>
</tr>
<tr>
<td><span class="xref">bool</span></td>
<td><span class="parametername">hidden</span></td>
<td><p>Determines if the achievement is hidden until unlocked</p>
</td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/SFGrenade/SFCore/new/master/apiSpec/new?filename=SFCore_AchievementHelper_unusedInit.md&amp;value=---%0Auid%3A%20SFCore.AchievementHelper.unusedInit%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">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/SFGrenade/SFCore/blob/master/src/AchievementHelper.cs/#L60">View Source</a>
</span>
<a id="SFCore_AchievementHelper_unusedInit_" data-uid="SFCore.AchievementHelper.unusedInit*"></a>
<h4 id="SFCore_AchievementHelper_unusedInit" data-uid="SFCore.AchievementHelper.unusedInit">unusedInit()</h4>
<div class="markdown level1 summary"><p>Used for static initialization.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="declaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static void unusedInit()</code></pre>
</div>
</article>
</div>

<div class="hidden-sm col-md-2" role="complementary">
<div class="sideaffix">
<div class="contribution">
<ul class="nav">
<li>
<a href="https://github.com/SFGrenade/SFCore/new/master/apiSpec/new?filename=SFCore_AchievementHelper.md&amp;value=---%0Auid%3A%20SFCore.AchievementHelper%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" class="contribution-link">Improve this Doc</a>
</li>
<li>
<a href="https://github.com/SFGrenade/SFCore/blob/master/src/AchievementHelper.cs/#L41" class="contribution-link">View Source</a>
</li>
</ul>
</div>
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
<h5>In This Article</h5>
<div></div>
</nav>
</div>
</div>
</div>
</div>

<footer>
<div class="grad-bottom"></div>
<div class="footer">
<div class="container">
<span class="pull-right">
<a href="#top">Back to top</a>
</span>

<span>Generated by <strong>DocFX</strong></span>
</div>
</div>
</footer>
</div>

<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
<script type="text/javascript" src="../styles/docfx.js"></script>
<script type="text/javascript" src="../styles/main.js"></script>
</body>
</html>
Loading

0 comments on commit b7c3d1c

Please sign in to comment.