PlainProps

API > API/Plugins

Classes

  Type Name Description
Public struct FArithmeticBindType    
Public struct FBaseTypenameId    
Public class FBitCacheReader Helper that consumes 8 bits from the byte value stream.  
Public struct FBitfieldBindType    
Public class FBoolRangeIterator    
Public class FBoolRangeView    
Public struct FBuiltEnumSchema    
Public struct FBuiltMember    
Public struct FBuiltSchemas    
Public struct FBuiltStructSchema    
Public struct FBuiltValue    
Public class FByteReader    
Public struct FConcreteTypenameId    
Public class FConstructedItems    
Public class FConstructionRequest    
Public struct FCustomBindingEntry    
Public class FCustomBindings    
Public class FDebugIds    
Public class FDeclarations    
Public struct FDefaultStruct Temporary data structure, will be replaced by something more sophisticated perhaps deduplicating all zero-memory defaults  
Public struct FDenseMemberBuilder Rough API draft.  
Public struct FDualStructSchemaId    
Public struct FEnumDeclaration    
Public struct FEnumerator    
Public struct FEnumSchemaId    
Public struct FExistingItems    
Public struct FExistingItemSlice    
Public class FFlatMemberReader Hides the inheritance chain and iterates over super members first.  
Public struct FFlatScopeId    
Public struct FGetItemsRequest Todo: switch to class  
Public struct FIdBinding Save -> load ids for ESchemaFormat::StableNames.  
Public class FIdIndexerBase    
Public struct FIdTranslator Maps saved ids -> runtime load ids for ESchemaFormat::StableNames.  
Public struct FIdTranslatorBase    
Public struct FLeafBindType    
Public struct FLeafMemberBinding    
Public class FLeafRangeAllocator Possible save opt: Use paged linear allocator that only allocates on page exhaustion.  
Public class FLeafRangeLoadView    
Public class FLeafRangeView    
Public struct FLeafType    
Public struct FLeafView    
Public struct FLoadBatchDeleter    
Public struct FLoadRangeContext    
Public struct FMemberBinder    
Public struct FMemberBinding    
Public struct FMemberBindType    
Public class FMemberBuilder Builds an ordered list of properties to be saved.  
Public struct FMemberId    
Public class FMemberReader Class FAnyMemberView  
Public struct FMemberSchema    
Public struct FMemberType    
Public struct FMemberValue    
Public class FMemberVisitor Iterates over member bindings.  
Public struct FNameId    
Public class FNestedRangeBuilder Helper class for building nested ranges.  
Public class FNestedRangeIterator    
Public struct FNestedScope Resolved FNestedScopeId.  
Public struct FNestedScopeId    
Public class FNestedScopeIndexer    
Public struct FNoId    
Public struct FOmitTypename    
Public class FOptionalId    
Public struct FParameterIndexRange    
Public struct FParametricType Name-resolved FParametricTypeId.  
Public struct FParametricTypeId    
Public class FParametricTypeIndexer    
Public struct FParametricTypeView Fully resolved FParametricTypeId.  
Public class FPlainPropsModule    
Public struct FQuat_Ctti    
Public class FRangeBinding    
Public struct FRangeBindType    
Public struct FRangeMemberBinding    
Public struct FRangeSchema    
Public struct FRangeType    
Public class FRangeView    
Public class FReadBatchId Represents a batch currently being read from.  
Public struct FSaveContext    
Public struct FSaveRangeContext TODO: Consider API changes so that  
Public struct FSchemaBinding Members are loaded in saved FStructSchema order, not current offset order unless upgrade layer reorders.  
Public class FSchemaBindings    
Public struct FSchemaId    
Public class FSchemasBuilder    
Public class FScopeId    
Public class FScratchAllocator Single-threaded scratch allocator for intermediate built representation.  
Public struct FSetDeltaIds    
Public struct FStringBinding    
Public struct FStructBindIds    
Public struct FStructBindType    
Public struct FStructDeclaration    
Public struct FStructMemberBinding    
Public class FStructRangeBuilder Helper class for building struct ranges.  
Public class FStructRangeIterator    
Public struct FStructSchemaHandle    
Public struct FStructSchemaId    
Public struct FStructType    
Public struct FStructView    
Public struct FTransformBinding TODO: Consider macroifying parts of this, e.g PP_CUSTOM_BIND(PLAINPROPS_API, FTransform, Transform, Translate, Rotate, Scale)  
Public struct FTypedRange Todo: Turn into smart pointer where dtor call FBuiltRange::Delete if Values not detached to FBuiltValue.  
Public struct FTypeId    
Public struct FTypenameId    
Public struct FUninitializedMemberBindType TRangeMemberHelper init helper.  
Public struct FUnpackedLeafBindType    
Public struct FUnpackedLeafType    
Public struct FVector_Ctti    
Public struct FVector4_Ctti    
Public class FWriter    
Public struct ICustomBinding Load/save a struct with custom code to handle:  
Public class IItemRangeBinding    
Public class ILeafRangeBinding Specialized binding for transcoding leaf ranges.  
Public struct IStructBindIds    
Public struct TArrayBinding    
Public struct TConcat    
Public struct TCttiOf    
Public struct TCustomBind    
Public struct TCustomInit    
Public struct TCustomTypename    
Public struct THexString    
Public class TIdIndexer    
Public struct TInnerType    
Public struct TMapBinding    
Public struct TOptionalBinding    
Public class TOptionalId    
Public struct TRangeBind    
Public struct TRangeMemberHelper Helps templated custom bindings save containers as ranges.  
Public class TRangeView    
Public struct TSetBinding    
Public struct TSetDeltaBinding    
Public struct TShortTypename WIP type trait used to type-erase range bind names, might get folded into TTypename.  
Public class TStructuralRangeView    
Public struct TTuple_Ctti    
Public struct TTypename Trait that defines DeclName, BindName and template Parameters that's part of the typename  
Public struct TUniquePtrBinding    

