Class PaperTileMapComponent

A component that handles rendering and collision for a single instance of a UPaperTileMap asset.

Inheritance
System.Object
UObject
ActorComponent
SceneComponent
PrimitiveComponent
MeshComponent
PaperTileMapComponent
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: UE4.Paper2D
Assembly: UE4DotNet.dll
Syntax
public class PaperTileMapComponent : MeshComponent
Remarks

This component is created when you drag a tile map asset from the content browser into a Blueprint, or contained inside of the actor created when you drag one into the level.

NOTE: This is an early access preview class. While not considered production-ready, it is a step beyond 'experimental' and is being provided as a preview of things to come:

  • We will try to provide forward-compatibility for content you create.
  • The classes may change significantly in the future.
  • The code is in an early state and may not meet the desired polish / quality bar.
  • There is probably no documentation or example content yet.
  • They will be promoted out of 'Early Access' when they are production ready.

@see UPrimitiveComponent, UPaperTileMap

Properties

| Improve this Doc View Source

bShowOutlineWhenUnselected

Declaration
public bool bShowOutlineWhenUnselected { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

bShowPerLayerGridWhenSelected

Declaration
public bool bShowPerLayerGridWhenSelected { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

bShowPerLayerGridWhenUnselected

Declaration
public bool bShowPerLayerGridWhenUnselected { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

bShowPerTileGridWhenSelected

Declaration
public bool bShowPerTileGridWhenSelected { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

bShowPerTileGridWhenUnselected

Declaration
public bool bShowPerTileGridWhenUnselected { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

bUseSingleLayer

Declaration
public bool bUseSingleLayer { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

DefaultObject

Get UE4 Default Object for this Class

Declaration
public static PaperTileMapComponent DefaultObject { get; }
Property Value
Type Description
PaperTileMapComponent
| Improve this Doc View Source

StaticClass

Get UE4 Class

Declaration
public static Class StaticClass { get; }
Property Value
Type Description
Class
| Improve this Doc View Source

TileMap

The tile map used by this component

Declaration
public PaperTileMap TileMap { get; }
Property Value
Type Description
PaperTileMap
| Improve this Doc View Source

TileMapColor

The color of the tile map (multiplied with the per-layer color and passed to the material as a vertex color)

Declaration
public LinearColor TileMapColor { get; set; }
Property Value
Type Description
LinearColor
| Improve this Doc View Source

UseSingleLayerIndex

The index of the single layer to use if enabled

Declaration
public int UseSingleLayerIndex { get; set; }
Property Value
Type Description
System.Int32

Methods

| Improve this Doc View Source

AddNewLayer()

Creates and adds a new layer to the tile map

Declaration
public PaperTileLayer AddNewLayer()
Returns
Type Description
PaperTileLayer
Remarks

Note: This will only work on components that own their own tile map (OwnsTileMap returns true), you cannot modify standalone tile map assets

| Improve this Doc View Source

CreateNewTileMap(Int32, Int32, Int32, Int32, Single, Boolean)

Creates a new tile map of the specified size, replacing the TileMap reference (or dropping the previous owned one) @

Declaration
public void CreateNewTileMap(int MapWidth, int MapHeight, int TileWidth, int TileHeight, float PixelsPerUnrealUnit, bool bCreateLayer)
Parameters
Type Name Description
System.Int32 MapWidth
System.Int32 MapHeight
System.Int32 TileWidth
System.Int32 TileHeight
System.Single PixelsPerUnrealUnit
System.Boolean bCreateLayer
Remarks

param MapWidth Width of the map (in tiles) @param MapHeight Height of the map (in tiles) @param TileWidth Width of one tile (in pixels) @param TileHeight Height of one tile (in pixels) @param bCreateLayer Should an empty layer be created?

| Improve this Doc View Source

GetLayerColor(Int32)

Gets the per-layer color multiplier for a specific layer (multiplied with the tile map color and passed to the material as a vertex color)

Declaration
public LinearColor GetLayerColor(int Layer)
Parameters
Type Name Description
System.Int32 Layer
Returns
Type Description
LinearColor
| Improve this Doc View Source

GetMapSize()

Returns the size of the tile map

Declaration
public (int, int, int) GetMapSize()
Returns
Type Description
System.ValueTuple<System.Int32, System.Int32, System.Int32>
| Improve this Doc View Source

GetTile(Int32, Int32, Int32)

Returns the contents of a specified tile cell

Declaration
public PaperTileInfo GetTile(int X, int Y, int Layer)
Parameters
Type Name Description
System.Int32 X
System.Int32 Y
System.Int32 Layer
Returns
Type Description
PaperTileInfo
| Improve this Doc View Source

GetTileCenterPosition(Int32, Int32, Int32, Boolean)

Returns the position of the center of the specified tile

Declaration
public Vector GetTileCenterPosition(int TileX, int TileY, int LayerIndex, bool bWorldSpace)
Parameters
Type Name Description
System.Int32 TileX
System.Int32 TileY
System.Int32 LayerIndex
System.Boolean bWorldSpace
Returns
Type Description
Vector
| Improve this Doc View Source

GetTileCornerPosition(Int32, Int32, Int32, Boolean)

Returns the position of the top left corner of the specified tile

Declaration
public Vector GetTileCornerPosition(int TileX, int TileY, int LayerIndex, bool bWorldSpace)
Parameters
Type Name Description
System.Int32 TileX
System.Int32 TileY
System.Int32 LayerIndex
System.Boolean bWorldSpace
Returns
Type Description
Vector
| Improve this Doc View Source

GetTileMapColor()

Gets the tile map global color multiplier (multiplied with the per-layer color and passed to the material as a vertex color)

Declaration
public LinearColor GetTileMapColor()
Returns
Type Description
LinearColor
| Improve this Doc View Source

GetTilePolygon(Int32, Int32, Int32, Boolean)

Returns the polygon for the specified tile (will be 4 or 6 vertices as a rectangle, diamond, or hexagon)

Declaration
public IReadOnlyCollection<Vector> GetTilePolygon(int TileX, int TileY, int LayerIndex, bool bWorldSpace)
Parameters
Type Name Description
System.Int32 TileX
System.Int32 TileY
System.Int32 LayerIndex
System.Boolean bWorldSpace
Returns
Type Description
System.Collections.Generic.IReadOnlyCollection<Vector>
| Improve this Doc View Source

MakeTileMapEditable()

Makes the tile map asset pointed to by this component editable.

Declaration
public void MakeTileMapEditable()
Remarks

Nothing happens if it was already instanced, but if the tile map is an asset reference, it is cloned to make a unique instance.

| Improve this Doc View Source

New(UObject, Name)

Spawn an object of this class

Declaration
public static PaperTileMapComponent New(UObject obj = null, Name name = default(Name))
Parameters
Type Name Description
UObject obj
Name name
Returns
Type Description
PaperTileMapComponent
| Improve this Doc View Source

OwnsTileMap()

Does this component own the tile map (is it instanced instead of being an asset reference)?

Declaration
public bool OwnsTileMap()
Returns
Type Description
System.Boolean
| Improve this Doc View Source

RebuildCollision()

Rebuilds collision for the tile map

Declaration
public void RebuildCollision()
| Improve this Doc View Source

ResizeMap(Int32, Int32)

Resizes the tile map (Note: This will only work on components that own their own tile map (OwnsTileMap returns true), you cannot modify standalone tile map assets)

Declaration
public void ResizeMap(int NewWidthInTiles, int NewHeightInTiles)
Parameters
Type Name Description
System.Int32 NewWidthInTiles
System.Int32 NewHeightInTiles
| Improve this Doc View Source

SetDefaultCollisionThickness(Single, Boolean)

Sets the default thickness for any layers that don't override the collision thickness

Declaration
public void SetDefaultCollisionThickness(float Thickness, bool bRebuildCollision)
Parameters
Type Name Description
System.Single Thickness
System.Boolean bRebuildCollision
Remarks

Note: This will only work on components that own their own tile map (OwnsTileMap returns true), you cannot modify standalone tile map assets

| Improve this Doc View Source

SetLayerCollision(Int32, Boolean, Boolean, Single, Boolean, Single, Boolean)

Sets the collision thickness for a specific layer

Declaration
public void SetLayerCollision(int Layer, bool bHasCollision, bool bOverrideThickness, float CustomThickness, bool bOverrideOffset, float CustomOffset, bool bRebuildCollision)
Parameters
Type Name Description
System.Int32 Layer
System.Boolean bHasCollision
System.Boolean bOverrideThickness
System.Single CustomThickness
System.Boolean bOverrideOffset
System.Single CustomOffset
System.Boolean bRebuildCollision
Remarks

Note: This will only work on components that own their own tile map (OwnsTileMap returns true), you cannot modify standalone tile map assets

| Improve this Doc View Source

SetLayerColor(LinearColor, Int32)

Sets the per-layer color multiplier for a specific layer (multiplied with the tile map color and passed to the material as a vertex color)

Declaration
public void SetLayerColor(LinearColor NewColor, int Layer)
Parameters
Type Name Description
LinearColor NewColor
System.Int32 Layer
Remarks

Note: This will only work on components that own their own tile map (OwnsTileMap returns true), you cannot modify standalone tile map assets

| Improve this Doc View Source

SetTile(Int32, Int32, Int32, PaperTileInfo)

Modifies the contents of a specified tile cell (Note: This will only work on components that own their own tile map (OwnsTileMap returns true), you cannot modify standalone tile map assets)

Declaration
public void SetTile(int X, int Y, int Layer, PaperTileInfo NewValue)
Parameters
Type Name Description
System.Int32 X
System.Int32 Y
System.Int32 Layer
PaperTileInfo NewValue
Remarks

Note: Does not update collision by default, call RebuildCollision after all edits have been done in a frame if necessary

| Improve this Doc View Source

SetTileMap(PaperTileMap)

Change the PaperTileMap used by this instance.

Declaration
public bool SetTileMap(PaperTileMap NewTileMap)
Parameters
Type Name Description
PaperTileMap NewTileMap
Returns
Type Description
System.Boolean
| Improve this Doc View Source

SetTileMapColor(LinearColor)

Sets the tile map global color multiplier (multiplied with the per-layer color and passed to the material as a vertex color)

Declaration
public void SetTileMapColor(LinearColor NewColor)
Parameters
Type Name Description
LinearColor NewColor

Operators

| Improve this Doc View Source

Implicit(IntPtr to PaperTileMapComponent)

Convert from IntPtr to UObject

Declaration
public static implicit operator PaperTileMapComponent(IntPtr p)
Parameters
Type Name Description
System.IntPtr p
Returns
Type Description
PaperTileMapComponent