mirror of
https://github.com/opensim/opensim.git
synced 2026-07-31 13:55:35 +08:00
* minor: method documentation
This commit is contained in:
@@ -36,28 +36,40 @@ using Amib.Threading;
|
||||
|
||||
namespace OpenSim.Region.ScriptEngine.Interfaces
|
||||
{
|
||||
/// <summary>
|
||||
/// An interface for a script API module to communicate with
|
||||
/// the engine it's running under
|
||||
/// </summary>
|
||||
public interface IScriptEngine
|
||||
{
|
||||
//
|
||||
// An interface for a script API module to communicate with
|
||||
// the engine it's running under
|
||||
//
|
||||
|
||||
Scene World { get; }
|
||||
IConfig Config { get; }
|
||||
Object AsyncCommands { get; }
|
||||
ILog Log { get; }
|
||||
string ScriptEngineName { get; }
|
||||
|
||||
/// <summary>
|
||||
/// Post an event to a single script
|
||||
/// </summary>
|
||||
bool PostScriptEvent(UUID itemID, EventParams parms);
|
||||
|
||||
/// <summary>
|
||||
/// Post event to an entire prim
|
||||
/// </summary>
|
||||
bool PostObjectEvent(uint localID, EventParams parms);
|
||||
|
||||
void ApiResetScript(UUID itemID);
|
||||
void ResetScript(UUID itemID);
|
||||
void SetScriptState(UUID itemID, bool state);
|
||||
bool GetScriptState(UUID itemID);
|
||||
void SetState(UUID itemID, string newState);
|
||||
int GetStartParameter(UUID itemID);
|
||||
|
||||
/// <summary>
|
||||
/// Queue an event for execution
|
||||
/// </summary>
|
||||
IScriptWorkItem QueueEventHandler(object parms);
|
||||
|
||||
IScriptApi GetApi(UUID itemID, string name);
|
||||
|
||||
DetectParams GetDetectParams(UUID item, int number);
|
||||
|
||||
@@ -50,6 +50,9 @@ namespace OpenSim.Region.ScriptEngine.Interfaces
|
||||
bool Wait(TimeSpan t);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Interface for interaction with a particular script instance
|
||||
/// </summary>
|
||||
public interface IScriptInstance
|
||||
{
|
||||
bool Running { get; set; }
|
||||
@@ -75,6 +78,11 @@ namespace OpenSim.Region.ScriptEngine.Interfaces
|
||||
void SetState(string state);
|
||||
|
||||
void PostEvent(EventParams data);
|
||||
|
||||
/// <summary>
|
||||
/// Process the next event queued for this script
|
||||
/// </summary>
|
||||
/// <returns></returns>
|
||||
object EventProcessor();
|
||||
|
||||
int EventTime();
|
||||
|
||||
Reference in New Issue
Block a user