API:DirectoryStream

The new DirectoryStream() constructor initializes an object that allows you to enumerate the contents of a directory.

Usage

dirstream_obj = new DirectoryStream(dir_name);

API Information

Description

new DirectoryStream() constructs a Directory Stream object, which allows you to enumerate the contents of a directory. Directory streams only provide filenames; you must use a FileStream to access the contents of a file.

Note:

The DirectoryStream class implements the JavaScript iterator protocol, which means you can use them in from() queries and for-of loops.

Parameters

dir_name

Path to the directory to be enumerated. Relative to the game manifest unless a SphereFS prefix is included.

Return Value

A newly constructed DirectoryStream object pointing at dir_name.

Class Information

Properties

• DirectoryStream::fileCount
• DirectoryStream::fileName
• DirectoryStream::position

Methods

• DirectoryStream::dispose()
• DirectoryStream::next()
• DirectoryStream::rewind()

See Also

• from()
• new FileStream()