Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > Paper2D > PAPER2UPaperTileLayer

Light Theme

Dark Theme

PAPER2UPaperTileLayer

This class represents a single layer in a tile map. All layers in the map must have the size dimensions.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

PAPER2UPaperTileLayer

References

Module	Paper2D
Header	/Engine/Plugins/2D/Paper2D/Source/Paper2D/Classes/PaperTileLayer.h
Include	#include "PaperTileLayer.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)()
class PAPER2UPaperTileLayer : public UObject

Remarks

This class represents a single layer in a tile map. All layers in the map must have the size dimensions.

Variables

		Name	Description
	FText	LayerName	Name of the layer.

Constructors

	Name	Description
	PAPER2UPaperTileLayer ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
void	AugmentBodySetup ( UBodySetup* ShapeBodySetup, float RenderSeparation )	Adds collision to the specified body setup.
void	ConvertToTileSetPerCell()
void	DestructiveAllocateMap ( int32 NewWidth, int32 NewHeight )	Reallocates the map. This is a destructive operation that does not copy data across!
FPaperTileIn...	GetCell ( int32 X, int32 Y )	Returns the tile information about the specified cell.
FLinearColor	GetLayerColor()	Gets the layer-specific color multiplier.
int32	GetLayerHeight()	Returns the height of the layer (in tiles)
int32	GetLayerIndex()	Returns the index of this layer in the parent tile map.
int32	GetLayerWidth()	Returns the width of the layer (in tiles)
int32	GetNumOccupiedCells()	Returns the number of occupied cells in the layer.
UPaperTileMa...	GetTileMap()	Returns the parent tile map.
FTransform	GetTileTransform ( int32 FlagIndex )	Returns the transform for the given packed flag index (0..7)
bool	InBounds ( int32 X, int32 Y )	Returns whether the specified coordinates are in bounds for the layer.
const FPaper...	PRIVATE_GetAllocatedCells()	Returns the raw pointer to the allocated cells, only for use when rendering the tile map and should never be held onto.
void	ReallocateAndCopyMap()
void	ResizeMap ( int32 NewWidth, int32 NewHeight )	Reallocates the map. This tries to preserve contents.
void	SetCell ( int32 X, int32 Y, const FPaperTileInfo& NewValue )	Sets the tile information about the specified cell.
void	SetLayerCollides ( bool bShouldCollide )
void	SetLayerCollisionOffset ( bool bShouldOverride, float OverrideValue )
void	SetLayerCollisionThickness ( bool bShouldOverride, float OverrideValue )
void	SetLayerColor ( FLinearColor NewColor )	Sets the layer-specific color multiplier (.
void	SetShouldRenderInEditor ( bool bShouldRender )	Set whether this layer should be drawn (in the editor)
bool	ShouldRenderInEditor()	Should this layer be drawn (in the editor)?
bool	ShouldRenderInGame()	Should this layer be drawn (in game)?
bool	UsesTileSet ( UPaperTileSet* TileSet )	Checks to see if this layer uses the specified tile set.

Overridden from UObject

		Name	Description
	void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called when a property on this object has been modified externally

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss