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

Parameter list items for using LoadTileFabs(List<TileFabLoadParams> loadParams, ref List<TilefabLoadResults> loadResultsList) INTENTIONALLY not serializable since contents are not completely serializable. More...

Collaboration diagram for TilePlus.TileFabLoadParams:

Public Member Functions

 TileFabLoadParams (Tilemap? tileParent, TpTileFab tileFab, Vector3Int offset, TpTileBundle.TilemapRotation rotation, FabOrBundleLoadFlags loadFlags, Dictionary< string, Tilemap > targetMap, Func< FabOrBundleFilterType, BoundsInt, object, bool >? filter=null)
 Ctor.

Public Attributes

bool m_Reserved
 Mark this zone reserved. See ZoneRegistration class.
bool m_Immortal
 Mark this zone as immortal. Zone will never be removed by Layout.
readonly? Tilemap m_TileParent
 Parent Tilemap of Tile, if the request is coming from a tile. Otherwise leave null.
TpTileFab m_TileFab
 The TileFab to load.
readonly Vector3Int m_Offset
 The position to place the TileFab.
readonly TpTileBundle.TilemapRotation m_Rotation
 The rotation to be applied (not implemented)
FabOrBundleLoadFlags m_LoadFlags
 Control Flags. See TileFabLib.
readonly? Func< FabOrBundleFilterType, BoundsInt, object, bool > m_Filter
 The filter, as described in the docs.
Dictionary< string, Tilemap > m_TargetMap
 Mapping from Tilemap Names in the TileFab to Tilemap references in the scene: a speedup.

Properties

bool Valid [get]
 Normally true, but is false if non-parameter constructor used. Indicates an error if false.

Detailed Description

Parameter list items for using LoadTileFabs(List<TileFabLoadParams> loadParams, ref List<TilefabLoadResults> loadResultsList) INTENTIONALLY not serializable since contents are not completely serializable.

Constructor & Destructor Documentation

◆ TileFabLoadParams()

TilePlus.TileFabLoadParams.TileFabLoadParams ( Tilemap? tileParent,
TpTileFab tileFab,
Vector3Int offset,
TpTileBundle.TilemapRotation rotation,
FabOrBundleLoadFlags loadFlags,
Dictionary< string, Tilemap > targetMap,
Func< FabOrBundleFilterType, BoundsInt, object, bool >? filter = null )

Ctor.

Parameters
tileParentParent Tilemap of Tile, if the request is coming from a tile. Otherwise leave null
tileFabThe TileFab to load
offsetThe position to place the TileFab
rotationThe rotation to be applied (not implemented)
loadFlagsControl flags. See TileFabLib
targetMapMapping from Tilemap Names in the TileFab to Tilemap references in the scene: a speedup.
filterThe filter, as described in the docs

Member Data Documentation

◆ m_Filter

readonly? Func<FabOrBundleFilterType, BoundsInt, object, bool> TilePlus.TileFabLoadParams.m_Filter

The filter, as described in the docs.

◆ m_Immortal

bool TilePlus.TileFabLoadParams.m_Immortal

Mark this zone as immortal. Zone will never be removed by Layout.

◆ m_LoadFlags

FabOrBundleLoadFlags TilePlus.TileFabLoadParams.m_LoadFlags

Control Flags. See TileFabLib.

◆ m_Offset

readonly Vector3Int TilePlus.TileFabLoadParams.m_Offset

The position to place the TileFab.

◆ m_Reserved

bool TilePlus.TileFabLoadParams.m_Reserved

Mark this zone reserved. See ZoneRegistration class.

◆ m_Rotation

readonly TpTileBundle.TilemapRotation TilePlus.TileFabLoadParams.m_Rotation

The rotation to be applied (not implemented)

◆ m_TargetMap

Dictionary<string, Tilemap> TilePlus.TileFabLoadParams.m_TargetMap

Mapping from Tilemap Names in the TileFab to Tilemap references in the scene: a speedup.

◆ m_TileFab

TpTileFab TilePlus.TileFabLoadParams.m_TileFab

The TileFab to load.

◆ m_TileParent

readonly? Tilemap TilePlus.TileFabLoadParams.m_TileParent

Parent Tilemap of Tile, if the request is coming from a tile. Otherwise leave null.

Property Documentation

◆ Valid

bool TilePlus.TileFabLoadParams.Valid
get

Normally true, but is false if non-parameter constructor used. Indicates an error if false.

true if valid; otherwise, false.


The documentation for this class was generated from the following file:
  • /Users/jms/Documents/Tpt_55/TPT55/Assets/Plugins/TilePlus/Runtime/FabAndZone/ClassesEnums/TileFabLibClasses.cs