FindFirstFile

A command for Pluggy.

Syntax:

(IsFileFound:bool) FindFirstFile (FileFound)StringID:long (FileMask)StringID:long RootID:short Directories:bool Global:bool

Note: All arguments should be on the same line.

Sets the content of (FileFound)StringID to the Filename of the first matching File and returns 1 if a file was found; 0 if not.

Notes

• FileMask is the StringID of the string containing the Windows filemask for the search. Wildcards are allowed. Default is -42 (*) (i.e.: every file).
• RootID specifies in which folder the search should be proceeded. Default is 0.
  • 0: "My Documents\My Games\Oblivion\Pluggy\User Files\"
  • 1: Oblivion Data folder.
  • 2: Oblivion main folder.
• Defines if files (0) or directories (1) are returned. Default is 0.
• If you want to modify a string from another mod, you will need to set the Global flag to 1. If Global is 0 or unset the function will fail. If the string is protected the function will fail.

Example

Quest script that display in the console the list of *.bsa files in Oblivion/Data folder:

scn testffs

Begin GameMode
    SetString -2000 "*.bsa"
    If ( FindFirstFile -2050 -2000 1 ) == 0
        StopQuest TestFF
        Return
    EndIf
    
    SaveIP
    
    StringMsg -2050 1
    If ( FindNextFile -2050 ) == 0
        StopQuest TestFF
        Return
    EndIf
    
    RestoreIP
End

See also

• FindNextFile
• GetFileSize