Spearhead/spearhead
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Spearhead API updates (#31)

Browse Source 
Co-authored-by: dutchie032 <dutchie032>
This commit is contained in:
dutchie031
2025-05-10 12:44:01 +02:00
committed by GitHub
co-authored by dutchie032 <dutchie032>
parent c7c532a08a
commit 05e2d067ce
7 changed files with 114 additions and 77 deletions
Download Patch File Download Diff File Expand all files Collapse all files
_docs/pages/spearheadapi.html
+1 -18
View File
@@ -66,24 +66,7 @@
<h2 id="stages">Stages</h2>
<pre>
<span class="lua-comment">---Changes the active stage of spearhead.
--- All other stages will change based on the normal logic. (CAP, BLUE etc.)
---@param stageNumber number the stage number you want changed
---@return boolean success indicator of success
---@return string message error message</span>
<span class="lua-variable">Spearhead.API.Stages</span>.<span class="lua-function">changeStage</span> <span class="lua-operator">=</span> <span class="lua-keyword">function</span>(<span class="lua-variable">stageNumber</span>) <span class="lua-keyword">end</span>
<span class="lua-comment">---Returns the current stange number
---Returns nil when the stagenumber was not set and spearhead is not started.
---@return number | nil</span>
<span class="lua-variable">Spearhead.API.Stages</span>.<span class="lua-function">getCurrentStage</span> <span class="lua-operator">=</span> <span class="lua-keyword">function</span>() <span class="lua-keyword">end</span>
<span class="lua-comment">---returns whether a stage (by index) is complete.
---@param stageNumber number
---@return boolean | nil
---@return string</span>
<span class="lua-variable">Spearhead.API.Stages</span>.<span class="lua-function">isStageComplete</span> <span class="lua-operator">=</span> <span class="lua-keyword">function</span>(<span class="lua-variable">stageNumber</span>) <span class="lua-keyword">end</span>
#{API_CODE}#
</pre>
</div>
</div>