UPaperSpriteComponent

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.


Name	UPaperSpriteComponent
Type	class
Header File	/Engine/Plugins/2D/Paper2D/Source/Paper2D/Classes/PaperSpriteComponent.h
Include Path	#include "PaperSpriteComponent.h"

Syntax

UCLASS (MinimalAPI, ShowCategories=(Mobility), ClassGroup=Paper2D,  
       Meta=(BlueprintSpawnableComponent))  
class UPaperSpriteComponent : public UMeshComponent

Inheritance Hierarchy

UObjectBase → UObjectBaseUtility → UObject → UActorComponent → USceneComponent → UPrimitiveComponent → UMeshComponent → UPaperSpriteComponent

Implements Interfaces

Constructors

Name	Remarks	Include Path	Unreal Specifiers
UPaperSpriteComponent ( const FObjectInitializer& ObjectInitializer )		PaperSpriteComponent.h

Functions

Public

Name	Remarks	Include Path	Unreal Specifiers
virtual UPaperSprite * GetSprite()	Gets the PaperSprite used by this instance.	PaperSpriteComponent.h	BlueprintPure Category="Sprite"
FLinearColor GetSpriteColor()	Returns the current color of the sprite	PaperSpriteComponent.h
FLinearColor GetWireframeColor()	Returns the wireframe color to use for this component.	PaperSpriteComponent.h
virtual bool SetSprite ( UPaperSprite* NewSprite )	Change the PaperSprite used by this instance.	PaperSpriteComponent.h	BlueprintCallable Category="Sprite"
void SetSpriteColor ( FLinearColor NewColor )	Set color of the sprite	PaperSpriteComponent.h	BlueprintCallable Category="Sprite"
void SetTransientTextureOverride ( const UTexture* TextureToModifyOverrideFor, UTexture* OverrideTexture )		PaperSpriteComponent.h

Overridden from UPrimitiveComponent

Name	Remarks	Include Path	Unreal Specifiers
virtual FPrimitiveSceneProxy * CreateSceneProxy()		PaperSpriteComponent.h
virtual UBodySetup * GetBodySetup()		PaperSpriteComponent.h
virtual UMaterialInterface * GetMaterial ( int32 MaterialIndex ) const		PaperSpriteComponent.h
virtual int32 GetNumMaterials()		PaperSpriteComponent.h
virtual void GetStreamingRenderAssetInfo ( FStreamingTextureLevelContext& LevelContext, TArray< FStreamingRenderAssetPrimitiveInfo >& OutStreamingRenderAssets ) const		PaperSpriteComponent.h
virtual void GetUsedMaterials ( TArray< UMaterialInterface* >& OutMaterials, bool bGetDebugMaterials ) const		PaperSpriteComponent.h
virtual void GetUsedTextures ( TArray< UTexture* >& OutTextures, EMaterialQualityLevel::Type QualityLevel )		PaperSpriteComponent.h

Overridden from USceneComponent

Name	Remarks	Include Path	Unreal Specifiers
virtual FBoxSphereBounds CalcBounds ( const FTransform& LocalToWorld ) const		PaperSpriteComponent.h
virtual bool DoesSocketExist ( FName InSocketName ) const		PaperSpriteComponent.h
virtual FTransform GetSocketTransform ( FName InSocketName, ERelativeTransformSpace TransformSpace ) const		PaperSpriteComponent.h
virtual bool HasAnySockets()		PaperSpriteComponent.h
virtual void QuerySupportedSockets ( TArray< FComponentSocketDescription >& OutSockets ) const		PaperSpriteComponent.h

Overridden from UActorComponent

Name	Remarks	Include Path	Unreal Specifiers
virtual const UObject * AdditionalStatObject()		PaperSpriteComponent.h
virtual void CheckForErrors()		PaperSpriteComponent.h
virtual void SendRenderDynamicData_Concurrent()		PaperSpriteComponent.h

Overridden from UObject

Name	Remarks	Include Path	Unreal Specifiers
virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent )		PaperSpriteComponent.h
virtual void PostLoad()		PaperSpriteComponent.h
virtual void Serialize ( FArchive& Ar )		PaperSpriteComponent.h

Deprecated Variables

Name	Type	Remarks	Include Path	Unreal Specifiers
MaterialOverride_DEPRECATED	TObjectPtr< UMaterialInterface >	DEPRECATED in 4.4: The material override for this sprite component (if any); replaced by the Materials array inherited from UMeshComponent.	PaperSpriteComponent.h

Navigation