Ark Server API (ASA) - Wiki
Loading...
Searching...
No Matches
IPhysicalPlatformFile Class Reference

#include <GenericPlatformFile.h>

+ Inheritance diagram for IPhysicalPlatformFile:
+ Collaboration diagram for IPhysicalPlatformFile:

Public Member Functions

virtual bool ShouldBeUsed (IPlatformFile *Inner, const TCHAR *CmdLine) const override
 
virtual bool Initialize (IPlatformFile *Inner, const TCHAR *CmdLine) override
 
virtual IPlatformFileGetLowerLevel () override
 
virtual void SetLowerLevel (IPlatformFile *NewLowerLevel) override
 
virtual const TCHAR * GetName () const override
 
- Public Member Functions inherited from IPlatformFile
virtual ~IPlatformFile ()
 
virtual void SetSandboxEnabled (bool bInEnabled)
 
virtual bool IsSandboxEnabled () const
 
virtual void InitializeAfterSetActive ()
 
virtual void InitializeAfterProjectFilePath ()
 
virtual void MakeUniquePakFilesForTheseFiles (const TArray< TArray< FString > > &InFiles)
 
virtual void InitializeNewAsyncIO ()
 
virtual void AddLocalDirectories (TArray< FString > &LocalDirectories)
 
virtual void BypassSecurity (bool bInBypass)
 
virtual void Tick ()
 
virtual bool FileExists (const TCHAR *Filename)=0
 
virtual int64 FileSize (const TCHAR *Filename)=0
 
virtual bool DeleteFile (const TCHAR *Filename)=0
 
virtual bool IsReadOnly (const TCHAR *Filename)=0
 
virtual bool MoveFile (const TCHAR *To, const TCHAR *From)=0
 
virtual bool SetReadOnly (const TCHAR *Filename, bool bNewReadOnlyValue)=0
 
virtual FDateTime GetTimeStamp (const TCHAR *Filename)=0
 
virtual void SetTimeStamp (const TCHAR *Filename, FDateTime DateTime)=0
 
virtual FDateTime GetAccessTimeStamp (const TCHAR *Filename)=0
 
virtual FString GetFilenameOnDisk (const TCHAR *Filename)=0
 
virtual bool IsSymlink (const TCHAR *Filename)
 
virtual IFileHandleOpenRead (const TCHAR *Filename, bool bAllowWrite=false)=0
 
virtual IFileHandleOpenReadNoBuffering (const TCHAR *Filename, bool bAllowWrite=false)
 
virtual IFileHandleOpenWrite (const TCHAR *Filename, bool bAppend=false, bool bAllowRead=false)=0
 
virtual bool DirectoryExists (const TCHAR *Directory)=0
 
virtual bool CreateDirectory (const TCHAR *Directory)=0
 
virtual bool DeleteDirectory (const TCHAR *Directory)=0
 
virtual FFileStatData GetStatData (const TCHAR *FilenameOrDirectory)=0
 
virtual bool IterateDirectory (const TCHAR *Directory, FDirectoryVisitor &Visitor)=0
 
virtual bool IterateDirectoryStat (const TCHAR *Directory, FDirectoryStatVisitor &Visitor)=0
 
virtual IAsyncReadFileHandle * OpenAsyncRead (const TCHAR *Filename)
 
virtual void SetAsyncMinimumPriority (EAsyncIOPriorityAndFlags MinPriority)
 
virtual IMappedFileHandleOpenMapped (const TCHAR *Filename)
 
virtual void GetTimeStampPair (const TCHAR *PathA, const TCHAR *PathB, FDateTime &OutTimeStampA, FDateTime &OutTimeStampB)
 
virtual FDateTime GetTimeStampLocal (const TCHAR *Filename)
 
virtual bool IterateDirectory (const TCHAR *Directory, FDirectoryVisitorFunc Visitor)
 
virtual bool IterateDirectoryStat (const TCHAR *Directory, FDirectoryStatVisitorFunc Visitor)
 
