Command Prompt

One could say that the command prompt is like something "in-between" a spoken language and a programming language. The experience with the command prompt is comparable to the experience of telling your smartphone what you want it to do. Most of the commands are intuitive, the same thing can be said multiple different ways, and you only need to learn some basic concepts and vocabulary. Furthermore, nothing is case-sensitive or spacebar-sensitive (with a few exceptions), and you don't need to worry about getting an error if something is entered wrong. After you have mastered using the command prompt, you may find that learning an actual coding language will come a little easier for you.

gallery/platformbuildercommand

The command prompt was introduced with the release of Platform Builder 5.0. It is a powerful tool which allows you to "talk" to Platform Builder and tell it what to do. This saves time and removes a lot of clutter.

The process is quite simple. Each command must be placed on a single line. Most commands are split into three parts: The command, the operator, and the value.*

 

  • The command is what you want to change (For example, health, maximum ammo, the ability to perform a "super jump.")
  • The operator is how you want to change it. "=" will make your command equal to something. "+" or "-" will add or subtract. "*" or "/" will multiply or divide**. (Do not use "x" or "X" to multiply. You must use the star). The operator you can use varies on the command. Sometimes you can use any of these operators, but sometimes you can only use =.
  • The value is what you want to change it to. (For example, 100, true, 50, action 3, etc.) This varies on the command. For instance, if you are turning a setting on or off, your command would be the name of the setting and your value would be true or false.*** If you are changing the music for your area, your value would be the name of the music track.

When you finish writing out your commands, right-click on your command input and Platform Builder will check to see if you used any commands which are not recognized.

 

Command

Operator

Value

Example

Notes

Character Stats

Command

Operator

Value

Example

Notes

Maximum Character Stats
Select from a list of categories below to learn about the different commands you can use with Platform Builder:

Command

Operator

Value

Example

Notes

Game Limitations

Command

Operator

Value

Example

Notes

Special Powers

Command

Operator

Value

Example

Notes

Locks and Keys

Command

Operator

Value

Example

Notes

Enable/Disable Moves

Command

Operator

Value

Example

Notes

Character Attack Settings

Command

Operator

Value

Example

Notes

Character Projectile Settings
Character Physics and Movement Styles

Command

Operator

Value

Example

Notes

The following are command setting for character physics. There are a couple things to keep in mind when using these settings.

gallery/screenshot

Command

Operator

Value

Example

Notes

Command

Operator

Value

Example

Notes

Character and Appearance

Command

Operator

Value 1

Value 2

Example

Notes

Change the Area or World
Complete the Course

Command

Operator

Value 1

Value 2

Example

Notes

Command

Operator

Value

Example

Notes

Sound Effects, Music and Background

Command

Operator

Value

Example

Notes

View Settings and Movements

The following are various commands for controlling the view of Platform Builder. They can be useful for gameplay, but also handy when you are doing cut-scenes for your game. For instance, you can cause the view to travel in certain direction to keep up with whatever it happening in your cut-scene. You could also use a timeline to cause the view to travel in a special path for an exciting gameplay experience.

Command

Operator

Value

Example

Notes

Command

Operator

Value

Example

Notes

Other Area Settings

Command

Operator

Value

Example

Notes

Timelines and Menus

The following are a couple commands which you can use when handling timelines and menus. If you are looking for commands which would be useful to use within timelines, look to view movements, controls for character/enemy/NPC movements, and displaying text.

Command

Operator

Value

Example

Notes

Controls for Character Movement

When using the command prompt in timelines, you may wish to take control of how the character moves so that you can design interesting cut-scenes. That is what the following commands are for. They allow you to control the character in the sense that you "take over the keyboard," telling the character to behave as if certain keys are being pressed and/or released. However, in order for the character controls to work, you will first need to "disable" the player, preventing the user of your game from controlling the character using the keyboard or a game pad. Then you will want to "enable" the player when you are done. To do this, see the first six commands listed in the following spreadsheet. (Note: Although technically NPCs are also characters, these commands do not apply to NPCs. To control NPC characters, keep scrolling down!)

Command

Operator

Value

Example

Notes

Controls for NPC and Enemy Movement

When using the command prompt in timelines, you may wish to move NPCs and enemies around. Unlike character movements (above) you do not need to "disable" the enemy or NPC before modifying their movements. However, you may want to resume their normal movement behavior after you are done using them. All of the controls you need are found below. Note that you do not need to specifiy the enemy ID if you are calling the command from a command prompt in the custom enemy settings. By skipping the ID, the command will apply only to the enemy that is running the commands.

Command

Operator

Value

Example

Notes

<fast jump>$10!

Displaying Text and Messages
Items, Blocks, Enemies, Projectiles, and NPCs

NPCs, Items, and Enemies can be created on the spot with commands in Platform Builder. In order to do this, you will need to place down an invisible spawning point in your area and give the spawning point a Spawn ID. (The platform Builder manual talks about spawn IDs in the manual when it discusses Advanced Mode.) These spawning points are found under "Invisible Blocks" in your Item Box. When you use commands to spawn enemies, items, etc., they will appear at your invisible spawning point, so long as you specify the proper Spawn ID. Unlike character Spawn IDs, you can have multiple spawning points with the same ID.

Command

Operator

Value 1

Value 2

Example

Notes

Command

Operator

Value

Example

Notes

Miscellaneous Commands
Finding the ID of your Item, Enemy, Etc.

Many commands that work with characters, enemies, items, etc., ask you to provide the ID. Each custom character, enemy, etc. has a number assigned to it called an ID, and the ID is used in the command prompt in order to work that that particular character, enemy, etc. Each editor for a custom character, enemy, etc. has a small box in the top-right which tells you the ID. Simply hover your mouse cursor over the box, and it will tell you what the ID is for the character, enemy, etc. you are currently working with. If you are looking for the ID of an area or world, go to the area/world settings. You can also display the ID of things from their managers by enabling an option from the Platform Builder main menu.

 

Commands which call for an ID require that a custom enemy, item, etc. is used and not a pre-built enemy, item, etc. from your workstation. This shouldn't be a big problem since most of the pre-built items and enemies can be re-created as custom ones.

gallery/enemyid

Command

Operator

Value

Example

Notes

Effects

Looking for something? Try Ctrl+F to search for commands on this page!