UPaperImporterSettings | Unreal Engine 5.7 Documentation

API > API/Plugins > API/Plugins/Paper2DEditor

Implements the settings for imported Paper2D assets, such as sprite sheet textures.


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

Syntax

UCLASS (MinimalAPI, Config=Editor, defaultconfig)  
class UPaperImporterSettings : public UObject

Inheritance Hierarchy

UObjectBase → UObjectBaseUtility → UObject → UPaperImporterSettings

Constructors

Name	Remarks	Include Path	Unreal Specifiers
UPaperImporterSettings()		PaperImporterSettings.h

Functions

Public

Name	Remarks	Include Path
ESpriteInitMaterialType AnalyzeTextureForDesiredMaterialType ( UTexture* Texture, const FIntPoint& Offset, const FIntPoint& Dimensions ) const	Analyzes the specified texture in the Offset..Offset+Dimensions region and returns the best kind of material to represent the alpha content in the texture (typically masked or translucent, but can return opaque if bAnalysisCanUseOpaque is true Note: Will return Automatic if the texture is null.	PaperImporterSettings.h
void ApplySettingsForSpriteInit ( FSpriteAssetInitParameters& InitParams, ESpriteInitMaterialLightingMode LightingMode, ESpriteInitMaterialType MaterialTypeMode ) const	Fills out the sprite init parameters with the default settings given the desired material type and lighting mode (which can both be automatic) Note: This should be called after the texture has been set, as that will be analyzed if the lighting/material type flags are set to automatic	PaperImporterSettings.h
void ApplySettingsForTileMapInit ( UPaperTileMap* TileMap, UPaperTileSet* DefaultTileSet, ESpriteInitMaterialLightingMode LightingMode, ESpriteInitMaterialType MaterialTypeMode, bool bCreateEmptyLayer ) const	Fills out the tile map with the default settings given the desired material type and lighting mode (which can both be automatic)	PaperImporterSettings.h
void ApplyTextureSettings ( UTexture2D* Texture ) const	Applies the compression settings to the specified texture.	PaperImporterSettings.h
void GenerateNormalMapNamesToTest ( const FString& InRoot, TArray< FString >& InOutNames ) const	Generates names to test for a normal map using NormalMapTextureSuffixes.	PaperImporterSettings.h
UMaterialInterface * GetDefaultMaskedMaterial ( bool bLit ) const	Returns the default masked material.	PaperImporterSettings.h
UMaterialInterface * GetDefaultMaterial ( ESpriteInitMaterialType MaterialType, bool bUseLitMaterial ) const	Returns the default material for the specified material type.	PaperImporterSettings.h
UMaterialInterface * GetDefaultOpaqueMaterial ( bool bLit ) const	Returns the default opaque material.	PaperImporterSettings.h
float GetDefaultPixelsPerUnrealUnit()	Returns the default pixels/uu setting.	PaperImporterSettings.h
UMaterialInterface * GetDefaultTranslucentMaterial ( bool bLit ) const	Returns the default translucent material.	PaperImporterSettings.h
FString RemoveSuffixFromBaseMapName ( const FString& InName ) const	Removes the suffix from the specified name if it matches something in BaseMapTextureSuffixes.	PaperImporterSettings.h
bool ShouldPickBestMaterialWhenCreatingTileMaps()	Should the source texture be scanned when creating new tile maps (from a tile set or via importing) to determine the appropriate material? (if false, the Default Masked Material is always used)	PaperImporterSettings.h

Navigation

Syntax

Inheritance Hierarchy

Constructors

Functions

Public