diff options
author | Justin Clark-Casey (justincc) | 2010-01-11 17:17:58 +0000 |
---|---|---|
committer | Justin Clark-Casey (justincc) | 2010-01-11 17:17:58 +0000 |
commit | b88bee9d48c2f953867737520f9ed731dc84cc2a (patch) | |
tree | 474b4022117ce5321606a38f52a5eab8022d8e62 /OpenSim | |
parent | Add explanation about AllowModFunctions to OpenSim.ini.example (diff) | |
download | opensim-SC-b88bee9d48c2f953867737520f9ed731dc84cc2a.zip opensim-SC-b88bee9d48c2f953867737520f9ed731dc84cc2a.tar.gz opensim-SC-b88bee9d48c2f953867737520f9ed731dc84cc2a.tar.bz2 opensim-SC-b88bee9d48c2f953867737520f9ed731dc84cc2a.tar.xz |
add interface/method documentatio nto IScriptModuleComms
Diffstat (limited to '')
-rw-r--r-- | OpenSim/Region/Framework/Interfaces/IScriptModuleComms.cs | 20 |
1 files changed, 18 insertions, 2 deletions
diff --git a/OpenSim/Region/Framework/Interfaces/IScriptModuleComms.cs b/OpenSim/Region/Framework/Interfaces/IScriptModuleComms.cs index 5cdf191..d7fa316 100644 --- a/OpenSim/Region/Framework/Interfaces/IScriptModuleComms.cs +++ b/OpenSim/Region/Framework/Interfaces/IScriptModuleComms.cs | |||
@@ -32,13 +32,29 @@ namespace OpenSim.Region.Framework.Interfaces | |||
32 | { | 32 | { |
33 | public delegate void ScriptCommand(UUID script, string id, string module, string command, string k); | 33 | public delegate void ScriptCommand(UUID script, string id, string module, string command, string k); |
34 | 34 | ||
35 | /// <summary> | ||
36 | /// Interface for communication between OpenSim modules and in-world scripts | ||
37 | /// </summary> | ||
38 | /// | ||
39 | /// See OpenSim.Region.ScriptEngine.Shared.Api.MOD_Api.modSendCommand() for information on receiving messages | ||
40 | /// from scripts in OpenSim modules. | ||
35 | public interface IScriptModuleComms | 41 | public interface IScriptModuleComms |
36 | { | 42 | { |
43 | /// <summary> | ||
44 | /// Modules can subscribe to this event to receive command invocations from in-world scripts | ||
45 | /// </summary> | ||
37 | event ScriptCommand OnScriptCommand; | 46 | event ScriptCommand OnScriptCommand; |
38 | 47 | ||
39 | void DispatchReply(UUID script, int code, string text, string k); | 48 | /// <summary> |
49 | /// Send a link_message event to an in-world script | ||
50 | /// </summary> | ||
51 | /// <param name="scriptId"></param> | ||
52 | /// <param name="code"></param> | ||
53 | /// <param name="text"></param> | ||
54 | /// <param name="key"></param> | ||
55 | void DispatchReply(UUID scriptId, int code, string text, string key); | ||
40 | 56 | ||
41 | // For use ONLY by the script API | 57 | // For use ONLY by the script API |
42 | void RaiseEvent(UUID script, string id, string module, string command, string k); | 58 | void RaiseEvent(UUID script, string id, string module, string command, string key); |
43 | } | 59 | } |
44 | } | 60 | } |