Interface to Tiles set up as UiControls. More...

Inheritance diagram for TilePlus.ITpUiControl:

[legend]

Public Member Functions
void	SetValue (object value, bool withNotify=true)
	Set c# object Value.
bool	RunEffect (UiEffect effectType, float duration, Vector3? endPoint=null, Color? endColor=null)
	Run an effect on the control, if implemented.

Properties
UiEffect	SupportedEffects `[get]`
	Returns a value from the FLAGS enum UiEffect, shows the controls effect capabilities.
int	GetIntValue `[get]`
	Get integer Value.
bool	GetBoolValue `[get]`
	Get bool Value.
object	GetValue `[get]`
	Get c# object Value.
string	GetStringValue `[get]`
	Get string value.
char	GetCharValue `[get]`
	Get value as a character.
bool	AcceptsClicks `[get]`
	Does this tile accept clicks?
bool	AcceptsHover `[get]`
	Does this tile accept hover?

Detailed Description

Interface to Tiles set up as UiControls.

Member Function Documentation

◆ RunEffect()

bool TilePlus.ITpUiControl.RunEffect	(	UiEffect	effectType,
		float	duration,
		Vector3?	endPoint = null,
		Color?	endColor = null )

Run an effect on the control, if implemented.

Parameters

effectType	Value from UiEffect enum
duration	duration of the effect.
endPoint	endpoint for V3 type effects
endColor	endpoint for Color type effects

Returns: false if unimplemented.

◆ SetValue()

void TilePlus.ITpUiControl.SetValue	(	object	value,
		bool	withNotify = true )

Set c# object Value.

Parameters

value	c# object (or boxed UnityEngine.Object) value
withNotify	permit notification if appropriate

Property Documentation

◆ AcceptsClicks

bool TilePlus.ITpUiControl.AcceptsClicks

get

Does this tile accept clicks?

◆ AcceptsHover

bool TilePlus.ITpUiControl.AcceptsHover

get

Does this tile accept hover?

◆ GetBoolValue

bool TilePlus.ITpUiControl.GetBoolValue

get

Get bool Value.

◆ GetCharValue

char TilePlus.ITpUiControl.GetCharValue

get

Get value as a character.

Implemented in TilePlus.UiButtonTile.

◆ GetIntValue

int TilePlus.ITpUiControl.GetIntValue

get

Get integer Value.

◆ GetStringValue

string TilePlus.ITpUiControl.GetStringValue

get

Get string value.

◆ GetValue

object TilePlus.ITpUiControl.GetValue

get

Get c# object Value.

◆ SupportedEffects

UiEffect TilePlus.ITpUiControl.SupportedEffects

get

Returns a value from the FLAGS enum UiEffect, shows the controls effect capabilities.

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

/Users/jms/Documents/Tpt_55/TPT55/Assets/Plugins/TilePlus/Runtime/Interface/ITpUiControl.cs

Public Member Functions

Properties