diff options
author | SignpostMarv | 2012-09-14 13:20:14 +0100 |
---|---|---|
committer | Melanie | 2012-09-17 14:15:52 +0100 |
commit | 0e5f5538bcaa031ae252468e5c0b70e5dce1a9b1 (patch) | |
tree | a6e1d6977d54509b0ba5135bf56218dbecec9f45 /OpenSim/Region/Framework | |
parent | Implementing ability to register script constants and invocations on a region... (diff) | |
download | opensim-SC_OLD-0e5f5538bcaa031ae252468e5c0b70e5dce1a9b1.zip opensim-SC_OLD-0e5f5538bcaa031ae252468e5c0b70e5dce1a9b1.tar.gz opensim-SC_OLD-0e5f5538bcaa031ae252468e5c0b70e5dce1a9b1.tar.bz2 opensim-SC_OLD-0e5f5538bcaa031ae252468e5c0b70e5dce1a9b1.tar.xz |
Documentation of IScriptModuleComms.RegisterConstant and IScriptModuleComms.LookupModConstant
Signed-off-by: Melanie <melanie@t-data.com>
Diffstat (limited to 'OpenSim/Region/Framework')
-rw-r--r-- | OpenSim/Region/Framework/Interfaces/IScriptModuleComms.cs | 19 |
1 files changed, 18 insertions, 1 deletions
diff --git a/OpenSim/Region/Framework/Interfaces/IScriptModuleComms.cs b/OpenSim/Region/Framework/Interfaces/IScriptModuleComms.cs index 277c9ed..93930ce 100644 --- a/OpenSim/Region/Framework/Interfaces/IScriptModuleComms.cs +++ b/OpenSim/Region/Framework/Interfaces/IScriptModuleComms.cs | |||
@@ -104,7 +104,18 @@ namespace OpenSim.Region.Framework.Interfaces | |||
104 | /// <param name="key"></param> | 104 | /// <param name="key"></param> |
105 | void DispatchReply(UUID scriptId, int code, string text, string key); | 105 | void DispatchReply(UUID scriptId, int code, string text, string key); |
106 | 106 | ||
107 | /// For constants | 107 | /// <summary> |
108 | /// Operation to for a region module to register a constant to be used | ||
109 | /// by the script engine | ||
110 | /// </summary> | ||
111 | /// <param name="cname"> | ||
112 | /// The name of the constant. LSL convention is for constant names to | ||
113 | /// be uppercase. | ||
114 | /// </param> | ||
115 | /// <param name="value"> | ||
116 | /// The value of the constant. Should be of a type that can be | ||
117 | /// converted to one of <see cref="OpenSim.Region.ScriptEngine.Shared.LSL_Types"/> | ||
118 | /// </param> | ||
108 | void RegisterConstant(string cname, object value); | 119 | void RegisterConstant(string cname, object value); |
109 | 120 | ||
110 | /// <summary> | 121 | /// <summary> |
@@ -113,6 +124,12 @@ namespace OpenSim.Region.Framework.Interfaces | |||
113 | /// </summary> | 124 | /// </summary> |
114 | /// <param name="target"></param> | 125 | /// <param name="target"></param> |
115 | void RegisterConstants(IRegionModuleBase target); | 126 | void RegisterConstants(IRegionModuleBase target); |
127 | |||
128 | /// <summary> | ||
129 | /// Operation to check for a registered constant | ||
130 | /// </summary> | ||
131 | /// <param name="cname">Name of constant</param> | ||
132 | /// <returns>Value of constant or null if none found.</returns> | ||
116 | object LookupModConstant(string cname); | 133 | object LookupModConstant(string cname); |
117 | 134 | ||
118 | // For use ONLY by the script API | 135 | // For use ONLY by the script API |