Skip to content

Commit

Permalink
update docfx gh-pages
Browse files Browse the repository at this point in the history
  • Loading branch information
Mushymato committed Oct 29, 2024
1 parent 247369d commit a56b410
Show file tree
Hide file tree
Showing 12 changed files with 469 additions and 73 deletions.
49 changes: 45 additions & 4 deletions docs/api/TrinketTinker.Effects.TrinketTinkerEffect.html
Original file line number Diff line number Diff line change
Expand Up @@ -527,6 +527,47 @@ <h4 class="section">Returns</h4>



<a id="TrinketTinker_Effects_TrinketTinkerEffect_GetMaxUnlockedCount_" data-uid="TrinketTinker.Effects.TrinketTinkerEffect.GetMaxUnlockedCount*"></a>

<h3 id="TrinketTinker_Effects_TrinketTinkerEffect_GetMaxUnlockedCount_System_Collections_Generic_List_System_String__System_Int32_StardewValley_Objects_Trinkets_Trinket_" data-uid="TrinketTinker.Effects.TrinketTinkerEffect.GetMaxUnlockedCount(System.Collections.Generic.List{System.String},System.Int32,StardewValley.Objects.Trinkets.Trinket)">
GetMaxUnlockedCount(List&lt;string?&gt;, int, Trinket)
<a class="header-action link-secondary" title="View source" href="https://github.com/Mushymato/TrinketTinker/blob/main/TrinketTinker/Effects/TrinketTinkerEffect.cs/#L243"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"><p>Get the maximum allowed count from list of GSQ.</p>
</div>
<div class="markdown level1 conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static int GetMaxUnlockedCount(List&lt;string?&gt; conditions, int count, Trinket trinket)</code></pre>
</div>

<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>conditions</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.list-1">List</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a>&gt;</dt>
<dd></dd>
<dt><code>count</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd></dd>
<dt><code>trinket</code> <span class="xref">Trinket</span></dt>
<dd></dd>
</dl>

<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd></dd>
</dl>











<a id="TrinketTinker_Effects_TrinketTinkerEffect_OnDamageMonster_" data-uid="TrinketTinker.Effects.TrinketTinkerEffect.OnDamageMonster*"></a>

<h3 id="TrinketTinker_Effects_TrinketTinkerEffect_OnDamageMonster_StardewValley_Farmer_StardewValley_Monsters_Monster_System_Int32_System_Boolean_System_Boolean_" data-uid="TrinketTinker.Effects.TrinketTinkerEffect.OnDamageMonster(StardewValley.Farmer,StardewValley.Monsters.Monster,System.Int32,System.Boolean,System.Boolean)">
Expand Down Expand Up @@ -749,7 +790,7 @@ <h4 class="section">Parameters</h4>

<h3 id="TrinketTinker_Effects_TrinketTinkerEffect_RerollLevel_StardewValley_Objects_Trinkets_Trinket_System_Int32_" data-uid="TrinketTinker.Effects.TrinketTinkerEffect.RerollLevel(StardewValley.Objects.Trinkets.Trinket,System.Int32)">
RerollLevel(Trinket, int)
<a class="header-action link-secondary" title="View source" href="https://github.com/Mushymato/TrinketTinker/blob/main/TrinketTinker/Effects/TrinketTinkerEffect.cs/#L244"><i class="bi bi-code-slash"></i></a>
<a class="header-action link-secondary" title="View source" href="https://github.com/Mushymato/TrinketTinker/blob/main/TrinketTinker/Effects/TrinketTinkerEffect.cs/#L263"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"><p>Randomize this trinket's ability level through anvil, return true if the level is rerolled.
Expand Down Expand Up @@ -789,7 +830,7 @@ <h4 class="section">Returns</h4>

<h3 id="TrinketTinker_Effects_TrinketTinkerEffect_RerollVariant_StardewValley_Objects_Trinkets_Trinket_System_Int32_" data-uid="TrinketTinker.Effects.TrinketTinkerEffect.RerollVariant(StardewValley.Objects.Trinkets.Trinket,System.Int32)">
RerollVariant(Trinket, int)
<a class="header-action link-secondary" title="View source" href="https://github.com/Mushymato/TrinketTinker/blob/main/TrinketTinker/Effects/TrinketTinkerEffect.cs/#L265"><i class="bi bi-code-slash"></i></a>
<a class="header-action link-secondary" title="View source" href="https://github.com/Mushymato/TrinketTinker/blob/main/TrinketTinker/Effects/TrinketTinkerEffect.cs/#L285"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"><p>Randomize this trinket's variant through trinket colorizer, return true if the variant is rerolled.
Expand Down Expand Up @@ -829,7 +870,7 @@ <h4 class="section">Returns</h4>

