Class PaperTileMap

A tile map is a 2D grid with a defined width and height (in tiles). There can be multiple layers, each of which can specify which tile should appear in each cell of the map for that layer.

Inheritance

System.Object

UObject

PaperTileMap

Inherited Members

UObject.TransientPackage

UObject.CastTo<T>(UObject)

UObject.CastTo(UObject, Type)

UObject.RemoveObject(UObject)

UObject.MakeObjectArrayField<T>(NativeArray*)

UObject.NotImplemented<T>()

UObject.Construct()

UObject.GetHashCode()

UObject.GetName()

UObject.ToString()

UObject.Name

UObject._None

UObject.None

UObject.ObjPointer

UObject.LoadObjectFromClass(Class, UObject, String, String, LoadFlags, PackageMap, Boolean)

UObject.LoadClass(Class, UObject, String, String, LoadFlags, PackageMap)

UObject.GetPropertyFor<T>(Name)

UObject.ExecuteUbergraph

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 PaperTileMap : UObject

Properties

| Improve this Doc View Source

AssetImportData

Importing data and options used for this tile map

Declaration

public AssetImportData AssetImportData { get; set; }

Property Value

Type	Description
AssetImportData

| Improve this Doc View Source

BackgroundColor

The background color displayed in the tile map editor

Declaration

public LinearColor BackgroundColor { get; set; }

Property Value

Type	Description
LinearColor

| Improve this Doc View Source

BodySetup

Baked physics data.

Declaration

public BodySetup BodySetup { get; set; }

Property Value

Type	Description
BodySetup

| Improve this Doc View Source

CollisionThickness

The extrusion thickness of collision geometry when using a 3D collision domain

Declaration

public float CollisionThickness { get; }

Property Value

Type	Description
System.Single

| Improve this Doc View Source

DefaultObject

Get UE4 Default Object for this Class

Declaration

public static PaperTileMap DefaultObject { get; }

Property Value

Type	Description
PaperTileMap

| Improve this Doc View Source

HexSideLength

The vertical height of the sides of the hex cell for a tile.

Declaration

public int HexSideLength { get; set; }

Property Value

Type	Description
System.Int32

Remarks

Note: This value should already be included as part of the TileHeight, and is purely cosmetic; it only affects how the tile cursor preview is drawn.

| Improve this Doc View Source

LayerGridColor

The color of the layer grid

Declaration

public LinearColor LayerGridColor { get; set; }

Property Value

Type	Description
LinearColor

| Improve this Doc View Source

LayerNameIndex

The naming index to start at when trying to create a new layer

Declaration

public int LayerNameIndex { get; set; }

Property Value

Type	Description
System.Int32

| Improve this Doc View Source

MapHeight

Height of map (in tiles)

Declaration

public int MapHeight { get; }

Property Value

Type	Description
System.Int32

| Improve this Doc View Source

MapWidth

Width of map (in tiles)

Declaration

public int MapWidth { get; }

Property Value

Type	Description
System.Int32

| Improve this Doc View Source

Material

The material to use on a tile map instance if not overridden

Declaration

public MaterialInterface Material { get; }

Property Value

Type	Description
MaterialInterface

| Improve this Doc View Source

MultiTileGridColor

The color of the multi tile grid

Declaration

public LinearColor MultiTileGridColor { get; set; }

Property Value

Type	Description
LinearColor

| Improve this Doc View Source

MultiTileGridHeight

Number of tiles the multi tile grid spans vertically. 0 removes horizontal lines

Declaration

public int MultiTileGridHeight { get; set; }

Property Value

Type	Description
System.Int32

| Improve this Doc View Source

MultiTileGridOffsetX

Number of tiles the multi tile grid is shifted to the right

Declaration

public int MultiTileGridOffsetX { get; set; }

Property Value

Type	Description
System.Int32

| Improve this Doc View Source

MultiTileGridOffsetY

Number of tiles the multi tile grid is shifted downwards

Declaration

public int MultiTileGridOffsetY { get; set; }

Property Value

Type	Description
System.Int32

| Improve this Doc View Source

MultiTileGridWidth

Number of tiles the multi tile grid spans horizontally. 0 removes vertical lines

Declaration

public int MultiTileGridWidth { get; set; }

Property Value

Type	Description
System.Int32

| Improve this Doc View Source

PixelsPerUnrealUnit

The scaling factor between pixels and Unreal units (cm) (e.g., 0.64 would make a 64 pixel wide tile take up 100 cm)

Declaration

public float PixelsPerUnrealUnit { get; set; }

Property Value

Type	Description
System.Single

| Improve this Doc View Source

ProjectionMode

Tile map type

Declaration

public byte ProjectionMode { get; }

Property Value

Type	Description
System.Byte

| Improve this Doc View Source

SelectedLayerIndex

The currently selected layer index

Declaration

public int SelectedLayerIndex { get; set; }

Property Value

Type	Description
System.Int32

| Improve this Doc View Source

SeparationPerLayer

The Z-separation between each layer of the tile map

Declaration

public float SeparationPerLayer { get; }

Property Value

Type	Description
System.Single

| Improve this Doc View Source

SeparationPerTileX

The Z-separation incurred as you travel in X (not strictly applied, batched tiles will be put at the same Z level)

Declaration

public float SeparationPerTileX { get; set; }

Property Value

Type	Description
System.Single

| Improve this Doc View Source

SeparationPerTileY

The Z-separation incurred as you travel in Y (not strictly applied, batched tiles will be put at the same Z level)

Declaration

public float SeparationPerTileY { get; set; }

Property Value

Type	Description
System.Single

| Improve this Doc View Source

SpriteCollisionDomain

Collision domain (no collision, 2D, or 3D)

Declaration

public byte SpriteCollisionDomain { get; }

Property Value

Type	Description
System.Byte

| 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

TileGridColor

The color of the tile grid

Declaration

public LinearColor TileGridColor { get; set; }

Property Value

Type	Description
LinearColor

| Improve this Doc View Source

TileHeight

Height of one tile (in pixels)

Declaration

public int TileHeight { get; }

Property Value

Type	Description
System.Int32

| Improve this Doc View Source

TileLayers

The list of layers

Declaration

public ObjectArrayField<PaperTileLayer> TileLayers { get; }

Property Value

Type	Description
ObjectArrayField<PaperTileLayer>

| Improve this Doc View Source

TileWidth

Width of one tile (in pixels)

Declaration

public int TileWidth { get; }

Property Value

Type	Description
System.Int32

Methods

| Improve this Doc View Source

New(UObject, Name)

Spawn an object of this class

Declaration

public static PaperTileMap New(UObject obj = null, Name name = default(Name))

Parameters

Type	Name	Description
UObject	obj
Name	name

Returns

Type	Description
PaperTileMap

Operators

| Improve this Doc View Source

Implicit(IntPtr to PaperTileMap)

Convert from IntPtr to UObject

Declaration

public static implicit operator PaperTileMap(IntPtr p)

Parameters

Type	Name	Description
System.IntPtr	p

Returns

Type	Description
PaperTileMap