From b88bee9d48c2f953867737520f9ed731dc84cc2a Mon Sep 17 00:00:00 2001
From: Justin Clark-Casey (justincc)
Date: Mon, 11 Jan 2010 17:17:58 +0000
Subject: add interface/method documentatio nto IScriptModuleComms
---
.../Framework/Interfaces/IScriptModuleComms.cs | 20 ++++++++++++++++++--
1 file 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
{
public delegate void ScriptCommand(UUID script, string id, string module, string command, string k);
+ ///
+ /// Interface for communication between OpenSim modules and in-world scripts
+ ///
+ ///
+ /// See OpenSim.Region.ScriptEngine.Shared.Api.MOD_Api.modSendCommand() for information on receiving messages
+ /// from scripts in OpenSim modules.
public interface IScriptModuleComms
{
+ ///
+ /// Modules can subscribe to this event to receive command invocations from in-world scripts
+ ///
event ScriptCommand OnScriptCommand;
- void DispatchReply(UUID script, int code, string text, string k);
+ ///
+ /// Send a link_message event to an in-world script
+ ///
+ ///
+ ///
+ ///
+ ///
+ void DispatchReply(UUID scriptId, int code, string text, string key);
// For use ONLY by the script API
- void RaiseEvent(UUID script, string id, string module, string command, string k);
+ void RaiseEvent(UUID script, string id, string module, string command, string key);
}
}
--
cgit v1.1