Skip to content
Jack Brookes edited this page Oct 31, 2020 · 1 revision

UXF.UI.NotesController

A script to control the NotesPanel


Fields

None

Properties

None

Methods

UXF.UI.DownloadOrCopyHandler.IsCompatibleWith(UnityEditor.BuildTargetGroup)

Returns true if this data handler is definitley compatible with this build target.

Parameters

  • buildTarget:

UXF.UI.DownloadOrCopyHandler.IsIncompatibleWith(UnityEditor.BuildTargetGroup)

Returns true if this data handler is definitley incompatible with this build target.

Parameters

  • buildTarget:

UXF.UI.ClickOutsidePanelEvent.HideIfClickedOutside()

Invokes an event if a mouse click was made outside the bounds of the UI the script is attached to

Parameters

None

UXF.UI.ClickOutsidePanelEvent.CheckVisible()

Check if the GameObject the script is attached to is visible in the scene - If there is no parent canvas, the GameObject has to be active in the hierarchy - If there is a parent canvas, the canvas has to be enabled and the GameObject active in the hierarchy

Parameters

None

UXF.UI.DraggableUI.CalculateNewTransformOffset(UnityEngine.Vector2)

Clamps a mouse delta from the OnDrag event to ensure the dragged UI stays within the screen

Parameters

  • mouseDelta: Mouse delta from the onDrag event

UXF.UI.ExperimentProfileSelector.Awake()

Awake is called when the script instance is being loaded.

Parameters

None

UXF.UI.ExperimentProfileSelector.Start()

Start is called on the frame when a script is enabled just before any of the Update methods is called the first time.

Parameters

None

UXF.UI.ExperimentProfileSelector.OnDestroy()

This function is called when the MonoBehaviour will be destroyed.

Parameters

None

UXF.UI.CheckboxElementSetup.Awake()

Awake is called when the script instance is being loaded.

Parameters

None

UXF.UI.DropDownElementSetup.Awake()

Awake is called when the script instance is being loaded.

Parameters

None

UXF.UI.TextElementSetup.OnValidate()

Called when the script is loaded or a value is changed in the inspector (Called in the editor only).

Parameters

None

UXF.UI.TextElementSetup.Awake()

Awake is called when the script instance is being loaded.

Parameters

None

UXF.UI.InfoBarController.Awake()

Awake is called when the script instance is being loaded.

Parameters

None

UXF.UI.InfoBarController.OnValidate()

Called when the script is loaded or a value is changed in the inspector (Called in the editor only).

Parameters

None

UXF.UI.LocalDirectorySelector.Awake()

Awake is called when the script instance is being loaded.

Parameters

None

UXF.UI.LocalDirectorySelector.Start()

Start is called on the frame when a script is enabled just before any of the Update methods is called the first time.

Parameters

None

UXF.UI.LocalDirectorySelector.OnDestroy()

This function is called when the MonoBehaviour will be destroyed.

Parameters

None

UXF.UI.NotesController.AddNewNote()

Instantiates a new note prefab with the text currently in the new note input field

Parameters

None

UXF.UI.NotesController.MoveScrollbarToBottom()

Starts a coroutine that yields 1 frame to allow the canvas to update, and then moves the notes scroll rect to the latest element added

Parameters

None

UXF.UI.NotesController.ToggleVisibility()

Performs actions when the NotePanel is turned off and on

Parameters

None

UXF.UI.NotesController.WriteNotes(UXF.Session)

Writes the session notes to a json file. File includes whether the session is marked as bad and any note added by the experimenter

Parameters

None

UXF.UI.NotesController.ResetNotes()

Reset the notes panel to default values

Parameters

None

UXF.UI.PPIDRandomGenerator.Awake()

Awake is called when the script instance is being loaded.

Parameters

None

UXF.UI.UIController.OnValidate()

Called when the script is loaded or a value is changed in the inspector (Called in the editor only).

Parameters

None

UXF.UI.UIController.Awake()

Awake is called when the script instance is being loaded.

Parameters

None

UXF.UI.UIController.Start()

Start is called on the frame when a script is enabled just before any of the Update methods is called the first time.

Parameters

None


Note: This file was automatically generated

๐Ÿง  Core topics

โ“ More help


๐Ÿ‘ฉโ€๐Ÿ’ป Programming reference

Unit tests

Clone this wiki locally