stingray.MsgDialog namespace reference

Description

The interface to access the message dialog system on the PlayStation 4.

This object is a singleton (there is only one MsgDialog).

Other related reference items

PlayStation 4

Functions

close ( ) Aborts the message dialog and closes it.

Parameters

This function does not accept any parameters.

Returns

This function does not return any values.

Generally, there is no need to call this, because the message dialog is closed by the user.

initialize ( ) Initializes the message dialog system.

Parameters

This function does not accept any parameters.

Returns

This function does not return any values.

Call this function only when stingray.MsgDialog.status() returns stingray.MsgDialog.NONE.

open ( message_type, user_id ) Opens the message dialog for the specified message type.

Parameters

message_type :	integer	The type of message to show.
user_id :	integer?	The ID of the player. Optional. This ID value is only neeeded for some types of messages. If omitted, the ID of the initial player is used when needed. The ? notation indicates that this type is optional: there may be zero or one instances of it.

Returns

This function does not return any values.

Call this function only when stingray.MsgDialog.status() returns stingray.MsgDialog.INITIALIZED or stingray.MsgDialog.FINISHED.

status ( ) : integer Same as stingray.MsgDialog.update(), but does not update the status first.

Parameters

This function does not accept any parameters.

Returns

integer

The status of the message dialog the last time update() was called. May be one of the status code constants.

This function is more lightweight than stingray.MsgDialog.update(), but does not guarantee the most up-to-date results.

Other related reference items

	stingray.MsgDialog.initialize() stingray.MsgDialog.open()
	Status codes

terminate ( ) Terminates the message dialog system and frees the related resources.

Parameters

This function does not accept any parameters.

Returns

This function does not return any values.

If the dialog is open, it is immediately terminated.

update ( ) : integer Updates the status of the message dialog and returns it.

Parameters

This function does not accept any parameters.

Returns

integer

The current status of the message dialog. May be one of the status code constants.

You must call this function and act upon its return value once per frame while the message dialog is in use.

Other related reference items

	stingray.MsgDialog.status()
	Status codes

Status codes

May be returned by calls to update() and status().

FINISHED : integer The message dialog is closed and finished.

Other related reference items

stingray.MsgDialog.open()

INITIALIZED : integer The message dialog is initialized, but not opened.

Other related reference items

stingray.MsgDialog.open()

NONE : integer Either the message dialog is not initialized, or it has already been terminated.

Other related reference items

stingray.MsgDialog.initialize()

RUNNING : integer The message dialog is open.