ff392e0e7e
* Initial Methods for SpearheadAPI * Added Spearhead API * Added Spearhead API * fixed compile for api * Added notes for API in beta * Added notes for API in beta * Added Menu to all doc pages * Added Menu to all doc pages * added it for real * added it for real * fixed develop * fixed develop * fixed develop * wip * wip * updated * work in progress * work in progress * added empty docs page * wip * removed SAR files from persistence branch * Added Blue Sams as seperate class * added initial persistance * added initial persistance * added initial persistance * added initial persistance * added initial persistance * added menu to persistence markdown * added menu to persistence markdown * added menu to persistence markdown * docs update * wip * wip * Refactor of Stage classes. * wip * wip * wip * reworked bluesam and stagebase * Added waiting stage functionality * updated docs * wip * wip * wip * updated * wip * wip * wip * refactored without issues, needs testing --------- Co-authored-by: Dutchie <54616262+dutchie032@users.noreply.github.com> Co-authored-by: dutchie032 <dutchie032> Co-authored-by: ex61wi <tim.rorije@ing.com>
1.2 KiB
1.2 KiB
Spearhead.API
NOTE: The Spearhead.API space is only release in the Beta branch at the moment.
the Spearhead.API space is specifically created to make sure mission makers can interact with the framework.
Simply alter logic, get the current state in Spearhead, and give the whole ME more control.
eg. Late activate the entire framework by calling Spearhead.API.Stages.changeStage(1) later or on demand and setting the starting config stage to -1 in the Spearhead configuration file
Stages
---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
Spearhead.API.Stages.changeStage = function(stageNumber) end
---Returns the current stange number
---Returns nil when the stagenumber was not set before ever, which means Spearhead was not started.
---@return number | nil
Spearhead.API.Stages.getCurrentStage = function() end
---returns whether a stage (by index) is complete.
---@param stageNumber number
---@return boolean | nil
---@return string
Spearhead.API.Stages.isStageComplete = function(stageNumber) end