File Search

System Summary

Descriptive summary of what the system is and what it does.

A global script that handles searching through the user's file system

---

Connected Systems

List of connecting/parent/subsystems.

Connecting Systems:

• Asset Manager

---

Bugs

List of known bugs. Be descriptive but keep it brief!

• None

---

Feature List / Breakdown of Features

List of features and descriptions within system.

Finding files:

• Can be used to search a root folder for files of a specific name

Finding directories:

• Can be used to search a root folder for directories of a specific name

File count:

• Can be used to count how many files are within a directory

Folder deletion:

• Can delete a folder including everything in it

---

Important Variables

Name the most important variables, their type, and what their purpose is

• filePath : String = The root file path that the file search will be confined to

Important Functions

Name of the most important functions, their parameters, and what they do.

• func find_file_by_name(targetFileName : String, currentDirectory : String) -> String: Recursively searches the file system to find and return the file path to a specified file

• func find_directory_by_name(targetDirectoryName : String, currentDirectory : String) -> String: Recursively searches the file system to find and return the file path to a specified directory

• func file_count_in_folder(folderName : String) -> int: Gets the amount of files within a folder

• func delete_folder(folderPath : String) -> void: Recursively deletes all files within a folder before deleting the folder

---

Future Work / Risks

List and description of upcoming work/risks.

Future Work:

1. Change the filepath dynamically to allow for assets to be level-based

Risks:

• Risk 1

---

Miscellaneous Notes

A place for miscellaneous notes pertaining to this system.

• Note 1
  • Subnote 1
• Note 2