UI_Prompt Class Reference

IWindowFunction class that prompts the user for action. More...

Inheritance diagram for UI_Prompt:

Collaboration diagram for UI_Prompt:

Public Types
enum	Type { Type.Close, Type.YesNo, Type.OkCancel }

Public Member Functions
delegate void	Response (bool response)
	Response callback delegate type. More...
	UI_Prompt (Response response, Type t, string title="Prompt", string prompt="Keep up the good work!")
	Initializes a new instance of the UI_Prompt class. More...

Properties
Type	type [get, set]
string	windowTitle [get, set]
string	message [get, set]
Rect	windowRect [get, set]
GUI.WindowFunction	windowFunction [get]
Properties inherited from IWindowFunction
string	windowTitle [get]
	Gets the window title. More...
Rect	windowRect [get, set]
	Gets or sets the window rect (window size and position). More...
GUI.WindowFunction	windowFunction [get]
	Gets the window function definition for GUILayout.Window() More...

Private Member Functions
void	Window (int windowID)
	GUI window function for the prompt. More...

Private Attributes
Response	callback
	The callback function to call once the user has responded to the prompt. More...
bool	close

Detailed Description

IWindowFunction class that prompts the user for action.

Definition at line 8 of file UI_Prompt.cs.

Member Enumeration Documentation

enum UI_Prompt.Type

Enumerator
Close	Close type response: display only a "Close" button.
YesNo	Yes or No type response: display "Yes" and "No" buttons.
OkCancel	Ok or Cancel type response: display "Ok" and "Cancel" buttons.

Definition at line 16 of file UI_Prompt.cs.

                     {
        Close,
        
        YesNo,
        
        OkCancel
    }

Constructor & Destructor Documentation

UI_Prompt.UI_Prompt	(	Response	response,
		Type	t,
		string	title = "Prompt",
		string	prompt = "Keep up the good work!"
	)

Initializes a new instance of the UI_Prompt class.

Parameters

response	Response callback function Reponse(bool).
t	Response Type.
title	Title.
prompt	Prompt.

Definition at line 41 of file UI_Prompt.cs.

                                                  {
        
        callback = response;
        type = t;
        windowTitle = title;
        message = prompt;
        
        windowRect = new Rect(Screen.width/2f, Screen.height/2f, 400, 100);
    }

Member Function Documentation

delegate void UI_Prompt.Response

(

bool

response

)

Response callback delegate type.

void UI_Prompt.Window ( int  windowID )

private

GUI window function for the prompt.

Definition at line 88 of file UI_Prompt.cs.

                              {
        
        GUILayout.Label(message);
                
        switch(type) {
            case Type.Close:
                if (GUILayout.Button("Close")) {
                    close = true;
                    callback(false);
                }
            break;
            
            case Type.OkCancel:
                GUILayout.BeginHorizontal();
                if (GUILayout.Button("OK")) {
                    callback(true);
                    close = true;
                }
                GUILayout.Space(20f);
                if (GUILayout.Button("Cancel")) {
                    callback(false);
                    close = true;
                }
                GUILayout.EndHorizontal();
            break;
            
            case Type.YesNo:
                GUILayout.BeginHorizontal();
                if (GUILayout.Button("Yes")) {
                    callback(true);
                    close = true;
                }
                GUILayout.Space(20f);
                if (GUILayout.Button("No")) {
                    callback(false);
                    close = true;
                }
                GUILayout.EndHorizontal();
            break;
        }
        
        GUI.DragWindow();
    }

Member Data Documentation

Response UI_Prompt.callback

private

The callback function to call once the user has responded to the prompt.

Definition at line 82 of file UI_Prompt.cs.

bool UI_Prompt.close

private

Definition at line 83 of file UI_Prompt.cs.

Property Documentation

string UI_Prompt.message

getset

Definition at line 63 of file UI_Prompt.cs.

Type UI_Prompt.type

getset

Definition at line 55 of file UI_Prompt.cs.

GUI.WindowFunction UI_Prompt.windowFunction

get

Definition at line 71 of file UI_Prompt.cs.

Rect UI_Prompt.windowRect

getset

Definition at line 67 of file UI_Prompt.cs.

string UI_Prompt.windowTitle

getset

Definition at line 59 of file UI_Prompt.cs.

---

The documentation for this class was generated from the following file:

• Assets/botnavsim/Scripts/UI/UI_Prompt.cs