Ark Server API (ASA) - Wiki
|
#include <ArchiveProxy.h>
Protected Attributes | |
FArchive & | InnerArchive |
Base class for archive proxies.
Archive proxies are archive types that modify the behavior of another archive type.
Definition at line 14 of file ArchiveProxy.h.
FArchiveProxy::FArchiveProxy | ( | FArchive & | InInnerArchive | ) |
Creates and initializes a new instance of the archive proxy.
InInnerArchive | The inner archive to proxy. |
FArchiveProxy::~FArchiveProxy | ( | ) |
|
delete |
|
delete |
Returns true if the current location within the backing data storage is at the end, always returns false if there is no storage.
Reimplemented from FArchive.
Definition at line 137 of file ArchiveProxy.h.
|
inlineoverridevirtual |
Attaches/ associates the passed in bulk data object with the linker.
Owner | UObject owning the bulk data |
BulkData | Bulk data object to associate |
Reimplemented from FArchive.
Definition at line 147 of file ArchiveProxy.h.
|
inlineoverridevirtual |
Adds external read dependency
Reimplemented from FArchive.
Definition at line 217 of file ArchiveProxy.h.
Attempts to close and finalize any handles used for backing data storage, returns true if it succeeded.
Reimplemented from FArchive.
Definition at line 177 of file ArchiveProxy.h.
Called to get the computed size from a size-detecting archive after it has finished serializing.
Reimplemented from FArchive.
Definition at line 110 of file ArchiveProxy.h.
|
inlineoverridevirtual |
Detaches the passed in bulk data object from the linker.
BulkData | Bulk data object to detach |
bEnsureBulkDataIsLoaded | Whether to ensure that the bulk data is loaded before detaching |
Reimplemented from FArchive.
Definition at line 152 of file ArchiveProxy.h.
Attempts to finish writing any buffered data to disk/permanent storage.
Reimplemented from FArchive.
Definition at line 172 of file ArchiveProxy.h.
Flushes cache and frees internal data.
Reimplemented from FArchive.
Definition at line 232 of file ArchiveProxy.h.
Inform the archive that a blueprint would like to force finalization, normally this is triggered by CDO load, but if there's no CDO we force finalization.
Reimplemented from FArchive.
Definition at line 237 of file ArchiveProxy.h.
|
inlineoverridevirtual |
Called to retrieve the archetype from the event driven loader. If this returns null, then call GetArchetype yourself.
Reimplemented from FArchive.
Definition at line 212 of file ArchiveProxy.h.
Returns the name of the Archive. Useful for getting the name of the package a struct or object is in when a loading error occurs.
This is overridden for the specific Archive Types
Reimplemented from FArchive.
Returns a pointer to an archive that represents the same data that the current archive covers, but that can be cached and reused later In the case of standard archives, this function will just return a pointer to itself. If the archive is actually a temporary proxy to another archive, and has a shorter lifecycle than the source archive, it should return either a pointer to the underlying archive, or if the data becomes inaccessible when the proxy object disappears (as is the case with text format archives) then nullptr
Reimplemented from FArchive.
Definition at line 296 of file ArchiveProxy.h.
|
inlineoverridevirtual |
Gets the custom version numbers for this archive. These are used to check for system or game-specific version numbers.
Reimplemented from FArchive.
Definition at line 192 of file ArchiveProxy.h.
|
inlineoverridevirtual |
Returns lowest level archive state, proxy archives will override this.
Reimplemented from FArchive.
Definition at line 301 of file ArchiveProxy.h.
If this archive is a FLinkerLoad or FLinkerSave, returns a pointer to the ULinker portion.
Reimplemented from FArchive.
Definition at line 117 of file ArchiveProxy.h.
|
inlinevirtual |
Determine if the given archive is a valid "child" of this archive. In general, this means "is exactly the same" but this function allows a derived archive to support "child" or "internal" archives which are different objects that proxy the original one in some way.
BulkData | Bulk data object to detach |
bEnsureBulkDataIsLoaded | Whether to ensure that the bulk data is loaded before detaching |
Reimplemented from FArchive.
Definition at line 291 of file ArchiveProxy.h.
Called when an object stops serializing property data using script serialization.
Reimplemented from FArchive.
Definition at line 187 of file ArchiveProxy.h.
|
inlineoverridevirtual |
Called when an object begins serializing property data using script serialization.
Reimplemented from FArchive.
Definition at line 182 of file ArchiveProxy.h.
|
inlineoverridevirtual |
Called to register a reference to a specific name value, of type TypeObject (UEnum or UStruct normally). Const so it can be called from PostSerialize
Reimplemented from FArchive.
Definition at line 207 of file ArchiveProxy.h.
Serializes a Field value from or into this archive.
This operator can be implemented by sub-classes that wish to serialize UObject instances.
Value | The value to serialize. |
Reimplemented from FArchive.
Definition at line 79 of file ArchiveProxy.h.
|
inlineoverridevirtual |
Serializes a lazy object pointer value from or into this archive.
Most of the time, FLazyObjectPtrs are serialized as UObject*, but some archives need to override this.
Value | The value to serialize. |
Reimplemented from FArchive.
Definition at line 55 of file ArchiveProxy.h.
Serializes an FName value from or into this archive.
This operator can be implemented by sub-classes that wish to serialize FName instances.
Value | The value to serialize. |
Reimplemented from FArchive.
Reimplemented in FNameAsStringProxyArchive, and FNameAsStringIndexProxyArchive.
Definition at line 31 of file ArchiveProxy.h.
|
inlineoverridevirtual |
Serializes a wrapped object pointer value from or into this archive.
Most of the time, FObjectPtrs are serialized as UObject*, but some archives need to override this.
Value | The value to serialize. |
Reimplemented from FArchive.
Definition at line 49 of file ArchiveProxy.h.
|
inlineoverridevirtual |
Serializes soft object paths from or into this archive.
Value | Soft object path to serialize. |
Reimplemented from FArchive.
Definition at line 61 of file ArchiveProxy.h.
|
inlineoverridevirtual |
Serializes asset pointer from or into this archive.
Most of the time, FSoftObjectPtr are serialized as UObject *, but some archives need to override this.
Value | The asset pointer to serialize. |
Reimplemented from FArchive.
Definition at line 67 of file ArchiveProxy.h.
Serializes an FText value from or into an archive.
Ar | The archive to serialize from or to. |
Value | The value to serialize. |
Reimplemented from FArchive.
Definition at line 37 of file ArchiveProxy.h.
|
inlineoverridevirtual |
Serializes FWeakObjectPtr value from or into this archive.
This operator can be implemented by sub-classes that wish to serialize FWeakObjectPtr instances.
Value | The value to serialize. |
Reimplemented from FArchive.
Definition at line 73 of file ArchiveProxy.h.
Serializes an UObject value from or into this archive.
This operator can be implemented by sub-classes that wish to serialize UObject instances.
Value | The value to serialize. |
Reimplemented from FArchive.
Definition at line 43 of file ArchiveProxy.h.
|
delete |
|
delete |
|
inlinevirtual |
Pops editor-only marker from the stack of currently serialized properties
Reimplemented from FArchive.
Definition at line 278 of file ArchiveProxy.h.
|
inlineoverridevirtual |
Hint the archive that the region starting at passed in offset and spanning the passed in size is going to be read soon and should be precached.
The function returns whether the precache operation has completed or not which is an important hint for code knowing that it deals with potential async I/O. The archive is free to either not implement this function or only partially precache so it is required that given sufficient time the function will return true. Archives not based on async I/O should always return true.
This function will not change the current archive position.
PrecacheOffset | Offset at which to begin precaching. |
PrecacheSize | Number of bytes to precache |
Reimplemented from FArchive.
Definition at line 162 of file ArchiveProxy.h.
Tells the archive to attempt to preload the specified object so data can be loaded out of it.
Reimplemented from FArchive.
Definition at line 105 of file ArchiveProxy.h.
|
inlinevirtual |
Pushes editor-only marker to the stack of currently serialized properties
Reimplemented from FArchive.
Definition at line 272 of file ArchiveProxy.h.
Resets the custom version numbers for this archive.
Reimplemented from FArchive.
Definition at line 202 of file ArchiveProxy.h.
Attempts to set the current offset into backing data storage, this will do nothing if there is no storage.
Reimplemented from FArchive.
Definition at line 142 of file ArchiveProxy.h.
Reimplemented from FArchive.
Definition at line 85 of file ArchiveProxy.h.
Reimplemented from FArchive.
Definition at line 90 of file ArchiveProxy.h.
|
inlineoverridevirtual |
Serialize bulk data.
BulkData | Bulk data object to serialize |
Params | Serialization parameters |
Reimplemented from FArchive.
Definition at line 157 of file ArchiveProxy.h.
Reimplemented from FArchive.
Definition at line 95 of file ArchiveProxy.h.
Packs int value into bytes of 7 bits with 8th bit for 'more'
Reimplemented from FArchive.
Definition at line 100 of file ArchiveProxy.h.
|
inlineoverridevirtual |
Sets mapping from offsets/ sizes that are going to be used for seeking and serialization to what is actually stored on disk. If the archive supports dealing with compression in this way it is going to return true.
CompressedChunks | Pointer to array containing information about [un]compressed chunks |
CompressionFlags | Flags determining compression format associated with mapping |
Reimplemented from FArchive.
Definition at line 167 of file ArchiveProxy.h.
|
inlineoverridevirtual |
Sets the custom version numbers for this archive.
CustomVersionContainer | - The container of custom versions to copy into the archive. |
Reimplemented from FArchive.
Definition at line 197 of file ArchiveProxy.h.
Sets a flag indicating that this archive needs to filter editor-only content.
InFilterEditorOnly | Whether to filter editor-only content. |
Reimplemented from FArchive.
Definition at line 242 of file ArchiveProxy.h.
|
inlineoverridevirtual |
Overrides the property that is currently being serialized
InProperty | Pointer to the property that is currently being serialized |
Reimplemented from FArchive.
Definition at line 259 of file ArchiveProxy.h.
|
inlineoverridevirtual |
Set the raw serialized property chain for this archive, optionally overriding the serialized property too (or null to use the head of the property chain)
Reimplemented from FArchive.
Definition at line 265 of file ArchiveProxy.h.
|
inlineoverridevirtual |
Checks whether the archive wants to skip the property independent of the other flags
Reimplemented from FArchive.
Definition at line 222 of file ArchiveProxy.h.
Returns the current location within the backing data storage, which can possibly be passed to Seek later to restore a read/write location. If this returns -1, there is no backing data storage and Seek will not function.
Reimplemented from FArchive.
Definition at line 127 of file ArchiveProxy.h.
Returns total size of the backing data storage.
Reimplemented from FArchive.
Definition at line 132 of file ArchiveProxy.h.
Checks whether the archive is used to resolve out-of-date enum indexes If function returns true, the archive should be called only for objects containing user defined enum
Reimplemented from FArchive.
Definition at line 227 of file ArchiveProxy.h.
|
protected |
Holds the archive that this archive is a proxy to.
Definition at line 309 of file ArchiveProxy.h.