DirectOutputR1
DirectOutput framework R1 for virtual pinball cabinets.
Go to:
Overview 
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Events Macros Pages
DirectOutput.Scripting.ScriptList Class Reference

List of Script objects. More...

Inheritance diagram for DirectOutput.Scripting.ScriptList:
Collaboration diagram for DirectOutput.Scripting.ScriptList:

Public Member Functions

IEnumerator< ScriptGetEnumerator ()
 Returns an enumerator that iterates through the collection. More...
 
void LoadAndAddScripts (string ScriptDirectory, string FilePattern="*.cs", bool ThrowExceptions=false)
 Loads and adds scripts from the specified directory. More...
 
void LoadAndAddScripts (DirectoryInfo ScriptDirectory, string FilePattern="*.cs", bool ThrowExceptions=false)
 Loads and adds scripts from the specified directory. More...
 
void LoadAndAddScripts (IEnumerable< FileInfo > ScriptFiles, bool ThrowExceptions=false)
 Loads and adds the scripts in the specified list of FileInfo objects. More...
 
void LoadAndAddScript (FileInfo ScriptFile, bool ThrowExceptions=false)
 Load and adds the script specified in the FileInfo object. More...
 

Properties

Script this[string Filename] [get]
 Gets the Script with the specified filename. More...
 
Script this[int Index] [get]
 Gets the Script at the specified index. More...
 
int Count [get]
 Gets the count of Script objects in the list. More...
 

Detailed Description

List of Script objects.

Definition at line 10 of file ScriptList.cs.

Member Function Documentation

IEnumerator<Script> DirectOutput.Scripting.ScriptList.GetEnumerator ( )
inline

Returns an enumerator that iterates through the collection.

Returns
A T:System.Collections.Generic.IEnumerator`1 that can be used to iterate through the collection.

Definition at line 21 of file ScriptList.cs.

void DirectOutput.Scripting.ScriptList.LoadAndAddScript ( FileInfo  ScriptFile,
bool  ThrowExceptions = false 
)
inline

Load and adds the script specified in the FileInfo object.

Parameters
ScriptFileThe script file.
ThrowExceptionsIf set to true exceptions are thrown if errors occur during script loading and compiling or if a script has already been added to the list.

Definition at line 130 of file ScriptList.cs.

void DirectOutput.Scripting.ScriptList.LoadAndAddScripts ( string  ScriptDirectory,
string  FilePattern = "*.cs",
bool  ThrowExceptions = false 
)
inline

Loads and adds scripts from the specified directory.

Parameters
ScriptDirectoryThe path to the script directory.
FilePatternThe file search pattern.
ThrowExceptionsIf set to true exceptions are thrown if errors occur during script loading and compiling or if a script has already been added to the list.

Definition at line 95 of file ScriptList.cs.

void DirectOutput.Scripting.ScriptList.LoadAndAddScripts ( DirectoryInfo  ScriptDirectory,
string  FilePattern = "*.cs",
bool  ThrowExceptions = false 
)
inline

Loads and adds scripts from the specified directory.

Parameters
ScriptDirectoryThe DirectoryInfo object for the script directory.
FilePatternThe file search pattern.
ThrowExceptionsIf set to true exceptions are thrown if errors occur during script loading and compiling or if a script has already been added to the list.

Definition at line 106 of file ScriptList.cs.

void DirectOutput.Scripting.ScriptList.LoadAndAddScripts ( IEnumerable< FileInfo >  ScriptFiles,
bool  ThrowExceptions = false 
)
inline

Loads and adds the scripts in the specified list of FileInfo objects.

Parameters
ScriptFilesIEnumerable list of FIleInfo objects.
ThrowExceptionsIf set to true exceptions are thrown if errors occur during script loading and compiling or if a script has already been added to the list.

Definition at line 116 of file ScriptList.cs.

Property Documentation

int DirectOutput.Scripting.ScriptList.Count
get

Gets the count of Script objects in the list.

The count of Script objects in the list.

Definition at line 85 of file ScriptList.cs.

Script DirectOutput.Scripting.ScriptList.this[int Index]
get

Gets the Script at the specified index.

The Script at the specified index.

Parameters
IndexThe index of the object.
Returns

Definition at line 71 of file ScriptList.cs.

Script DirectOutput.Scripting.ScriptList.this[string Filename]
get

Gets the Script with the specified filename.

The Script object for the spiecifed file.

Parameters
FilenameThe filename of the script.
Returns

Definition at line 47 of file ScriptList.cs.


The documentation for this class was generated from the following file: