Skip to content

Commit

Permalink
auto generated help
Browse files Browse the repository at this point in the history
  • Loading branch information
torusrxxx committed Jun 19, 2016
1 parent df5345e commit b993291
Show file tree
Hide file tree
Showing 8 changed files with 92 additions and 0 deletions.
19 changes: 19 additions & 0 deletions commands/script-commands/Jxx.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
Jxx/IFxx
========

There are various branches that can react on the flags set by the `cmp` (and maybe other) command(s):

* unconditional branch    - `jmp`/`goto`* branch if not equal   - `jne`/`ifne(q)`/`jnz`/`ifnz`
* branch if equal      - `je`/`ife(q)`/`jz`/`ifz`
* branch if smaller     - `jb`/`ifb`/`jl`/`ifl`
* branch if bigger     - `ja`/`ifa`/`jg`/`ifg`
* branch if bigger/equal  - `jbe`/`ifbe(q)`/`jle`/`ifle(q)`
* branch if smaller/equal - `jae`/`ifae(q)`/`jge`/`ifge(q)`

arguments
---------
  [arg1]: The label to jump to.

result
------
This command does not set any result variables.
11 changes: 11 additions & 0 deletions commands/script-commands/call.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# call
A call works exactly the same as an uncondentional branch, but it places it's address on the script stack.
## arguments
  arg1: The label to jump to.
## result
This command does not set any result variables.
Expand Down
11 changes: 11 additions & 0 deletions commands/script-commands/invalid.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# invalid
Invalid command to throw an error message. This command will halt the script execution.
## arguments
This command has no arguments.
## result
This command does not set any result variables.
Expand Down
16 changes: 16 additions & 0 deletions commands/script-commands/log.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
log
===
Put information in the log.

arguments
---------
[arg1]: Format string (see down for more information). When not specified, a newline will be logged.
[argN]: Data for the format string.

format string
-------------
A format string like "Info 1: {0}, Info 2: {1}\n Info 3:{2}". In place of {n} the n-th argument after the format string is inserted. You can specify how to format the inserted data by prepending a format type: "{s:0}" logs a string. Other types are: "d" (log as signed decimal), "u" (log as unsigned decimal), "p" (log as ????????).You can print a "{" by escaping it like "{{". Same for "{". "\n" inserts a newline.

result
------
This command does not set any result variables.
8 changes: 8 additions & 0 deletions commands/script-commands/msg.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# msg
Display a message box.

## arguments
[arg1]: Message box text.

## result
This command does not set any result variables.
8 changes: 8 additions & 0 deletions commands/script-commands/msgyn.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# msgyn
Display a message box, asking the user to answer yes or no.

## arguments
[arg1]: Message box text.

## result
The `$result` variable will be set to 1 when the user answered yes. Otherwise it's set to 0.
8 changes: 8 additions & 0 deletions commands/script-commands/pause.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# pause
Halt the script execution. The user can resume the script after this command.

## arguments
This command has no arguments.

## result
This command does not set any result variables.
11 changes: 11 additions & 0 deletions commands/script-commands/scriptload.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# scriptload
Load a script file.
## arguments
 arg1: Script file to load.
## result
This command does not set any result variables.
Expand Down

0 comments on commit b993291

Please sign in to comment.