show_message_async(str)

From ENIGMA
Jump to navigation Jump to search

Description

Creates a new asynchronous message box thread that will display the given message and fire the Asynchronous dialog event when resolved.

The following is a table of values that will be stored in the global async_load map when the thread completes and the Asynchronous dialog event is fired.

Key Value
"id" index of the thread
"status" true if ok was selected, false if cancelled

Parameters

Parameter Data Type Description
str string The message to be displayed in the dialog box.

Return Values

integer: Returns the index of the thread or -1 on failure to start the thread (if the thread fails it will be deleted and freed from memory automatically).

Example Call

// demonstrates showing an asynchronous message
var thread;
thread = show_message_async("Hello, World!");