TilePlus Version 5
Unity3D Tilemap Extension
Loading...
Searching...
No Matches
TilePlus.TptShowFieldAttribute Class Reference

This attribute can be used in Tile classes to affect what is displayed in the Tile++Brush selection inspector. More...

Inheritance diagram for TilePlus.TptShowFieldAttribute:
Collaboration diagram for TilePlus.TptShowFieldAttribute:

Public Member Functions

 TptShowFieldAttribute (float rangeMin=0, float rangeMax=0, SpaceMode spaceMode=SpaceMode.None, ShowMode showMode=ShowMode.Always, string visibilityProperty="", bool updateTpLib=false, bool forceFieldInPlay=false)
 Show a field.

Public Attributes

readonly float m_RangeMin
 Minimum value for range.
readonly float m_RangeMax
 Maximum value for range.
readonly bool m_UpdateTpLib
 Optional, for fields only (incl enums/obj field). Use when TpLib needs to be updated. See the m_Tag field in TilePlusBase for example.
readonly bool m_ForceShowField
 Force showing field if showmode.
Public Attributes inherited from TilePlus.TptAttributeBaseAttribute
SpaceMode m_SpaceMode
 Space or draw-line control.
ShowMode m_ShowMode
 Controls how to show the item that the attr is attached to.
string m_VisibilityProperty
 If showMode == Property, the name of a property to control visibility.

Additional Inherited Members

Protected Member Functions inherited from TilePlus.TptAttributeBaseAttribute
 TptAttributeBaseAttribute (SpaceMode spaceMode=SpaceMode.None, ShowMode showMode=ShowMode.Always, string visibilityProperty="")
 Constructor for the Tpt base attribute.

Detailed Description

This attribute can be used in Tile classes to affect what is displayed in the Tile++Brush selection inspector.

Constructor & Destructor Documentation

◆ TptShowFieldAttribute()

TilePlus.TptShowFieldAttribute.TptShowFieldAttribute ( float rangeMin = 0,
float rangeMax = 0,
SpaceMode spaceMode = SpaceMode::None,
ShowMode showMode = ShowMode::Always,
string visibilityProperty = "",
bool updateTpLib = false,
bool forceFieldInPlay = false )

Show a field.

Parameters
rangeMinint/float only - minimum value for range slider. min and max must both be nonzero for sliders to appear.
rangeMaxint/float only - maximum value for range slider. min and max must both be nonzero for sliders to appear.
updateTpLibOptional, for fields only (incl enums/obj field). Use when TpLib needs to be updated. See the m_Tag field in TilePlusBase for example.
forceFieldInPlayForce showing this field in Play: requires ShowMode = InPlay,Always, or Property when eval=true) – Use when you want to force a field to be editable @ runtime. Normally they're forced to plain text helpboxes.

Member Data Documentation

◆ m_ForceShowField

readonly bool TilePlus.TptShowFieldAttribute.m_ForceShowField

Force showing field if showmode.

◆ m_RangeMax

readonly float TilePlus.TptShowFieldAttribute.m_RangeMax

Maximum value for range.

◆ m_RangeMin

readonly float TilePlus.TptShowFieldAttribute.m_RangeMin

Minimum value for range.

◆ m_UpdateTpLib

readonly bool TilePlus.TptShowFieldAttribute.m_UpdateTpLib

Optional, for fields only (incl enums/obj field). Use when TpLib needs to be updated. See the m_Tag field in TilePlusBase for example.


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