opensim-development – Blame information for rev 1

Subversion Repositories:
Rev:
Rev Author Line No. Line
1 eva 1 /*
2 * Copyright (c) Contributors, http://opensimulator.org/
3 * See CONTRIBUTORS.TXT for a full list of copyright holders.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are met:
7 * * Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
9 * * Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
12 * * Neither the name of the OpenSimulator Project nor the
13 * names of its contributors may be used to endorse or promote products
14 * derived from this software without specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY
17 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19 * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY
20 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
23 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
25 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 */
27  
28 using System;
29 using System.Reflection;
30 using OpenSim.Framework;
31 using OpenSim.Region.Framework.Scenes;
32 using OpenSim.Region.Framework.Interfaces;
33 using OpenSim.Region.ScriptEngine.Interfaces;
34 using OpenSim.Region.ScriptEngine.Shared;
35 using Amib.Threading;
36 using log4net;
37 using Nini.Config;
38 using OpenMetaverse;
39  
40 namespace OpenSim.Region.ScriptEngine.Interfaces
41 {
42 /// <summary>
43 /// An interface for a script API module to communicate with
44 /// the engine it's running under
45 /// </summary>
46 public interface IScriptEngine
47 {
48 /// <summary>
49 /// Queue an event for execution
50 /// </summary>
51 IScriptWorkItem QueueEventHandler(object parms);
52  
53 Scene World { get; }
54  
55 IScriptModule ScriptModule { get; }
56  
57 /// <summary>
58 /// Post an event to a single script
59 /// </summary>
60 bool PostScriptEvent(UUID itemID, EventParams parms);
61  
62 /// <summary>
63 /// Post event to an entire prim
64 /// </summary>
65 bool PostObjectEvent(uint localID, EventParams parms);
66  
67 DetectParams GetDetectParams(UUID item, int number);
68 void SetMinEventDelay(UUID itemID, double delay);
69 int GetStartParameter(UUID itemID);
70  
71 void SetScriptState(UUID itemID, bool state);
72 bool GetScriptState(UUID itemID);
73 void SetState(UUID itemID, string newState);
74 void ApiResetScript(UUID itemID);
75 void ResetScript(UUID itemID);
76 IConfig Config { get; }
77 IConfigSource ConfigSource { get; }
78 string ScriptEngineName { get; }
79 string ScriptEnginePath { get; }
80  
81 /// <summary>
82 /// Return the name of the class that will be used for all running scripts.
83 /// </summary>
84 /// <remarks>
85 /// Each class goes in its own assembly so we don't need to otherwise distinguish the class name.
86 /// </remarks>
87 string ScriptClassName { get; }
88  
89 /// <summary>
90 /// Return the name of the base class that will be used for all running scripts.
91 /// </summary>
92 string ScriptBaseClassName { get; }
93  
94 /// <summary>
95 /// Assemblies that need to be referenced when compiling scripts.
96 /// </summary>
97 /// <remarks>
98 /// These are currently additional to those always referenced by the compiler, BUT THIS MAY CHANGE IN THE
99 /// FUTURE.
100 /// This can be null if there are no additional assemblies.
101 /// </remarks>
102 string[] ScriptReferencedAssemblies { get; }
103  
104 /// <summary>
105 /// Parameters for the generated script's constructor.
106 /// </summary>
107 /// <remarks>
108 /// Can be null if there are no parameters
109 /// </remarks>
110 ParameterInfo[] ScriptBaseClassParameters { get; }
111  
112 IScriptApi GetApi(UUID itemID, string name);
113 }
114 }