greg/no-more-secrets-rust
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

More formatting changes

Browse Source 
modified:   README.md
This commit is contained in:
Brian Barto 2016-04-26 11:57:18 -04:00
parent 95b86556d4
commit 53715bf7f6
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -106,16 +106,16 @@ typedef struct {
} NmsArgs;
```
* `char *src`
Pointer to the string of characters on which to perform the effect.
* Pointer to the string of characters on which to perform the effect.
Useful for displaying menus:
* `char *return_opts`
String pointer containg only the character options that the user must choose from once the src characters are revealed. For example, if you are showing a menu with six options, this string might be "123456". The user will have to choose one of these characters before execution is handed back to the calling function. Note that the character selected is returned by `nms_exec()`;
* String pointer containg only the character options that the user must choose from once the src characters are revealed. For example, if you are showing a menu with six options, this string might be "123456". The user will have to choose one of these characters before execution is handed back to the calling function. Note that the character selected is returned by `nms_exec()`;
* `int input_cursor_x` and `int input_cursor_y`
If your menu has a specific location that you'd like to place the cursor for user input, use these to set the x and y screen corrdinates for the position.
* If your menu has a specific location that you'd like to place the cursor for user input, use these to set the x and y screen corrdinates for the position.
* `bool show_cursor`
Set to `true` if you want the cursor to be visible during the text decryption effect. It is set to `false` by default.
* Set to `true` if you want the cursor to be visible during the text decryption effect. It is set to `false` by default.
Assign values to the structure members as needed. Then simply pass a pointer to the structure to the
nms_exec() function: