MessageDisplayDialogData Class |
Namespace: ImmerseSDK.UI.MessageDisplay
public class MessageDisplayDialogData
The MessageDisplayDialogData type exposes the following members.
Name | Description | |
---|---|---|
MessageDisplayDialogData | ||
MessageDisplayDialogData |
Creates a new instance
|
Name | Description | |
---|---|---|
AllowInput |
Allows the hand to go into the laset mode and provide a way to press buttons in VR.
| |
CurrentProgress |
The current progress that will be displayed on a progress bar (if the layout supports it)
| |
DurationInSeconds |
Message duration in seconds. Specify 0 for displaying the message indefinitely
| |
HasExpired |
Returns true if this notification has a duration and the time since it's show time is up
| |
Layout |
Specifies this message's layout
| |
MainImage |
Main Image to display on the dialog (in the first column if there is one). The dialog's layout will be change appropriately. Set either MainImage or MainSprite. Only one will be used.
| |
MainSprite |
Sprite to display on the dialog in the first (or only) column. The dialog's layout will be change appropriately. Set either MainImage or MainSprite. Only one will be used.
| |
MainSpriteText |
Optional Sprite text to display on the dialog. The dialog's layout will be change appropriately.
| |
MainText |
Text to display in the first (or only) column.
| |
OnCancelButtonClick |
If specified, the Cancel button will be displayed, and this handler will be called when it is pressed. If this handler is not specified, the Cancel button is hidden.
| |
OnClose |
If specified, this handler will be called when the dialog is closed.
| |
OnOkButtonClick |
If specified, the Ok button will be displayed, and this handler will be called when it is pressed. If this handler is not specified, the Ok button is hidden.
| |
Priority |
Message priority. Messages are sorted on priority, and only the highest priority message is displayed.
| |
ProgressColor |
The color for the progress bar (if the layout supports it)
| |
SecondaryImage |
Secondary Image to display on the dialog in the second column. The dialog's layout will be change appropriately. Set either SecondaryImage or SecondarySprite. Only one will be used.
| |
SecondarySprite |
Sprite to display on the dialog in the second column. The dialog's layout will be change appropriately.
| |
SecondarySpriteText |
Optional Sprite text to display on the dialog. The dialog's layout will be change appropriately.
| |
SecondaryText |
Text to display in the second column
| |
ShouldTrackCamera |
Set this to true if you want the dialog to stay in front of the user's view and track their head camera
| |
ShowDuration |
Returns the number of seconds this dialog has been displayed for
| |
ShowOnlyInVr |
Only display this dialog in VR
| |
TimeLeft |
How much time is left to show this dialog
| |
Title |
Dialog title text
|
Name | Description | |
---|---|---|
CreateControllerMessageDialog |
Creates a new instance with a layout that has a picture of the controller currently used, and text for each button describing it's functions.
To change the text that is displayed for each of the buttons, you can override the following NamedText key entries.
Note: If you override the key AND set the text to empty, it will hide the button from the dialog
DIALOG_CONTROLLER_TRACKPAD_TOP_PRESSED
For Oculus this is when the Thumbstick is pulled upwards and pressed down
DIALOG_CONTROLLER_TRACKPAD_BTM_PRESSED
For Oculus this is when the Thumbstick is pulled downwards and pressed down
DIALOG_CONTROLLER_MENU_BTN_PRESSED
For Oculus this is either the X or the A button on either controller
DIALOG_CONTROLLER_SYSTEM_BTN_PRESSED
For Oculus this is either the Y or the B button on either controller
DIALOG_CONTROLLER_TRIGGER_PULLED
For Oculus this is the index finger trigger
DIALOG_CONTROLLER_GRIP_BTN_PRESSED
For Oculus this is the hand trigger
| |
CreateMessageDialog(Notification) |
Creates a new instance with a notification message layout with no buttons
| |
CreateMessageDialog(String, String, Sprite, Single, Int32, Action, Action) |
Creates a new instance with a layout that includes a single column of text and an optional image
| |
CreateMessageDialog(String, String, Texture, Single, Int32, Action, Action) |
Creates a new instance with a layout that includes a single column of text and an optional image
| |
CreateMessageDialog(String, String, Sprite, String, Single, Int32, Action, Action) |
Creates a new instance with a layout that includes a single column of text and an optional image
| |
CreateMessageDialog(String, String, Texture, String, Single, Int32, Action, Action) |
Creates a new instance with a layout that includes a single column of text and an optional image
| |
CreateMessageDialog(String, String, String, Sprite, Sprite, Single, Int32, Action, Action) |
Creates a new instance with a layout that includes a double column of text and an optional image for each column
| |
CreateMessageDialog(String, String, String, Texture, Texture, Single, Int32, Action, Action) |
Creates a new instance with a layout that includes a single column of text and an optional image
| |
CreateMessageDialog(String, String, String, Sprite, Sprite, String, String, Single, Int32, Action, Action) |
Creates a new instance with a layout that includes a double column of text and an optional image for each column
| |
CreateMessageDialog(String, String, String, Texture, Texture, String, String, Single, Int32, Action, Action) |
Creates a new instance with a layout that includes a single column of text and an optional image
| |
CreateProgressMessageDialog(String, Single) |
Creates a new instance with a layout that has a progress bar and some text
| |
CreateProgressMessageDialog(String, Single, Int32) |
Creates a new instance with a layout that has a progress bar and some text
| |
CreateProgressMessageDialog(String, Color, Single) |
Creates a new instance with a layout that has a progress bar and some text
| |
CreateProgressMessageDialog(String, Color, Single, Int32) |
Creates a new instance with a layout that has a progress bar and some text
| |
PauseTimer |
Pause or unpause the timer
| |
TryToLocalise |
Attempt to localise all the text fields
|
Name | Description | |
---|---|---|
DefaultPriority |
Default priority assigned to dialogs
| |
DefaultProgressColor |
Default progress color for the progress bar
| |
DefaultSystemPriority |
Default Priority assigned to system messages
|