<h3 id="TrinketTinker_Effects_TrinketTinkerEffect_SetLevel_StardewValley_Objects_Trinkets_Trinket_System_Int32_" data-uid="TrinketTinker.Effects.TrinketTinkerEffect.SetLevel(StardewValley.Objects.Trinkets.Trinket,System.Int32)">
SetLevel(Trinket, int)
<a class="header-action link-secondary" title="View source" href="https://github.com/Mushymato/TrinketTinker/blob/main/TrinketTinker/Effects/TrinketTinkerEffect.cs/#L279"><i class="bi bi-code-slash"></i></a>
<a class="header-action link-secondary" title="View source" href="https://github.com/Mushymato/TrinketTinker/blob/main/TrinketTinker/Effects/TrinketTinkerEffect.cs/#L305"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"><p>Set level</p>
Expand Down Expand Up @@ -863,7 +904,7 @@ <h4 class="section">Parameters</h4>

<h3 id="TrinketTinker_Effects_TrinketTinkerEffect_SetVariant_StardewValley_Objects_Trinkets_Trinket_System_Int32_" data-uid="TrinketTinker.Effects.TrinketTinkerEffect.SetVariant(StardewValley.Objects.Trinkets.Trinket,System.Int32)">
SetVariant(Trinket, int)
<a class="header-action link-secondary" title="View source" href="https://github.com/Mushymato/TrinketTinker/blob/main/TrinketTinker/Effects/TrinketTinkerEffect.cs/#L300"><i class="bi bi-code-slash"></i></a>
<a class="header-action link-secondary" title="View source" href="https://github.com/Mushymato/TrinketTinker/blob/main/TrinketTinker/Effects/TrinketTinkerEffect.cs/#L326"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"><p>Set trinket variant</p>
Expand Down
99 changes: 90 additions & 9 deletions docs/api/TrinketTinker.Extras.ItemQuery.html
Original file line number Diff line number Diff line change
Expand Up @@ -153,16 +153,46 @@ <h2 class="section" id="fields">Fields



<h3 id="TrinketTinker_Extras_ItemQuery_CreateTrinketQuery" data-uid="TrinketTinker.Extras.ItemQuery.CreateTrinketQuery">
CreateTrinketQuery
<h3 id="TrinketTinker_Extras_ItemQuery_ItemQuery_CREATE_TRINKET" data-uid="TrinketTinker.Extras.ItemQuery.ItemQuery_CREATE_TRINKET">
ItemQuery_CREATE_TRINKET
<a class="header-action link-secondary" title="View source" href="https://github.com/Mushymato/TrinketTinker/blob/main/TrinketTinker/Extras/ItemQuery.cs/#L11"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static readonly string CreateTrinketQuery</code></pre>
<pre><code class="lang-csharp hljs">public static readonly string ItemQuery_CREATE_TRINKET</code></pre>
</div>




<h4 class="section">Field Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
</dl>










<h3 id="TrinketTinker_Extras_ItemQuery_ItemQuery_CREATE_TRINKET_ALL_VARIANTS" data-uid="TrinketTinker.Extras.ItemQuery.ItemQuery_CREATE_TRINKET_ALL_VARIANTS">
ItemQuery_CREATE_TRINKET_ALL_VARIANTS
<a class="header-action link-secondary" title="View source" href="https://github.com/Mushymato/TrinketTinker/blob/main/TrinketTinker/Extras/ItemQuery.cs/#L12"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static readonly string ItemQuery_CREATE_TRINKET_ALL_VARIANTS</code></pre>
</div>


Expand All @@ -186,22 +216,22 @@ <h2 class="section" id="methods">Methods
</h2>


<a id="TrinketTinker_Extras_ItemQuery_CreateTrinket_" data-uid="TrinketTinker.Extras.ItemQuery.CreateTrinket*"></a>
<a id="TrinketTinker_Extras_ItemQuery_CREATE_TRINKET_" data-uid="TrinketTinker.Extras.ItemQuery.CREATE_TRINKET*"></a>

