display_choices
Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
| display_choices [2021/06/29 19:08] – justin | display_choices [2021/06/29 20:39] – justin | ||
|---|---|---|---|
| Line 2: | Line 2: | ||
| ---- | ---- | ||
| - | Displays a set of choices to the player using a [[dialogue]] box. The list of choices must be provided as an [[array]] of [[string]] values. Once the player has selected an option, the choice will be stored into the result variable as a [[number]] (with 0 being the first option, 1 being the second, and so forth). | + | Displays a set of choices to the player using a [[dialogue]] box. The list of choices must be provided as an [[array]] of [[string]] values. Once the player has selected an option, the choice will be stored into the result variable as a [[number]] (with 0 being the first option, 1 being the second, and so forth). This function, when paired together with the [[Display Message]] function, can be used to create simple, on the fly conversations without the need for a standalone [[dialogue]] file. |
| ====Signature: | ====Signature: | ||
| Line 11: | Line 11: | ||
| ^Argument^Description^Type^Required^ | ^Argument^Description^Type^Required^ | ||
| |message_text|Message text to display in the [[dialogue]] box.|[[String]]|Yes| | |message_text|Message text to display in the [[dialogue]] box.|[[String]]|Yes| | ||
| - | |choices| |[[Array]]|Yes| | + | |choices|List of choices the player will be presented with.|[[Array]]|Yes| |
| |speaker|[[character|Character]] who will speak the message.|[[Entity]]|No| | |speaker|[[character|Character]] who will speak the message.|[[Entity]]|No| | ||
| Line 20: | Line 20: | ||
| ====Example: | ====Example: | ||
| <code bauxite> | <code bauxite> | ||
| - | display_choices(" | + | display_choices(" |
| </ | </ | ||
| - | // | + | // |
| <WRAP center round tip 100%> | <WRAP center round tip 100%> | ||
| - | Use the **Display Choices** function to . | + | Use the **Display Choices** function to provide a list of rewards for the player to choose from when completing a quest, or to provide a simple prompt to the player for determining a course of action to take. |
| </ | </ | ||
display_choices.txt · Last modified: 2021/06/29 20:42 by justin
Page Tools
