3
Console API
Craig edited this page 5 years ago
Here is a list of the available commands in SmoulderingBeachBallCLI. Each command uses the following template:
Name
- Parameters
- Description
- Usage Example(s)
test
- N.A.
- Display a text message indicating this program is running properly.
test
help
- N.A.
- Displays a list of available commands provided by this program.
help
exit
- N.A.
- Exits the program.
exit
cheat
- N.A.
- Saves this program's cheat-sheet to the desktop.
cheat
draw-default
(image-width: int)(image-height: int)- Saves an image to the desktop, using the default setting. The user must specify the width and the height of the image. The image is white with a full overlay, which is black.
draw-default 500 500
draw-image
(image-width: int)(image-height: int)(main-colour: string)(overlay-colour: string)(overlay-type: string)(file-path: string)- Creates an image using the values specified by the user. To see a list of available colours use the 'list-colours' command. For the overlay-type you can enter either 'none', 'border' or 'full. For the file path, you can enter 'desktop' to save to the desktop. Otherwise, you must specify the whole path.
draw-image 770 400 white black full desktopdraw-image 600 400 purple grey border C:/work/project-folder/images/draw-image 800 440 black - none D:/your-project/assets/
list-colours
- N.A.
- Lists out the colours this program uses to draw its grids.
list-colours
List of Available Colours
SmoulderingBeachBallCLI uses a handful of colours in an attempt to keep things
simple for the end-user. My thinking around this is it is easier to
remember something like "red" than #ef23ed. So, here are the list of
colours you can use in SmoulderingBeachBallCLI:
- blue
- brown
- black
- gray
- green
- purple
- red
- white
- yellow
Table of Contents
As Source Code
SmoulderingBeachBall
SmoulderingBeachBallCLI
- SmoulderingBeachBallCLI Home
- C.L.I. Project Breakdown
- The C.L.I's Flow
- Creating the Input-loop
- Command-Methods Overview
- C.L.I. Validation Overview
- Changing the C.L.I. Icon
TestCentre
- TestCentre Home
- TestCentre Breakdown
- Unit and Property Tests Overview
- Console and Library Tests Overview
As a Command-Line Interface (C.L.I)
- C.L.I. Home
- Add SmoulderingBeachBallCLI to Your Machine
- Using the Console Program
- Console A.P.I.
- C.L.I. Aliases