<h3 id="TrinketTinker_Extras_ItemQuery_CreateTrinket_System_String_System_String_StardewValley_Internal_ItemQueryContext_System_Boolean_System_Collections_Generic_HashSet_System_String__System_Action_System_String_System_String__" data-uid="TrinketTinker.Extras.ItemQuery.CreateTrinket(System.String,System.String,StardewValley.Internal.ItemQueryContext,System.Boolean,System.Collections.Generic.HashSet{System.String},System.Action{System.String,System.String})">
CreateTrinket(string, string, ItemQueryContext, bool, HashSet&lt;string&gt;, Action&lt;string, string&gt;)
<a class="header-action link-secondary" title="View source" href="https://github.com/Mushymato/TrinketTinker/blob/main/TrinketTinker/Extras/ItemQuery.cs/#L47"><i class="bi bi-code-slash"></i></a>
<h3 id="TrinketTinker_Extras_ItemQuery_CREATE_TRINKET_System_String_System_String_StardewValley_Internal_ItemQueryContext_System_Boolean_System_Collections_Generic_HashSet_System_String__System_Action_System_String_System_String__" data-uid="TrinketTinker.Extras.ItemQuery.CREATE_TRINKET(System.String,System.String,StardewValley.Internal.ItemQueryContext,System.Boolean,System.Collections.Generic.HashSet{System.String},System.Action{System.String,System.String})">
CREATE_TRINKET(string, string, ItemQueryContext, bool, HashSet&lt;string&gt;, Action&lt;string, string&gt;)
<a class="header-action link-secondary" title="View source" href="https://github.com/Mushymato/TrinketTinker/blob/main/TrinketTinker/Extras/ItemQuery.cs/#L49"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"><p>mushymato.TrinketTinker_CREATE_TRINKET UnqualifiedId Level? Variant?
<div class="markdown level1 summary"><p>mushymato.TrinketTinker_CREATE_TRINKET UnqualifiedId [Level] [Variant]<br>
Creates a new trinket item. If the trinket has tinker data, set level and variant.
If level=&quot;R&quot;, roll a random level
If variant=&quot;R&quot;, roll a random variant</p>
</div>
<div class="markdown level1 conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static IEnumerable&lt;ItemQueryResult&gt; CreateTrinket(string key, string arguments, ItemQueryContext context, bool avoidRepeat, HashSet&lt;string&gt; avoidItemIds, Action&lt;string, string&gt; logError)</code></pre>
<pre><code class="lang-csharp hljs">public static IEnumerable&lt;ItemQueryResult&gt; CREATE_TRINKET(string key, string arguments, ItemQueryContext context, bool avoidRepeat, HashSet&lt;string&gt; avoidItemIds, Action&lt;string, string&gt; logError)</code></pre>
</div>

<h4 class="section">Parameters</h4>
Expand All @@ -215,7 +245,58 @@ <h4 class="section">Parameters</h4>
<dt><code>avoidRepeat</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd></dd>
<dt><code>avoidItemIds</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.hashset-1">HashSet</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a>&gt;</dt>
<dd><p>ignored</p>
</dd>
<dt><code>logError</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.action-2">Action</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a>, <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a>&gt;</dt>
<dd></dd>
</dl>

<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a>&lt;<span class="xref">ItemQueryResult</span>&gt;</dt>
<dd></dd>
</dl>











<a id="TrinketTinker_Extras_ItemQuery_CREATE_TRINKET_ALL_VARIANTS_" data-uid="TrinketTinker.Extras.ItemQuery.CREATE_TRINKET_ALL_VARIANTS*"></a>

<h3 id="TrinketTinker_Extras_ItemQuery_CREATE_TRINKET_ALL_VARIANTS_System_String_System_String_StardewValley_Internal_ItemQueryContext_System_Boolean_System_Collections_Generic_HashSet_System_String__System_Action_System_String_System_String__" data-uid="TrinketTinker.Extras.ItemQuery.CREATE_TRINKET_ALL_VARIANTS(System.String,System.String,StardewValley.Internal.ItemQueryContext,System.Boolean,System.Collections.Generic.HashSet{System.String},System.Action{System.String,System.String})">
CREATE_TRINKET_ALL_VARIANTS(string, string, ItemQueryContext, bool, HashSet&lt;string&gt;, Action&lt;string, string&gt;)
<a class="header-action link-secondary" title="View source" href="https://github.com/Mushymato/TrinketTinker/blob/main/TrinketTinker/Extras/ItemQuery.cs/#L83"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"><p>mushymato.TrinketTinker_CREATE_TRINKET_ALL_VARIANTS UnqualifiedId [Level]<br>
If the trinket has trinket tinker data, create one of each variant.
If level=&quot;R&quot;, roll a random level and apply it to every created trinket.</p>
</div>
<div class="markdown level1 conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static IEnumerable&lt;ItemQueryResult&gt; CREATE_TRINKET_ALL_VARIANTS(string key, string arguments, ItemQueryContext context, bool avoidRepeat, HashSet&lt;string&gt; avoidItemIds, Action&lt;string, string&gt; logError)</code></pre>
</div>

<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>key</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
<dt><code>arguments</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
<dt><code>context</code> <span class="xref">ItemQueryContext</span></dt>
<dd></dd>
<dt><code>avoidRepeat</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd></dd>
<dt><code>avoidItemIds</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.hashset-1">HashSet</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a>&gt;</dt>
<dd><p>ignored</p>
</dd>
<dt><code>logError</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.action-2">Action</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a>, <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a>&gt;</dt>
<dd></dd>
</dl>
Expand Down
70 changes: 68 additions & 2 deletions docs/api/TrinketTinker.Models.TinkerData.html
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,72 @@ <h1 id="TrinketTinker_Models_TinkerData" data-uid="TrinketTinker.Models.TinkerDa



<h2 class="section" id="fields">Fields
</h2>



<h3 id="TrinketTinker_Models_TinkerData_AbilityUnlockConditions" data-uid="TrinketTinker.Models.TinkerData.AbilityUnlockConditions">
AbilityUnlockConditions
<a class="header-action link-secondary" title="View source" href="https://github.com/Mushymato/TrinketTinker/blob/main/TrinketTinker/Models/TinkerData.cs/#L27"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"><p>GSQ conditions for locking abilities.</p>
</div>
<div class="markdown level1 conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">public List&lt;string?&gt; AbilityUnlockConditions</code></pre>
</div>




<h4 class="section">Field 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="https://learn.microsoft.com/dotnet/api/system.string">string</a>&gt;</dt>
<dd></dd>
</dl>










<h3 id="TrinketTinker_Models_TinkerData_VariantUnlockConditions" data-uid="TrinketTinker.Models.TinkerData.VariantUnlockConditions">
VariantUnlockConditions
<a class="header-action link-secondary" title="View source" href="https://github.com/Mushymato/TrinketTinker/blob/main/TrinketTinker/Models/TinkerData.cs/#L25"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"><p>GSQ conditions for locking variants.</p>
</div>
<div class="markdown level1 conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">public List&lt;string?&gt; VariantUnlockConditions</code></pre>
</div>




<h4 class="section">Field 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="https://learn.microsoft.com/dotnet/api/system.string">string</a>&gt;</dt>
<dd></dd>
</dl>









<h2 class="section" id="properties">Properties
</h2>

Expand Down Expand Up @@ -218,7 +284,7 @@ <h4 class="section">Property Value</h4>

<h3 id="TrinketTinker_Models_TinkerData_Motion" data-uid="TrinketTinker.Models.TinkerData.Motion">
Motion
<a class="header-action link-secondary" title="View source" href="https://github.com/Mushymato/TrinketTinker/blob/main/TrinketTinker/Models/TinkerData.cs/#L13"><i class="bi bi-code-slash"></i></a>
<a class="header-action link-secondary" title="View source" href="https://github.com/Mushymato/TrinketTinker/blob/main/TrinketTinker/Models/TinkerData.cs/#L11"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"><p>Shim for case of just 1 motion</p>
Expand Down Expand Up @@ -250,7 +316,7 @@ <h4 class="section">Property Value</h4>

<h3 id="TrinketTinker_Models_TinkerData_Motions" data-uid="TrinketTinker.Models.TinkerData.Motions">
Motions
<a class="header-action link-secondary" title="View source" href="https://github.com/Mushymato/TrinketTinker/blob/main/TrinketTinker/Models/TinkerData.cs/#L11"><i class="bi bi-code-slash"></i></a>
<a class="header-action link-secondary" title="View source" href="https://github.com/Mushymato/TrinketTinker/blob/main/TrinketTinker/Models/TinkerData.cs/#L21"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"><p>List of motions</p>
Expand Down
Loading

0 comments on commit a56b410

Please sign in to comment.