This page has been translated automatically.
UnigineEditor
Interface Overview
Assets Workflow
Settings and Preferences
Working With Projects
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Landscape Tool
Using Editor Tools for Specific Tasks
Extending Editor Functionality
Programming
Fundamentals
Setting Up Development Environment
Usage Examples
UnigineScript
C++
C#
UUSL (Unified UNIGINE Shader Language)
File Formats
Rebuilding the Engine Tools
GUI
Double Precision Coordinates
API
Containers
Common Functionality
Controls-Related Classes
Engine-Related Classes
GUI-Related Classes
Math Functionality
Node-Related Classes
Objects-Related Classes
Networking Functionality
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
IG Plugin
CIGIConnector Plugin
Rendering-Related Classes
Warning! This version of documentation is OUTDATED, as it describes an older SDK version! Please switch to the documentation for the latest SDK version.
Warning! This version of documentation describes an old SDK version which is no longer supported! Please upgrade to the latest SDK version.

engine.filesystemassets Functions

Warning
The scope of applications for UnigineScript is limited to implementing materials-related logic (material expressions, scriptable materials, brush materials). Do not use UnigineScript as a language for application logic, please consider C#/C++ instead, as these APIs are the preferred ones. Availability of new Engine features in UnigineScipt (beyond its scope of applications) is not guaranteed, as the current level of support assumes only fixing critical issues.

This class represents the subsystem of the Engine's file system that is used to manage assets and runtime files.

FileSystemAssets Class

Members


int isAsset ( ) #

Returns a value indicating whether the file with the specified GUID is a non-native asset (has runtime files generated for it).

