C#Code
C#Code
Public Member Functions | Private Attributes
Libraries.ScriptingCSharp.BaseCSharpScript Class Reference
Inheritance diagram for Libraries.ScriptingCSharp.BaseCSharpScript:
Libraries.TestScripting.SetupRun3D Libraries.TestScripting.SetupRun3D

List of all members.

Public Member Functions

 BaseCSharpScript (CSharpScriptDelegate script, StringType ID)
 BaseCSharpScript (CSharpScriptDelegate script, string ID)
 BaseCSharpScript (CSharpScriptDelegate script)
void StoreParamObj (object param)
Libraries.StringType GetScriptID ()
bool IsFinished ()
void Run ()
IEnumerator< bool > Yield ()
 BaseCSharpScript (CSharpScriptDelegate script, StringType ID)
 BaseCSharpScript (CSharpScriptDelegate script, string ID)
 BaseCSharpScript (CSharpScriptDelegate script)
Libraries.StringType GetScriptID ()
bool IsFinished ()
void Run ()
IEnumerator< bool > Yield ()

Private Attributes

StringType m_ID = null
 The ID of the script. Used when you want to be able to access a specific script in the script manager.
IEnumerator< bool > m_scriptEnumerator
 The script. A enumerator so we can do yield in the script.
CSharpScriptDelegate m_script
 Store the script to run.
object m_scriptParam
 Param object to pass when running the script.

Detailed Description

This is a base C# script. Derive real scripts from it. A script is anonymous if it doesn't have a ID. Once a anonymous script runs, it runs until it finishes or the script manager is cleared.


Constructor & Destructor Documentation

Libraries.ScriptingCSharp.BaseCSharpScript.BaseCSharpScript ( CSharpScriptDelegate  script,
StringType  ID 
)

Constructor. Set the script delegate that will be run by the script. The delegate is what contains the script code to run. Put yields in the script delegate to simulate the way lua works.

script - The script delegate to run.
ID - ID to use for the script. If null then it will be a anonymous
Libraries.ScriptingCSharp.BaseCSharpScript.BaseCSharpScript ( CSharpScriptDelegate  script,
string  ID 
)

Constructor. Set the script delegate that will be run by the script. The delegate is what contains the script code to run. Put yields in the script delegate to simulate the way lua works.

script - The script delegate to run.
ID - ID to use for the script. If null then it will be a anonymous
Libraries.ScriptingCSharp.BaseCSharpScript.BaseCSharpScript ( CSharpScriptDelegate  script)

Constructor. Set the script delegate that will be run by the script. The delegate is what contains the script code to run. Put yields in the script delegate to simulate the way lua works. This will be a anonymous script.

script - The script delegate to run.
Libraries.ScriptingCSharp.BaseCSharpScript.BaseCSharpScript ( CSharpScriptDelegate  script,
StringType  ID 
)

Constructor. Set the script delegate that will be run by the script. The delegate is what contains the script code to run. Put yields in the script delegate to simulate the way lua works.

script - The script delegate to run.
ID - ID to use for the script. If null then it will be a anonymous
Libraries.ScriptingCSharp.BaseCSharpScript.BaseCSharpScript ( CSharpScriptDelegate  script,
string  ID 
)

Constructor. Set the script delegate that will be run by the script. The delegate is what contains the script code to run. Put yields in the script delegate to simulate the way lua works.

script - The script delegate to run.
ID - ID to use for the script. If null then it will be a anonymous
Libraries.ScriptingCSharp.BaseCSharpScript.BaseCSharpScript ( CSharpScriptDelegate  script)

Constructor. Set the script delegate that will be run by the script. The delegate is what contains the script code to run. Put yields in the script delegate to simulate the way lua works. This will be a anonymous script.

script - The script delegate to run.

Member Function Documentation

Libraries.StringType Libraries.ScriptingCSharp.BaseCSharpScript.GetScriptID ( )

Get the ID associated with the script. This will be null if it is a anonymous script.

Libraries.StringType Libraries.ScriptingCSharp.BaseCSharpScript.GetScriptID ( )

Get the ID associated with the script. This will be null if it is a anonymous script.

bool Libraries.ScriptingCSharp.BaseCSharpScript.IsFinished ( )

Get wether the script has finished.

Return:
Value is true if the script has finished, false if not.

bool Libraries.ScriptingCSharp.BaseCSharpScript.IsFinished ( )

Get wether the script has finished.

Return:
Value is true if the script has finished, false if not.

void Libraries.ScriptingCSharp.BaseCSharpScript.Run ( )

Run the script. Does nothing if the script is finished.

void Libraries.ScriptingCSharp.BaseCSharpScript.Run ( )

Run the script. Does nothing if the script is finished.

void Libraries.ScriptingCSharp.BaseCSharpScript.StoreParamObj ( object  param)

Stores the given object to use as the param to pass when running the script.

param - Param to store.
IEnumerator<bool> Libraries.ScriptingCSharp.BaseCSharpScript.Yield ( )

Yields the script. Return the result of this funtion to yield the script. Yielding leaves the script at that point and continues there the next time the script is run.

IEnumerator<bool> Libraries.ScriptingCSharp.BaseCSharpScript.Yield ( )

Yields the script. Return the result of this funtion to yield the script. Yielding leaves the script at that point and continues there the next time the script is run.


Member Data Documentation

The ID of the script. Used when you want to be able to access a specific script in the script manager.

Store the script to run.

Store the script to run. This will be null when the script has finished.

The script. A enumerator so we can do yield in the script.

Param object to pass when running the script.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Enumerations Properties