Paper2D

Windows
MacOS
Linux

Classes

Name

Description

Public class

FFlipbookFinishedPlaySignature

Event for a non-looping flipbook finishing play.

Public struct UStruct BlueprintType

FIntMargin

Describes the space around a 2D area on an integer grid.

Public struct UStruct

FPaperFlipbookKeyFrame

Public struct UStruct

FPaperSpriteAtlasSlot

Public struct UStruct BlueprintType

FPaperSpriteSocket

Public struct UStruct BlueprintType

FPaperTerrainMaterialRule

Rule for a single section of a terrain material.

Public struct

FPaperTerrainSpriteGeometry

Public struct UStruct BlueprintType meta

FPaperTileInfo

This is the contents of a tile map cell.

Public class

FScopedFlipbookMutator

Helper class to edit properties of a UPaperFlipbook while ensuring that cached data remains up to date.

Public struct UStruct

FSpriteAssetInitParameters

Public struct

FSpriteGeometryCollisionBuilderBase

A helper class for converting one or more FSpriteGeometryCollection objects into a UBodySetup object.

Public struct UStruct

FSpriteInstanceData

Public struct

FTerrainSegment

Public struct

FTerrainSpriteStamp

Public class

IPaper2DModuleInterface

Public class UClass

PAPER2APaperCharacter

APaperCharacter behaves like ACharacter, but uses a UPaperFlipbookComponent instead of a USkeletalMeshComponent as a visual representation Note: The variable named Mesh will not be set up on this actor!

Public class UClass componentwrapperclass

PAPER2APaperFlipbookActor

An instance of a UPaperFlipbook in a level.

Public class UClass componentwrapperclass

PAPER2APaperGroupedSpriteActor

A group of sprites that will be rendered and culled as a single unit

Public class UClass Meta componentwrapperclass

PAPER2APaperSpriteActor

An instance of a UPaperSprite in a level.

Public class UClass BlueprintType experimental

PAPER2APaperTerrainActor

An instance of a piece of 2D terrain in the level

Public class UClass componentwrapperclass

PAPER2APaperTileMapActor

An instance of a UPaperTileMap in a level.

Public struct

PAPER2FAlphaBitmap

Public struct UStruct BlueprintType meta

PAPER2FPaperTileMetadata

Information about a single tile in a tile set.

Public struct UStruct

PAPER2FPaperTileSetTerrain

Information about a terrain type.

Public struct UStruct

PAPER2FSpriteDrawCallRecord

Public struct UStruct

PAPER2FSpriteGeometryCollection

Public struct UStruct

PAPER2FSpriteGeometryShape

A single piece of geometry (e.g., a polygon which may be convex or concave, a box, or a circle)

Public class UClass HideCategories

PAPER2UMaterialExpressionSpriteTextureSampler

This is a texture sampler 2D with a special automatically defined parameter name. The texture specified here will be replaced by the SourceTexture or an AdditionalSourceTextures entry of a Paper2D sprite if this material is used on a sprite.

Public class UClass BlueprintType Meta

PAPER2UPaperFlipbook

Contains an animation sequence of sprite frames

Public class UClass ClassGroup, ShowCategories, Meta

PAPER2UPaperFlipbookComponent

Public class UClass ClassGroup, ShowCategories, Meta earlyaccesspreview

PAPER2UPaperGroupedSpriteComponent

A component that handles rendering and collision for many instances of one or more UPaperSprite assets.

Public class UClass Config defaultconfig

PAPER2UPaperRuntimeSettings

Implements the settings for the Paper2D plugin.

Public class UClass BlueprintType Meta

PAPER2UPaperSprite

Sprite Asset

Public class UClass ClassGroup, ShowCategories, Meta

PAPER2UPaperSpriteComponent

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

Public class UClass BlueprintType experimental

PAPER2UPaperTerrainComponent

The terrain visualization component for an associated spline component.

Public class UClass BlueprintType

PAPER2UPaperTerrainMaterial

Paper Terrain Material

Public class UClass BlueprintType experimental

PAPER2UPaperTerrainSplineComponent

Public class UClass

PAPER2UPaperTileLayer

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

Public class UClass BlueprintType

PAPER2UPaperTileMap

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.

Public class UClass ClassGroup, HideCategories, Meta earlyaccesspreview

PAPER2UPaperTileMapComponent

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

Public class UClass BlueprintType

PAPER2UPaperTileSet

A tile set is a collection of tiles pulled from a texture that can be used to fill out a tile map.

Public class UClass MinimalAPI BlueprintType Meta experimental

UPaperSpriteAtlas

Groups together a set of sprites that will try to share the same texture atlas (allowing them to be combined into a single draw call)

Public class UClass Meta

UPaperSpriteBlueprintLibrary

Public class UClass Meta

UTileMapBlueprintLibrary

A collection of utility methods for working with tile map components

Typedefs

Enums

Name

Description

Public enum

EFlipbookCollisionMode::Type

Public enum UEnum

EPaperSpriteAtlasPadding

Public enum

EPaperTileFlags

Flags used in the packed tile index.

Public enum

ESpriteCollisionMode::Type

The kind of collision that a Paper2D asset or component might participate in.

Public enum

ESpritePivotMode::Type

Public enum

ESpritePolygonMode::Type

Method of specifying polygons for a sprite's render or collision data.

Public enum UEnum

ESpriteShapeType

The type of a shape in a sprite geometry structure.

Public enum

ETileMapProjectionMode::Type

The different kinds of projection modes supported.

Variables

Name Description

Public variable

PAPER2FVector

 

PaperAxisX

The 3D vector that corresponds to the sprite X axis.

Public variable

PAPER2FVector

 

PaperAxisY

The 3D vector that corresponds to the sprite Y axis.

Public variable

PAPER2FVector

 

PaperAxisZ

The 3D vector that corresponds to the sprite Z axis.

Public variable

 

STATCAT_Advanced

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