 |
TilePlus Version 5
Unity3D Tilemap Extension
|
|
TilePlus Version 5
Unity3D Tilemap Extension
|
Classes | |
| class | ActionToTilePacket |
| A packet used to tell a tile that a user has clicked on it. See TpInputActionToTile component and TpActionToTile S.O. classes. More... | |
| class | AnimatorControlPacket |
| A message packet with an info for an animator. More... | |
| class | AnimStateTilePingerBase |
| Use as a state machine behaviour to notify a TPT tile, e.g. a TpZoneAnimator. TpZoneAnimator pokes its instance ID into the animator as a parameter (called 'id'). Other uses of this class require a similar setup. More... | |
| class | AssetGuidPositionHash |
| used for quick HashSet lookups to see if an asset has already been loaded using a particular offset. More... | |
| class | BezierCurve |
| Create a Bezier curve with up to 16 points. More... | |
| class | BoolPacket |
| Simple packet with just a boolean value. More... | |
| class | BundleGuidMap |
| Stores the positions and TPT tile GUIDs for a Bundle. More... | |
| struct | CustomGuiReturn |
| Used to provide the return value from methods tagged with TptShowCustomGUI. More... | |
| class | EmptyPacket |
| Empty class to use when a placeholder is needed. More... | |
| interface | IActionPlugin |
| Used with ZoneActions and EventActions to provide a way to have a second asset (typ, a Scriptable Obj but can be any UnityEngine.Object) be inspectable thru the IMGUI tile editor (selection inspector). Note that the asset ought to be a PROJECT asset and NOT a SCENE object, although this is not enforced or checked. More... | |
| interface | IChunkSelector |
| Interface IChunkSelector. More... | |
| interface | IHoverableControl |
| This marks a tile as accepting BoolPackets for New Input System hover events. When used for zones, the packet value is true when a zone is entered or false when the zone is exited. More... | |
| interface | IScriptableService |
| This interface lets TpLib's update pump (TpLibTasks) know what to update (not all SRS' need it) and if the SRS is ready to update (may not need it). Default is no updating and an empty Update method. It's also used to indicate if messages can be sent to the Service as well as what types of messages as well as indicating if this service should persist thru scene changes. More... | |
| interface | ITilePlus |
| All tiles that want to use the special features of TilePlus Toolkit like the Tile+Brush and Tile+Painter need to implement this interface. NOTE: ensure that the methods and properties that are in the UNITY_EDITOR section below are placed in similarly-demarked regions in your code. Also be sure to provide backing fields for properties (if appropriate) to ensure serialization. More... | |
| interface | ITpMessaging< in T > |
| Interface for using TpLib SendMessage methods. More... | |
| interface | ITpPersistence< out TR, in T > |
| Interface for built-in data save/restore scheme. More... | |
| interface | ITpPersistenceBase |
| this is used to detect tiles that want to use this persistence scheme. It allows looking for tiles that implement this base interface without having to specify the in and out types. More... | |
| interface | ITpSpawnUtilClient |
| Contract for tiles that spawn prefabs or paint tiles and want to use methods in TpSpawner. More... | |
| interface | ITpUiControl |
| Interface to Tiles set up as UiControls. More... | |
| interface | ITSceneInitializer |
| Interface to use for TSceneInitilizers. More... | |
| interface | IZoneActionTarget |
| Apply this interface to a tile if it should respond to a ZoneAction as a target. Note that this inteface inherits from a particular ITpMessaging interface. More... | |
| class | LoadWrapper |
| A wrapper for AssetRegistration saves. More... | |
| class | MessagePacket< T > |
| Abstract base class for message packets. More... | |
| class | MessagingContext |
| Used by the TpMessaging Service in its context stack. Pooled. More... | |
| class | ObjectPacket |
| This is a 'union' of the most likely Types of objects one might like to send. For the UnityObject and object values the type is is available. The optional info string can be used to provide context (ie target switching actions based on what the string is), debug info, or left empty. More... | |
| class | PerkinsStringUtils |
| String utilities. More... | |
| class | PositionPacket |
| Common message packet for a Vector3Int position to a tile. More... | |
| class | PositionZmPacket |
| PositionPacket with Zone Manager reference. More... | |
| class | SaveDataWrapper |
| A simple wrapper class for saving data. More... | |
| class | ScriptableRuntimeService< T > |
| Simple and simplistic base class for Runtime Services. "Scriptable Runtime Service" or SRS. More... | |
| class | SetDontDestroy |
| Simple component to set HideFlags to HideFlags.DontSave. More... | |
| class | SlideShowSaveData |
| Data object for slideshow tile. More... | |
| class | StandardEventData |
| Used for EventAction data. TilePlusBase.EventActionObject More... | |
| class | StringPacket |
| Common message packet for a string sent to a tile. E.G., a JSON string for the tile to expand and use to restore data. Note that there's a pool for these in TpMessaging. More... | |
| class | TemplateSelectorQueryResults< T > |
| Used for return values for TpChunkTemplateSelector.GetTilePlusTilesOfType. More... | |
| class | TileFabLib |
| Utilities for Tilefab loading. More... | |
| class | TileFabLoadParams |
| Parameter list items for using LoadTileFabs(List<TileFabLoadParams> loadParams, ref List<TilefabLoadResults> loadResultsList) INTENTIONALLY not serializable since contents are not completely serializable. More... | |
| class | TilefabLoadResults |
| Results from using LoadImportedTilefab. More... | |
| class | TilemapParallax |
| Simple Tilemap Parallax. More... | |
| class | TilePlusBase |
| This is a base class for any TilePlus Tile. It implements all of the interfaces required by ITilePlus, with many virtual methods so you can override to add functionality as desired. It's inadvisable to change anything in this file. More... | |
| class | TilePlusPrefabSpawnerItem |
| specification for spawning a prefab More... | |
| class | TpAniClip |
| specification for a single animation clip More... | |
| class | TpAnimatedSpawner |
| (New in Version 3.1) Base class for a simple Animated spawner Note that the position of the prefab is dictated by the position and positionIsRelative fields of the items in the prefab list. As written, spawned GOs are parented to the same tilemap as the Tile. More... | |
| class | TpAnimatedTile |
| Simple version of an animated tile that works with TilePlus. More... | |
| class | TpAnimatorAction |
| -—BASE CLASS-— This is used by TpZoneAnimator to provide customization. More... | |
| class | TpAnimZoneLoader |
| Zone-based tileset loader class. More... | |
| class | TpAnimZoneSpawner |
| Animated zone spawner/painter tile class. More... | |
| class | TpBundleLoader |
| A component that can be added to a Tilemap's GameObject that loads a tilemap archive Bundle. More... | |
| class | TpBundleTile |
| A proxy for a TpTileBundle. Overwrites itself with the Bundle when painted. More... | |
| class | TpChunkedSceneManager |
| A Scene Manager component for Tilemaps when used with the templating system (TileFabLib/TpZoneManager/TpZoneLayout). More... | |
| class | TpChunkSelectorBase |
| Not for use, just a concrete base class. More... | |
| class | TpChunkZoneSelector |
| A specialized ChunkSelector that uses the Chunkified data in Bundles to fill in empty areas in the ZoneLayout. More... | |
| class | TpEasingFunction |
| class | TpEvents |
| Events library for TilePlus tiles. More... | |
| class | TpFabLoader |
| A component that can be added to a GRID's GameObject for loading an entire TileFab. Note that the names or tags of the Tilemaps need to match the names or tags embedded in the TileFab or this will not work. More... | |
| class | TpFlexAnimatedTile |
| FlexAnimated Tiles are animated tiles using animation clips from an asset. Several animation sequences can be set up and selected at runtime. Animation can be started and stopped at runtime. More... | |
| class | TpGoTween |
| Simple tweener to attach to a GameObject Other examples in demo folder. More... | |
| class | TpGoTweenSequence |
| Create and play a sequence. More... | |
| class | TpGoTweenSpec |
| Tween specs list for GameObject tweens. More... | |
| class | TpGuidToAction |
| Send an ActionToTile message to a tile with a specfic GUID. More... | |
| class | TpImmortalizer |
| TpImmortalizer tiles may be painted into a Zone (ie a square area of a particular size eg 8x8, 16x16 etc) to mark that Zone as Immortal when used with the Layout system. Note that this tile is a convenience, but the implementation is part of your app, see the ChunkingDemo for an example. More... | |
| class | TpLib |
| This static class maintains edit-time and run-time dictionaries which track TilePlusBase items on a per-tilemap basis. In-Editor, heirarchy and tilemap changes are tracked and dictionaries are updated as necessary. More... | |
| class | TpLibInit |
| TpLib runtime init. Asset must be in a Resources/Tp folder WARNING: if more than one of these exists in Resources then the first one found is used!! More... | |
| class | TpLibMemAlloc |
| This class is used when reallocating data structure sizes in TpLib. See TpLib.Resize. More... | |
| class | TpMessaging |
| Library of tile messaging methods. Note that it's a Service. More... | |
| class | TpNote |
| A way to add a note to a stack of components Can also be used to add tags to game objects. More... | |
| class | TpPrefabList |
| an asset with prefabs to spawn More... | |
| class | TpPrefabMarker |
| Marks this Prefab as created by the TilePlus Prefab Bundler. Loads tilefabs when a prefab is dragged-in or viewed in a Stage (in-editor), or when instantiated at runtime. Should be placed on the Tilemaps' parent Grid's GameObject. More... | |
| class | TpServiceManager |
| Manages Runtime Scriptable Services. Registration, queries, diagnostics. More... | |
| class | TpSingleFabChunkSelector |
| Base-class for Chunk Selectors as used by TpZoneLayout. This just returns the same TileFab each time. More... | |
| class | TpSlidesClip |
| Specification for a slideshow. More... | |
| class | TpSlideShow |
| Show a sprite at a time. Not animation. More... | |
| class | TpSlideShowSpriteSet |
| An asset with a set of slide show clips. More... | |
| class | TpSpawner |
| Pooled spawner for TilePlus system. More... | |
| class | TpSpawnLink |
| simple class that exists to provide context for a spawned prefab. Includes init after spawn, despawning, optional auto-destroy feature, etc., and an optional Note/Tag field. More... | |
| class | TpSpriteAnimationClipSet |
| An asset with sprites to animate. More... | |
| class | TptAttributeBaseAttribute |
| This is the base class for all Tpt attributes except ShowAsLabelBrushInspector. More... | |
| class | TpTileBundle |
| An asset used to bundle-up tiles for later re-creation. Since Transforms, Colors, and Flags values are often the same, those are indexed to save space. Note this is a partial class. More... | |
| class | TpTileEventAction |
| -—BASE CLASS ONLY-— Assets of this type are added as refs to TPT tiles. Takes an action when a TileEvent is evaluated by a controlling program. Such a program can, when handling events, see if there's a ref to one in a tile and execute its code. Moves code from center to edges. More... | |
| class | TpTileFab |
| Class used when bundling tilemaps/grids. More... | |
| class | TpTileList |
| A list of tilespawneritems. More... | |
| class | TpTilePositionDb |
| A Scriptable Runtime Service implementing a mini-database of occupied positions on Tilemaps. More... | |
| class | TpTileUtils |
| Some static utility methods for tile math. More... | |
| class | TpTileZoneAction |
| Assets of this type are added as refs to TilePlus tiles. More... | |
| class | TptNoteAttribute |
| 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... | |
| class | TptShowAsLabelBrushInspectorAttribute |
| This attribute can be used in Tile classes to affect what is displayed in the Tile+Brush Brush inspector (ie in the palette). For a field or property, the value returned is displayed with ToString, so whatever you tag with this must have a ToString() method. This isn't an issue for most types of fields or properties that you might use, but keep it in mind. Sometimes you can create a property just to show it as a label, based on other values in your Tile class. More... | |
| class | TptShowAsLabelSelectionInspectorAttribute |
| This attribute can be used in Tile classes to affect what is displayed in the Tile++Brush selection inspector. For a field or property, the value returned is displayed with ToString, so whatever you tag with this must have a ToString() method. This isn't an issue for most types of fields or properties that you might use, but keep it in mind. Sometimes you can create a property just to show it as a label, based on other values in your Tile class. More... | |
| class | TptShowCustomGUIAttribute |
| This attribute is used to provide customGUI for a tile class. note that the method needs to be: [TptShowCustomGUI] public CustomGuiReturn BaseGui(GUISkin skin, Vector2 buttonSize, bool inPrefab) The return value should be an instance of CustomGuiReturn. See TilePlusBase, TpFlexAnimatedTile, etc for an example. NOTE access has to be public or protected. More... | |
| class | TptShowEnumAttribute |
| This attribute can be used in Tile classes to affect what is displayed in the Tile++Brush selection inspector. This is used to show Enums in a pop-up. More... | |
| class | TptShowFieldAttribute |
| This attribute can be used in Tile classes to affect what is displayed in the Tile++Brush selection inspector. More... | |
| class | TptShowMethodAsButtonAttribute |
| This attribute is used to display an invoke button for a method. Note that if the access type for the method isn't public or protected then it'll be ignored. More... | |
| class | TptShowObjectFieldAttribute |
| This attribute can be used in Tile classes show an object field. More... | |
| class | TpTween |
| Data structure for a tween. More... | |
| class | TpTweener |
| Tweener/Sequencer Scriptable Runtime Service (SRS) More... | |
| class | TpTweenerFlexTile |
The most flexible Tweener tile: set up the effect right in the TilePlus Selection inspector. It's handy to have so that you can play with all the settings easily. However, the Tweener tiles that use an asset are much more useful. See: TpTweenSpecTile
Note that there are no messaging interfaces specified for this tile but ofc you can subclass it and add what you need or you can call PlayTween directly from code. More... | |
| class | TpTweenerSubObject |
| This is a sub-object to be added to Event and/or Zone actions. This can be used as a base class. The implementation here plays a sequence. More... | |
| class | TpTweenSequence |
| Describes a sequence for use with TpTweener. More... | |
| class | TpTweenSpec |
| Tween specs list for Tpt tiles. More... | |
| class | TpTweenSpecSequenceTile |
| This tweener tile plays a sequence using a TweenSpec asset for all the tweens. Here, the entirety of the list of tweens in the asset is used. However, note that in CreateSequenceFromSpec its possible to provide a list of indices into that asset's list of tweens so that you can customize the way this works in a subclass if you like. More... | |
| class | TpTweenSpecTile |
| This Tweener tile uses a TweenSpec asset. What is that? It's just a list of params for setting up tweens. Since most of the time one uses the same tweens over and over this approach is much more useful than specifying the tween in the tile asset itself as is done in TpTweenerFlexTile. More... | |
| class | TpUiButtonEventAction |
| Simple Event Action for use with UiButtonTile and UiAnimButtonTile. More... | |
| class | TpZoneActionRadio |
| Customized Zone Action to implement Radio Buttons. More... | |
| class | TpZoneAnimator |
| This tile spawns one or more prefabs and can control animation. More... | |
| class | TpZoneLayout |
| This is a simple chunking system based on TileFabs. More... | |
| class | TpZoneManager |
| TpZoneManager is used to manage square areas of tilemaps called Zones. More... | |
| class | TpZoneManagerLib |
| Utility methods for working with the Zone Manager. More... | |
| class | TSceneInitializer |
| -—BASE CLASS-— More... | |
| class | TSceneList |
| A Set of TScenes for the templating system (TileFabLib/TpZoneManager/TpZoneLayout). More... | |
| class | UiAnimButtonTile |
| Implements a button with hover. Can be a toggle or momentary. REQUIRES a clipset with THREE animations whose names match those provided in this instance. Note that the inactive animation can be just one tile if that works for you. If the tile's sprite or default sprite are not the same as the single sprite that may or may not be what you want. Once animation begins it's not possible to return to the default sprite, so the "Inactive" animation is used. More... | |
| class | UiAsciiCharTile |
| Tile that shows ASCII characters (i=32 and up) More... | |
| class | UiAsciiStringTile |
| This tile is only a zone. Arrange a seres of UiAsciiCharTiles in a rectangular array (1 col and N rows, or 1 row and N columns or N columns and M rows) and add a UiAsciiStringTile. Using the AsciiStringTile's Zone controls, draw a zone around the array of AsciiCharTiles. This is easy to do using Painter or Tile+Brush. – Now the AsciiStringTile is a controller for all of the AsciiChar tiles. At runtime, write strings to the AsciiStringTile and it'll treat the AsciiCharTiles as a group and place the string characters in the proper locations, with simple left, center, or right justification. o - ONLY left-to-right is supported. o - DOES NOT support editing. 0 - DOES NOT support sparse arrays of AsciiCharTiles: the entire zone must be filled with tiles. If not, you're adding spaces. The array of tiles can be a horizontal row, a vertical column, or a box. This tile assumes that the ASCII char tiles are on the same tilemap. If not, see UpdateTiles(). More... | |
| class | UiButtonTile |
| Implements a UI momentary button. Unlike UiToggleButtonTile, all that happens here is a color change. Simpler to understand. More... | |
| class | UiHoverZone |
| A hoverable but not clickable zone. More... | |
| class | UiRadioButtonTile |
| Subclass of SlideShow to create a radio button. More... | |
| class | UiToggleButtonTile |
| customized slide show tile implementing a Toggle or Momentary button. UNLIKE UiButtonTile, the alternate state is a different SlideShow image. In ButtonTile the Color is changed. More... | |
| class | WantsEarlyUpdate |
| If a tile implements this then it will get Early Updates. See TpLibTasks. More... | |
| class | ZoneReg |
| Specification for individual items in the "breadcrumbs" list. Info in here is used for TileFab loading/persistence and for Chunking. There is one of these for each TileFab loaded. The names may seem odd but they're short in order to keep the file size shorter. More... | |
Enumerations | |
| enum | SpaceMode { None , SpaceBefore , SpaceAfter , SpaceBoth , LineBefore , LineAfter , LineBoth } |
| Control visual appearance of each item. More... | |
| enum | ShowMode { Always , InPlay , NotInPlay , Property } |
| Control how this item is shown. More... | |
| enum | FabOrBundleLoadFlags { None = 0 , OverrideNone = 4096 , LoadPrefabs = 1 , ClearPrefabs = 2 , ClearTilemap = 4 , ForceRefresh = 8 , NewGuids = 16 , FilterOnlyTilePlusTiles = 32 , NoClone = 64 , MarkZoneRegAsImmortal = 128 , Chunkified = 256 , SingleChunkBundle = 512 , NormalWithFilter = LoadPrefabs | NewGuids | FilterOnlyTilePlusTiles , Normal = LoadPrefabs | NewGuids , ChunkifiedDefault = LoadPrefabs | Chunkified | FilterOnlyTilePlusTiles } |
| Options for LoadTileFab and LoadBundle. More... | |
| enum | FabOrBundleFilterType { Prefab , TilePlus , Unity } |
| Tells a TileFab/Bundle load filter what data it has been given. More... | |
| enum | UiEffect { None = 0 , BumpSize = 1 , BumpColor = 2 , BumpRotation = 4 , BumpPosition = 8 , All = BumpSize | BumpColor | BumpRotation | BumpPosition } |
| Control Effect type. Details depend on control implementation. More... | |
| enum | NumTileWithInterfaceFilterResult { Fail , Pass , PassAndQuit } |
| Return values for filter used in NumTileWithInterface. More... | |
| enum | OnTypeOrTagChangedVariety { Type , Tag } |
| Value passed when TpLib OnTypeOrTagChanged event fires. More... | |
| enum | TpLibChangeType { Added , AddedToEmptyMap , Deleted , Modified , ModifiedOrAdded , TagsModified } |
| When the OnTpLibChanged event fires, this param is the type of change that occurred. More... | |
| enum | SpriteClearMode { Ignore , ClearInSceneView , ClearOnStart , ClearInSceneViewAndOnStart } |
| SpriteClearMode: ClearInSceneView: the tile sprite is cleared during edit time Note that the tile itself is still present, just not visible. Why do this? You can have a tile showing in the palette but when placed you don't want to see it anymore, ie you're only using the tile's sprite so you can see something in the palette. You could for example have a sprite that's some text like "waypoint" so it'd display that in the palette but not appear after the tile is placed. Useful w/ prefabs. ClearOnStart: Clears the sprite when the app begins ClearInSceneViewAndOnStart = ClearInSceneView + ClearOnStart. More... | |
| enum | ColliderMode { NoOverride , Sprite , Grid , NoCollider } |
| Force the tile sprite collider mode. More... | |
| enum | TilePlusState { Asset , Clone , Locked } |
| Indicates the state of the tile. More... | |
| enum | TileResetOperation { MakeLockedAsset , MakeNormalAsset , UnlockAndClone , MakeCopy , SetCloneState , ClearGuid , ResetLocalState , Restore } |
| how is this tile being reset? More... | |
| enum | OversizeSpriteMode { Ignore , Auto , Manual } |
| How to handle oversize sprites, if at all. More... | |
Options for LoadTileFab and LoadBundle.
| Enumerator | |
|---|---|
| None | No flags used. |
| OverrideNone | Use this in a TSceneSpec to indicate clearing all the Selector flags. |
| LoadPrefabs | Load Prefabs. Normally true. |
| ClearPrefabs | Clear Prefabs. Normally false. |
| ClearTilemap | Clear Tilemap. Normally false. |
| ForceRefresh | Force Refresh. Normally false. |
| NewGuids | New GUIDs for TilePlus tiles. Normally true. |
| FilterOnlyTilePlusTiles | Apply filtering only to TilePlus tiles. Normally true. |
| NoClone | Do not clone TPT tiles in TpTileBundle.Tileset. This normally ONLY used when in the Editor for previews and other such internal operations. If used when doing any sort of tilefab loading you'll have all sorts of problems. To that end, this flag does nothing when in a built app or in editor-play mode. |
| MarkZoneRegAsImmortal | Mark a Zone Reg as immortal. Note: ONLY valid when using ZoneManager and Layouts. |
| Chunkified | Indicates to TileFabLib.LoadTilefab that this load is from a Chunkified bundle and the raw tile data is already cached. Note that this doesn't include any prefabs. Those still must be instantiated. |
| SingleChunkBundle | Indicates to a bundle that it's a single-chunk bundle for use in the Layout system. If this is set, a cached TCD is used and no possibility for GUID updates. Clone tiles are re-cloned. Assumes NO filtering. |
| NormalWithFilter | Most common set of options, with filtering only TPT tiles. |
| Normal | Most common set of options, with filtering for anything (if a filter is provided) |
| ChunkifiedDefault | Default for Chunkified loads: see TSceneList. |
Value passed when TpLib OnTypeOrTagChanged event fires.
| Enumerator | |
|---|---|
| Type | A TYPE has changed. |
| Tag | A TAG has changed. |
| enum TilePlus.ShowMode |
| enum TilePlus.SpaceMode |
SpriteClearMode: ClearInSceneView: the tile sprite is cleared during edit time Note that the tile itself is still present, just not visible. Why do this? You can have a tile showing in the palette but when placed you don't want to see it anymore, ie you're only using the tile's sprite so you can see something in the palette. You could for example have a sprite that's some text like "waypoint" so it'd display that in the palette but not appear after the tile is placed. Useful w/ prefabs. ClearOnStart: Clears the sprite when the app begins ClearInSceneViewAndOnStart = ClearInSceneView + ClearOnStart.
how is this tile being reset?
| Enumerator | |
|---|---|
| MakeLockedAsset | Want to make a locked asset. |
| MakeNormalAsset | Want to make a normal asset. |
| UnlockAndClone | Unlock a tile and clone it. |
| MakeCopy | Used when a clone tile is being duplicated. |
| SetCloneState | Used to force a TPT tile into the clone state from the asset state. Use with caution! |
| ClearGuid | Clear the GUID. |
| ResetLocalState | Reset the normal state vars like ParentTilemap, TileGridPosition, etc. summary> op=Restore is used only in editor mode, when picked tiles are painted. As the picked tiles are moved around the map, their Startup is called many times by Editor code, placing incorrect grid position and possible incorrect map refs in m_TileGridPosition and m_ParentTilemap. Restore uses the saved values in TpLib's TileIdToTile dictionary to restore the proper values. Only used in TilePlusBase implementations but might be of use in other situations. |
| Restore | |
When the OnTpLibChanged event fires, this param is the type of change that occurred.
| Enumerator | |
|---|---|
| Added | A TilePlus tile was added. |
| AddedToEmptyMap | A TilePlus tile was added to a previously-empty tilemap. |
| Deleted | A tile (any sort of tile) was deleted. |
| Modified | A tile (any sort of tile) was modified. |
| ModifiedOrAdded | Something was either modified or added. ONLY for Tile or TileBase class instances Note that position will be invalid. |
| TagsModified | Tags were modified. |
| enum TilePlus.UiEffect |
Control Effect type. Details depend on control implementation.
1.14.0