Constants

Name Description
PlainProps::UeArrayName  
PlainProps::UeMapName  
PlainProps::UeSetName  

Typedefs

Name Description
CttiOf  
CustomBind  
FDefaultStructs  
FLoadBatchPtr  
FNestedRangeView  
FOptionalConcreteTypenameId  
FOptionalEnumSchemaId  
FOptionalMemberId  
FOptionalNameId  
FOptionalNestedScopeId  
FOptionalParametricTypeId  
FOptionalSchemaId  
FOptionalStructSchemaId  
FStructRangeView  
RangeBind  

Enums

  Type Name Description
Public enum PlainProps::ECustomLoadMethod    
Public enum PlainProps::EEnumMode    
Public enum PlainProps::ELeafBindType    
Public enum PlainProps::ELeafType    
Public enum PlainProps::ELeafWidth    
Public enum PlainProps::EMemberKind    
Public enum PlainProps::EMemberPresence    
Public enum PlainProps::ERangeSizeType    
Public enum PlainProps::ESchemaFormat    
Public enum PlainProps::ETypename A declared struct can be bound to multiple runtime implementations.  

Functions

  Type Name Description
Public function TTuple_Ctti< Ts... >

CttiOfPtr ( TTuple< Ts... >*
)

  
Public function const T *

PlainProps::AlignPtr ( const void* Ptr
)

  
Public function void

PlainProps::AppendString ( FString& Out,
const FName& Name
)

  
Public function void

PlainProps::AppendString ( FString& Out,
const NameType& Str
)

  
Public function FStructSchemaId  
Public function FMemberBindType  
Public function FMemberBinding  
Public function FMemberBindType  
Public function void  
Public function FTypedRange

PlainProps::BuildEnumRange ( FScratchAllocator& Scratch,
FEnumSchemaId Enum,
TConstArrayView< T, SizeType > Values
)

  
Public function FTypedRange

PlainProps::BuildLeafRange ( FScratchAllocator& Scratch,
const T* Values,
SizeType Num
)

  
Public function FTypedRange

PlainProps::BuildLeafRange ( FScratchAllocator& Scratch,
TConstArrayView< T, SizeType > Values
)

  
Public function void

PlainProps::ConstructAndLoadStruct ( void* Dst,
FStructView Src,
const FLoadBatch& Batch
)

  
Public function uint32  
Public function FLoadBatchPtr

PlainProps::CreateLoadPlans ( FReadBatchId ReadId,
TConstArrayView< FStructSchemaId > RuntimeIds
)

  
Public function FEnumSchemaId  
Public function FStructSchemaId  
Public function bool

PlainProps::EqualItems ( RangeTypeA&& A,
RangeTypeB&& B
)

 Works with FBoolRangeView, which lack GetData(), TRangeView, TArrayView, std::intializer_list and T[].
Public function Static void

PlainProps::ForEachVar ( Fn&& Visitor
)

 E.g. ForEachVar>([]() { printf(Var::Name); });.
