Differences

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

--- display_message [2017/04/09 21:44] – created justin
+++ display_message [2021/06/29 19:37] (current) – 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 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:====
+<code python>
+display_message(message_text, speaker)
+</code>
+^Argument^Description^Type^Required^
+|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%>
+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>
+====Example:====
+<code bauxite>
+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 [[object|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~~

RPG in a BoxOfficial Documentation

User Tools

Site Tools

Differences

Page Tools

RPG in a Box
Official Documentation