Arguments

    Return value

    1 if the file with the specified GUID is a non-native asset; otherwise, 0.

    int isAsset ( ) #

    Returns a value indicating whether the file with the specified path is a non-native asset (has runtime files generated for it).

    Arguments

      Return value

      1 if the file with the specified path is a non-native asset; otherwise, 0.

      UGUID getAssetGUID ( ) #

      Returns a GUID of a non-native asset (having generated runtime file or files) for the specified path.

      Arguments

        Return value

        GUID of a non-native asset corresponding to the specified path if it exists; otherwise, empty GUID.
        Notice
        This method will return an empty GUID for any asset having no runtimes generated for it.

        UGUID getAssetGUID ( ) #

        Returns a GUID of a non-native asset (having generated runtime file or files) for the specified GUID.

        Arguments

          Return value

          GUID of a non-native asset corresponding to the specified path if it exists; otherwise, empty GUID.
          Notice
          This method will return an empty GUID for any asset having no runtimes generated for it.

          int getNumRuntimes ( ) #

          Returns a number of runtime files for a non-native asset having the specified path.

          Arguments

            Return value

            Number of runtime files generated for the specified asset.

            int getNumRuntimes ( ) #

            Returns a number of runtime files for a non-native asset having the specified GUID.

            Arguments

              Return value

              Number of runtime files generated for the specified asset.

              int isPrimary ( ) #

              Returns a value indicating whether the runtime file corresponding to the specified path is a primary one.

              Arguments

                Return value

                1 if the runtime file corresponding to the specified path is a primary one; otherwise, 0.

                int isPrimary ( ) #

                Returns a value indicating whether the runtime file corresponding to the specified GUID is a primary one.

                Arguments

                  Return value

                  1 if the runtime file corresponding to the specified GUID is a primary one; otherwise, 0.

                  UGUID getPrimaryGUID ( ) #

                  Returns the GUID of the primary runtime file for the specified file GUID if it exists.

                  Arguments

                    Return value

                    Return value is determined by the specified GUID in accordance with the following:
                    • Asset file GUID -> GUID of its primary runtime file, if any; otherwise empty GUID.
                    • Primary runtime file GUID -> GUID of this primary runtime file.
                    • Runtime file GUID -> GUID of the primary runtime file for its asset, if any; otherwise empty GUID.
                    • Any other file GUID -> empty GUID.

                    UGUID getPrimaryGUID ( ) #

                    Returns the GUID of the primary runtime file for the specified file path if it exists.

                    Arguments

                      Return value

                      Return value is determined by the specified GUID in accordance with the following:
                      • Asset file path -> GUID of its primary runtime file, if any; otherwise empty GUID.
                      • Primary runtime file path -> GUID of this primary runtime file.
                      • Runtime file path -> GUID of the primary runtime file for its asset, if any; otherwise empty GUID.
                      • Any other file path -> empty GUID.

                      int isMeta ( UGUID any_guid ) #

                      Returns a value indicating whether the file with the specified GUID is a *.meta file.

                      Arguments

                      • UGUID any_guid - Any file GUID.

                      Return value

                      1 if the file with the specified GUID is a *.meta file; otherwise, 0.

                      int isRuntime ( ) #

                      Returns a value indicating whether the file corresponding to the specified path is a generated runtime file.

                      Arguments

                        Return value

                        1 if the file corresponding to the specified path is a generated runtime file; otherwise, 0.
                        Notice
                        This method will return 0 for any native asset.

                        int isRuntime ( ) #

                        Returns a value indicating whether the file corresponding to the specified GUID is a generated runtime file.

                        Arguments

                          Return value

                          1 if the file corresponding to the specified path is a generated runtime file; otherwise, 0.
                          Notice
                          This method will return 0 for any native asset.

                          int isRuntimePath ( string path ) #

                          Returns a value indicating whether the specified path is a path to a generated runtime file.

                          Arguments

                          • string path - Any file path.

                          Return value

                          1 if the specified path is a path to a generated runtime file; otherwise, 0.

                          getRuntimeAlias ( ) #

                          Returns the alias of the generated runtime file, specified by the given path.

                          Arguments

                            Return value

                            Alias set for the specified generated runtime file, if it exists; otherwise nullptr.

                            getRuntimeAlias ( ) #

                            Returns the alias of the generated runtime file, specified by the given GUID.

                            Arguments

                              Return value

                              Alias set for the specified generated runtime file, if it exists; otherwise nullptr.

                              getRuntimeAlias ( int index ) #

                              Returns the alias of the generated runtime file, specified by the given non-native asset path and runtime index.

                              Arguments

                              • int index - Index of the generated runtime file.

                              Return value

                              Alias set for the specified generated runtime file, if it exists; otherwise nullptr.

                              getRuntimeAlias ( int index ) #

                              Returns the alias of the generated runtime file, specified by the given non-native asset GUID and runtime index.

                              Arguments

                              • int index - Index of the generated runtime file.

                              Return value

                              Alias set for the specified generated runtime file, if it exists; otherwise nullptr.

                              int setRuntimeGUID ( ) #

                              Sets a new GUID for the generated runtime file with a given path.

                              Arguments

                                Return value

                                1 if a new GUID is successfully set; otherwise, 0.

                                int setRuntimeGUID ( ) #

                                Sets a new GUID for the generated runtime file with a given GUID.

                                Arguments

                                  Return value

                                  1 if a new GUID is successfully set; otherwise, 0.

                                  int setRuntimeGUID ( int index ) #

                                  Sets a new GUID for the generated runtime file, specified by the given non-native asset path and runtime index.

                                  Arguments

                                  • int index - Index of the generated runtime file.

                                  Return value

                                  1 if a new GUID is successfully set; otherwise, 0.

                                  int setRuntimeGUID ( int index ) #

                                  Sets a new GUID for the generated runtime file, specified by the given non-native asset GUID and runtime index.

                                  Arguments

                                  • int index - Index of the generated runtime file.

                                  Return value

                                  1 if a new GUID is successfully set; otherwise, 0.

                                  UGUID getRuntimeGUID ( int index ) #

                                  Returns the current GUID for the generated runtime file, specified by the given non-native asset path and runtime index.

                                  Arguments

                                  • int index - Index of the generated runtime file.

                                  Return value

                                  Current generated runtime file GUID for the given asset and runtime index, if any; otherwise, empty GUID.

                                  UGUID getRuntimeGUID ( int index ) #

                                  Returns the current GUID for the generated runtime file, specified by the given non-native asset GUID and runtime index.

                                  Arguments

                                  • int index - Index of the generated runtime file.

                                  Return value

                                  Current generated runtime file GUID for the given asset and runtime index, if any; otherwise, empty GUID.

                                  UGUID addRuntime ( int primary = 0 ) #

                                  Creates a new runtime file for the asset with a given path. A new GUID will be generated for the new runtime file.

                                  Arguments

                                  • int primary - Use 1 to create a new runtime as a primary one; otherwise, 0.

                                  Return value

                                  GUID of the new created runtime, if it was successfully created, or an empty GUID, otherwise.

                                  UGUID addRuntime ( int primary = 0 ) #

                                  Creates a new runtime file for the asset with a given GUID. A new GUID will be generated for the new runtime file.

                                  Arguments

                                  • int primary - Use 1 to create a new runtime as a primary one; otherwise, 0.

                                  Return value

                                  GUID of the new created runtime, if it was successfully created, or an empty GUID, otherwise.

                                  int addRuntime ( int primary = 0 ) #

                                  Creates a new runtime file for the asset with a given path. The specified GUID will be assigned to the new runtime file.

                                  Arguments

                                  • int primary - Use 1 to create a new runtime as a primary one; otherwise, 0.

                                  Return value

                                  1 if a new runtime file is successfully created; otherwise, 0.

                                  int addRuntime ( int primary = 0 ) #

                                  Creates a new runtime file for the asset with a given GUID. The specified GUID will be assigned to the new runtime file.

                                  Arguments

                                  • int primary - Use 1 to create a new runtime as a primary one; otherwise, 0.

                                  Return value

                                  1 if a new runtime file is successfully created; otherwise, 0.

                                  int clearRuntimes ( ) #

                                  Deletes all generated runtime files for the asset with the specified path.

                                  Arguments

                                    Return value

                                    1 if all generated runtime files for the specified asset are successfully deleted; otherwise, 0.

                                    int clearRuntimes ( ) #

                                    Deletes all generated runtime files for the asset with the specified GUID.

                                    Arguments

                                      Return value

                                      1 if all generated runtime files for the specified asset are successfully deleted; otherwise, 0.

                                      UGUID copyRuntime ( ) #

                                      Adds a copy of the generated runtime file with the specified path to another asset with the specified path.
                                      Notice
                                      A new GUID will be generated for the created runtime file copy.

                                      Arguments

                                        Return value

                                        GUID of the new runtime file copy, if it is created successfully; otherwise, empty GUID.

                                        UGUID copyRuntime ( ) #

                                        Adds a copy of the generated runtime file with the specified path to another asset having the specified GUID.
                                        Notice
                                        A new GUID will be generated for the created runtime file copy.

                                        Arguments

                                          Return value

                                          GUID of the new runtime file copy, if it is created successfully; otherwise, empty GUID.

                                          UGUID copyRuntime ( ) #

                                          Adds a copy of the generated runtime file with the specified path to another asset having the specified path.
                                          Notice
                                          A new GUID will be generated for the created runtime file copy.

                                          Arguments

                                            Return value

                                            GUID of the new runtime file copy, if it is created successfully; otherwise, empty GUID.

                                            UGUID copyRuntime ( ) #

                                            Adds a copy of the generated runtime file with the specified GUID to another asset specified by GUID.
                                            Notice
                                            A new GUID will be generated for the created runtime file copy.

                                            Arguments

                                              Return value

                                              GUID of the new runtime file copy, if it is created successfully; otherwise, empty GUID.

                                              UGUID copyRuntime ( int index ) #

                                              Adds a copy of the runtime file with the specified index, generated for the asset specified by path, to another asset having the specified path.
                                              Notice
                                              A new GUID will be generated for the created runtime file copy.

                                              Arguments

                                              Return value

                                              GUID of the new runtime file copy, if it is created successfully; otherwise, empty GUID.

                                              UGUID copyRuntime ( int index ) #

                                              Adds a copy of the runtime file with the specified index, generated for the asset specified by path, to another asset having the specified GUID.
                                              Notice
                                              A new GUID will be generated for the created runtime file copy.

                                              Arguments

                                              Return value

                                              GUID of the new runtime file copy, if it is created successfully; otherwise, empty GUID.

                                              UGUID copyRuntime ( int index ) #

                                              Adds a copy of the runtime file with the specified index, generated for the asset specified by GUID, to another asset having the specified path.
                                              Notice
                                              A new GUID will be generated for the created runtime file copy.

                                              Arguments

                                              Return value

                                              GUID of the new runtime file copy, if it is created successfully; otherwise, empty GUID.

                                              UGUID copyRuntime ( int index ) #

                                              Adds a copy of the runtime file with the specified index, generated for the asset specified by GUID, to another asset having the specified GUID.
                                              Notice
                                              A new GUID will be generated for the created runtime file copy.

                                              Arguments

                                              Return value

                                              GUID of the new runtime file copy, if it is created successfully; otherwise, empty GUID.

                                              int copyRuntime ( ) #

                                              Adds a copy of the generated runtime file specified by path, to another asset having the specified path.
                                              Notice
                                              The created runtime file copy will have the specified runtime GUID assigned.

                                              Arguments

                                                Return value

                                                1 if the specified runtime file is successfully copied; otherwise, 0.

                                                int copyRuntime ( ) #

                                                Adds a copy of the generated runtime file specified by path, to another asset having the specified GUID.
                                                Notice
                                                The created runtime file copy will have the specified runtime GUID assigned.

                                                Arguments

                                                  Return value

                                                  1 if the specified runtime file is successfully copied; otherwise, 0.

                                                  int copyRuntime ( ) #

                                                  Adds a copy of the generated runtime file specified by GUID, to another asset having the specified path.
                                                  Notice
                                                  The created runtime file copy will have the specified runtime GUID assigned.

                                                  Arguments

                                                    Return value

                                                    1 if the specified runtime file is successfully copied; otherwise, 0.

                                                    int copyRuntime ( ) #

                                                    Adds a copy of the generated runtime file specified by GUID, to another asset having the specified GUID.
                                                    Notice
                                                    The created runtime file copy will have the specified runtime GUID assigned.

                                                    Arguments

                                                      Return value

                                                      1 if the specified runtime file is successfully copied; otherwise, 0.

                                                      int copyRuntime ( int index ) #

                                                      Adds a copy of the runtime file with the specified index, generated for the asset specified by path, to another asset having the specified path.
                                                      Notice
                                                      The created runtime file copy will have the specified runtime GUID assigned.

                                                      Arguments

                                                      Return value

                                                      1 if the specified runtime file is successfully copied; otherwise, 0.

                                                      int copyRuntime ( int index ) #

                                                      Adds a copy of the runtime file with the specified index, generated for the asset specified by path, to another asset having the specified GUID.
                                                      Notice
                                                      The created runtime file copy will have the specified runtime GUID assigned.

                                                      Arguments

                                                      Return value

                                                      1 if the specified runtime file is successfully copied; otherwise, 0.

                                                      int copyRuntime ( int index ) #

                                                      Adds a copy of the runtime file with the specified index, generated for the asset specified by GUID, to another asset having the specified path.
                                                      Notice
                                                      The created runtime file copy will have the specified runtime GUID assigned.

                                                      Arguments

                                                      Return value

                                                      1 if the specified runtime file is successfully copied; otherwise, 0.

                                                      int copyRuntime ( int index ) #

                                                      Adds a copy of the runtime file with the specified index, generated for the asset specified by GUID, to another asset having the specified GUID.
                                                      Notice
                                                      The created runtime file copy will have the specified runtime GUID assigned.

                                                      Arguments

                                                      Return value

                                                      1 if the specified runtime file is successfully copied; otherwise, 0.

                                                      int removeRuntime ( ) #

                                                      Deletes the specified generated runtime file and removes it from the list of runtimes of the corresponding asset.

                                                      Arguments

                                                        Return value

                                                        1 if the specified runtime file is successfully deleted; otherwise, 0.

                                                        int removeRuntime ( ) #

                                                        Deletes the specified generated runtime file and removes it from the list of runtimes of the corresponding asset.

                                                        Arguments

                                                          Return value

                                                          1 if the specified runtime file is successfully deleted; otherwise, 0.

                                                          int removeRuntime ( int index ) #

                                                          Deletes the generated runtime file with the specified index, and removes it from the list of runtimes of the asset specified by path.

                                                          Arguments

                                                          Return value

                                                          1 if the specified runtime file is successfully deleted; otherwise, 0.

                                                          int removeRuntime ( int index ) #

                                                          Deletes the generated runtime file with the specified index, and removes it from the list of runtimes of the asset specified by GUID.

                                                          Arguments

                                                          Return value

                                                          1 if the specified runtime file is successfully deleted; otherwise, 0.

                                                          UGUID resolve ( UGUID any_guid ) #

                                                          Resolves a given GUID.

                                                          Arguments

                                                          • UGUID any_guid - Any file GUID.

                                                          Return value

                                                          Return GUID value is determined by the GUID specified in accordance with the following:
                                                          • Non-native asset file GUID -> GUID of its primary runtime file, if any; otherwise, asset file GUID.
                                                          • Any other file GUID -> file GUID as is.
                                                          Source code (C++)
                                                          // if there is a primary runtime generated
                                                          resolve(asset_guid);		//	-> primary_guid
                                                          resolve(primary_guid);		//	-> primary_guid
                                                          resolve(runtime_guid);		//	-> runtime_guid
                                                          
                                                          // if there is no primary runtime generated
                                                          resolve(asset_guid);		//	-> asset_guid
                                                          resolve(primary_guid);		//	-> primary_guid
                                                          resolve(runtime_guid);		//	-> runtime_guid

                                                          UGUID resolveAsset ( UGUID any_guid ) #

                                                          Resolves a given GUID to a corresponding asset GUID, if any, or keeps the specified GUID as is.

                                                          Arguments

                                                          • UGUID any_guid - Any file GUID.

                                                          Return value

                                                          Return GUID value is determined by the GUID specified in accordance with the following:
                                                          • Primary runtime file GUID -> source asset file GUID.
                                                          • Generated runtime file GUID -> source asset file GUID.
                                                          • Non-native asset file GUID -> GUID as is.
                                                          • Any other file GUID -> GUID as is.
                                                          Source code (C++)
                                                          resolveAsset(asset_guid);		//	-> asset_guid
                                                          resolveAsset(primary_guid);		//	-> asset_guid
                                                          resolveAsset(runtime_guid);		//	-> asset_guid

                                                          UGUID resolvePrimary ( UGUID any_guid ) #

                                                          Resolves a given GUID to a corresponding primary runtime GUID, if any.

                                                          Arguments

                                                          • UGUID any_guid - Any file GUID.

                                                          Return value

                                                          Return GUID value is determined by the GUID specified in accordance with the following:
                                                          • Any generated runtime file GUID -> GUID of the primary runtime file for the source asset.
                                                          • Non-native asset file GUID -> GUID of its primary runtime file, if any; otherwise, empty GUID.
                                                          • Any other file GUID -> empty GUID.
                                                          Source code (C++)
                                                          // if there is a primary runtime generated
                                                          resolvePrimary(asset_guid);		//	-> primary_guid
                                                          resolvePrimary(primary_guid);	//	-> primary_guid
                                                          resolvePrimary(runtime_guid);	//	-> primary_guid
                                                          
                                                          // if there is no primary runtime generated
                                                          resolvePrimary(asset_guid);			//	-> empty guid
                                                          resolvePrimary(runtime_guid);		//	-> empty guid

                                                          UGUID resolveRuntimeAlias ( string path ) #

                                                          Resolves a given alias of a generated runtime file to a corresponding GUID, if any.

                                                          Arguments

                                                          • string path - Runtime file alias.

                                                          Return value

                                                          GUID of the generated runtime file having the specified alias, af any; otherwise, empty GUID

                                                          int setRuntimeAlias ( int index ) #

                                                          Sets a new alias for the generated runtime file, specified by the given non-native asset GUID and runtime index.

                                                          Arguments

                                                          • int index - Index of the generated runtime file.

                                                          Return value

                                                          1 if a new alias is successfully set; otherwise, 0.

                                                          int setRuntimeAlias ( ) #

                                                          Sets a new alias for the generated runtime file with a given GUID.

                                                          Arguments

                                                            Return value

                                                            1 if a new alias is successfully set; otherwise, 0.

                                                            int setRuntimeAlias ( ) #

                                                            Sets a new alias for the generated runtime file with a given path.

                                                            Arguments

                                                              Return value

                                                              1 if a new alias is successfully set; otherwise, 0.

                                                              int setRuntimeAlias ( int index ) #

                                                              Sets a new alias for the generated runtime file, specified by the given non-native asset path and runtime index.

                                                              Arguments

                                                              • int index - Index of the generated runtime file.

                                                              Return value

                                                              1 if a new alias is successfully set; otherwise, 0.

                                                              int setRuntimePrimary ( int index, int primary ) #

                                                              Sets or unsets the generated runtime file, specified by the given non-native asset path and runtime index, as a primary one.

                                                              Arguments

                                                              • int index - Index of the generated runtime file.
                                                              • int primary - 1 to make the runtime file primary; 0 to unmake, if it is already set.

                                                              Return value

                                                              1 if the runtime file is successfully set as a primary one; otherwise, 0.
                                                              Notice
                                                              There can be the only one primary runtime file, so when a new runtime file is set as the primary, the previous one is unset.

                                                              int setRuntimePrimary ( int primary ) #

                                                              Sets or unsets the generated runtime file with a given path as a primary one.

                                                              Arguments

                                                              • int primary - 1 to make the runtime file primary; 0 to unmake, if it is already set.

                                                              Return value

                                                              1 if the runtime file is successfully set as a primary one; otherwise, 0.
                                                              Notice
                                                              There can be the only one primary runtime file, so when a new runtime file is set as the primary, the previous one is unset.

                                                              int setRuntimePrimary ( int primary ) #

                                                              Sets or unsets the generated runtime file with a given GUID as a primary one.

                                                              Arguments

                                                              • int primary - 1 to make the runtime file primary; 0 to unmake, if it is already set.

                                                              Return value

                                                              1 if the runtime file is successfully set as a primary one; otherwise, 0.
                                                              Notice
                                                              There can be the only one primary runtime file, so when a new runtime file is set as the primary, the previous one is unset.

                                                              int setRuntimePrimary ( int index, int primary ) #

                                                              Sets or unsets the generated runtime file, specified by the given non-native asset GUID and runtime index, as a primary one.

                                                              Arguments

                                                              • int index - Index of the generated runtime file.
                                                              • int primary - 1 to make the runtime file primary; 0 to unmake, if it is already set.

                                                              Return value

                                                              1 if the runtime file is successfully set as a primary one; otherwise, 0.
                                                              Notice
                                                              There can be the only one primary runtime file, so when a new runtime file is set as the primary, the previous one is unset.
                                                              Last update: 2020-07-31
                                                              Build: ()