Confirm Prompt UGUI

Scripting with the InventoolConfirmPromptUGUI class.

The InventoolConfirmPromptUGUI class is a pop-up UI element that prompts the user to confirm or cancel an action.

Fields & Properties

Name
Description
Type
Access

canvas

The root canvas.

Canvas

public

content

The main content container.

RectTransform

public

hiddenCloseButton

The full-screen invisible close button.

Button

protected

titleLabel

The title label.

TextMeshProUGUI

protected

descriptionLabel

The description label.

TextMeshProUGUI

protected

leftButton

The left button option.

Button

protected

rightButton

The right button option.

Button

protected

leftButtonIconImage

Left button icon element.

Image

protected

rightButtonIconImage

Right button icon element.

Image

protected

leftButtonLabel

The left button label.

TextMeshProUGUI

protected

rightButtonLabel

The right button label.

TextMeshProUGUI

protected

leftButtonAction

The left button on-click action.

Action

protected

rightButtonAction

The right button on-click action.

Action

protected

Active Instance

You can get the active InventoolConfirmPromptUGUI instance with InventoolConfirmPromptUGUI.Instance. Ensure there's an instance of it in your scene before using this field.

Open

The Open method has many parameters you can use to customize what's displayed on the confirm prompt.

Name
Description
Type

title

The prompt title or the localized string key if you're using localization.

string

description

The prompt description or the localized string key if you're using localization.

string

leftButtonAction

The left button on-click action.

Action

rightButtonAction

The right button on-click action.

Action

showLeftButton

If the left button should be displayed.

bool

showRightButton

If the right button should be displayed.

bool

leftButtonText

The left button text or the localized string key if you're using localization.

string

rightButtonText

The right button text or the localized string key if you're using localization.

string

leftButtonIcon

The left button icon.

Sprite

rightButtonIcon

The right button icon.

Sprite

leftLabelIsNumeric

If the left label is numeric (localization disabled).

bool

rightLabelIsNumeric

If the right label is numeric (localization disabled).

bool

InventoolConfirmPromptUGUI.Instance.Open("My Title", "My Description");

Close

InventoolConfirmPromptUGUI.Instance.Close();

Last updated