Class: MockFileSystemList

Mock of the X-Ray engine FS file list.

Implements

• FS_file_list
• FS_file_list_ex

Constructors

Constructor

new MockFileSystemList(list?: (string | FS_item)[]): MockFileSystemList;

Parameters

Parameter	Type	Default value
list	(string | FS_item)[]	[]

Returns

MockFileSystemList

Methods

Free()

Free(): void;

Release the native file list.

Returns

void

Implementation of

FS_file_list.Free

---

GetAt()

GetAt(index: number): FS_item;

Get file item by index.

Parameters

Parameter	Type	Description
index	number	Zero-based item index.

Returns

FS_item

File item.

Remarks

The binding does not clamp the index. Use Size before indexing.

Implementation of

FS_file_list.GetAt

---

Size()

Size(): number;

Get number of items in the list.

Returns

number

Item count.

Implementation of

FS_file_list.Size

---

Sort()

Sort(_mode?: number): void;

Sort the list with an FS_sort_by_* mode.

Parameters

Parameter	Type
_mode?	number

Returns

void

Remarks

Unknown sort modes are ignored.

Implementation of

FS_file_list_ex.Sort

---

create()

static create(list?: (string | FS_item)[]): MockFileSystemList;

Parameters

Parameter	Type	Default value
list	(string | FS_item)[]	[]

Returns

MockFileSystemList

---

mock()

static mock(list?: (string | FS_item)[]): FS_file_list & FS_file_list_ex;

Parameters

Parameter	Type	Default value
list	(string | FS_item)[]	[]

Returns

FS_file_list & FS_file_list_ex

Properties

list

list: FS_item[];