Notebook

Edit and show notes for assets and scene UnityEngine.GameObject. More...

Inherits EditorWindow, and IHasCustomMenu.

Public Member Functions
void	AddItemsToMenu (GenericMenu menu)
	Add the window context menu items. More...

Static Public Member Functions
static void	OpenWindow ()
	Open the window. More...
static void	Open (params Object[] targets)
	Open a locked notebook window with the specified targets. More...
static void	Popup (Object target, Vector2 position=default)
	Open a popup notebook window with the specified target. More...
static string	GetNote (Object target)
	Get the note of specified target. More...
static void	SetNote (Object target, string note)
	Set the note of specified target, this'll save asset note when saving project for performance. More...

Public Attributes
bool	locked
	Flag to lock targets or track selection. More...
string	search = ""
	The search filter pattern in the search bar. More...
bool	setting
	Flag to show settings. More...
int	fontSize
	The note font size. More...

Properties
static int	iconOffset [get, set]
	Hierarchy and Project icon offset pixels. More...

Detailed Description

Edit and show notes for assets and scene UnityEngine.GameObject.

Easily comment the project structure to partners, or use it as a todo list. Edit and read the notes with a well readable list and search filter. Switch lock or track to show notes of selected objects, just like the Inspector. Show note icons with custom color and tooltip in the Hierarchy or Project window for quick preview if exist. Persist the scene notes added or changed when playing.

To open:

1. Menu "Window/Notebook" to open.
2. Context menu "Edit Note" in the Hierarchy or Project window to open and lock with the selection.
3. Click the icon in the Hierarchy or Project window to popup the note.
4. Or press "Ctrl" and click it to open a normal locked window.

The window:

1. Context menu "Lock" or the top-right "Lock" icon to switch lock or track selection.
2. Context menu "Scan..." to scan and show the existing notes in the scene or assets.
3. Drag objects into the window to add items if locked.
4. Click the "Out" icon at the right of an item label to remove from the list if locked.

Filter items with the search bar:

1. Input any text to filter the item label or note, e.g., "button" or "#TODO @Boss" if noted.
2. Click "Magnifier" icon to filter notes by tags, e.g., words start with "#" or "@".

Browse notes with well readability:

1. Adjust the font size with the top-right slider, useful for FHD laptop.
2. Click the label to highlight an item, useful for moving eyes between multiple windows.
3. Customize the label and icon color with the left color picker, or set black to use default color.
4. Click the "Aim" icon to ping the noted object or double-click to select it.
5. The text before the first empty line becomes the tooltip in the Hierarchy and Project window.

Instructions:

1. This saves asset notes in AssetImporter.userData, it may conflict with other plugins which use.
2. Then saves scene notes in a Note component, and it's excluded from build by default.

Member Function Documentation

static void OpenWindow ( )

static

Open the window.

static void Open ( params Object[]  targets )

static

Open a locked notebook window with the specified targets.

The targets will be filtered to include assets or UnityEngine.GameObject only. Focus the existing one with the same targets if found, otherwise open new.

Parameters

targets

Targets.

static void Popup ( Object  target, Vector2  position = default  )

static

Open a popup notebook window with the specified target.

The target must be an asset or UnityEngine.GameObject. Optional to set the window position, otherwise use the mouse position if called from the GUI.

Parameters

target	Target.
position	Position.

static string GetNote ( Object  target )

static

Get the note of specified target.

Parameters

target

Target.

Returns

The note.

static void SetNote ( Object  target, string  note  )

static

Set the note of specified target, this'll save asset note when saving project for performance.

Parameters

target	Target.
note	Note.

void AddItemsToMenu

(

GenericMenu

menu

)

Add the window context menu items.

Menu "About" to open the online manual, and "Settings" for common preferences. Menu "New Window" to open another Notebook window. Menu "Lock" to switch lock state, and "Remove Empty Notes" to scan and remove empty Note components.

Menu "Scan All" to lock show all existing scene and asset notes. Menu "Scan Scene" and "Scan Asset" for scene notes or assets, and "Scan Selected" to scan from selection. Scanning will ignore scene notes with HideFlags.HideInHierarchy, or assets with label "Ignore".

Parameters

menu

Menu.

Member Data Documentation

bool locked

Flag to lock targets or track selection.

string search = ""

The search filter pattern in the search bar.

bool setting

Flag to show settings.

int fontSize

The note font size.

Property Documentation

int iconOffset

staticgetset

Hierarchy and Project icon offset pixels.