2
Console API
Craig edited this page 5 years ago
Here is a list of the available commands in WetPancakeCLI. Each command uses the following template:
Name
- Parameters (nameOfParameter: type)
- Description
- Usage Example(s)
Test
- N.A.
- Prints a test message to the console.
Test
Help
- N.A.
- Lists out the commands this programs offers.
Help
QuickGuide
(filePath: string)
- Writes a quick-guide to the specified location or the desktop if no path was specified.
QuickGuide
Exit
- N.A.
- Exits out of the program.
Exit
CleanText
- (sentences: int) (text: string)
- Checks to see if the string matches the desired sentence count and removes any over that limit. If the string has less sentences than the number requested, it will not change. Sentences must be greater than 0 and the text must contain at least one "." "?" "!"
CleanText 1 "This is a test sentence. And, this one needs to be removed."
RequestAllTemplateFiles
- N.A.
- Returns a list of all the available .txt files built-in to WetPancake.
RequestAllTemplateFiles
ValidateFile
(file path: string)
- Checks the text in the specified .txt file to see if it is compatible with this program. For a file to be compatible, it must be a .txt file and contain at least one '.', '!' or '?'.
ValidateFile "C:/your-file.txt"
MakeCleanText
(gibberish-level: int)
(sentences: int)
(copy-to-clipboard: bool)
- Makes text using the gibberish-level and number of sentences specified by the user. The result goes through an extra "cleaning" process to remove any artefact sentences. Use this if you cannot tolerate the odd extra sentence. With that said, it does mean it is slower than its MakeText counterpart. Gibberish-level must be between 2 and 20. Sentences must be greater than 0. Pass in "true" to copy the result straight to the clipboard. Pass in "false" or leave blank to not copy the result.
MakeCleanText 5 10 true
MakeCleanText 3 7 false
MakeCleanText 9 12
MakeCleanTextFromFile
(gibberish-level: int)
(sentences:int)
(file path: string)
(copy-to-clipboard: bool)
- Loads the specified .txt file and makes text based on it, using the gibberish-level and number of sentences specified by the user. The result goes through an extra "cleaning" process to remove any artefact sentences. Use this if you cannot tolerate the odd extra sentence. With that said, it does mean it is slower than its MakeTextFromFile counterpart. Gibberish-level must be between 2 and 20. Sentences must be greater than 0. Pass in "true" to copy the result straight to the clipboard. Pass in "false" or leave blank to not copy the result.
MakeCleanTextFromFile 3 6 C:/yourfile.txt true
MakeCleanTextFromFile 5 9 C:/yourfile.txt false
MakeCleanTextFromFile 7 15 C:/yourfile.txt
MakeRandomText
(copy-to-clipboard: bool)
- Makes random text, the number of sentences Maked is randomly determined. Pass in true to copy result straight to clipboard. Pass in "false" or leave blank to not copy the r
MakeRandomText true
MakeRandomText false
MakeRandomText
MakeText
(gibberish-level: int)
(sentences: int)
(copy-to-clipboard: bool)
- Makes text using the gibberish-level and number of sentences specified by the user. This command does not run the result through the extra "cleaning" process like MakeCleanText. This means this command is faster but it might produce an extra sentence on the odd occasion. Use this if you prefer speed over accuracy. Gibberish-level must be between 2 and 20. Sentences must be greater than 0. Pass in "true" to copy the result straight to the clipboard. Pass in "false" or leave blank to not copy the result.
MakeText 5 10 true
MakeText 7 15 false
MakeText 10 5
MakeTextFromFile
(gibberish-level: int)
(sentences: int)
(file path: string)
- Loads the specified .txt file and makes text based on it, using the gibberish-level and number of sentencesspecifiedby the user. This command does not run the result through the extra "cleaning" process like MakeCleanTextFromFile. This means this command is faster but it might produce an extra sentence on the odd occasion. Use this if you prefer speed over accuracy. Gibberish-level must be between 2 and 20. Sentences must be greater than 0. Pass in "true" to copy the result straight to the clipboard. Pass in "false" or leave blank to not copy the result.
MakeTextFromFile 3 6 C:/yourfile.txt true
MakeTextFromFile 6 13 C:/yourfile.txt false
MakeTextFromFile 12 8 C:/yourfile.txt