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 > PAPER2UPaperSpriteComponent

Light Theme

Dark Theme

PAPER2UPaperSpriteComponent

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

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UActorComponent

USceneComponent

UPrimitiveComponent

UMeshComponent

PAPER2UPaperSpriteComponent

References

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

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(ShowCategories=(Mobility), ClassGroup=Paper2D, Meta=(BlueprintSpawnableComponent))
class PAPER2UPaperSpriteComponent : public UMeshComponent

Remarks

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

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

Variables

		Name	Description
	UPaperSprite &#...	SourceSprite	The sprite asset used by this component.
	FLinearColor	SpriteColor	The color of the sprite (passed to the sprite material as a vertex color)

Constructors

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

Functions

	Name	Description
UPaperSprite...	GetSprite()	Gets the PaperSprite used by this instance.
FLinearColor	GetSpriteColor()	Returns the current color of the sprite
FLinearColor	GetWireframeColor()	Returns the wireframe color to use for this component.
bool	SetSprite ( UPaperSprite* NewSprite )	Change the PaperSprite used by this instance.
void	SetSpriteColor ( FLinearColor NewColor )	Set color of the sprite
void	SetTransientTextureOverride ( const UTexture* TextureToModif..., UTexture* OverrideTexture )

Overridden from UPrimitiveComponent

	Name	Description
FPrimitiveSc...	CreateSceneProxy()	Creates a proxy to represent the primitive to the scene manager in the rendering thread.
UBodySetup &...	GetBodySetup()	Return the BodySetup to use for this PrimitiveComponent (single body case)
UMaterialInt...	GetMaterial ( int32 ElementIndex )	Returns the material used by the element at the specified index
int32	GetNumMaterials()	Return number of material elements in this primitive
void	GetStreamingRenderAssetInfo ( FStreamingTextureLevelContext& Lev..., TArray< FStreamingRenderAssetPrimit... )	Enumerates the streaming textures/meshes used by the primitive.
void	GetUsedMaterials ( TArray< UMaterialInterface* > ..., bool bGetDebugMaterials )	Retrieves the materials used in this component
void	GetUsedTextures ( TArray< UTexture* >& OutTextu..., EMaterialQualityLevel::Type Quality... )	Returns the material textures used to render this primitive for the given platform.

Overridden from USceneComponent

	Name	Description
FBoxSphereBo...	CalcBounds ( const FTransform& LocalToWorld )	Calculate the bounds of the component. Default behavior is a bounding box/sphere of zero size.
bool	DoesSocketExist ( FName InSocketName )	Return true if socket with the given name exists
FTransform	GetSocketTransform ( FName InSocketName, ERelativeTransformSpace TransformSp... )	Get world-space socket transform.
bool	HasAnySockets()	Returns true if this component has any sockets
void	QuerySupportedSockets ( TArray< FComponentSocketDescription... )	Get a list of sockets this component contains

Overridden from UActorComponent

	Name	Description
const UObjec...	AdditionalStatObject()	Give a readable name for this component, including asset name if applicable
void	CheckForErrors()	Function that gets called from within Map_Check to allow this actor component to check itself for any potential errors and register them with map check dialog.
void	SendRenderDynamicData_Concurrent()	Called to send dynamic data for this component to the rendering thread

Overridden from UObject

	Name	Description
void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called when a property on this object has been modified externally
void	PostLoad()	Do any object-specific cleanup required immediately after loading an object.
void	Serialize ( FArchive& Ar )	Handles reading, writing, and reference collecting using FArchive.

Deprecated Variables

		Name	Description
	UMaterialInterf...	MaterialOverride_DEPRECATED	DEPRECATED in 4.4: The material override for this sprite component (if any); replaced by the Materials array inherited from UMeshComponent.