rpgSprite Script Commands

Regular Commands
pause Pause
This command allows you to pause or un-pause parts of the game engine, such as the player. You can use this to halt the player during auto scripts, or allow the player to move during talk scripts.


If the game is programmed for it, you can also pause other things such as enemies and or disable menus with this.
move Move
This command can contain a list of movements, that can tell a sprite to walk somewhere. It's also used to change the appearance of that sprite.


This does not pause the script, so it's possible to make multiple characters move at the same time, by using multple move commands.
wait Wait
This tells the script to wait a moment. You can use this for dramatic pauses after a character says something weird.


It can also be used to wait until a sprite finishes moving before continuing the script.
... Comment
This is used to add notes to your script. It doesn't affect the game, so just use it to plan out your scenes.

textbox Textbox
This displays a textbox on the screen, which is used for when characters are talking.

teleport Teleport
This sends the player to another level.

swf SWF
This places a SWF file on the screen. It's a useful way to add features to your game without reprogramming it.


This can also place picture files, videos (contained in SWF files), and internal movieClips.
remove swf Remove SWF
This removes a SWF, picture, or movieClip from the screen. It can also be used to remove sprites.

sound Sound
This plays a sound effect.

music Music
This plays a music file. Music continues between levels.

fade music Fade Music
This makes the current song fade out or fade in.

set variable Set Variable
This adds or changes variables in the game. Use it to set flags, or make the game remember things for later. This command can also be used to call functions and optionally read values from them. For example...


[Math.random()]
If you put this in the "value" box, The variable will store a random number between 0 and 0.999, which can be stored in a variable. You can also call any function in the game.
condition Condition
This checks to see if a variable has a certian value, and then does stuff if it does.

loop Loop
This does stuff over and over, as long as a variable has a certain value. To make the loop stop, use a Set Variable command to change the variable's value to something else.

Last updated: August 27, 2011