User Tools

Site Tools


display_message

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
display_message [2020/03/12 11:01] justindisplay_message [2021/06/29 19:37] (current) justin
Line 2: Line 2:
 ---- ----
  
-Displays a dialogue box with the specified message text. Interaction with the scene will be disabled until the player clicks on the dialogue box or presses SPACE to dismiss it.+Displays a [[dialogue]] box with the specified message text. Interaction with the scene will be disabled until the player clicks the left mouse button or presses SPACE to dismiss it. The optional "speaker" parameter, along with the [[Display Choices]] function, can be used to create simple, on the fly conversations without the need for a standalone [[dialogue]] file.
  
 ====Signature:==== ====Signature:====
 <code python> <code python>
-display_message(message_text)+display_message(message_text, speaker)
 </code> </code>
  
 ^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
 +|speaker|[[character|Character]] who will speak the message.|[[Entity]]|No|
  
 <WRAP center round info 100%> <WRAP center round info 100%>
-You can use [[placeholder_expression|placeholder expressions]] within the message text, or even variables and properties on their own, if you'd like to display dynamic information (for example, the current value of a global property).+You can use [[placeholder_expression|placeholder expressions]] within the message text, or even variables and properties on their own, if you'd like to display dynamic information (for example, the current value of a [[global_properties|global property]]).
 </WRAP> </WRAP>
  
 ====Example:==== ====Example:====
 <code bauxite> <code bauxite>
-display_message("Justin and Sarah's House")+display_message("Justin and Sarah's House");
 </code> </code>
-//Results:// A dialogue box is displayed containing the text "Justin and Sarah's House".+//Results://[[dialogue]] box is displayed containing the text "Justin and Sarah's House".
  
 <WRAP center round tip 100%> <WRAP center round tip 100%>
-Use the **Display Message** function to display information about interactive objects (such as signs) or to inform the player of events that have occurred.+Use the **Display Message** function to display information about interactive [[object|objects]] (such as signs) or to inform the player of events that have occurred.
 </WRAP> </WRAP>
  
Line 35: Line 36:
  
 <WRAP half column> <WRAP half column>
-====Visual Demo:==== +====Visual Demo:====
 {{:wiki:display_message_demo.gif?nolink|}} {{:wiki:display_message_demo.gif?nolink|}}
 </WRAP> </WRAP>
display_message.1584036117.txt.gz · Last modified: 2020/03/12 11:01 by justin