TilePlus.CustomGuiReturn Struct Reference

Used to provide the return value from methods tagged with TptShowCustomGUI. More...

Public Member Functions
	CustomGuiReturn (bool refresh, bool delaySceneSave=false, string modifiedField=null)
	Ctor.

Public Attributes
readonly bool	m_Refresh
	Refresh the tile?
readonly bool	m_DelaySceneSave
	Save the scene?
readonly string	m_ModifiedField
	Any modified fields? If the field had a TPT tag then put the field name here so that inspectors will refresh.

Detailed Description

Used to provide the return value from methods tagged with TptShowCustomGUI.

Note that TilePlusBase has the property 'NoActionRequiredCustomGuiReturn' which is a do-nothing return value. That is, don't refresh, save the scene, or update any fields.

Constructor & Destructor Documentation

CustomGuiReturn()

TilePlus.CustomGuiReturn.CustomGuiReturn	(	bool	refresh,
		bool	delaySceneSave = false,
		string	modifiedField = null )

Ctor.

Parameters

refresh	cause a tile refresh
delaySceneSave	cause a delayed scene save
modifiedField	specify any modified field. If null, string.Empty is substituted.

Member Data Documentation

m_DelaySceneSave

readonly bool TilePlus.CustomGuiReturn.m_DelaySceneSave

Save the scene?

m_ModifiedField

readonly string TilePlus.CustomGuiReturn.m_ModifiedField

Any modified fields? If the field had a TPT tag then put the field name here so that inspectors will refresh.

m_Refresh

readonly bool TilePlus.CustomGuiReturn.m_Refresh

Refresh the tile?

---

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

• /Users/jms/Documents/Tpt_55/TPT55/Assets/Plugins/TilePlus/Runtime/StaticLib/ClassesEnums/CustomGuiReturn.cs