Class LogUIHandler

Controls the log panel.

Inheritance

object

LogUIHandler

Namespace: AS2.UI

Assembly: .dll

Syntax

public class LogUIHandler : MonoBehaviour

Fields

color_debug

Declaration

public Color color_debug

Field Value

Type	Description
Color

color_error

Declaration

public Color color_error

Field Value

Type	Description
Color

color_log

Declaration

public Color color_log

Field Value

Type	Description
Color

color_warning

Declaration

public Color color_warning

Field Value

Type	Description
Color

go_elementParent

Declaration

public GameObject go_elementParent

Field Value

Type	Description
GameObject

go_expand

Declaration

public GameObject go_expand

Field Value

Type	Description
GameObject

go_log

Declaration

public GameObject go_log

Field Value

Type	Description
GameObject

instance

Declaration

public static LogUIHandler instance

Field Value

Type	Description
LogUIHandler

keepVisible

Declaration

private bool keepVisible

Field Value

Type	Description
bool

logElementList

Declaration

public List<GameObject> logElementList

Field Value

Type	Description
List<GameObject>

logEntryID

Declaration

private int logEntryID

Field Value

Type	Description
int

maxLogEntries

Declaration

private int maxLogEntries

Field Value

Type	Description
int

scrollBar

Declaration

public Scrollbar scrollBar

Field Value

Type	Description
Scrollbar

scrollRect

Declaration

public ScrollRect scrollRect

Field Value

Type	Description
ScrollRect

scrollToBottomInAmountOfFrames

Declaration

private int scrollToBottomInAmountOfFrames

Field Value

Type	Description
int

timeVisible

Declaration

private float timeVisible

Field Value

Type	Description
float

timeVisibleInitial

Declaration

private float timeVisibleInitial

Field Value

Type	Description
float

timestampLastInteraction

Declaration

private float timestampLastInteraction

Field Value

Type	Description
float

Methods

AddLogEntry(string, EntryType)

Adds a log entry to the log.

Declaration

public void AddLogEntry(string text, LogUIHandler.EntryType type)

Parameters

Type	Name	Description
string	text	The text to log.
LogUIHandler.EntryType	type	The type of the log entry.

AddLogEntry(string, EntryType, bool, bool)

Adds a log entry to the log.

Declaration

protected void AddLogEntry(string text, LogUIHandler.EntryType type, bool showNumberOfEntry, bool useOldPrefab = false)

Parameters

Type	Name	Description
string	text	The text to log.
LogUIHandler.EntryType	type	The type of the log entry.
bool	showNumberOfEntry	True if the number of the entry should be shown.
bool	useOldPrefab	True if the old prefab which does not support multiline should be used. Recommendation: Keep this at false.

AddWelcomeMessage()

Adds the log entries making up the welcome message so that the log is not empty.

Declaration

private void AddWelcomeMessage()

ButtonPressed_ClearLog()

The user pressed the clear log button. Delete all log entries.

Declaration

public void ButtonPressed_ClearLog()

ButtonPressed_CollapseLog()

The user pressed the collapse log button. Hide the log panel.

Declaration

public void ButtonPressed_CollapseLog()

ButtonPressed_ExpandLog()

The user pressed the expand log button. Show the log panel.

Declaration

public void ButtonPressed_ExpandLog()

GetLogElementTMPHeader(GameObject)

Returns the TMP UGUI for the header.

Declaration

private TextMeshProUGUI GetLogElementTMPHeader(GameObject logElement)

Parameters

Type	Name	Description
GameObject	logElement

Returns

Type	Description
TextMeshProUGUI

GetLogElementTMPText(GameObject)

Returns the TMP UGUI for the text.

Declaration

private TextMeshProUGUI GetLogElementTMPText(GameObject logElement)

Parameters

Type	Name	Description
GameObject	logElement

Returns

Type	Description
TextMeshProUGUI

GetLogElementTextMeshProUGUI(GameObject, int)

Returns the first/second/third/etc... found TMP UGUI in the child elements of the log element. Index starting at 1.

Declaration

private TextMeshProUGUI GetLogElementTextMeshProUGUI(GameObject logElement, int firstSecondEtc)

Parameters

Type	Name	Description
GameObject	logElement
int	firstSecondEtc

Returns

Type	Description
TextMeshProUGUI

Hide()

Hides the log.

Declaration

public void Hide()

InitLog()

Initializes the log and writes some welcome message.

Declaration

private void InitLog()

ScrollToBottom()

Scrolls to the bottom of the log. We call this method after some very small number of frames because Unity needs to update some internal UI stuff before the sizes of the UI elements are in the system.

Declaration

public void ScrollToBottom()

Show(bool, bool)

Shows the log.

Declaration

public void Show(bool scrollDown, bool keepVisible)

Parameters

Type	Name	Description
bool	scrollDown	True if the log should scroll down.
bool	keepVisible	True if the log should be kept visible, false if it should disappear automatically after some time.

Start()

Declaration

public void Start()

Update()

Update loop for the log UI, called each frame.

Declaration

public void Update()