Public function FMemberId  
Public function IdType  
Public function FParametricTypeId  
Public function FEnumSchemaId Cached by function static.
Public function TConstArrayView< FRangeBinding >  
Public function FStructSchemaId Cached by function static.
Public function FStructSchemaId Cached by function static.
Public function std::string_view  
Public function FUnpackedLeafType  
Public function ELeafWidth  
Public function FTypeId  
Public function FTypeId  
Public function FScopeId  
Public function FTypeId  
Public function FTypeId

PlainProps::IndexParametricType ( FTypeId TemplatedType,
const std::tuple< Ts... >*
)

  
Public function FStructSchemaId  
Public function FDualStructSchemaId  
Public function FTypeId  
Public function FMemberSchema  
Public function FMemberSchema  
Public function FMemberSchema

PlainProps::MakeNestedRangeSchema ( ERangeSizeType SizeType,
const FMemberType(&) InnerTypes,
FOptionalSchemaId InnermostSchema
)

  
Public function FSaveContext  
Public function FTypedRange

PlainProps::MakeStructRange ( FStructSchemaId Schema,
ERangeSizeType SizeType,
FBuiltRange* Values
)

  
Public function FMemberSchema  
Public function uint64  
Public function bool  
Public function void

PlainProps::Private::Append ( char*& ToIt,
std::string_view From
)

  
Public function ERangeSizeType  
Public function ERangeSizeType  
Public function ERangeSizeType  
Public function ERangeSizeType  
Public function ERangeSizeType  
Public function ERangeSizeType  
Public function ERangeSizeType  
Public function ERangeSizeType  
Public function ERangeSizeType  
Public function FMemberType  
Public function std::string_view  
Public function SIZE_T  
Public function SIZE_T  
Public function FAnsiStringView

PlainProps::ToAnsiView ( std::string_view Str
)

  
Public function uint32  
Public function uint32  
Public function uint32  
Public function uint32  
Public function uint32  
Public function uint32  
Public function Static ELeafBindType  
Public function Static ELeafType  
Public function Static FLeafType  
Public function TOptionalId< IdType >

PlainProps::ToOptional ( IdType Id
)

  
Public function FOptionalSchemaId  
Public function FOptionalSchemaId  
Public function FUnpackedLeafType Type != ELeafBindType::BitfieldBool
Public function uint64

PlainProps::ValueCast ( char8_t Value
)

  
Public function uint64  
Public function uint64  
Public function uint64  
Public function uint64  
Public function uint64  
Public function uint64  
Public function uint64  
Public function uint64

PlainProps::ValueCast ( bool Value
)

  
Public function uint64

PlainProps::ValueCast ( char16_t Value
)

  
Public function uint64  
Public function uint64

PlainProps::ValueCast ( char32_t Value
)

  

Variables

  Type Name Description
Public variable std::string_view ArithmeticName  
Public variable std::string_view Concat  
Public variable FMemberType DefaultStructType  
Public variable std::string_view HexString  
Public variable std::string_view InlineAllocatorPrefix  
Public variable ELeafWidth LeafWidth  
Public variable ELeafWidth LeafWidth< 1 >  
Public variable ELeafWidth LeafWidth< 2 >  
Public variable ELeafWidth LeafWidth< 4 >  
Public variable ELeafWidth LeafWidth< 8 >  
Public variable FNoId NoId  
Public variable FUnpackedLeafType ReflectArithmetic  
Public variable FUnpackedLeafType ReflectArithmetic< bool >  
Public variable FUnpackedLeafType ReflectArithmetic< char >  
Public variable FUnpackedLeafType ReflectArithmetic< char16_t >  
Public variable FUnpackedLeafType ReflectArithmetic< char32_t >  
Public variable FUnpackedLeafType ReflectArithmetic< char8_t >  
Public variable FUnpackedLeafType ReflectArithmetic< double >  
Public variable FUnpackedLeafType ReflectArithmetic< float >  
Public variable FUnpackedLeafType ReflectArithmetic< int16 >  
Public variable FUnpackedLeafType ReflectArithmetic< int32 >  
Public variable FUnpackedLeafType ReflectArithmetic< int64 >  
Public variable FUnpackedLeafType ReflectArithmetic< int8 >  
Public variable FUnpackedLeafType ReflectArithmetic< uint16 >  
Public variable FUnpackedLeafType ReflectArithmetic< uint32 >  
Public variable FUnpackedLeafType ReflectArithmetic< uint64 >  
Public variable FUnpackedLeafType ReflectArithmetic< uint8 >  
Public variable FUnpackedLeafType ReflectEnum  
Public variable std::string_view ShortTypename  
Public variable FMemberType SuperStructType  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page