Navigation
API > API/Plugins > API/Plugins/Paper2DEditor
References
| Module | Paper2DEditor |
| Header | /Engine/Plugins/2D/Paper2D/Source/Paper2DEditor/Public/PaperJSONHelpers.h |
| Include | #include "PaperJSONHelpers.h" |
Syntax
class PAPER2FPaperJSONHelpers
Functions
| Type | Name | Description | |
|---|---|---|---|
| const TArray< TSharedPtr< FJsonValue > > & | ReadArray
(
TSharedPtr< class FJsonObject > Item, |
Returns the array named Key or nullptr if it is missing or the wrong type. | |
| bool | ReadBoolean
(
const TSharedPtr< class FJsonObject > Item, |
Returns the bool named Key or bDefaultIfMissing if it is missing or the wrong type (note: no way to determine errors!) | |
| bool | ReadFloatNoDefault
(
const TSharedPtr< class FJsonObject > Item, |
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) | |
| bool | ReadFloatNoDefault
(
const TSharedPtr< class FJsonObject > Item, |
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) | |
| bool | ReadIntegerNoDefault
(
const TSharedPtr< class FJsonObject > Item, |
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) | |
| bool | ReadIntPoint
(
const TSharedPtr< class FJsonObject > Item, |
Returns true if the object named Key is a struct containing two floats (x,y), populating XY with the values) | |
| TSharedPtr< class FJsonObject > | ReadObject
(
TSharedPtr< class FJsonObject > Item, |
Returns the object named Key or nullptr if it is missing or the wrong type. | |
| bool | ReadRectangle
(
const TSharedPtr< class FJsonObject > Item, |
Returns true if the object named Key is a struct containing four integers (x,y,w,h), populating XY and WH with the values) | |
| bool | ReadSize
(
const TSharedPtr< class FJsonObject > Item, |
Returns true if the object named Key is a struct containing two floats (w,h), populating WH with the values) | |
| FString | ReadString
(
TSharedPtr< class FJsonObject > Item, |
Returns the value of Key in Item, or DefaultValue if the Key is missing or the wrong type | |
| bool | ReadXY
(
const TSharedPtr< class FJsonObject > Item, |
Returns true if the object named Key is a struct containing two floats (x,y), populating WH with the values) |