1. Epic GamesDeveloper
  3. FPaperJSONHelpers

FPaperJSONHelpers

API > API/Plugins > API/Plugins/Paper2DEditor

   
Name FPaperJSONHelpers
Type class
Header File /Engine/Plugins/2D/Paper2D/Source/Paper2DEditor/Public/PaperJSONHelpers.h
Include Path #include "PaperJSONHelpers.h"

Syntax

class FPaperJSONHelpers

Constructors

Name Remarks Include Path Unreal Specifiers

FPaperJSONHelpers()

   PaperJSONHelpers.h  

Functions

Static

Name Remarks Include Path Unreal Specifiers

static const TArray< TSharedPtr< FJsonValue > > & ReadArray ( TSharedPtr< class FJsonObject > Item,
const FString& Key
)

 Returns the array named Key or nullptr if it is missing or the wrong type. PaperJSONHelpers.h  

static bool ReadBoolean ( const TSharedPtr< class FJsonObject > Item,
const FString& Key,
bool bDefaultIfMissing
)

 Returns the bool named Key or bDefaultIfMissing if it is missing or the wrong type (note: no way to determine errors!) PaperJSONHelpers.h  

static bool ReadFloatNoDefault ( const TSharedPtr< class FJsonObject > Item,
const FString& Key,
float& Out_Value
)

 Returns true if the field named Key is a Number, populating Out_Value, or false if it is missing or the wrong type (Out_Value is set to 0.0f on failure) PaperJSONHelpers.h  

static bool ReadFloatNoDefault ( const TSharedPtr< class FJsonObject > Item,
const FString& Key,
double& Out_Value
)

 Returns true if the field named Key is a Number, populating Out_Value, or false if it is missing or the wrong type (Out_Value is set to 0.0f on failure) PaperJSONHelpers.h  

static bool ReadIntegerNoDefault ( const TSharedPtr< class FJsonObject > Item,
const FString& Key,
int32& Out_Value
)

 Returns true if the field named Key is a Number (truncating it to an integer), populating Out_Value, or false if it is missing or the wrong type (Out_Value is set to 0 on failure) PaperJSONHelpers.h  

static bool ReadIntPoint ( const TSharedPtr< class FJsonObject > Item,
const FString& Key,
FIntPoint& Out_XY
)

 Returns true if the object named Key is a struct containing two floats (x,y), populating XY with the values) PaperJSONHelpers.h  

static TSharedPtr< class FJsonObject > ReadObject ( TSharedPtr< class FJsonObject > Item,
const FString& Key
)

 Returns the object named Key or nullptr if it is missing or the wrong type. PaperJSONHelpers.h  

static bool ReadRectangle ( const TSharedPtr< class FJsonObject > Item,
const FString& Key,
FIntPoint& Out_XY,
FIntPoint& Out_WH
)

 Returns true if the object named Key is a struct containing four integers (x,y,w,h), populating XY and WH with the values) PaperJSONHelpers.h  

static bool ReadSize ( const TSharedPtr< class FJsonObject > Item,
const FString& Key,
FVector2D& Out_WH
)

 Returns true if the object named Key is a struct containing two floats (w,h), populating WH with the values) PaperJSONHelpers.h  

static FString ReadString ( TSharedPtr< class FJsonObject > Item,
const FString& Key,
const FString& DefaultValue
)

 Returns the value of Key in Item, or DefaultValue if the Key is missing or the wrong type PaperJSONHelpers.h  

static bool ReadXY ( const TSharedPtr< class FJsonObject > Item,
const FString& Key,
FVector2D& Out_WH
)

 Returns true if the object named Key is a struct containing two floats (x,y), populating WH with the values) PaperJSONHelpers.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page