 |
Operating System Simulator Plugin
3.5.1
Unreal Engine plugin that simulates an Operating System Environment
|
|
Operating System Simulator Plugin
3.5.1
Unreal Engine plugin that simulates an Operating System Environment
|
#include "OperatingSystemDir_Documents.h"
Public Member Functions | |
| UOperatingSystemDir_Documents () | |
 Public Member Functions inherited from UOperatingSystemDirectory | |
| UOperatingSystemDirectory () | |
| FText | GetDirectoryName () const |
| bool | IsSystemDirectory () const |
| UObject * | GetDirectoryIconObject () const |
| virtual TArray< UOperatingSystemDirectory * > | GetChildDirectories () const override final |
| Get the child directories of the current operating system directory. | |
| virtual void | GetParentExplorerInterface (TScriptInterface< IOperatingSystemExplorerInterface > &OutInterface) const override final |
| Retrieves the parent explorer interface of the operating system directory. | |
| virtual bool | IsPartition () const override final |
| Check if the directory is a partition. This method checks whether the directory is a partition or not. | |
| virtual FText | GetInterfaceDisplayName () const override final |
| Returns the display name of the interface. This method returns the display name of the interface as a FText object. The display name is a textual representation of the interface. | |
| virtual bool | FindDirectoryByTag (const FGameplayTag DirectoryTag, const bool bRecursive, UOperatingSystemDirectory *&OutDirectory) const override final |
| Finds a directory by tag. This method searches for a directory with the specified tag within the current directory and, optionally, within its child directories recursively. | |
| virtual TScriptInterface< IOperatingSystemExplorerInterface > | GetChildDirectory (const FString &TargetChildDirectoryName, const bool bRecursive=true) const override final |
| Retrieves a child directory with the specified name. This method searches for a child directory with the given name in the current directory. If the child directory is found, it is returned. | |
| virtual TArray< UOperatingSystemFile * > | GetAllFiles (const FString &WithExtension="*") const override final |
| GetAllFiles is a method that returns an array of operating system files in the directory. | |
| virtual bool | CanCreateNewFile () const override final |
| Determines whether the operating system directory can create a new file. | |
| virtual bool | HasEnoughSpace (const FOperatingSystemSizeInMB &TestSpace) const override final |
| Determines if the operating system directory has enough space to hold a given amount of data. | |
| virtual UOperatingSystem * | GetOperatingSystem () const override final |
| Returns the operating system object associated with the directory. | |
| virtual TOptional< FString > | GetFullPath () const override final |
| Retrieves the full path of the operating system directory. This method returns the full path of the operating system directory by traversing through its parent directories and concatenating the directory names. | |
| virtual TScriptInterface< IOperatingSystemExplorerInterface > | GetInterfaceFromPath (const FString &NewPath) const override final |
| Retrieves an interface from a specified path. This method retrieves an interface from a specified path. The path is used to locate the desired interface in the operating system. | |
| virtual bool | IsUnixRootDirectory () const |
| void | LoadFiles (const FOperatingSystemDirectoriesSaveLoad &DirectoriesSaveLoad) |
| Load the files from the provided FOperatingSystemDirectoriesSaveLoad object. This method creates UOperatingSystemFile objects for each file specified in the SaveLoad_Files array of the FOperatingSystemDirectoriesSaveLoad object and adds them to the Files array of the UOperatingSystemDirectory object. It also checks if there are any newly added file classes in the FileClasses array of the UOperatingSystemDirectory object, and creates UOperatingSystemFile objects for each newly added file class, if necessary. | |
| FString | GetDirectoryPath () const |
| void | GetSaveData (TArray< FOperatingSystemDirectoriesSaveLoad > &OutSaveData) const |
| Retrieves the save data for the operating system directories. | |
| bool | CheckForDirectoryWithTag (const FGameplayTag &TestTag, const bool bRecursive) const |
| Check if the directory has a specific tag. | |
| FORCEINLINE bool | CanCreateNewFolder () const |
| Checks if the user has permission to create a new folder. | |
| FORCEINLINE bool | CanRename () const |
| Checks if the directory can be renamed. | |
| FORCEINLINE FGameplayTag | GetDirectoryTag () const |
| Retrieves the directory tag. | |
| template<class T > | |
| T * | GetAs () const |
| Returns a pointer to the current object casted to the specified type. The specified type, T, must be derived from the UOperatingSystemDirectory class. | |
| template<class T > | |
| FORCEINLINE const T * | GetAsConst () const |
| Returns a pointer to the current object casted to the specified type. The specified type, T, must be derived from the UOperatingSystemDirectory class. | |
| template<class T > | |
| T * | GetChildDirectory (const FString &TargetChildDirectoryName, const bool bRecursive=true) const |
| Retrieves a child directory with the given name. | |
Additional Inherited Members | |
| Static Public Member Functions inherited from UOperatingSystemDirectory | |
| static UOperatingSystemDirectory * | CreateDirectory (const TWeakObjectPtr< UOperatingSystemPartition > OwningPartition, const TWeakObjectPtr< UOperatingSystemDirectory > OwningDirectory, const TWeakObjectPtr< UOperatingSystem > OwningOS, const TSoftClassPtr< UOperatingSystemDirectory > &DirectoryClass, const bool bIsFromSaveGame, FGenericError &OutError) |
| template<class T > | |
| static T * | CreateDirectory (const TWeakObjectPtr< UOperatingSystemPartition > OwningPartition, const TWeakObjectPtr< UOperatingSystemDirectory > OwningDirectory, const TWeakObjectPtr< UOperatingSystem > OwningOS, const TSoftClassPtr< UOperatingSystemDirectory > &DirectoryClass, const bool bIsFromSaveGame, FGenericError &OutError) |
| Creates a new directory of type T in the operating system. | |
| Protected Member Functions inherited from UOperatingSystemDirectory | |
| virtual void | OnValidate (FGenericError &OutError) |
| This method is called to perform custom validation for the operating system directory. | |
| Protected Attributes inherited from UOperatingSystemDirectory | |
| FText | Name |
| FGameplayTag | Tag |
| TSoftObjectPtr< UObject > | OverrideIcon |
| uint8 | bCanCreateNewFolder: 1 |
| uint8 | bCanCreateNewFile: 1 |
| uint8 | bIsHidden: 1 |
| TSet< TSoftClassPtr< UOperatingSystemFile > > | FileClasses |
| TSoftObjectPtr< UOperatingSystemDirectoriesCollection > | ChildDirectoryCollection |
| TWeakObjectPtr< UOperatingSystemDirectory > | ParentDirectory |
| TWeakObjectPtr< UOperatingSystemPartition > | ParentPartition |
| TArray< TObjectPtr< UOperatingSystemFile > > | Files |
| TArray< TObjectPtr< UOperatingSystemDirectory > > | ChildDirectories |
| TWeakObjectPtr< UOperatingSystem > | ParentOS |
The UOperatingSystemDir_Documents class is a blueprintable and blueprint type class that represents a directory in the operating system's documents folder.
| UOperatingSystemDir_Documents::UOperatingSystemDir_Documents | ( | ) |
1.10.0