User Tools

Site Tools


display_message

Differences

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

Link to this comparison view

Next revision
Previous revision
Next revisionBoth sides next revision
display_message [2017/04/09 21:44] – created justindisplay_message [2017/04/12 15:56] justin
Line 1: Line 1:
-Display Message+======Display Message====== 
 +---- 
 + 
 +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. 
 + 
 +<code python> 
 +display_message(message_text) 
 +</code> 
 + 
 +^Argument^Description^Type^Required^ 
 +|message_text|Message text to display in the dialogue box.|[[String]]|Yes| 
 + 
 +<WRAP center round info 100%> 
 +You can use [[placeholder_expression|placeholder expressions]] within the message text if you'd like to display dynamic information (for example, the current value of a global property). 
 +</WRAP> 
 + 
 +====Example:==== 
 +<code python> 
 +display_message("Justin and Sarah's House"
 +</code> 
 +//Results:// A dialogue box is displayed containing the text "Justin and Sarah's House"
 + 
 +<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. 
 +</WRAP> 
 + 
 +<WRAP group> 
 +<WRAP half column> 
 +====Editor Node:==== 
 +{{:wiki:display_message_node.png?nolink|}} 
 +</WRAP> 
 + 
 +<WRAP half column> 
 +====Visual Demo:====  
 +{{:wiki:display_message_demo.gif?nolink|}} 
 +</WRAP> 
 +</WRAP> 
 + 
 +~~NOTOC~~
display_message.txt · Last modified: 2021/06/29 19:37 by justin