-
Notifications
You must be signed in to change notification settings - Fork 8
4.X Commands
This is a list of commands that are available in Rumor:
character: string
Clears the stage and replaces it with dialog with the contents of a string
expression string
spoken by character
. If character
is not specified, then
the default speaker is used instead.
character+ string
Adds dialog with the contents of a string expression string
spoken by
character
. If character
is not specified, then the default speaker is used
instead.
choice
> say
> something
Adds a choice to the stage with the contents of the string expression string
.
Any indented children directly after this command will be treated as the dialog
to use if this choice is selected.
choose
Pauses execution until a choice is picked.
clear (dialog|choices)
If neither dialog
or choices
is specified, clears the dialog and choices
from the stage.
If dialog
is specified, the dialog is cleared from the stage.
If choices
is specified, the choices are cleared from the stage.
elif { expression }
Can only be used directly after an if or another elif statement. Any indented
children directly after this command will be executed if and only if
expression
evaluates as true and the previous if or elif statement(s)
evaluated as false.
else
Can only be used directly after an if or elif statement. Any indented children directly after this command will be executed if and only if the previous if or elif statement(s) evaluated as false.
if { expression }
Any indented children directly after this command will be executed if and only
if expression
evaluates as true.
jump name
Moves execution to the label with the name name
and then returns execution
back after all of the label's children have been executed. Works similar to a
function call.
label [name]
Marks a location in the script that can be jumped to with a name. The name cannot be an expression, must be alphanumeric, and cannot start with a number or an underscore. Any indented children directly after this command will be considered as part of this label.
pause expression unit
Pauses execution for expression
units of time and then auto-advances.
unit
can be one of:
milliseconds
millisecond
ms
seconds
second
s
minutes
minute
m
return
Stops execution. If this return statement is encountered after a jump
, then
execution is returned to the jump
statement.
wait
Pauses execution until the user advances the dialog.