Skip to content

Commit

Permalink
add doc for the save argument
Browse files Browse the repository at this point in the history
  • Loading branch information
mcmonkey4eva committed Nov 12, 2019
1 parent 9f933e4 commit c6f9fca
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 1 deletion.
Expand Up @@ -90,6 +90,23 @@ public static boolean handleDefs(ScriptEntry scriptEntry, boolean genned) {

public static ScriptQueue currentQueue;

// <--[language]
// @name The Save Argument
// @group Script Command System
// @description
// The "save:<name>" argument is a special meta-argument that is available for all commands, but is only useful for some.
// It is written like:
// - run MyScript save:mysave
//
// When the save argument is used, the results of the command will be saved on the queue, for later usage by the "entry" tag.
//
// The useful entry keys available for any command are listed in the "Tags" documentation section for any command.
// For example, the "run" command lists "<entry[saveName].created_queue>".
// The "saveName" part should be replaced with whatever name you gave to the "save" argument,
// and the "created_queue" part changes between commands.
// Some commands have multiple save entry keys, some have just one, most don't have any.
// -->

public boolean execute(ScriptEntry scriptEntry) {
if (scriptEntry.dbCallShouldDebug()) {
StringBuilder output = new StringBuilder();
Expand Down
Expand Up @@ -8,7 +8,7 @@ public interface Holdable {

// <--[language]
// @name ~Waitable
// @group Object System
// @group Script Command System
// @description
// A command that is "~Waitable" (or "Holdable", or that can be "~waited for") is a command that:
// - Might potentially take a while to execute
Expand Down

0 comments on commit c6f9fca

Please sign in to comment.