UI_Credits Class Reference

IWindowFunction class for displaying credits. Also inherits from MonoBehaviour to expose credit data to UnityEditor when added as a component to the UI GameObject More...

Inheritance diagram for UI_Credits:

Collaboration diagram for UI_Credits:

Classes
class	Credit
	Serializable (exposed to UnityEditor) for holding creditation data More...

Public Attributes
Credit[]	credits
	Array of credits exposed and edited in the Unity Inspector More...
float	width = 500f
	The width of the window. More...
bool	close

Properties
string	windowTitle [get]
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	Awake ()
	Awake this instance. More...
void	Window (int id)
	GUI Window function to display credits in a scroll view. More...

Private Attributes
Vector2	_scrollPos = new Vector2()

Detailed Description

IWindowFunction class for displaying credits. Also inherits from MonoBehaviour to expose credit data to UnityEditor when added as a component to the UI GameObject

Definition at line 8 of file UI_Credits.cs.

Member Function Documentation

void UI_Credits.Awake ( )

private

Awake this instance.

Definition at line 71 of file UI_Credits.cs.

                 {
        windowRect = new Rect(0,0,500,500);
    }

void UI_Credits.Window ( int  id )

private

GUI Window function to display credits in a scroll view.

Definition at line 78 of file UI_Credits.cs.

                        {
        if (GUILayout.Button("Close")) {
            close = true;
        }
        _scrollPos = GUILayout.BeginScrollView(_scrollPos, true, false);
        GUILayout.Label(Strings.projectAbout, GUILayout.Width(width-60f));
        GUILayout.Space (25);
        GUILayout.Label("The following resources were used in this project: ");
        GUILayout.Space (25);
        foreach(Credit c in credits) {
            GUILayout.Label(c.name + " by " + c.author,GUILayout.Width(width-60f));
            GUILayout.Label(c.description,GUILayout.Width(width-60f));
            if (GUILayout.Button(c.url,GUILayout.Width(width-60f))) Application.OpenURL(c.url);
            GUILayout.Space (50);
        }
        GUILayout.EndScrollView();
        GUI.DragWindow();
    }

Member Data Documentation

Vector2 UI_Credits._scrollPos = new Vector2()

private

Definition at line 66 of file UI_Credits.cs.

bool UI_Credits.close

Definition at line 64 of file UI_Credits.cs.

Credit [] UI_Credits.credits

Array of credits exposed and edited in the Unity Inspector

Definition at line 40 of file UI_Credits.cs.

float UI_Credits.width = 500f

The width of the window.

Definition at line 45 of file UI_Credits.cs.

Property Documentation

GUI.WindowFunction UI_Credits.windowFunction

get

Definition at line 57 of file UI_Credits.cs.

Rect UI_Credits.windowRect

getset

Definition at line 53 of file UI_Credits.cs.

string UI_Credits.windowTitle

get

Definition at line 47 of file UI_Credits.cs.

---

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

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