diff options
author | Justin Clarke Casey | 2008-09-16 16:37:16 +0000 |
---|---|---|
committer | Justin Clarke Casey | 2008-09-16 16:37:16 +0000 |
commit | 7f3bfa277b894b90e660badf5ee47e4d99ef102c (patch) | |
tree | 5da96a515d1d37d9aa59affa3daf42bf5c69428c /OpenSim/Region/ScriptEngine/Interfaces/IScriptEngine.cs | |
parent | Mantis #1843 (diff) | |
download | opensim-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/IScriptEngine.cs')
-rw-r--r-- | OpenSim/Region/ScriptEngine/Interfaces/IScriptEngine.cs | 22 |
1 files changed, 17 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 | ||
37 | namespace OpenSim.Region.ScriptEngine.Interfaces | 37 | namespace 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); |