virtual bool IterateDirectoryRecursively (const TCHAR *Directory, FDirectoryVisitor &Visitor)
 
virtual bool IterateDirectoryStatRecursively (const TCHAR *Directory, FDirectoryStatVisitor &Visitor)
 
virtual bool IterateDirectoryRecursively (const TCHAR *Directory, FDirectoryVisitorFunc Visitor)
 
virtual bool IterateDirectoryStatRecursively (const TCHAR *Directory, FDirectoryStatVisitorFunc Visitor)
 
virtual void FindFiles (TArray< FString > &FoundFiles, const TCHAR *Directory, const TCHAR *FileExtension)
 
virtual void FindFilesRecursively (TArray< FString > &FoundFiles, const TCHAR *Directory, const TCHAR *FileExtension)
 
virtual bool DeleteDirectoryRecursively (const TCHAR *Directory)
 
virtual bool CreateDirectoryTree (const TCHAR *Directory)
 
virtual bool CopyFile (const TCHAR *To, const TCHAR *From, EPlatformFileRead ReadFlags=EPlatformFileRead::None, EPlatformFileWrite WriteFlags=EPlatformFileWrite::None)
 
virtual bool CopyDirectoryTree (const TCHAR *DestinationDirectory, const TCHAR *Source, bool bOverwriteAllExisting)
 
virtual FString ConvertToAbsolutePathForExternalAppForRead (const TCHAR *Filename)
 
virtual FString ConvertToAbsolutePathForExternalAppForWrite (const TCHAR *Filename)
 
virtual bool SendMessageToServer (const TCHAR *Message, IFileServerMessageHandler *Handler)
 
virtual bool DoesCreatePublicFiles ()
 
virtual void SetCreatePublicFiles (bool bCreatePublicFiles)
 

Additional Inherited Members

- Public Types inherited from IPlatformFile
typedef TFunctionRef< bool(const TCHAR *, boolFDirectoryVisitorFunc)
 
typedef TFunctionRef< bool(const TCHAR *, const FFileStatData &) FDirectoryStatVisitorFunc)
 
- Static Public Member Functions inherited from IPlatformFile
static IPlatformFileGetPlatformPhysical ()
 
static const TCHAR * GetPhysicalTypeName ()
 

Detailed Description

Common base for physical platform File I/O Interface

Definition at line 621 of file GenericPlatformFile.h.

Member Function Documentation

◆ GetLowerLevel()

virtual IPlatformFile * IPhysicalPlatformFile::GetLowerLevel ( )
inlineoverridevirtual

Gets the platform file wrapped by this file.

Implements IPlatformFile.

Definition at line 630 of file GenericPlatformFile.h.

◆ GetName()

virtual const TCHAR * IPhysicalPlatformFile::GetName ( ) const
inlineoverridevirtual

Gets this platform file type name.

Implements IPlatformFile.

Definition at line 638 of file GenericPlatformFile.h.

+ Here is the call graph for this function:

◆ Initialize()

virtual bool IPhysicalPlatformFile::Initialize ( IPlatformFile * Inner,
const TCHAR * CmdLine )
overridevirtual

Initializes platform file.

Parameters
InnerPlatform file to wrap by this file.
CmdLineCommand line to parse.
Returns
true if the initialization was successful, false otherise.

Implements IPlatformFile.

◆ SetLowerLevel()

virtual void IPhysicalPlatformFile::SetLowerLevel ( IPlatformFile * NewLowerLevel)
inlineoverridevirtual

Sets the platform file wrapped by this file.

Implements IPlatformFile.

Definition at line 634 of file GenericPlatformFile.h.

◆ ShouldBeUsed()

virtual bool IPhysicalPlatformFile::ShouldBeUsed ( IPlatformFile * Inner,
const TCHAR * CmdLine ) const
inlineoverridevirtual

Checks if this platform file should be used even though it was not asked to be. i.e. pak files exist on disk so we should use a pak file

Reimplemented from IPlatformFile.

Definition at line 625 of file GenericPlatformFile.h.


The documentation for this class was generated from the following file: