aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/OpenSim/Region/ScriptEngine/Interfaces
diff options
context:
space:
mode:
authorJustin Clarke Casey2008-09-16 16:37:16 +0000
committerJustin Clarke Casey2008-09-16 16:37:16 +0000
commit7f3bfa277b894b90e660badf5ee47e4d99ef102c (patch)
tree5da96a515d1d37d9aa59affa3daf42bf5c69428c /OpenSim/Region/ScriptEngine/Interfaces
parentMantis #1843 (diff)
downloadopensim-SC_OLD-7f3bfa277b894b90e660badf5ee47e4d99ef102c.zip
opensim-SC_OLD-7f3bfa277b894b90e660badf5ee47e4d99ef102c.tar.gz
opensim-SC_OLD-7f3bfa277b894b90e660badf5ee47e4d99ef102c.tar.bz2
opensim-SC_OLD-7f3bfa277b894b90e660badf5ee47e4d99ef102c.tar.xz
* minor: method documentation
Diffstat (limited to 'OpenSim/Region/ScriptEngine/Interfaces')
-rw-r--r--OpenSim/Region/ScriptEngine/Interfaces/IScriptEngine.cs22
-rw-r--r--OpenSim/Region/ScriptEngine/Interfaces/IScriptInstance.cs8
2 files changed, 25 insertions, 5 deletions
diff --git a/OpenSim/Region/ScriptEngine/Interfaces/IScriptEngine.cs b/OpenSim/Region/ScriptEngine/Interfaces/IScriptEngine.cs
index 43c2487..ba7e653 100644
--- a/OpenSim/Region/ScriptEngine/Interfaces/IScriptEngine.cs
+++ b/OpenSim/Region/ScriptEngine/Interfaces/IScriptEngine.cs
@@ -36,28 +36,40 @@ using Amib.Threading;
36 36
37namespace OpenSim.Region.ScriptEngine.Interfaces 37namespace OpenSim.Region.ScriptEngine.Interfaces
38{ 38{
39 /// <summary>
40 /// An interface for a script API module to communicate with
41 /// the engine it's running under
42 /// </summary>
39 public interface IScriptEngine 43 public interface IScriptEngine
40 { 44 {
41 //
42 // An interface for a script API module to communicate with
43 // the engine it's running under
44 //
45
46 Scene World { get; } 45 Scene World { get; }
47 IConfig Config { get; } 46 IConfig Config { get; }
48 Object AsyncCommands { get; } 47 Object AsyncCommands { get; }
49 ILog Log { get; } 48 ILog Log { get; }
50 string ScriptEngineName { get; } 49 string ScriptEngineName { get; }
51 50
51 /// <summary>
52 /// Post an event to a single script
53 /// </summary>
52 bool PostScriptEvent(UUID itemID, EventParams parms); 54 bool PostScriptEvent(UUID itemID, EventParams parms);
55
56 /// <summary>
57 /// Post event to an entire prim
58 /// </summary>
53 bool PostObjectEvent(uint localID, EventParams parms); 59 bool PostObjectEvent(uint localID, EventParams parms);
60
54 void ApiResetScript(UUID itemID); 61 void ApiResetScript(UUID itemID);
55 void ResetScript(UUID itemID); 62 void ResetScript(UUID itemID);
56 void SetScriptState(UUID itemID, bool state); 63 void SetScriptState(UUID itemID, bool state);
57 bool GetScriptState(UUID itemID); 64 bool GetScriptState(UUID itemID);
58 void SetState(UUID itemID, string newState); 65 void SetState(UUID itemID, string newState);
59 int GetStartParameter(UUID itemID); 66 int GetStartParameter(UUID itemID);
67
68 /// <summary>
69 /// Queue an event for execution
70 /// </summary>
60 IScriptWorkItem QueueEventHandler(object parms); 71 IScriptWorkItem QueueEventHandler(object parms);
72
61 IScriptApi GetApi(UUID itemID, string name); 73 IScriptApi GetApi(UUID itemID, string name);
62 74
63 DetectParams GetDetectParams(UUID item, int number); 75 DetectParams GetDetectParams(UUID item, int number);
diff --git a/OpenSim/Region/ScriptEngine/Interfaces/IScriptInstance.cs b/OpenSim/Region/ScriptEngine/Interfaces/IScriptInstance.cs
index 169955c..a05edbd 100644
--- a/OpenSim/Region/ScriptEngine/Interfaces/IScriptInstance.cs
+++ b/OpenSim/Region/ScriptEngine/Interfaces/IScriptInstance.cs
@@ -50,6 +50,9 @@ namespace OpenSim.Region.ScriptEngine.Interfaces
50 bool Wait(TimeSpan t); 50 bool Wait(TimeSpan t);
51 } 51 }
52 52
53 /// <summary>
54 /// Interface for interaction with a particular script instance
55 /// </summary>
53 public interface IScriptInstance 56 public interface IScriptInstance
54 { 57 {
55 bool Running { get; set; } 58 bool Running { get; set; }
@@ -75,6 +78,11 @@ namespace OpenSim.Region.ScriptEngine.Interfaces
75 void SetState(string state); 78 void SetState(string state);
76 79
77 void PostEvent(EventParams data); 80 void PostEvent(EventParams data);
81
82 /// <summary>
83 /// Process the next event queued for this script
84 /// </summary>
85 /// <returns></returns>
78 object EventProcessor(); 86 object EventProcessor();
79 87
80 int EventTime(); 88 int EventTime();