TilePlus.TptNoteAttribute Class Reference

Add a note to a field or method. Choice of embedding a string or using a property to provide the string. Always displayed as a 'helpbox' above the field or method button. More...

Inheritance diagram for TilePlus.TptNoteAttribute:

Collaboration diagram for TilePlus.TptNoteAttribute:

Public Member Functions
	TptNoteAttribute (bool useProperty, string noteOrProperty, bool isWarning=false)
	Ctor.

Public Attributes
readonly bool	m_UseProperty
	true if a property is used to provide the note.
readonly string	m_NoteOrProperty
	The name of the property providing the string or the string if m_UseProperty is false.
readonly bool	m_IsWarning
	Use 'Warning' style messagebox if true.

Detailed Description

Add a note to a field or method. Choice of embedding a string or using a property to provide the string. Always displayed as a 'helpbox' above the field or method button.

Selection Inspector ONLY, ALWAYS hidden in Play mode

Constructor & Destructor Documentation

TptNoteAttribute()

TilePlus.TptNoteAttribute.TptNoteAttribute	(	bool	useProperty,
		string	noteOrProperty,
		bool	isWarning = false )

Ctor.

Parameters

useProperty	If true, 'noteOrProperty' is the name of a public property that will provide the string to display
noteOrProperty	The note or the name of a property that will provide the note.
isWarning	If true, a Warning type of messagebox is used to show the string

Member Data Documentation

m_IsWarning

readonly bool TilePlus.TptNoteAttribute.m_IsWarning

Use 'Warning' style messagebox if true.

m_NoteOrProperty

readonly string TilePlus.TptNoteAttribute.m_NoteOrProperty

The name of the property providing the string or the string if m_UseProperty is false.

m_UseProperty

readonly bool TilePlus.TptNoteAttribute.m_UseProperty

true if a property is used to provide the note.

---

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

• /Users/jms/Documents/Tpt_55/TPT55/Assets/Plugins/TilePlus/Runtime/Attributes/TptNoteAttribute.cs